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

Cflowd

API calls for real-time monitoring of cflowd information:

Collector

Display information about the configured cflowd collectors that the vEdge router has learned from a vSmart controller (on vEdge routers only).

CLI Equivalent: show app cflowd collector

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

Flows

Display cflowd flow information (on vEdge routers only).

CLI Equivalent: show app cflowd flows

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

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type
deviceId Yes IP address of device Query String
dest-ip Optional Destination IP address Query String
src-ip Optional Source IP address Query String
vpn-id Optional VPN ID Query String

Response Content Type: application/json

Response Object: See Response Object, below.

Flows Count

Display the number of current cflowd traffic flows (on vEdge routers only).

CLI Equivalent: show app cflowd flow-count

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

Statistics

Display cflowd packet statistics (on vEdge routers only).

CLI Equivalent: show app cflowd statistics

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

Template

Display the cflowd template information that the vEdge router transmits periodically to the cflowd collector (on vEdge routers only).

CLI Equivalent: show app cflowd template

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

Response Object for Real-Time Monitoring API Calls

The 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?