Connect Devices

Display all devices in the overlay network that are connected to the Cisco Catalyst SD-WAN Manager instance.

GET https://{vmanage-ip-address}/dataservice/device

Content-Type: application/json

Request query parameter:

Response body:

[
    {
      "deviceId": {device-id},
      "system-ip": {device-ip},
      "host-name": {hostname},
      "reachability": "reachable",
      "status": "normal",
      "personality": "vedge",
      "device-type": "vedge",
      "timezone": {TZ},
      "device-groups": [
        {device-group}
      ],
      "lastupdated": {timestamp},
      "bfdSessionsUp": {bfd-session-number},
      "domain-id": {domain},
      "board-serial": {serial-number},
      "certificate-validity": "Valid",
      "max-controllers": "0",
      "uuid": "1c5ac3d6-e315-47b5-a678-f12086bbb03a",
      "bfdSessions": {bfd-session-number},
      "controlConnections": {connection-number},
      "device-model": "vedge-cloud",
      "version": {image-version},
      "connectedVManages": [
        {vmanage-ip-address}
      ],
      "site-id": {site-id},
      "ompPeers": {omp-peer-number},
      "latitude": {latitude},
      "longitude": {longitude},
      "isDeviceGeoData": true,
      "platform": "x86_64",
      "uptime-date": {timestamp},
      "statusOrder": 4,
      "device-os": "next",
      "validity": "valid",
      "state": "green",
      "state_description": "All daemons up",
      "model_sku": "None",
      "local-system-ip": {local-system-ip},
      "total_cpu_count": {cpu-count},
      "linux_cpu_count": {cpu-count},
      "testbed_mode": {boolean},
      "layoutLevel": 4
    }
]

Controllers

Display all available Cisco Catalyst SD-WAN Manager Controllers—Cisco Catalyst SD-WAN Manager Validators orchestrators, Cisco Catalyst SD-WAN Manager Controllers NMS, and Cisco Catalyst SD-WAN Manager Controllers—in the overlay network.

GET https://{vmanage-ip-address}/dataservice/system/device/controllers

Content-Type: application/json

Request query parameter:

Response body:

[
   {
      "deviceType":"vsmart",
      "serialNumber": {serial-number},
      "ncsDeviceName":"vsmart-b95e9ddc-017b-4bb3-b00e-26c9011d1d3d",
      "configStatusMessage":"In Sync",
      "templateApplyLog":[
         "[19-Jun-2020 18:47:23 UTC] Sync-from successful"
      ],
      "uuid":"b95e9ddc-017b-4bb3-b00e-26c9011d1d3d",
      "managementSystemIP": {system-ip-address},
      "templateStatus":"Success",
      "chasisNumber":"b95e9ddc-017b-4bb3-b00e-26c9011d1d3d",
      "configStatusMessageDetails":"",
      "configOperationMode":"cli",
      "deviceModel":"vsmart",
      "deviceState":"READY",
      "validity":"valid",
      "platformFamily":"vsmart",
      "username":"--",
      "rootCertHash":"6b5c439fc8446d2d7ba45365eb3a43516ed039de",
      "state":"vBond Updated",
      "globalState":"normal",
      "valid":"valid",
      "requestTokenID":"35aa1f5f-16e6-446d-81d2-f72d07d4220f",
      "expirationDate":"Jun 19 18:37:24 2021 GMT",
      "expirationDateLong":1624127844000,
      "deviceIP": {device-ip-address},
      "activity":[
         "vBond Updated"
      ],
      "certInstallStatus":"Installed",
      "personality":"vsmart",
      "expirationStatus":"normal",
      "uploadSource":"Auto Discovered",
      "timeRemainingForExpiration":30419646000,
      "policy-template-version":"",
      "policy-template-name":"",
      "local-system-ip":{local-system-ip-address},
      "system-ip":{system-ip-address},
      "model_sku":"None",
      "site-id":{site-id},
      "host-name":{hostname},
      "version":{image-version},
      "vbond":{vbond-ip-address},
      "vmanageConnectionState":"connected",
      "lastupdated":{timestamp},
      "reachability":"reachable",
      "uptime-date":{timestamp},
      "defaultVersion":{image-version},
      "availableVersions":[
      ],
      "lifeCycleRequired":false,
      "hardwareCertSerialNumber":"NA",
      "subjectSerialNumber":"NA"
   }
]

vEdges

Display all available vEdge routers in the overlay network.

GET https://{vmanage-ip-address}/dataservice/system/device/vedges

Content-Type: application/json

Request query parameter:

Response body:

[
   {
      "deviceType":"vedge",
      "serialNumber":{serial-number},
      "ncsDeviceName":"vedge-5cf59daf-6500-489d-b33c-b4520f6f2600",
      "configStatusMessage":"In Sync",
      "templateApplyLog":[
         "[27-Jun-2020 4:17:56 PDT] Sync-from successful"
      ],
      "uuid":"5cf59daf-6500-489d-b33c-b4520f6f2600",
      "managementSystemIP":{system-ip-address},
      "templateStatus":"Success",
      "chasisNumber":"5cf59daf-6500-489d-b33c-b4520f6f2600",
      "configStatusMessageDetails":"",
      "configOperationMode":"cli",
      "deviceModel":"vedge-cloud",
      "deviceState":"READY",
      "validity":"valid",
      "platformFamily":"vedge-x86",
      "username":"--",
      "rootCertHash":"6b5c439fc8446d2d7ba45365eb3a43516ed039de",
      "deviceIP":{deevice-id-address},
      "personality":"vedge",
      "uploadSource":"Auto Discovered",
      "local-system-ip":{local-system-ip-address},
      "system-ip":{system-ip-address},
      "model_sku":"None",
      "site-id":{site-id},
      "host-name":{hostname},
      "version":{image-versioln},
      "vbond":{vbond-ip-address},
      "vmanageConnectionState":"connected",
      "lastupdated":{timestamp},
      "reachability":"reachable",
      "uptime-date":{timestamp},
      "defaultVersion":{image-version},
      "availableVersions":[
      ],
      "lifeCycleRequired":true,
      "vedgeCertificateState":"certinstalled",
      "expirationDate":"NA",
      "hardwareCertSerialNumber":"NA",
      "subjectSerialNumber":"NA"
   }
]