nethsm-key-get(1)

NAME
nethsm-key-get - Get information on a key

SYNOPSIS
nethsm key get [-a|--auth-passphrase-file] [-c|--config] [-l|--label] [-u|--user] [-h|--help] <KEY_ID>

DESCRIPTION
Get information on a key

Displays information on supported key mechanisms, the key type, which restrictions apply (i.e. which tags are set for the key), information on the public key part and how many operations have been done with the key.

System-wide users in the "Administrator" or "Operator" role can only retrieve information on system-wide keys. Namespaced users in the "Administrator" or "Operator" role can only retrieve information on keys in their own namespace.

Requires authentication of a user in the "Administrator" or "Operator" role (with access to the key - see "nethsm key tag" and "nethsm user tag").

OPTIONS

-a, --auth-passphrase-file <AUTH_PASSPHRASE_FILE>
    The path to a file containing a passphrase for authentication The passphrase provided in the file must be the one for the user chosen for the command. This option can be provided multiple times, which is needed for commands that require multiple roles at once. With multiple passphrase files ordering matters, as the files are assigned to the respective user provided by the "--user" option.
    May also be specified with the NETHSM_AUTH_PASSPHRASE_FILE environment variable.

-c, --config <CONFIG>
    The path to a custom configuration file If specified, the custom configuration file is used instead of the default configuration file location.
    May also be specified with the NETHSM_CONFIG environment variable.

-l, --label <LABEL>
    A label uniquely identifying a device in the configuration file Must be provided if more than one device is setup in the configuration file.
    May also be specified with the NETHSM_LABEL environment variable.

-u, --user <USER>
    A user name which is used for a command Can be provided, if no user name is setup in the configuration file for a device. Must be provided, if several user names of the same target role are setup in the configuration file for a device. This option can be provided multiple times, which is needed for commands that require multiple roles at once.
    May also be specified with the NETHSM_USER environment variable.

-h, --help
    Print help (see a summary with '-h')

<KEY_ID>
    The ID of the key, for which to show information for
    May also be specified with the NETHSM_KEY_ID environment variable.