nethsm-env-add-credentials(1)                          General Commands Manual

NAME
       nethsm-env-add-credentials - Add credentials for a device in the
       configuration

SYNOPSIS
       nethsm env add credentials [-p|--passphrase-file]
       [-w|--with-passphrase] [-a|--auth-passphrase-file] [-c|--config]
       [-l|--label] [-u|--user] [-h|--help] <NAME> [ROLE]

DESCRIPTION
       Add credentials for a device in the configuration

       By default credentials in the configuration file only contain user name
       and role.  In this scenario the passphrase of a user is prompted for
       interactively, once it is needed.

       Optionally, it is possible to also persist a passphrase for a given
       user name to allow non-interactive use.  This use is discouraged as it
       persists the passphrase in an unencrypted configuration file.

OPTIONS
       -p, --passphrase-file <PASSPHRASE_FILE>
              The path to a file containing the passphrase
              May also be specified with the NETHSM_PASSPHRASE_FILE
              environment variable.

       -w, --with-passphrase
              Whether to prompt for and store a passphrase for the user

              The passphrase is persisted in the configuration file. Use with
              caution!
              May also be specified with the NETHSM_WITH_PASSPHRASE
              environment variable.

       -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')

       <NAME> The name of the user on the target device
              May also be specified with the NETHSM_USER_NAME environment
              variable.

       [ROLE] The optional role of the user on the target device

              One of ["Administrator", "Backup", "Metrics", "Operator"]
              (defaults to "Operator").
              May also be specified with the NETHSM_USER_ROLE environment
              variable.

                          nethsm-env-add-credentials
                                                 nethsm-env-add-credentials(1)