write network
Saves a backup of the system to a network location
Last updated
Island Router CLI Reference Guide 2.3.2
Saves a backup of the system to a network location
Last updated
n
(Optional) The number of days of history data to be included in the backup.
include-keys
(Optional) If specified, the Island's private keys are included in the backup.
nohistory
(Option) No history data will be included in the backup. This is the same as days 0.
size
(Optional) If specified, an estimate of the resulting backup file in bytes will be displayed, but no file will be written.
url
(Optional) The location to where the backup file is to be written. Required unless size is specified.
By default, 10 years of history data will be included, and private keys will not be included.
The write network command creates a backup of the Island router and writes it to a remote file. The resulting file can be restored using the command.
If desired, historical usage data can be included in the backup file. Note that history data can dramtically increase the size of the backup file. A backup file with no history data will typically be under 1 MB. On an Island with many devices, however, each day of history data may increase the size of the backup file by tens or hundreds of megabytes. The size option can be used to get an estimate of the backup file size before actually creating the backup.
Backup files should be kept in a secure location since they may contain sensitive data.
Private security keys are not included in the backup by default. If the resulting backup is restored to another Island, or to the same Island after performing a factory reset, all VPNs will have to be deleted and recreated, and any remote access sessions from the Island app will need to be reestablished. To avoid this issue, the include-keys option can be used to include the Island's private keys in the backup. Although all Island backup files should be kept secure from access by unauthorized parties, files contining private keys are especially sensitive. Anyone with access to a backup file containing private keys could potentially gain access to the Island remotely and/or intercept its VPN communications.
Refer to the section of this document for more information on the syntax of the url parameter.