Cisco D9800 Reference Manual page 24

Backup Command
Table 2: Options
Option
STD
UD
EXT
Example of issuing the backup command (assuming the STD option is specified):
Input:
curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v1/backup?t=STD"
Expected output (may not be exactly as shown):
<BKPRST>
<FILE_INFO><PLAT_TYPE>D9800</PLAT_TYPE><DESIGNATION>10</DESIGNATION>
<VERSION>1.00</VERSION>
<DATE_TIME>Date YYYY/DD/MM 2015/07/20 Time HR:MIN:SEC 20:57:33</DATE_TIME>
<FILE_NAME>file name</FILE_NAME></FILE_INFO>
<SETTINGS>
<BKPRST>
</SETTINGS>
</SETTINGS>
...other XML data ...
</BKPRST>
Note The XML response is not immediate and may take several seconds to complete. While the Backup command
is in progress, the BKPRSTSTAT UIC table should not be queried by other curl clients other than the UI
(if at all), in order to reduce the risk of timeout due to inter process call overhead. Prior to the completion
of the command, the BKPRSTSTAT UIC table is incremented, with internal state changes and incremental
progress percent completions, up to 100%. However, these state changes may occur faster than they are
polled. When the command is completed, the BKPRSTSTAT UIC table Operation Status state will set
back to Idle, and the Progress percentage will set back to 0%, in preparation for any subsequent Backup
or Restore operation. The availability of the new Backup XML data (or file Save As dialog in the case of
using the UI Browser) is the valid indicator for the successful completion of this command. If there is an
issue with generating the Backup file, then the BKPRSTSTAT UIC table Operation Status will indicate
the Fail state, with the Detailed Status field, indicating the reason for the Failure. Check this data only
after the command returns. If there is a problem with file transfer, timeout, or invoking the command,
then the XML response to this command will indicate a failure response through the legacy command
Status form.
Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
12
<RECORD>
<OID>1.3.6.1.4.1.1482.20.1.9.1.1.2.1</OID>
<VALUE>6C410A0A</VALUE>
</RECORD>
...other XML records ...
Description
Backs up standard data.
Backs up user changes to factory data (customer
presets).
Backs up all standard data and user data.
API Definitions