Summary:
List network devices for which flow is being collected and stored, and flow history for a specified device. Network devices must be configured to send flow information to Entuity, meaning that Entuity has no control over the flow information it receives. Further, flow information is not stored by default - this must be enabled for each device where desired.
URL:
http(s)://{server hostname}/api/flowDevices
Methods summary
- GET Method - lists devices for which flow information is being collected.
GET Method detail
Lists the devices for which flow information is currently being collected.
Response:
The API will respond with a list of devices for which Entuity has collected flow data. Within the list, each device is represented as an associative array, containing the following information about the devices:
| Name | Description |
|---|---|
|
flowServerId |
ID of the flow server that is collecting flow for this device. Typically, each Entuity server manages a single flow server. In this case you would expect flowServerId to match serverId. However, an Entuity server can manage multiple flow servers and this attribute would allow you to determine which one. |
|
zoneName |
name of the zone that the device has been placed in. If zoning is not in use, the value of zoneName will be null. |
|
deviceId |
ID of the device as assigned when the device is taken under management by Entuity. This ID is unique to a server but must be used in conjunction with flowServerId to uniquely identify a device in a multi-server configuration. |
|
IpAddress |
string representation of the management IP address of the device. IPv4 and IPv6 are supported. |
|
deviceName |
string representation of the device's display name. |
|
swObId |
StormWorks Object ID. All objects, including devices, are assigned a stormworks object ID. As with deviceId, swObId must be used in conjunction with flowServerId to uniquely identify an object in a multi-server configuration. |
|
vxlan |
indicates that the flow record originates from a VMWare virtualized device. Either True or False. |
|
ifIndexes |
list of port ifIndexes for which flow is being collected. Note that ifIndexes are only unique within a device. |
Example:
INPUT
curl -u admin:admin https://localhost/api/flowDevices?media=json
OUTPUT
{
"devices" : [ {
"flowServerId" : "5ba829fa-86d9-4246-b4ce-24cc896180c0",
"zoneName" : null,
"deviceId" : 17,
"ipAddress" : "10.18.0.2",
"deviceName" : "ca01",
"swObjId" : 866,
"vxlan" : false,
"ifIndexes" : [ 1, 2, 3, 4, 5 ]
}, {
"flowServerId" : "5ba829fa-86d9-4246-b4ce-24cc896180c0",
"zoneName" : null,
"deviceId" : 1,
"ipAddress" : "10.1.2.2",
"deviceName" : "hq01",
"swObjId" : 730,
"vxlan" : false,
"ifIndexes" : [ 1, 2, 3, 4, 5 ]
}
]
}
Comments
0 comments
Please sign in to leave a comment.