Software Upgrade

• Display a list of software images available on a Cisco Catalyst SD-WAN Manager instance GET https://{vmanage-ip-address}/dataservice/device/action/software

  with response body:

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

• Upload software to a device.
  POST https://{vmanage-ip-address}/dataservice/device/action/software/package content type: multipart/form-data

  with request body:

  Content-Disposition: form-data; name="file"; filename="vmanage-16.3.1-x86_64.tar.gz"
  Content-Type: application/x-gzip
  

• Post device details to begin a software upgrade.
  POST https://vmanage-ip-address/dataservice/device/action/install

  with request body:

  {  
    "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"
  }
  

• Get information about an upgraded device
  GET https://{vmanage-ip-address}/dataservice/device/action/install?deviceId=deviceId

• Delete a software image in a two-step process:

  • To retrieve a list of all software versions on Cisco Catalyst SD-WAN Manager: GET https://{vmanage-ip-address}/dataservice/device/action/software

  The response contains information about all software images on Cisco Catalyst SD-WAN Manager:

  {
    "versionType": "vmanage",
    "versionId": "6b46230d-484c-4566-9e23-2b42bd12b403",
    "updatedOn": 1486072271028,
    "versionName": "16.3.1",
    "versionURL": "http://<VMANAGE_HOST>:8080/software/package/",
    "availableFiles": "vmanage-16.3.1-x86_64.tar.gz"
  }
  

  • To delete the software version, issue a Delete Software call with the version Id:
    POST https://{vmanage-ip-address}/dataservice/device/action/software/6b46230d-484c-4566-9e23-2b42bd12b403

• Add URL of Remote Software Repository
  POST https://{vmanage-ip-address}/dataservice/device/action/software

• Activate software
  Post device details to activate a software image
  POST https://{vmanage-ip-address}/dataservice/device/action/changepartition

  with request body:

  {  
    "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

• Display activate information
  GET https://{vmanage-ip-address}/dataservice/device/action/changepartition?deviceId=deviceId

• Set an image as default software image
  POST https://{vmanage-ip-address}/dataservice/device/action/defaultpartition

  with request body:

  {  
    "action":"defaultpartition",
    "devices":[
      {  
        "version":"99.99.999-2499",
        "deviceIP":"172.16.255.16",
        "deviceId":"13cf949c-9192-4c5d-8096-12c41fbd366d"
      }
    ],
    "deviceType":"vedge"
  }
  

Device Operation

• Reboot device
  POST https://{vmanage-ip-address}/dataservice/dataservice/device/action/reboot

  with request body:

  {
     "action":"reboot",
     "deviceType":"vedge",
     "devices":[
        {
           "deviceIP":{device-ip-address},
           "deviceId":{device-uuid}
        }
     ]
  }
  

• Reset interface
  POST https://{vmanage-ip-address}/dataservice/device/tools/reset/interface/{device-ip-address}

  with request body:
  {"vpnId": vpn-Id,"ifname": interface-name}

• Generate admin tech log
  POST https://{vmanage-ip-address}/dataservice/device/tools/admintech

  with request body:

  {
     "deviceIP": {device-ip-address},
     "exclude-cores":false,
     "exclude-tech":false,
     "exclude-logs":false
  }
  

• Reset locked user on device
  POST https://{vmanage-ip-address}/dataservice/device/tools/resetuser/{device-ip-address}

  with request body:
  {"user":"admin"}

• Rediscover device
  POST https://{vmanage-ip-address}/dataservice/device/action/rediscover

  with request body:

  {
     "action":"rediscover",
     "devices":[
        {
           "deviceId": {uuid},
           "deviceIP": {device-ip-address}
        }
     ]
  }