WAS v8.5 > Reference > Commands (wsadmin scripting)

keyManagerCommands command group for AdminTask

We 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. We can use these commands to create, modify, list, or obtain information about key managers.

The keyManagerCommands command group for AdminTask includes the following commands:

• createKeyManager
• deleteKeyManager
• getKeyManager
• listKeyManagers
• modifyKeyManager

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

Provider. (String, optional)

-algorithm

Algorithm name of the key manager. (String, optional)

-keyManagerClass

Custom class that implements the KeyManager interface. (String, optional)

Examples

Batch mode example usage:

• Jacl:

  $AdminTask createKeyManager {-name testKM}

• Jython string:

  AdminTask.createKeyManager ('[-name testKM]')

• Jython list:

  AdminTask.createKeyManager (['-name', 'testKM'])

Interactive mode example usage:

• Jacl:

  $AdminTask createKeyManager {-interactive}

• Jython string:

  AdminTask.createKeyManager ('[-interactive]')

• Jython list:

  AdminTask.createKeyManager (['-interactive'])

deleteKeyManager

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

Target object None.

Required parameters

-name

Name that uniquely identifies the key manager. (String, required)

Optional parameters

-scopeName

Unique name that identifies the management scope. (String, optional)

Examples

Batch mode example usage:

• Jacl:

  $AdminTask deleteKeyManager {-name testKM}

• Jython string:

  AdminTask.deleteKeyManager('[-name testKM]')

• Jython list:

  AdminTask.deleteKeyManager(['-name', 'testKM'])

Interactive mode example usage:

• Jacl:

  $AdminTask deleteKeyManager {-interactive}

• Jython:

  AdminTask.deleteKeyManager('-interactive')

getKeyManager

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

Target object None.

Required parameters

-name

Name that uniquely identifies the key manager. (String, required)

Optional parameters

-scopeName

Unique name that identifies the management scope. (String, optional)

Examples

Batch mode example usage:

• Jacl:

  $AdminTask getKeyManager {-name testKM}

• Jython string:

  AdminTask.getKeyManager('[-name testKM]')

• Jython list:

  AdminTask.getKeyManager(['-name', 'testKM'])

Interactive mode example usage:

• Jacl:

  $AdminTask getKeyManager {-interactive}

• Jython:

  AdminTask.getKeyManager('-interactive')

listKeyManagers

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

Target object None.

Required parameters None.

Optional parameters

-scopeName

Unique name that identifies the management scope. (String, optional)

-displayObjectName

Set Set true to to list the key manager objects within the scope. Set the value of this parameter to false to list the strings containing 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. Default is false. (String, optional)

Examples

Batch mode example usage:

• Jacl:

  $AdminTask listKeyManagers

• Jython:

  AdminTask.listKeyManagers()

Interactive mode example usage:

• Jacl:

  $AdminTask listKeyManagers {-interactive}

• Jython:

  AdminTask.listKeyManagers('-interactive')

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

Unique name that identifies the management scope. (String, optional)

-provider

Provider name of the key manager. (String, optional)

-algorithm

Algorithm name of the key manager. (String, optional)

-keyManagerClass

Name of the key manager implementation class. We cannot use this parameter with the provider or the algorithm parameter. (String, optional)

Examples

Batch mode example usage:

• Jacl:

  $AdminTask modifyKeyManager {-name testKM -provider IBMJSSE2 -algorithm IbmX509}

• Jython string:

  AdminTask.modifyKeyManager('[-name testKM -provider IBMJSSE2 -algorithm IbmX509]')

• Jython list:

  AdminTask.modifyKeyManager(['-name', 'testKM', '-provider', 'IBMJSSE2', '-algorithm', 'IbmX509'])

Interactive mode example usage:

• Jacl:

  $AdminTask modifyKeyManager {-interactive}

• Jython:

  AdminTask.modifyKeyManager('-interactive')

Related concepts:

Key management for cryptographic uses

Related

Use the wsadmin scripting AdminTask object for scripted administration
Automating SSL configurations using scripting
Create an SSL configuration at the node scope using scripting

+

Search Tips   |   Advanced Search