WAS v8.5 > Reference > Commands (wsadmin scripting)

WSSCacheManagement command group for AdminTask

Use this topic as a reference for the commands for the WSSCacheManagement group of AdminTask. 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

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.

Interactive mode example usage


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 containing the configuration properties and values for the distributed cache configuration. The following table displays the configuration properties the command returns:

Command properties. Use the command to list distributed cache configuration properties.

Property Description
tokenRecovery Whether token recovery is enabled or disabled. If the tokenRecovery property is set to true, the Datasource property specifies the shared data source assigned to the distributed cache.
distributedCache Whether distributed caching is enabled or disabled.
Datasource Name of the shared data source assigned to the distributed cache if token recovery is enabled.
renewIntervalBeforeTimeoutMinutes Amount of time, in minutes, the client waits before it attempts to renew the token.
synchronousClusterUpdate Whether the system performs a synchronous update of distributed caches on cluster members. By default, synchronous cluster updating is enabled.
minutesInCacheAfterTimeout Amount of time the token remains in the cache after the token times out.

Interactive mode example usage


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 containing the name and value pairs that correspond to each custom property.

Interactive mode example usage


updateWSSDistributedCacheConfig command

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

Target object None.

Required parameters None.

Optional parameters

-renewIntervalBeforeTimeoutMinutes

Amount of time, in minutes, that a renew request is allowed before the token expires. (Integer)

-minutesInCacheAfterTimeout

Amount of time, in minutes, the token remains in the cache after it expires. The token is renewable for this amount of time. (Integer)

-distributedCache

Whether distributed cache is enabled or disabled. (Boolean)

-synchronousClusterUpdate

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

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

Name of the shared data source assigned to the distributed cache if token recovery is enabled. (String)

Return value

This command returns a success or failure message.

Interactive mode example usage


updateWSSDistributedCacheCustomConfig command

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

Target object None.

Required parameters

-customProperties

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.

Interactive mode example usage


Related


Use the wsadmin scripting AdminTask object for scripted administration
Manage WS-Security distributed cache configuration
Configure the Web Services Security distributed cache
Secure conversation client cache and trust service configuration


+

Search Tips   |   Advanced Search