NAME
nethsm-config-get-tls-csr - The "nethsm config get tls-csr" command
SYNOPSIS
nethsm config get tls-csr [-a|--auth-passphrase-file] [-f|--force] [-c|--config] [-o|--output] [-l|--label] [-u|--user] [-h|--help] <COMMON_NAME> [ORG_NAME] [ORG_UNIT] [LOCALITY] [STATE] [COUNTRY] [EMAIL] [SUBJECT_ALT_NAMES]
DESCRIPTION
The "nethsm config get tls-csr" 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.
- -f, --force
-
Write to output file even if it exists already
May also be specified with the NETHSM_FORCE 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.
- -o, --output <OUTPUT>
-
The optional path to a specific file that the certificate is written to
May also be specified with the NETHSM_CONFIG_TLS_CSR_OUTPUT_FILE 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')
- <COMMON_NAME>
-
The mandatory "Common Name" (CN) attribute for the CSR
A fully qualified domain name (FQDN) that should be secured using the CSR.
May also be specified with the NETHSM_TLS_CSR_COMMON_NAME environment variable.
- [ORG_NAME]
-
The optional "Organization Name" (O) attribute for the CSR
Usually the legal name of a company or entity and should include any suffixes such as Ltd., Inc., or Corp.
May also be specified with the NETHSM_TLS_CSR_ORG_NAME environment variable.
- [ORG_UNIT]
-
The optional "Organizational Unit" (OU) attribute for the CSR
Internal organization department/division name.
May also be specified with the NETHSM_TLS_CSR_ORG_UNIT environment variable.
- [LOCALITY]
-
The optional "Locality" (L) attribute for the CSR
Name of town, city, village, etc.
May also be specified with the NETHSM_TLS_CSR_LOCALITY environment variable.
- [STATE]
-
The optional "State" (ST) attribute for the CSR
Province, region, county or state.
May also be specified with the NETHSM_TLS_CSR_STATE environment variable.
- [COUNTRY]
-
The optional "Country" (C) attribute for the CSR
The two-letter ISO code for the country where the "Organization" (O) is located.
May also be specified with the NETHSM_TLS_CSR_COUNTRY environment variable.
- [EMAIL]
-
The optional "Email Address" (EMAIL) attribute for the CSR
The organization contact, usually of the certificate administrator or IT department.
May also be specified with the NETHSM_TLS_CSR_EMAIL environment variable.
- [SUBJECT_ALT_NAMES]
-
The optional list of subject alt names (SAN) for the CSR
If omitted, it is set to the same value as common_name. If it is set to an empty list, no SAN Extension is added. All SANs are considered DNS names, unless they start with "IP:" to signal IP names.
May also be specified with the NETHSM_TLS_CSR_SUBJECT_ALT_NAME environment variable.