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

NAME
       nethsm-system-backup - Backup the key store of a device

SYNOPSIS
       nethsm system backup [-f|--force] [-o|--output]
       [-a|--auth-passphrase-file] [-c|--config] [-l|--label] [-u|--user]
       [-h|--help]

DESCRIPTION
       Backup the key store of a device

       Writes an encrypted backup to a file in the current working directory,
       named after the device label in the configuration file and the current
       time.  Optionally, a specific output file can be provided.

       Note: Requires setting the backup passphrase using "nethsm config set
       backup-passphrase" first!

       Requires authentication of a system-wide user in the "Backup" role.

OPTIONS
       -f, --force
              Write to output file even if it exists already
              May also be specified with the NETHSM_FORCE environment
              variable.

       -o, --output <OUTPUT>
              The optional path to a specific output file
              May also be specified with the NETHSM_BACKUP_OUTPUT_FILE
              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')

                             nethsm-system-backup      nethsm-system-backup(1)