Upgrade Software
API calls for upgrading software on Viptela devices:
Install
Post device details to begin upgrading software.
URL: https://vmanage-ip-address/dataservice/device/action/install
Method: POST
Request Parameters
| Name | Required | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| inputJson | Yes | Parameters for install 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 to upgrade. |
| deviceIP | System IP of the device to upgrade. It can be an IPv4 or IPv6 address. |
| deviceId | Chassis number of the device to upgrade. |
| deviceType | Type of device. It can be controller (for a vBond orchestrator or vSmart controller), vmanage, or vedge. |
| reboot | Whether to activate the installed software. The value true performs a reboot, to activate the software. The value false does not activate the software. |
| sync | The value true keeps the device's existing configuration. The value false reverts to the factory-default configuration. |
| vEdgeVPN | vEdge router VPN number on which to download the software image. |
| version | Software version number to install. |
| versionType | Source for downloading the software image to the device. It can be vmanage or remote. |
| vSmartVPN | vSmart controller VPN number on which to download the software image. |
Example Request and Response
Upgrading software is a two-step process:
- Issue the POST call to initiate the action:
{
"action":"install",
"input":{
"vEdgeVPN":0,
"vSmartVPN":0,
"version":"16.2.0",
"versionType":"vmanage",
"reboot":false,
"sync":true
},
"devices":[
{
"deviceIP":"172.16.255.14",
"deviceId":"2f876a33-9944-450a-91ee-f1f80eb68348"
}
],
"deviceType":"vedge"
} The response contains the process ID for the software upgrade action:
"{"id":"software_install-01232017T154359940"}" - Issue a monitor device action status call with the process ID to display the status of the software upgrade action:
https://vmanage-ip-address/dataservice/device/action/status/software_install-01232017T154359940
The second response object retrieves the detailed action status.
Install Devices
Display information about upgraded devices by device type.
URL: https://vmanage-ip-address/dataservice/device/action/install/deviceType?groupId=groupId
Method: GET
Request Parameters
| Name | Required | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| deviceType | Yes | Type of device. It can be controller (for a vBond orchestrator or vSmart controller), vmanage, or vedge. | Path | String |
| groupId | Yes | Group identifier for the device. | Query | String |
Response Content Type: application/json
Response Object: See Response Object, below.
Install Information
Display information about an upgraded device.
URL: https://vmanage-ip-address/dataservice/device/action/install?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
]
}