nethsm-system-restore(1)    General Commands Manual   nethsm-system-restore(1)

NAME
       nethsm-system-restore - Restore the device from a backup

SYNOPSIS
       nethsm system restore [-b|--backup-passphrase-file] [-s|--system-time]
       [-a|--auth-passphrase-file] [-c|--config] [-l|--label] [-u|--user]
       [-h|--help] <INPUT>

DESCRIPTION
       Restore the device from a backup

       The device may be in state "Operational" or "Unprovisioned".  In both
       cases, the users and keys from the backup replace those on the device
       (if any).

       If the device is in state "Unprovisioned", any credentials provided for
       authentication are ignored, the system configuration (e.g. TLS
       certificate, unlock passphrase, etc.) from the backup is used as well,
       the device is rebooted and ends up in "Locked" state.

       If no new system time is provided, it is derived from the caller's
       system time.  If no backup passphrase is provided specifically, it is
       prompted for interactively.

       Requires authentication of a system-wide user in the "Administrator"
       role only if the device is in "Operational" state.

OPTIONS
       -b, --backup-passphrase-file <BACKUP_PASSPHRASE_FILE>
              The path to a file containing the backup passphrase
              May also be specified with the NETHSM_BACKUP_PASSPHRASE_FILE
              environment variable.

       -s, --system-time <SYSTEM_TIME>
              The new system time for the device

              Must be provided as an ISO 8601 formatted UTC timestamp.
              May also be specified with the NETHSM_SYSTEM_TIME 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')

       <INPUT>
              The path to a valid NetHSM backup file
              May also be specified with the NETHSM_BACKUP_FILE environment
              variable.

                            nethsm-system-restore     nethsm-system-restore(1)