NVIDIA Docs Hub Homepage NVIDIA Networking Networking Software NVIDIA NEO REST API Guide v2.7.20 Network Snapshots

Network Snapshots

Description	Manages networks running configurations in NEO (creating, restoring, uploading, downloading, saving, deleting, etc.)
Request URL	/neo/app/network_snapshots
Main Operations	Create snapshot Upload snapshot Get a list of all snapshots Get specific snapshots Download a specific snapshot Delete snapshot Edit snapshot description Apply snapshot Save snapshot

Description

Manages networks running configurations in NEO (creating, restoring, uploading, downloading, saving, deleting, etc.)

Request URL

/neo/app/network_snapshots

Main Operations

Create snapshot
Upload snapshot
Get a list of all snapshots
Get specific snapshots
Download a specific snapshot
Delete snapshot
Edit snapshot description
Apply snapshot
Save snapshot

Create Snapshot

Description	Creates a new snapshot
Request URL	POST /neo/app/network_snapshots
Response	HTTP response location header will contain an ID created for the new snapshot
Status Codes	Note: status code 415 UNSUPPORTED MEDIA TYPE occurs when case systems are not Mellanox or Cumulus

Request Data:

Copy
Copied!

            
            {
     "name":"<name>",
     "description":"<desc>",
     "systems":[
           "<system_ip>","<system_ip>","<system_ip>"
     ]
}

Upload Snapshot

Description	Receives a tar file containing a previously saved snapshot
Request URL	POST /app/network_snapshots?full_content=true
Request Content Type	Multipart/form-data
Response	Snapshot tar file that is downloaded from NEO to the user's download directory
Status Codes	Note: status code 415 UNSUPPORTED MEDIA TYPE occurs when case systems are not Mellanox or Cumulus

Get a list of all Snapshots

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

Response:

Copy
Copied!

            
            {
     "network_snapshots":[
           {"type":"<user | daily>",
           "name":"<name>",
           "description":"<desc>",
           "systems":[
                "<system_ip>","<system_ip>","<system_ip>"
           ],
           "date":"< date_time >"}
           ]
}

Get a Specific Snapshot

Description	Retrieves information on a specific snapshot in NEO
Request URL	GET /neo/app/network_snapshots/<name>/<system_ip>
Response	{ "content":"<content>", "last_checked": "<date_time>", "created": "<date_time>" }

Download a Specific Snapshot

Description	Downloads a previously saved snapshot
Request URL	GET /neo/app/network_snapshots/<name>?full_content=true
Response	Snapshot tar file that is downloaded from NEO to the user's download directory

Delete Snapshot

Description	Removes an existing snapshot
Request URL	DELETE /neo/app/network_snapshots/<name>
Request Data	N/A
Response	Location header includes a URI with a Job ID for snapshot deletion.

Edit a Snapshot's Description

Description	Edits a specific snapshot's description
Request URL	PUT /neo/app/network_snapshots/<name>
Request Data	{ "description":"<desc>" }
Response	HTTP response location header will contain an ID created for the new snapshot
Status Codes	Note: status code 415 UNSUPPORTED MEDIA TYPE occurs when case systems are not Mellanox or Cumulus

Apply Snapshot

Description	Applies a specific snapshot on the fabric
Request URL	POST /neo/app/network_snapshots/<name>
Request Data	{ "systems":[ "<system_ip>","<system_ip>","<system_ip>" ] }
Response	HTTP response location header will contain an ID created for the new snapshot

Save Snapshot

Description	Saves a snapshot with a new name
Request URL	PUT /neo/app/network_snapshots/<name>
Request Data	{ "name":"<name>" }
Response	HTTP response location header will contain an ID created for the new snapshot

On This Page