KeyReferenceCommands

Use the Jython or Jacl scripting languages to configure security with the wsadmin tool. The commands in the KeyReferenceCommands group can be used to manage the key reference settings for key set objects in the configuration.

The KeyReferenceCommands command group for the AdminTask objectcommands include:

• createKeyReference
• deleteKeyReference
• getKeyReference
• listKeyReferences

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 specified. (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 value 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 we created.

Examples

Batch mode example usage:

• Jacl:
  $AdminTask createKeyReference {-keySetName testKeySet -keyAlias testKey -password testPWD -passwordVerify testPWD -keyReferenceSaveConfig true}

• Jython string:
  AdminTask.createKeyReference ('[-keySetName testKeySet -keyAlias testKey -password testPWD -passwordVerify testPWD -keyReferenceSaveConfig true]')

• Jython list:
  AdminTask.createKeyReference (['-keySetName', 'testKeySet', '-keyAlias', 'testKey', '-password', 'testPWD', '-passwordVerify', 'testPWD', '-keyReferenceSaveConfig', 'true'])

Interactive mode example usage:

• Jacl:
  $AdminTask createKeyReference {-interactive}

• Jython string:
  AdminTask.createKeyReference ('[-interactive]')

• 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.

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 specified. (String, required)

• Returns: None.

Examples

Batch mode example usage:

• Jacl:
  $AdminTask deleteKeyReference { -keySetName testKeySet -keyAlias testKey }

• Jython string:
  AdminTask.deleteKeyReference ('[-keySetName testKeySet -keyAlias testKey]')

• Jython list:
  AdminTask.deleteKeyReference (['-keySetName', 'testKeySet', '-keyAlias', 'testKey'])

Interactive mode example usage:

• Jacl:
  $AdminTask deleteKeyReference {-interactive}

• Jython string:
  AdminTask.deleteKeyReference ('[-interactive]')

• Jython list:
  AdminTask.deleteKeyReference (['-interactive'])

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 specified. (String, required)

• Returns: The settings of the key reference object.

Examples

Batch mode example usage:

• Jacl:
  $AdminTask getKeyReference { -keySetName testKeySet -keyAlias testKey }

• Jython string:
  AdminTask.getKeyReference ('[-keySetName testKeySet -keyAlias testKey]')

• Jython list:
  AdminTask.getKeyReference (['-keySetName', 'testKeySet', '-keyAlias', 'testKey'])

Interactive mode example usage:

• Jacl:
  $AdminTask getKeyReference {-interactive}

• Jython string:
  AdminTask.getKeyReference ('[-interactive]')

• Jython list:
  AdminTask.getKeyReference (['-interactive'])

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)

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

Examples

Batch mode example usage:

• Jacl:
  $AdminTask listKeyRefereces { -keySetName testKeySet}

• Jython string:
  AdminTask.listKeyRefereces ('[-keySetName testKeySet]')

• Jython list:
  AdminTask.listKeyRefereces (['-keySetName', 'testKeySet'])

Interactive mode example usage:

• Jacl:
  $AdminTask listKeyReferences {-interactive}

• Jython string:
  AdminTask.listKeyReferences ('[-interactive]')

• Jython list:
  AdminTask.listKeyReferences (['-interactive'])

wsadmin AdminTask

Commands for the AdminTask object