Skip to main content
Viptela is now part of Cisco.
Support
Product Documentation
Viptela Documentation

Set Default Software

API call for setting a software image as the default image on a Viptela device:

Set Default Software

Post device details to set a software image as the default image.

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

Method: POST

Request Parameters

Name Required Description Parameter Type Data Type
inputJson Yes Parameters for set default software 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 set default software.
version Version of software to set as the default.
deviceIP System IP of the device on which to set default software. It can be an IPv4 or IPv6 address.
deviceID Chassis number of the device on which to set default software.
deviceType Type of device. It can be controller (for a vBond orchestrator or vSmart controller), vmanage, or vedge.

Example Request and Response

Setting a default software image is a two-step process:

  1. Issue the POST call to initiate the action:
{  
  "action":"defaultpartition",
  "devices":[
    {  
      "version":"99.99.999-2499",
      "deviceIP":"172.16.255.16",
      "deviceId":"13cf949c-9192-4c5d-8096-12c41fbd366d"
    }
  ],
  "deviceType":"vedge"
}

The response contains the process ID for the setting a default software image:

"{"id":"default_partition-01112017T159951140"}"
  1. Issue a monitor device action status call with the process ID to display the status of setting a default software image:
https://vmanage-ip-address/dataservice/device/action/status/default_partition-01112017T159951140

The second response object retrieves the detailed action status.

  • Was this article helpful?