Skip to main content
Viptela is now part of Cisco.
Support
Product Documentation
Viptela Documentation

IPsec

API calls for real-time monitoring of IPsec information:

Inbound Connections

Display information about IPsec tunnels that originate on remote routers (on vEdge routers only).

CLI Equivalent: show ipsec inbound-connections

URL: https://vmanage-ip-address/dataservice/device/ipsec/inbound?deviceId=deviceId

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type
deviceId Yes IP address of device Query String
local-tloc-color Optional Local TLOC color Query String
remote-tloc-address Optional IP address of the remote TLOC Query IPv4
remote-tloc-color Optional Remote TLOC color Query String

Response Content Type: application/json

Response Object: See Response Object, below.

Local SA

Display security association information for the IPsec tunnels that have been created for local TLOCs (on vEdge routers only). 

CLI Equivalent: show ipsec local-sa

URL: https://vmanage-ip-address/dataservice/device/ipsec/localsa?deviceId=deviceId

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type
deviceId Yes IP address of device Query String

Response Content Type: application/json

Response Object: See Response Object, below.

Outbound Connections

Display information about the IPsec connections to remote routers (on vEdge routers only).

CLI Equivalent: show ipsec outbound-connections

URL: https://vmanage-ip-address/dataservice/device/ipsec/outbound?deviceId=deviceId

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type
deviceId Yes IP address of device Query String
remote-tloc-address Optional IP address of the remote TLOC Query IPv4
remote-tloc-color Optional Remote TLOC color Query String

Response Content Type: application/json

Response Object: See Response Object, below.

Response Object for Real-Time Monitoring API Calls

Real-time monitoring API call responses have the following format:

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

Additional Information

Using the vManage REST API

  • Was this article helpful?