KeySetGroupCommands command group for the AdminTask object

You can use the Jython or Jacl scripting languages to configure security with the wsadmin tool. The commands and parameters in the KeySetGroupCommands group can be used to create and manage key set groups. Use these commands to manage groups of public, private, and shared keys.

The KeySetGroupCommands command group for the AdminTask object includes the following commands:

deleteKeySetGroup

The deleteKeySetGroup command deletes the settings of a key set group from the configuration.

Target object

None

Parameters and return values

-name
The name that uniquely identifies the key set group. (String, required)
-scopeName
The name of the scope. (String, optional)
To list the valid management scopes, you can run the listManagementScope task. For example:
wsadmin>$AdminTask listManagementScopes 
"scopeName: (cell):IBM-2143376CB9ECell03 " 
"scopeName: (cell):IBM-2143376CB9ECell03:(node):IBM-2143376CB9ECellManager03 " 
"scopeName: (cell):IBM-2143376CB9ECell03:(node):IBM-2143376CB9ENode02 " 
"scopeName: (cell):IBM-2143376CB9ECell03:(node):IBM-2143376CB9ENode04 " 
"scopeName: (cell):IBM-2143376CB9ECell03:(node):IBM-2143376CB9ENode05

Examples

Batch mode example usage:

Interactive mode example usage:

generateKeyForKeySetGroup

The generateKeyForKeySetGroup command generates keys for all of the keys in the key sets that make up the key set group.

Target object

None

Parameters and return values

-keySetGroupName
Specifies the name that uniquely identifies the key set group. (String, required)
-keySetGroupScope
Specifies the management scope. (String, optional).
To list the valid management scopes, you can run the listManagementScope task. For example:
wsadmin>$AdminTask listManagementScopes 
"scopeName: (cell):IBM-2143376CB9ECell03 " 
"scopeName: (cell):IBM-2143376CB9ECell03:(node):IBM-2143376CB9ECellManager03 " 
"scopeName: (cell):IBM-2143376CB9ECell03:(node):IBM-2143376CB9ENode02 " 
"scopeName: (cell):IBM-2143376CB9ECell03:(node):IBM-2143376CB9ENode04 " 
"scopeName: (cell):IBM-2143376CB9ECell03:(node):IBM-2143376CB9ENode05
-keySetGroupSaveConfig
Specifies to automatically save the change to the security configuration. (Boolean, optional)
-keySetGroupUpdateRuntime
Specifies to update the environment to use the newly generated keys at run time. (Boolean, optional)

Examples

Batch mode example usage:

Interactive mode example usage:

getKeySetGroups

The getKeySetGroups command displays the settings of a particular key set group.

Target object

None

Parameters and return values

-name
The name that uniquely identifies the key set group. (String, required)
-scopeName
The name of the scope. (String, optional)
To list the valid management scopes, you can run the listManagementScope task. For example:
wsadmin>$AdminTask listManagementScopes 
"scopeName: (cell):IBM-2143376CB9ECell03 " 
"scopeName: (cell):IBM-2143376CB9ECell03:(node):IBM-2143376CB9ECellManager03 " 
"scopeName: (cell):IBM-2143376CB9ECell03:(node):IBM-2143376CB9ENode02 " 
"scopeName: (cell):IBM-2143376CB9ECell03:(node):IBM-2143376CB9ENode04 " 
"scopeName: (cell):IBM-2143376CB9ECell03:(node):IBM-2143376CB9ENode05

Examples

Batch mode example usage:

Interactive mode example usage:

listKeySetGroups

The listKeySetGroups command lists the key set groups for a particular scope.

Target object

None

Parameters and return values

-scopeName
The name of the scope. (String, optional)
To list the valid management scopes, you can run the listManagementScope task. For example:
wsadmin>$AdminTask listManagementScopes 
"scopeName: (cell):IBM-2143376CB9ECell03 " 
"scopeName: (cell):IBM-2143376CB9ECell03:(node):IBM-2143376CB9ECellManager03 " 
"scopeName: (cell):IBM-2143376CB9ECell03:(node):IBM-2143376CB9ENode02 " 
"scopeName: (cell):IBM-2143376CB9ECell03:(node):IBM-2143376CB9ENode04 " 
"scopeName: (cell):IBM-2143376CB9ECell03:(node):IBM-2143376CB9ENode05
-displayObjectNames
If you set the value of this parameter to true, the command returns a list of all of the key set group objects within a scope. If you set the value of this parameter to false, the command returns a list of strings that contain the key set group name and management scope. (Boolean, optional)

Examples

Batch mode example usage:

Interactive mode example usage:

modifyKeySetGroup

The modifyKeySetGroup command changes the settings of an existing key set group.

Target object

None

Parameters and return values

-name
The name that uniquely identifies the key set group. (String, required)
-scopeName
The name of the scope. (String, optional)
To list the valid management scopes, you can run the listManagementScope task. For example:
wsadmin>$AdminTask listManagementScopes 
"scopeName: (cell):IBM-2143376CB9ECell03 " 
"scopeName: (cell):IBM-2143376CB9ECell03:(node):IBM-2143376CB9ECellManager03 " 
"scopeName: (cell):IBM-2143376CB9ECell03:(node):IBM-2143376CB9ENode02 " 
"scopeName: (cell):IBM-2143376CB9ECell03:(node):IBM-2143376CB9ENode04 " 
"scopeName: (cell):IBM-2143376CB9ECell03:(node):IBM-2143376CB9ENode05
-autoGenerate
Set the value of this parameter to true if you want to automatically generate keys. If not, set the value to false. (Boolean, optional)
-wsScheduleName
The name of the scheduler to use to perform key generation. (String, optional)
-keySetObjectNames
A list of key set configuration names separated by colons (:). (String, optional)

Examples

Batch mode example usage:

Interactive mode example usage:




Related tasks
Using the AdminTask object for scripted administration
Related reference
Commands for the AdminTask object
Reference topic Reference topic    

Terms and conditions for information centers | Feedback

Last updatedLast updated: Aug 31, 2013 2:56:59 AM CDT
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=pix&product=was-nd-dist&topic=rxml_atwskeygroup
File name: rxml_atwskeygroup.html