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

Reboot Device

API calls for rebooting Viptela devices:

Reboot

Post device details to begin rebooting a device.

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

Method: POST

Request Parameters

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

Example Request and Response

Rebooting a device is a two-step process:

  1. Issue the POST call to initiate the action:
{  
  "action":"reboot",
  "deviceType":"vedge",
  "devices":[      
    {  
      "deviceIP":"172.16.255.11", 
      "deviceId":"6ace13f8-fded-4669-994a-a100b84b14dd"
    }
  ]
}

The response contains the process ID for the reboot action:

"{"id":"reboot-01232017T154359940"}"
  1. Issue a monitor device action status call with the process ID to display the status of the reboot action:
https://vmanage-ip-address/dataservice/device/action/status/reboot-01232017T154359940

The second response object retrieves the detailed action status.

Reboot Devices

Display information about rebooted devices by device type.

URL: https://vmanage-ip-address/dataservice/device/action/reboot/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. Query String

Response Content Type: application/json

Response Object: See Response Object, below.

Reboot Information

Display information about a rebooted device.

URL: https://vmanage-ip-address/dataservice/device/action/reboot?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 response 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?