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.
The deleteWSSDistributedCacheConfigCustomProperties command removes WS-Security distributed cache custom properties.
Target object
NoneRequired parameters
Optional parameters
None.Return value
This command returns a message that indicates the success or failure of the command.
Batch mode example usage
AdminTask.deleteWSSDistributedCacheConfigCustomProperties('[-propertyNames
[prop1,prop2,prop3]]')
AdminTask.deleteWSSDistributedCacheConfigCustomProperties([',-'propertyNames',
'[prop1,prop2,prop3]'])
Interactive mode example usage
AdminTask.deleteWSSDistributedCacheConfigCustomProperties('-interactive')
The queryWSSDistributedCacheConfig command lists the WS-Security distributed cache configuration non-custom properties.
Target object
None.Required parameters
None.Optional parameters
None.Return value
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
print AdminTask.queryWSSDistributedCacheConfig()
Interactive mode example usage
AdminTask.queryWSSDistributedCacheConfig('-interactive')
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
AdminTask.queryWSSDistributedCacheCustomConfig()
Interactive mode example usage
AdminTask.queryWSSDistributedCacheCustomConfig('-interactive')
The updateWSSDistributedCacheConfig command updates the WS-Security distributed cache configuration non-custom properties.
Target object
None.Required parameters
None.Optional parameters
Return value
This command returns a success or failure message.
Batch mode example usage
AdminTask.updateWSSDistributedCacheConfig('[-customProperties "[ [property2 value2]
[property1 value1] ]"]')
AdminTask.updateWSSDistributedCacheConfig(['-customProperties', '[ [property2 value2]
[property1 value1] ]'])
Interactive mode example usage
AdminTask.updateWSSDistributedCacheConfig('-interactive')
The updateWSSDistributedCacheCustomConfig command updates the WS-Security distributed cache configuration custom properties.
Target object
None.Required parameters
Optional parameters
None.Return value
This command returns a success or failure message.
Batch mode example usage
AdminTask.updateWSSDistributedCacheCustomConfig('[-customProperties [[property1 value1]
[property2 value2]]]')
AdminTask.updateWSSDistributedCacheCustomConfig(['-customProperties', '[[property1 value1]
[property2 value2]]'])
Interactive mode example usage
AdminTask.updateWSSDistributedCacheCustomConfig('-interactive')