KeyReferenceCommands 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 KeyReferenceCommands group can be used to create and manage the key reference settings for key set objects in your configuration.

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

createKeyReference

The createKeyReference command creates the key reference setting in the configuration for key set objects.

Target object

None.

Parameters and return values

-keySetName
The name that uniquely identifies the key set to which the key reference belongs. (String, required)
-keySetScope
The management scope of the key set. (String, optional)
-keyAlias
The alias name that identifies the key for the key set that you specify. (String, required)
-keyPassword
The password used for encrypting the key. (String, optional)
-keyPasswordVerify
The password used for encrypting the key. (String, optional)
-version
The version of the key reference. (String, optional)
-keyReferenceSaveConfig
Set the value of this parameter to true to save the key reference to the configuration. Otherwise, set the value to false. (String, optional)

Examples

Batch mode example usage:

Interactive mode example usage:

deleteKeyReference

The deleteKeyReference command deletes a key reference object from the key set object in the configuration.

Target object

None.

Parameters and return values

-keySetName
The name that uniquely identifies the key set to which the key reference belongs. (String, required)
-keySetScope
The management scope of the key set. (String, optional)
-keyAlias
The alias name that identifies the key for the key set that you specify. (String, required)

Examples

Batch mode example usage:

Interactive mode example usage:

getKeyReference

The getKeyReference command displays the setting of a key reference object.

Target object

None.

Parameters and return values

-keySetName
The name that uniquely identifies the key set to which the key reference belongs. (String, required)
-keySetScope
The management scope of the key set. (String, optional)
-keyAlias
The alias name that identifies the key for the key set that you specify. (String, required)

Examples

Batch mode example usage:

Interactive mode example usage:

listKeyReferences

The listKeyReferences command lists the key references for a particular key set in the configuration.

Target object

None.

Parameters and return values

-keySetName
The name that uniquely identifies the key set to which the key reference belongs. (String, required)
-keySetScope
The management scope of the key set. (String, optional)

Examples

Batch mode example usage:

Interactive mode example usage:




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

Terms of Use | Feedback

Last updatedLast updated: Sep 19, 2011 3:08:41 PM CDT
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=matt&product=was-nd-zos&topic=rxml_atwskeyref
File name: rxml_atwskeyref.html