keyManagerCommands command group for the AdminTask object

 

You 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. You can use these commands to create, modify, list, or obtain information about key managers. The keyManagerCommands command group for the AdminTask object includes the following commands:

• deleteKeyManager

• getKeyManager

• listKeyManagers

• modifyKeyManagers

 

deleteKeyManager

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

Target object

None

Parameters and return values

-name

The name that uniquely identifies the key manager. (String, optional)

-scopeName

The name of the scope. (String, optional)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask deleteKeyManager {-name testKM}
  

• Use Jython string:

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

• Use Jython list:

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

Interactive mode example usage:

• Use Jacl:

  $AdminTask deleteKeyManager {-interactive}
  

• Use Jython string:

  AdminTask.deleteKeyManager ('[-interactive]')
  

• Use Jython list:

  AdminTask.deleteKeyManager (['-interactive'])
  

 

getKeyManager

The getKeyManager command obtains the settings of a key manager.

Target object

None

Parameters and return values

-name

The name that uniquely identifies the key manager. (String, optional)

-scopeName

The name of the scope. (String, optional)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask getKeyManager {-name testKM}
  

• Use Jython string:

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

• Use Jython list:

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

Interactive mode example usage:

• Use Jacl:

  $AdminTask getKeyManager {-interactive}
  

• Use Jython string:

  AdminTask.getKeyManager ('[-interactive]')
  

• Use Jython list:

  AdminTask.getKeyManager (['-interactive'])
  

 

listKeyManagers

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

Target object

None

Parameters and return values

-scopeName

The name of the 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)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask listKeyManagers
  

• Use Jython:

  AdminTask.listKeyManagers()
  

Interactive mode example usage:

• Use Jacl:

  $AdminTask listKeyManagers {-interactive}
  

• Use Jython string:

  AdminTask.listKeyManagers ('[-interactive]')
  

• Use Jython list:

  AdminTask.listKeyManagers (['-interactive'])
  

 

modifyKeyManagers

The modifyKeyManagers command changes existing key manager settings.

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

The provider name of the key manager. (String, optional)

-algorithm

The algorithm name of the key manager. (String, optional)

-keyManagerClass

The name of the key manager implementation class. You can not use this parameter with the provider or the algorithm parameter. (String, optional)

Examples

Batch mode example usage:

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

• Use Jacl:

  $AdminTask modifyKeyManagers {-interactive}
  

• Use Jython string:

  AdminTask.modifyKeyManagers ('[-interactive]')
  

• Use Jython list:

  AdminTask.modifyKeyManagers (['-interactive'])
  

---

 

Related tasks

Use the AdminTask object for scripted administration

 

Related Reference

Commands for the AdminTask object

 

Reference topic