nethsm-user-add(1)          General Commands Manual         nethsm-user-add(1)

NAME
       nethsm-user-add - Add a user

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

DESCRIPTION
       Add a user

       Adds a new user by providing a real name and a user role.  If no user
       name is provided specifically, a random one is generated automatically
       by the target device.  If no passphrase is provided, it is prompted for
       interactively.

       New users inherit the scope of the user that created them.  If a
       system-wide user in the "Administrator" role creates a new user (e.g.
       "user1"), then that new user is also a system-wide user.  As exception
       to this rule, a system-wide user in the "Administrator" role can create
       namespaced users by providing a user name specifically (e.g.
       "namespace1~user1"), but only if the targeted namespace (i.e.
       "namespace1") does not yet exist (see "nethsm namespace add").  If a
       namespaced user in the "Administrator" role creates a new user, then
       that new user is also a user in that namespace.  If a namespaced user
       in the "Administrator" role (e.g. "namespace1~admin1") provides a
       specific user name, it must be in that same namespace (e.g.
       "namespace1~user1", not "namespace2~user1")!

       The device must be in state "Operational".

       Requires authentication of a user in the "Administrator" role.

OPTIONS
       -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.

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

       <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.

                               nethsm-user-add              nethsm-user-add(1)