Reference

nethsm-system(1)

The "nethsm system" command

NAME

nethsm-system - The "nethsm system" command

SYNOPSIS

nethsm system [-a|--auth-passphrase-file] [-c|--config] [-l|--label] [-u|--user] [-h|--help] <subcommands>

DESCRIPTION

The "nethsm system" 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.

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

SUBCOMMANDS

nethsm-system-backup(1)

The "nethsm system backup" command

nethsm-system-factory-reset(1)

The "nethsm system factory-reset" command

nethsm-system-info(1)

The "nethsm system info" command

nethsm-system-reboot(1)

The "nethsm system reboot" command

nethsm-system-restore(1)

The "nethsm system restore" command

nethsm-system-shutdown(1)

The "nethsm system shutdown" command

nethsm-system-upload-update(1)

The "nethsm system upload-update" command

nethsm-system-cancel-update(1)

The "nethsm system cancel-update" command

nethsm-system-commit-update(1)

The "nethsm system commit-update" command

nethsm-system-validate-backup(1)

The "nethsm system validate-backup" command

nethsm-system-help(1)

Print this message or the help of the given subcommand(s)