.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.TH nethsm-system-backup 1  "nethsm-system-backup " 
.SH NAME
nethsm\-system\-backup \- Backup the key store of a device
.SH SYNOPSIS
\fBnethsm system backup\fR [\fB\-f\fR|\fB\-\-force\fR] [\fB\-o\fR|\fB\-\-output\fR] [\fB\-a\fR|\fB\-\-auth\-passphrase\-file\fR] [\fB\-c\fR|\fB\-\-config\fR] [\fB\-l\fR|\fB\-\-label\fR] [\fB\-u\fR|\fB\-\-user\fR] [\fB\-h\fR|\fB\-\-help\fR] 
.SH DESCRIPTION
Backup the key store of a device
.PP
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.
.PP
Note: Requires setting the backup passphrase using "nethsm config set backup\-passphrase" first!
.PP
Requires authentication of a system\-wide user in the "Backup" role.
.SH OPTIONS
.TP
\fB\-f\fR, \fB\-\-force\fR
Write to output file even if it exists already
.RS
May also be specified with the \fBNETHSM_FORCE\fR environment variable. 
.RE
.TP
\fB\-o\fR, \fB\-\-output\fR \fI<OUTPUT>\fR
The optional path to a specific output file
.RS
May also be specified with the \fBNETHSM_BACKUP_OUTPUT_FILE\fR environment variable. 
.RE
.TP
\fB\-a\fR, \fB\-\-auth\-passphrase\-file\fR \fI<AUTH_PASSPHRASE_FILE>\fR
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.
.RS
May also be specified with the \fBNETHSM_AUTH_PASSPHRASE_FILE\fR environment variable. 
.RE
.TP
\fB\-c\fR, \fB\-\-config\fR \fI<CONFIG>\fR
The path to a custom configuration file

If specified, the custom configuration file is used instead of the default configuration file location.
.RS
May also be specified with the \fBNETHSM_CONFIG\fR environment variable. 
.RE
.TP
\fB\-l\fR, \fB\-\-label\fR \fI<LABEL>\fR
A label uniquely identifying a device in the configuration file

Must be provided if more than one device is setup in the configuration file.
.RS
May also be specified with the \fBNETHSM_LABEL\fR environment variable. 
.RE
.TP
\fB\-u\fR, \fB\-\-user\fR \fI<USER>\fR
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.

.RS
May also be specified with the \fBNETHSM_USER\fR environment variable. 
.RE
.TP
\fB\-h\fR, \fB\-\-help\fR
Print help (see a summary with \*(Aq\-h\*(Aq)