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

NAME
       nethsm-env-add-device - Add a device to the configuration

SYNOPSIS
       nethsm env add device [-a|--auth-passphrase-file] [-c|--config]
       [-l|--label] [-u|--user] [-h|--help] <URL> <TLS_SECURITY>

DESCRIPTION
       Add a device to the configuration

       Device entries are added with a URL and settings for the TLS connection
       security.

       For this command it is required to provide a label that identifies the
       device.

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

       <URL>  The URL of the device API
              May also be specified with the NETHSM_URL environment variable.

       <TLS_SECURITY>
              The TLS connection security for the device

              One of the following: * "Unsafe": the TLS connection is not
              validated by authenticating the target host certificate *
              "Native": the TLS connection is validated by authenticating the
              target host certificate against the caller's native system-wide
              certificate store * the pinned SHA-256 checksum of the target
              host key (prefixed with "sha256:") is used to validate the
              target host certificate
              May also be specified with the NETHSM_TLS_SECURITY environment
              variable.

                            nethsm-env-add-device     nethsm-env-add-device(1)