ctmkeygen utility actions

The following table describes the actions in the ctmkeygen utility:

Action

Description

add

Creates a new entry in the key table. It also verifies that a key with the same name does not exist. All the parameters are mandatory.

update

Modifies the details of an existing entry in the key table. The entry includes the same fields as used to create a new key pair. The updated entry replaces the existing entry in the key table in the database and the public key file. The passphrase must match the one that was used to create the existing key.

For the optional parameters, if a value not specified, the value stored in the Control-M/Server database is used.

delete

Deletes the entry associated with the logical key name. The passphrase must match the one that was used to create the existing key.

list

Returns a list of lines, each containing: the logical key name, type, bits, and format.

export

Exports the details of the keys stored in the key table to a text file.

EXAMPLE:

ctmkeygen -action export -filename $HOME/ctm_server/data/key_details.txt

import

Imports the details of the keys stored in the key table. Using the import parameter enables you to:

  • prepare and save files of keys that can be reused
  • specify utility input longer than the number of characters allowed in the command line

    EXAMPLE:

    ctmkeygen -action import -filename $HOME/ctm_server/data/key_details.txt

help

Displays the usage of the ctmkeygen utility.

Parent Topic

ctmkeygen