Activate Software
API calls for activating a software image on a Viptela device:
Activate
Post device details to activate a software image.
URL: https://vmanage-ip-address/dataservice/device/action/changepartition
Method: POST
Request Parameters
| Name | Required | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| inputJson | Yes | Parameters for activate 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 activate software. |
| version | Version of software to upgrade to. |
| deviceIP | System IP of the device to upgrade. It can be an IPv4 or IPv6 address. |
| deviceID | Chassis number of the device being upgraded. |
| deviceType | Type of device. It can be controller (for a vBond orchestrator or vSmart controller), vmanage, or vedge. |
Example Request and Response
Activating a software image is a two-step process:
- Issue the POST call to initiate the action:
{
"action":"changepartition",
"devices":[
{
"version":"16.3.0",
"deviceIP":"172.16.51.1",
"deviceId":"52fe5cd3-ec3d-4141-92e4-0c31d0e0347a"
},
{
"version":"16.3.0",
"deviceIP":"172.16.51.2",
"deviceId":"4d4507df-29b4-4f68-9129-36cfa4528847"
}
],
"deviceType":"vedge"
} The response contains the process ID for the software activation:
"{"id":"change_partition-01232017T154359940"}" - Issue a monitor device action status call with the process ID to display the status of software activation:
https://vmanage-ip-address/dataservice/device/action/status/change_partition-01232017T154359940
The second response object retrieves the detailed action status.
Activate Information
Display information about the active software on a device.
URL: https://vmanage-ip-address/dataservice/device/action/changepartition?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 call responses have the following format:
{
"header": {
"generatedOn": timestamp, milliseconds (in UNIX time format),
"viewKeys": {
"uniqueKey": ["key"]
},
"fields": [
properties and types
],
},
"data": [
array of objects
]
}