WSSCacheManagement command group for the AdminTask object

Use this topic as a reference for the commands for the WSSCacheManagement group of the AdminTask object. Use these commands with your administrative scripts to query, update, and remove distributed cache configuration data.

Use the following commands in the WSSCacheManagement group to manage your custom and non-custom distributed cache configurations:

deleteWSSDistributedCacheConfigCustomProperties command

The deleteWSSDistributedCacheConfigCustomProperties command removes WS-Security distributed cache custom properties.

Target object

None

Required parameters

-propertyNames
Specifies the names of the custom properties to delete from the distributed cache configuration. (String[])

Optional parameters

None.

Return value

This command returns a message that indicates the success or failure of the command.

Batch mode example usage

  • Using Jython string: 
    AdminTask.deleteWSSDistributedCacheConfigCustomProperties('[-propertyNames
 [prop1,prop2,prop3]]')
  • Using Jython list: 
    AdminTask.deleteWSSDistributedCacheConfigCustomProperties([',-'propertyNames', 
'[prop1,prop2,prop3]'])

Interactive mode example usage

  • Using Jython:
    AdminTask.deleteWSSDistributedCacheConfigCustomProperties('-interactive')

queryWSSDistributedCacheConfig command

The queryWSSDistributedCacheConfig command lists the WS-Security distributed cache configuration non-custom properties.

Target object

None.

Required parameters

None.

Optional parameters

None.

Return value

This command returns a properties object that contains the configuration properties and values for the distributed cache configuration. The following table displays the configuration properties that the command returns:
Table 1. Command properties . Use the command to list distributed cache configuration properties.
Property Description
tokenRecovery Specifies whether token recovery is enabled or disabled. If the tokenRecovery property is set to true, the Datasource property specifies the shared data source that is assigned to the distributed cache.
distributedCache Specifies whether distributed caching is enabled or disabled.
Datasource Specifies the name of the shared data source that is assigned to the distributed cache if token recovery is enabled.
renewIntervalBeforeTimeoutMinutes Specifies the amount of time, in minutes, that the client waits before it attempts to renew the token.
synchronousClusterUpdate Specifies whether the system performs a synchronous update of distributed caches on cluster members. By default, synchronous cluster updating is enabled.
minutesInCacheAfterTimeout Specifies the amount of time that the token remains in the cache after the token times out.

Batch mode example usage

  • Using Jython: 
    print AdminTask.queryWSSDistributedCacheConfig()

Interactive mode example usage

  • Using Jython:
    AdminTask.queryWSSDistributedCacheConfig('-interactive')

queryWSSDistributedCacheCustomConfig command

The queryWSSDistributedCacheCustomConfig command lists the WS-Security distributed cache configuration custom properties.

Target object

None.

Required parameters

None.

Optional parameters

None.

Return value

This command returns a properties object that contains the name and value pairs that correspond to each custom property.

Batch mode example usage

  • Using Jython: 
    AdminTask.queryWSSDistributedCacheCustomConfig()

Interactive mode example usage

  • Using Jython:
    AdminTask.queryWSSDistributedCacheCustomConfig('-interactive')

updateWSSDistributedCacheConfig command

The updateWSSDistributedCacheConfig command updates the WS-Security distributed cache configuration non-custom properties.

Target object

None.

Required parameters

None.

Optional parameters

-renewIntervalBeforeTimeoutMinutes
Specifies the amount of time, in minutes, that a renew request is allowed before the token expires. (Integer)
-minutesInCacheAfterTimeout
Specifies the amount of time, in minutes, that the token remains in the cache after it expires. The token is renewable for this amount of time. (Integer)
-distributedCache
Specifies whether distributed cache is enabled or disabled. (Boolean)
-synchronousClusterUpdate
Specifies whether the system performs a synchronous update of distributed caches on cluster members. By default, synchronous cluster updating is enabled. Specify false to disable synchronous cluster updating. (Boolean)
-tokenRecovery
Specifies whether token recovery is enabled or disabled. If you set the tokenRecovery property to true, specify the shared data source to assign to the distributed cache with the -Datasource parameter. (Boolean)
-Datasource
Specifies the name of the shared data source that is assigned to the distributed cache if token recovery is enabled. (String)

Return value

This command returns a success or failure message.

Batch mode example usage

  • Using Jython string: 
    AdminTask.updateWSSDistributedCacheConfig('[-customProperties "[ [property2 value2]
 [property1 value1] ]"]')
  • Using Jython list: 
    AdminTask.updateWSSDistributedCacheConfig(['-customProperties', '[ [property2 value2] 
[property1 value1] ]'])

Interactive mode example usage

  • Using Jython:
    AdminTask.updateWSSDistributedCacheConfig('-interactive')

updateWSSDistributedCacheCustomConfig command

The updateWSSDistributedCacheCustomConfig command updates the WS-Security distributed cache configuration custom properties.

Target object

None.

Required parameters

-customProperties
Specifies the name and value of each custom property to add or update in the WS-Security distributed cache configuration. (java.util.Properties)

Optional parameters

None.

Return value

This command returns a success or failure message.

Batch mode example usage

  • Using Jython string:
    AdminTask.updateWSSDistributedCacheCustomConfig('[-customProperties [[property1 value1]
[property2 value2]]]')
  • Using Jython list:
    AdminTask.updateWSSDistributedCacheCustomConfig(['-customProperties', '[[property1 value1]
[property2 value2]]'])

Interactive mode example usage

  • Using Jython:
    AdminTask.updateWSSDistributedCacheCustomConfig('-interactive')