NAME
nethsm-user-add - The "nethsm user add" command
SYNOPSIS
nethsm user add [-a|--auth-passphrase-file] [-p|--passphrase-file] [-c|--config] [-l|--label] [-u|--user] [-h|--help] <REAL_NAME> [ROLE] [NAME]
DESCRIPTION
The "nethsm user add" command
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.
- -p, --passphrase-file <PASSPHRASE_FILE>
-
The path to a file containing the new user's passphrase
The passphrase must be >= 10 and <= 200 characters long.
May also be specified with the NETHSM_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')
- <REAL_NAME>
-
The real name of the user that is created
This name is only used for further identification, but not for authentication!
May also be specified with the NETHSM_REAL_NAME environment variable.
- [ROLE]
-
The role of the user that is created
One of ["Administrator", "Backup", "Metrics", "Operator"] (defaults to "Operator").
May also be specified with the NETHSM_USER_ROLE environment variable.
- [NAME]
-
A unique name for the user that is created
This name must be unique as it is used for authentication!
May also be specified with the NETHSM_USER_NAME environment variable.