Skip to main content
Cisco SD-WAN
Support
Product Documentation
Viptela Documentation

Delete Software

API calls for deleting a Viptela software image:

Delete

Post device details to begin deleting a software image.

URL: https://vmanage-ip-address/dataservice/device/action/removepartition

Method: POST

Request Parameters

Name Required Description Parameter Type Data Type
inputJson Yes Parameters for delete action Body
See Request Body Schema table, below, for details.
String

Response Content Type: application/json

Request Body Schema

Value Description
devices List of devices on which to delete software.
version Version of software to delete.
deviceIP System IP of the device on which to delete software. It can be an IPv4 or IPv6 address.
deviceID Chassis number of the device on which to delete software.
deviceType Type of device. It can be controller (for a vBond orchestrator or vSmart controller), vmanage, or vedge.

Example Request and Response

Deleting a software image is a two-step process:

  1. Issue the POST call to initiate the action:
{  
  "action":"removepartition",
  "devices":[  
    {  
      "deviceIP":"172.16.255.11",
      "deviceId":"6ace13f8-fded-4669-994a-a100b84b14dd",
      "version":[  
        "16.2.9",
        "16.3.1"
      ]
    },
    {  
      "deviceIP":"172.16.255.21",
      "deviceId":"bedf3db0-c9c9-439d-b5fe-0edf09c2f33f",
      "version":[  
        "16.2.9"
      ]
    }
  ],
  "deviceType":"vedge"
}

The response contains the process ID for the software deletion:

"{"id":"delete_partition-01132017T159951140"}"
  1. Issue a monitor device action status call with the process ID to display the status of software deletion:
https://vmanage-ip-address/dataservice/device/action/status/delete_partition-01132017T159951140

The second response object retrieves the detailed action status.

Delete Information

Display information about the software image deleted from a device.

URL: https://vmanage-ip-address/dataservice/device/action/removepartition?deviceId=deviceId

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type
deviceId Yes System IP address of the device. It can be an IPv4 or IPv6 address. Query String

Response Content Type: application/json

Response Object: See Response Object, below.

Response Object

API calls responses have the following format:

{
  "header": {
    "generatedOn": timestamp, milliseconds (in UNIX time format),                            
      "viewKeys": {
        "uniqueKey": ["key"]                       
      },
      "fields": [
        properties and types
      ],
   },
   "data": [
     array of objects
   ]
}
  • Was this article helpful?