nethsm-env-add-device(1)

🌸 NAME 🌸

okay bestie, this is nethsm-env-add-device(1) from the General Commands Manual, and it's all about the netshm env add device command 💅. Yes, NAME spells it netshm env add device while the synopsis spells it nethsm env add device — both are here exactly as given, no cap 🫶.

✨ SYNOPSIS ✨

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

🦋 DESCRIPTION 🦋

It's the netshm env add device command. That's the description on the page — short, sweet, and iconic 💖.

💅 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 — keep them lined up, bestie 🎀. 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) 😭. Yes, the help entry says to see a summary with -h — that's exactly what the page says, and I'm obsessed.
• <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.

Cute sign-off from the footer: nethsm-env-add-device and nethsm-env-add-device(1) are the source/version-ish bits at the end, and the supplied footer shows no date — so I'm not inventing one 🎀✨💜.