nethsm-user-add(1)

💅 nethsm-user-add — like, the whole manual, bestie

okay so real talk: this is the man page for nethsm-user-add(1), which lives in the General Commands Manual section, and it's the page for the nethsm user add command. yes, that's the whole NAME section, we move 🎀

✨ SYNOPSIS ✨

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

that's the shape of it, bestie — memorize the vibe 🦋

🌸 DESCRIPTION 🌸

The nethsm user add command. that's literally what it does, that's the description, we're not gonna overthink it 💀

👑 OPTIONS 👑

• -a, --auth-passphrase-file <AUTH_PASSPHRASE_FILE> — the path to a file containing a passphrase for authentication. the passphrase in that file must be the one for the user you chose for the command, no cap. you can pass this option multiple times, which you need for commands that require multiple roles at once — and when you do that, ordering matters, because the files get assigned to the respective user given 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. this passphrase has to be >= 10 and <= 200 characters long, so don't be out here writing a whole novel. may also be specified with the NETHSM_PASSPHRASE_FILE environment variable 🔥
• -c, --config <CONFIG> — the path to a custom configuration file. if you specify it, that custom config 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 set up in the configuration file (like, you gotta tell it which one, bestie). 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 set up in the configuration file for a device; must be provided if several user names of the same target role are set up 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) 👑 (yes, the flag itself is -h and it's telling you to use -h for the summary — iconic, not gonna lie)

🦋 the positional args 🦋

• <REAL_NAME> — the real name of the user that is created. this name is only used for further identification, not for authentication, so don't get it twisted! 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 because it is used for authentication! may also be specified with the NETHSM_USER_NAME environment variable 🔥

lowkey important reminder: <REAL_NAME> is identification only, [NAME] is the authentication one. don't swap them, i'm begging 🙈

and that's the whole page, no skips, no summaries, every single flag accounted for 💅✨

this adorable little sign-off is brought to you by the source/version line and footer of the page, which read nethsm-user-add on both sides and mark this as nethsm-user-add(1) in the General Commands Manual — so yeah, that's the whole footprint, mwah 🫶💖