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

IP

API calls for real-time monitoring of IP information:

FIB

Display the IPv4 entries in the local forwarding table (on vEdge routers only).

CLI Equivalent: show ip fib

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

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type
deviceId Yes IP address of device Query String
vpn-id Optional VPN ID Query String
address-family Optional IP address family Query String
prefix Optional IP prefix Query String
tloc Optional TLOC IP address Query String
color Optional TLOC color Query String

Response Content Type: application/json

Response Object: See Response Object, below.

MFIB OIL

Display the list of outgoing interfaces from the Multicast Forwarding Information Base (MFIB) (on vEdge routers only).

CLI Equivalent: show ip mfib oil

URL: https://vmanage-ip-address/dataservice/device/ip/mfiboil?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.

MFIB Statistics

Display packet transmission and receipt statistics for active entries in the Multicast Forwarding Information Base (MFIB) (on vEdge routers only). Packet rates are computed every 10 seconds.

CLI Equivalent: show ip mfib stats

URL: https://vmanage-ip-address/dataservice/device/ip/mfibstats?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.

MFIB Summary

Display a summary of all active entries in the Multicast Forwarding Information Base (MFIB) (on vEdge routers only).

CLI Equivalent: show ip mfib summary

URL: https://vmanage-ip-address/dataservice/device/ip/mfibsummary?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.

NAT Filter

Display the NAT translational filters (on vEdge routers only).

CLI Equivalent: show ip nat filter

URL: https://vmanage-ip-address/dataservice/device/ip/nat/filter?deviceId=deviceId

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type
deviceId Yes IP address of device Query String
nat-vpn-id Optional NAT VPN ID Query String
nat-ifname Optional NAT interface name Query String
private-source-address Optional Private source address Query String
proto Optional Protocol Query String

Response Content Type: application/json

Response Object: See Response Object, below.

NAT Interface

List the interfaces on which NAT is enabled and the NAT translational filters on those interfaces (on vEdge routers only).

CLI Equivalent: show ip nat interface

URL: https://vmanage-ip-address/dataservice/device/ip/nat/interface?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.

NAT Interface Statistics

List packet, NAT, and ICMP statistics for the interfaces on which NAT is enabled (on vEdge routers only).

CLI Equivalent: show ip nat interface-statistics

URL: https://vmanage-ip-address/dataservice/device/ip/nat/interfacestatistics?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.

Routes

Display the IPv4 entries in the local route table. On vSmart controllers, the route table incorporates forwarding information.

CLI Equivalent: show ip routes

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

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type
deviceId Yes IP address of device Query String
vpn-id Optional VPN ID Query String
address-family Optional IP address family Query String
prefix Optional IP prefix Query String
protocol Optional IP protocol 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?