keyManagerCommands command group for the AdminTask object

You can use the Jython or Jacl scripting languages to configure security. The commands and parameters in the keyManagerCommands group can be used to manage key manager settings. You can use these commands to create, modify, list, or obtain information about key managers.

The keyManagerCommands command group for the AdminTask object includes the following commands:
[jun2010]

createKeyManager

The createKeyManager command creates a key manager in the configuration.

Target object

None

Parameters and return values

-name
The name that uniquely identifies the key manager. (String, required)
-scopeName
The name of the scope. (String, optional)
-provider
Specifies the provider. (String, optional)
-algorithm
Specifies the algorithm name of the key manager. (String, optional)
-keyManagerClass
Specifies the custom class that implements the KeyManager interface. (String, optional)

Examples

Batch mode example usage:

Interactive mode example usage:

[jun2010]
jun2010

deleteKeyManager

The deleteKeyManager command deletes the key manager settings from the configuration.

Target object

None.

Required parameters

-name
Specifies the name that uniquely identifies the key manager. (String, required)

Optional parameters

-scopeName
Specifies the unique name that identifies the management scope. (String, optional)

Examples

Batch mode example usage:

Interactive mode example usage:

getKeyManager

The getKeyManager command displays a properties object that contains the key manager attributes and values.

Target object

None.

Required parameters

-name
Specifies the name that uniquely identifies the key manager. (String, required)

Optional parameters

-scopeName
Specifies the unique name that identifies the management scope. (String, optional)

Examples

Batch mode example usage:

Interactive mode example usage:

listKeyManagers

The listKeyManagers command lists the key managers within a particular management scope.

Target object

None.

Required parameters

None.

Optional parameters

-scopeName
Specifies the unique name that identifies the management scope. (String, optional)
-displayObjectName
Set the value of this parameter to true to list the key manager objects within the scope. Set the value of this parameter to false to list the strings that contain the key manager name and the management scope. (Boolean, optional)
-all
Specify the value of this parameter as true to list all key managers. This parameter overrides the scopeName parameter. The default value is false. (String, optional)

Examples

Batch mode example usage:

Interactive mode example usage:

modifyKeyManager

The modifyKeyManager command changes existing key manager settings.

Target object

None.

Required parameters

-name
The name that uniquely identifies the key manager. (String, required)

Optional parameters

-scopeName
Specifies the unique name that identifies the management scope. (String, optional)
-provider
Specifies the provider name of the key manager. (String, optional)
-algorithm
Specifies the algorithm name of the key manager. (String, optional)
-keyManagerClass
Specifies the name of the key manager implementation class. You cannot use this parameter with the provider or the algorithm parameter. (String, optional)

Examples

Batch mode example usage:

Interactive mode example usage:




Related concepts
Key management for cryptographic uses
Related tasks
Using the wsadmin scripting AdminTask object for scripted administration
Automating SSL configurations using scripting
Creating an SSL configuration at the node scope using scripting
Reference topic    

Terms of Use | Feedback

Last updated: Oct 22, 2010 12:21:29 AM CDT
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=compass&product=was-nd-zos&topic=rxml_atkeymgr
File name: rxml_atkeymgr.html