system-backup

Last published : Oct 30, 2026
The following operations can be performed on "system-backup":

add system backup

Adds a backup file (*.tgz) that was created in remote system by using the "create system backup" command.

Synopsis

add system backup <fileName>

Arguments

fileName Name of the backup file(*.tgz) to be restored.

show system backup

Retrieves the backed up files that were created in the appliance.

Synopsis

show system backup

Arguments

fileName Name of the backup file(*.tgz) to be restored.

Output

level Level of data to be backed up.
comment Comment specified at the time of creation of the backup file(*.tgz).
size Size of the backup file(*.tgz) in KB.
creationTime Creation time of the backup file(*.tgz).
version Build version of the backup file(*.tgz).
createdBy Name of user who created the backup file(*.tgz).
IPAddress Ip of Citrix ADC box where the backup file(*.tgz) was created.
devno count stateflag

create system backup

Creates a backup file (*.tgz) that is stored in the /var/ns_sys_backup/ directory. This file can be used to restore the appliance by using the "restore system backup" command.

Synopsis

create system backup

Arguments

fileName Name of the backup file(*.tgz) to be restored.
level Level of data to be backed up.
Possible values: basic, full Default value: basic
comment Comment specified at the time of creation of the backup file(*.tgz).

restore system backup

Restores an appliance by using the backup file (*.tgz) that was created by using the "create system backup" command.

Synopsis

restore system backup <fileName>

Arguments

fileName Name of the backup file(*.tgz) to be restored.
skipbackup Use this option to skip taking backup during restore operation

rm system backup

Removes a backup file (*.tgz) that was created by using the "create system backup" command.

Synopsis

rm system backup <fileName>

Arguments

fileName Name of the backup file(*.tgz) to be restored.