NVIDIA Docs Hub Homepage NVIDIA Networking Networking Software NVIDIA NEO REST API Guide v2.7.20 Backup and Restore

Backup and Restore

Description	Manages NEO configuration (creating, restoring, uploading, downloading, saving, deleting, etc.).
Request URL	/neo/app/backupsets
Main Operations	Create backupsets Import backupsets Get a list of all backupsets Download a specific backupset Delete backupsets Edit snapshot backupsets Restore backupsets Upgrade backupsets

Create Backupsets

Description	Creates new backupsets
Request URL	POST /neo/app/backupsets
Options	discovery_methods": [lldp", "agent" , "range_scan"] "device_types": ["mlnxos_switch", "arista_switch", "brocade_switch", "hp_switch", "cumulus_switch", "juniper_switch", "cisco_switch", "linux_host", "windows_host"]
Response	HTTP response location header will contain a URI with a job ID created for the creation of backupset: /neo/app/jobs/<job_ID>

Request Data:

Copy
Copied!

            
            {
"name":"<name>",
"description":"<desc>", 
"options":["data", "configuration"]
}

Import Backupsets

Description	Receives a tar file containing previously saved backupsets
Request URL	POST/app/backupsets/import
Request Content Type	Multipart/form-data
Response	Getting a tar from the user (uploading), unpacking it and adding it as a backupset (folder).

Get a List of All Backupsets

Description	Retrieves a list of all backupsets in NEO
Request URL	GET/neo/app/backupsets

Response:

Copy
Copied!

            
            {
                "description": "Backup test", 
"version":"2.0.0-4",
"date": "2017-11-21 11:30:00",
"name": "test1"
}, 
{
"description": "Backup test2", 
"version":"2.0.0-4",
"date": "2017-11-21 12:30:00", 
"name": "test2"
} 
]

Export Specific Backupsets

Description	Export a previously saved backupset
Request URL	GET/neo/app/backupsets/<name>?export=true
Response	Backupsets tar file that is downloaded from NEO to the user's download directory.

Delete Backupsets

Description	Removes an existing backupset
Request URL	DELETE/neo/app/backupsets /<name>

Edit a Backupset

Description	Edits a specific backupset
Request URL	PUT/neo/app/backupsets /<name>
Request Data	{ "description":"<desc>" "name": "new name" }

Warning

Changing the backupset's name will save a copy with the new name.

Restore Backupsets

Description	Restore backupsets in NEO
Request URL	POST/neo/app/backupsets /restore/<name>
Request Data	{ "ha":"[true, false]" }

Warning

NEO will be restarted with the new configuration.

On This Page