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

NAME
       nethsm-system-validate-backup - Validate a backup file

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

DESCRIPTION
       Validate a backup file

       Parse an encrypted backup file to ensure general properties.  If a
       passphrase is provided, decrypting the backup file and validating its
       version number is attempted.  This command exits with a non-zero exit
       code, if the file is corrupted, decryption or validation fails.

       Note: Backups are created using "nethsm system backup"

OPTIONS
       -b, --backup-passphrase-file <BACKUP_PASSPHRASE_FILE>
              The path to a file containing the backup passphrase
              May also be specified with the
              NETHSM_VALIDATE_BACKUP_PASSPHRASE_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')

       <INPUT>
              The path to the backup file to validate
              May also be specified with the NETHSM_VALIDATE_BACKUP_FILE
              environment variable.

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