keyManagerCommands

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

The keyManagerCommands includes the following commands:

• deleteKeyManager
• getKeyManager
• listKeyManagers
• modifyKeyManager

 

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}
  

• Use Jython string:

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

• Use 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 that contains 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}
  

• Use Jython string:

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

• Use 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 the value of this parameter to true to list the key manager objects within the scope. Set the value of this parameter to false to list the strings that contain 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 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}
  

• Use Jython string:

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

• Use 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 tasks

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