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:

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: Specifies the provider. (String, optional)
-algorithm: Specifies the algorithm name of the key manager. (String, optional)
-keyManagerClass: Specifies the custom class that implements the KeyManager interface. (String, optional)

Examples

Batch mode example usage:

Using Jacl:

$AdminTask createKeyManager {-name testKM}

Using Jython string:

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

Using Jython list:

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

Interactive mode example usage:

Using Jacl:

$AdminTask createKeyManager {-interactive}

Using Jython string:

AdminTask.createKeyManager ('[-interactive]')

Using Jython list:

AdminTask.createKeyManager (['-interactive'])

deleteKeyManager

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

Target object

None.

Required parameters

-name: Specifies the name that uniquely identifies the key manager. (String, required)

Optional parameters

-scopeName: Specifies the unique name that identifies the management scope. (String, optional)

Examples

Batch mode example usage:

Using Jacl:

$AdminTask deleteKeyManager {-name testKM}

Using Jython string:

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

Using Jython list:

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

Interactive mode example usage:

Using Jacl:

$AdminTask deleteKeyManager {-interactive}

Using 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: Specifies the name that uniquely identifies the key manager. (String, required)

Optional parameters

-scopeName: Specifies the unique name that identifies the management scope. (String, optional)

Examples

Batch mode example usage:

Using Jacl:
```
$AdminTask getKeyManager {-name testKM}
```

Using Jython string:

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

Using Jython list:

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

Interactive mode example usage:

Using Jacl:
```
$AdminTask getKeyManager {-interactive}
```
Using 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: Specifies the 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:

Using Jacl:
```
$AdminTask listKeyManagers
```
Using Jython:
```
AdminTask.listKeyManagers()
```

Interactive mode example usage:

Using Jacl:

$AdminTask listKeyManagers {-interactive}

Using 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: Specifies the unique name that identifies the management scope. (String, optional)
-provider: Specifies the provider name of the key manager. (String, optional)
-algorithm: Specifies the algorithm name of the key manager. (String, optional)
-keyManagerClass: Specifies the name of the key manager implementation class. You cannot use this parameter with the provider or the algorithm parameter. (String, optional)

Examples

Batch mode example usage:

Using Jacl:

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

Using Jython string:

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

Using Jython list:

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

Interactive mode example usage:

Using Jacl:

$AdminTask modifyKeyManager {-interactive}

Using Jython:

AdminTask.modifyKeyManager('-interactive')