keyManagerCommands (AdminTask)

keyManagerCommands commands can be used to manage key manager settings. We can use these commands to create, modify, list, or obtain information about key managers.

createKeyManager

Create 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:

• Jacl:

  $AdminTask createKeyManager {-name testKM}

• Jython string...

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

• Jython list:

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

Interactive mode:

• Jacl:

  $AdminTask createKeyManager {-interactive}

• Jython string...

  AdminTask.createKeyManager ('[-interactive]')

• Jython list:

  AdminTask.createKeyManager (['-interactive'])

deleteKeyManager

Delete 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 identifying management scope. (String, optional)

Examples

Batch mode example:

• Jacl:

  $AdminTask deleteKeyManager {-name testKM}

• Jython string...

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

• Jython list:

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

Interactive mode:

• Jacl:

  $AdminTask deleteKeyManager {-interactive}

• Jython:

  AdminTask.deleteKeyManager('-interactive')

getKeyManager

Display 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 identifying management scope. (String, optional)

Examples

Batch mode example:

• Jacl:

  $AdminTask getKeyManager {-name testKM}

• Jython string...

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

• Jython list:

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

Interactive mode:

• Jacl:

  $AdminTask getKeyManager {-interactive}

• Jython:

  AdminTask.getKeyManager('-interactive')

listKeyManagers

List the key managers within a particular management scope.

Target object None.

Required parameters None.

Optional parameters

-scopeName

Unique name identifying management scope. (String, optional)

-displayObjectName

Set to true to list the key manager objects within the scope. Set 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. The default value is false. (String, optional)

Examples

Batch mode example:

• Jacl:

  $AdminTask listKeyManagers

• Jython:

  AdminTask.listKeyManagers()

Interactive mode:

• Jacl:

  $AdminTask listKeyManagers {-interactive}

• Jython:

  AdminTask.listKeyManagers('-interactive')

modifyKeyManager

Change 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 identifying 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:

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

• Jacl:

  $AdminTask modifyKeyManager {-interactive}

• Jython:

  AdminTask.modifyKeyManager('-interactive')

Related concepts

Key management for cryptographic uses

Automating SSL configurations

Create an SSL configuration at the node scope