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

• deleteKeyReference

• getKeyReference

• listKeyReferences

createKeyReference

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

Target object None.

Required 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)

• Returns: The configuration object name of the key reference scope object that you created.

Examples

Batch mode example usage:

• Using Jacl:

  $AdminTask createKeyReference {-keySetName testKeySet  -keyAlias testKey 
  –password testPWD –passwordVerify testPWD –keyReferenceSaveConfig true}

• Using Jython string:

  AdminTask.createKeyReference ('[-keySetName testKeySet  -keyAlias testKey 
  –password testPWD –passwordVerify testPWD –keyReferenceSaveConfig true]')

• Using Jython list:

  AdminTask.createKeyReference (['-keySetName', 'testKeySet', '-keyAlias', 'testKey', 
  '–password', 'testPWD', '–passwordVerify', 'testPWD', '–keyReferenceSaveConfig', 'true'])

Interactive mode example usage:

• Using Jacl:

  $AdminTask createKeyReference {-interactive}

• Using Jython string:

  AdminTask.createKeyReference ('[-interactive]')

• Using Jython list:

  AdminTask.createKeyReference (['-interactive'])

deleteKeyReference

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

Target object None.

Required 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)

• Returns: None.

Examples

Batch mode example usage:

• Using Jacl:

  $AdminTask deleteKeyReference { -keySetName testKeySet –keyAlias testKey }

• Using Jython string:

  AdminTask.deleteKeyReference ('[-keySetName testKeySet –keyAlias testKey]')

• Using Jython list:

  AdminTask.deleteKeyReference (['-keySetName', 'testKeySet', '–keyAlias', 'testKey'])

Interactive mode example usage:

• Using Jacl:

  $AdminTask deleteKeyReference {-interactive}

• Using Jython string:

  AdminTask.deleteKeyReference ('[-interactive]')

• Using Jython list:

  AdminTask.deleteKeyReference (['-interactive'])

getKeyReference

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

Target object None.

Required 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)

• Returns: The settings of the key reference object.

Examples

Batch mode example usage:

• Using Jacl:

  $AdminTask getKeyReference { -keySetName testKeySet –keyAlias testKey }

• Using Jython string:

  AdminTask.getKeyReference ('[-keySetName testKeySet –keyAlias testKey]')

• Using Jython list:

  AdminTask.getKeyReference (['-keySetName', 'testKeySet', '–keyAlias', 'testKey'])

Interactive mode example usage:

• Using Jacl:

  $AdminTask getKeyReference {-interactive}

• Using Jython string:

  AdminTask.getKeyReference ('[-interactive]')

• Using Jython list:

  AdminTask.getKeyReference (['-interactive'])

listKeyReferences

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

Target object None.

Required 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)

• Returns: The configuration object name of the key reference scope object that you created.

Examples

Batch mode example usage:

• Using Jacl:

  $AdminTask listKeyRefereces { -keySetName testKeySet}

• Using Jython string:

  AdminTask.listKeyRefereces ('[-keySetName testKeySet]')

• Using Jython list:

  AdminTask.listKeyRefereces (['-keySetName', 'testKeySet'])

Interactive mode example usage:

• Using Jacl:

  $AdminTask listKeyReferences {-interactive}

• Using Jython string:

  AdminTask.listKeyReferences ('[-interactive]')

• Using Jython list:

  AdminTask.listKeyReferences (['-interactive'])

Related tasks

Related Reference

Reference topic