Fetches all Border Routers in a PfR controlled site that are actively exporting PfR NetFlow within a specified time range.The URL Format is: /op/pfrMonitoringExt/getAllBorderRouters/startTime/endTime/siteName?siteHierachyPath. Here are the sample queries:
- /op/pfrMonitoringExt/getAllBorderRouters/1475824562/1476429362/BANGALORE -- Returns all Border Routers in a PfR controlled site that are actively exporting pfr Netflow within a specified time range for the give site.
- /op/pfrMonitoringExt/getAllBorderRouters/1475824562/1476429362/BANGALORE? hierarchyPath=/Location/All Locations-- Returns all Border Routers in a PfR controlled site that are actively exporting pfr Netflow within a specified time range for the given site under the given hierarchyPath.
Since Product Version: 3.1
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
API version v1 is deprecated
This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.
Resource URL
/webacs/api/v1/op/pfrMonitoringExt/getAllBorderRouters/{startTime}/{endTime}/{siteName}
Request Parameters
startTime
Long
|
path
|
Required
Specifies the start time in milli seconds to get the all border routers from.
|
endTime
Long
|
path
|
Required
Specifies the start time in milli seconds to get the all border routers to.
|
siteName
String
|
path
|
Required
Specifies the site name to get the all border routers for specified site.
|
hierarchyPath
String
|
query
|
Optional
OPTIONAL Specifies the site name to get the all border routers for specified site hierarchy.
|
Response Parameters
childStatistics
StatisticsDTO[]
|
The set of nested StatisticsDTO objects.
|
childStatistics
StatisticsDTO[]
|
The set of nested StatisticsDTO objects.
|
statisticEntry
StatisticsEntry[]
|
The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.
|
attributeName
String
|
The name of the attribute.
|
displayName
String
|
The display name of the attribute.
|
entryValue
String
|
|
|
statisticsName
StatisticsOperationTypeEnum
|
The Statistics operation type.
|
|
statisticEntry
StatisticsEntry[]
|
The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.
|
attributeName
String
|
The name of the attribute.
|
displayName
String
|
The display name of the attribute.
|
entryValue
String
|
|
|
statisticsName
StatisticsOperationTypeEnum
|
The Statistics operation type.
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Response Payload
https://localhost/webacs/api/v1/op/pfrMonitoringExt/getAllBorderRouters/1463999256456/1465208856234/Site1?hierarchyPath="Location/All Locations/Site1"
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v1/op/pfrMonitoringExt/getAllBorderRouters/1463999256456/1465208856234/Site1?hierarchyPath=&quot;Location/All Locations/Site1&quot;
" rootUrl="https://localhost/webacs/api/v1/op">
<statisticsDTO>
<childStatistics></childStatistics>
<statisticEntries>
<statisticEntry>
<attributeName>String value</attributeName>
<displayName>String value</displayName>
<entryValue>String value</entryValue>
</statisticEntry>
</statisticEntries>
<statisticsName>DEVICE_TOPN_CPU_UTILIZATION</statisticsName>
</statisticsDTO>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v1/op/pfrMonitoringExt/getAllBorderRouters/1463999256456/1465208856234/Site1.json?hierarchyPath="Location/All Locations/Site1"
{
"mgmtResponse" : {
"@responseType" : "operation",
"@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op\/pfrMonitoringExt\/getAllBorderRouters\/1463999256456\/1465208856234\/Site1?hierarchyPath="Location\/All Locations\/Site1"\n\t\t\t\t\t",
"@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op",
"statisticsDTO" : {
"childStatistics" : "",
"statisticEntries" : {
"statisticEntry" : {
"attributeName" : "String value",
"displayName" : "String value",
"entryValue" : "String value"
}
},
"statisticsName" : "DEVICE_TOPN_CPU_UTILIZATION"
}
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v2/op/pfrMonitoringExt/getAllBorderRouters/{startTime}/{endTime}/{siteName}
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
startTime
Long
|
path
|
Required
Specifies the start time in milli seconds to get the all border routers from.
|
endTime
Long
|
path
|
Required
Specifies the start time in milli seconds to get the all border routers to.
|
siteName
String
|
path
|
Required
Specifies the site name to get the all border routers for specified site.
|
hierarchyPath
String
|
query
|
Optional
OPTIONAL Specifies the site name to get the all border routers for specified site hierarchy.
|
Response Parameters
childStatistics
StatisticsDTO[]
|
The set of nested StatisticsDTO objects.
|
childStatistics
StatisticsDTO[]
|
The set of nested StatisticsDTO objects.
|
statisticEntry
StatisticsEntry[]
|
The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.
|
attributeName
String
|
The name of the attribute.
|
displayName
String
|
The display name of the attribute.
|
entryValue
String
|
|
|
statisticsName
StatisticsOperationTypeEnum
|
The Statistics operation type.
|
|
statisticEntry
StatisticsEntry[]
|
The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.
|
attributeName
String
|
The name of the attribute.
|
displayName
String
|
The display name of the attribute.
|
entryValue
String
|
|
|
statisticsName
StatisticsOperationTypeEnum
|
The Statistics operation type.
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Response Payload
https://localhost/webacs/api/v2/op/pfrMonitoringExt/getAllBorderRouters/1463999256456/1465208856234/Site1?hierarchyPath="Location/All Locations/Site1"
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v2/op/pfrMonitoringExt/getAllBorderRouters/1463999256456/1465208856234/Site1?hierarchyPath=&quot;Location/All Locations/Site1&quot;
" rootUrl="https://localhost/webacs/api/v2/op">
<statisticsDTO>
<childStatistics></childStatistics>
<statisticEntries>
<statisticEntry>
<attributeName>String value</attributeName>
<displayName>String value</displayName>
<entryValue>String value</entryValue>
</statisticEntry>
</statisticEntries>
<statisticsName>DEVICE_TOPN_CPU_UTILIZATION</statisticsName>
</statisticsDTO>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v2/op/pfrMonitoringExt/getAllBorderRouters/1463999256456/1465208856234/Site1.json?hierarchyPath="Location/All Locations/Site1"
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v2/op/pfrMonitoringExt/getAllBorderRouters/1463999256456/1465208856234/Site1?hierarchyPath="Location/All Locations/Site1"\n\t\t\t\t\t",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v2/op",
"statisticsDTO" : [ {
"childStatistics" : {
"childStatistic" : [ ]
},
"statisticEntries" : {
"statisticEntry" : [ {
"attributeName" : "String value",
"displayName" : "String value",
"entryValue" : "String value"
} ]
},
"statisticsName" : "DEVICE_TOPN_CPU_UTILIZATION"
} ]
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v3/op/pfrMonitoringExt/getAllBorderRouters/{startTime}/{endTime}/{siteName}
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
startTime
Long
|
path
|
Required
Specifies the start time in milli seconds to get the all border routers from.
|
endTime
Long
|
path
|
Required
Specifies the start time in milli seconds to get the all border routers to.
|
siteName
String
|
path
|
Required
Specifies the site name to get the all border routers for specified site.
|
hierarchyPath
String
|
query
|
Optional
OPTIONAL Specifies the site name to get the all border routers for specified site hierarchy.
|
Response Parameters
childStatistics
StatisticsDTO[]
|
The set of nested StatisticsDTO objects.
|
childStatistics
StatisticsDTO[]
|
The set of nested StatisticsDTO objects.
|
statisticEntry
StatisticsEntry[]
|
The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.
|
attributeName
String
|
The name of the attribute.
|
displayName
String
|
The display name of the attribute.
|
entryValue
String
|
|
|
statisticsName
StatisticsOperationTypeEnum
|
The Statistics operation type.
|
|
statisticEntry
StatisticsEntry[]
|
The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.
|
attributeName
String
|
The name of the attribute.
|
displayName
String
|
The display name of the attribute.
|
entryValue
String
|
|
|
statisticsName
StatisticsOperationTypeEnum
|
The Statistics operation type.
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Response Payload
https://localhost/webacs/api/v3/op/pfrMonitoringExt/getAllBorderRouters/1463999256456/1465208856234/Site1?hierarchyPath="Location/All Locations/Site1"
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v3/op/pfrMonitoringExt/getAllBorderRouters/1463999256456/1465208856234/Site1?hierarchyPath=&quot;Location/All Locations/Site1&quot;
" rootUrl="https://localhost/webacs/api/v3/op">
<statisticsDTO>
<childStatistics></childStatistics>
<statisticEntries>
<statisticEntry>
<attributeName>String value</attributeName>
<displayName>String value</displayName>
<entryValue>String value</entryValue>
</statisticEntry>
<statisticEntry>
<attributeName>Another string value</attributeName>
<displayName>Another string value</displayName>
<entryValue>Another string value</entryValue>
</statisticEntry>
</statisticEntries>
<statisticsName>DEVICE_TOPN_CPU_UTILIZATION</statisticsName>
</statisticsDTO>
<statisticsDTO>
<childStatistics></childStatistics>
<statisticEntries>
<statisticEntry>
<attributeName>String value</attributeName>
<displayName>String value</displayName>
<entryValue>String value</entryValue>
</statisticEntry>
<statisticEntry>
<attributeName>Another string value</attributeName>
<displayName>Another string value</displayName>
<entryValue>Another string value</entryValue>
</statisticEntry>
</statisticEntries>
<statisticsName>DEVICE_TOPN_MEMORY_UTILIZATION</statisticsName>
</statisticsDTO>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v3/op/pfrMonitoringExt/getAllBorderRouters/1463999256456/1465208856234/Site1.json?hierarchyPath="Location/All Locations/Site1"
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v3/op/pfrMonitoringExt/getAllBorderRouters/1463999256456/1465208856234/Site1?hierarchyPath="Location/All Locations/Site1"\n\t\t\t\t\t",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v3/op",
"statisticsDTO" : [ {
"childStatistics" : {
"childStatistic" : [ ]
},
"statisticEntries" : {
"statisticEntry" : [ {
"attributeName" : "String value",
"displayName" : "String value",
"entryValue" : "String value"
}, {
"attributeName" : "Another string value",
"displayName" : "Another string value",
"entryValue" : "Another string value"
} ]
},
"statisticsName" : "DEVICE_TOPN_CPU_UTILIZATION"
}, {
"childStatistics" : {
"childStatistic" : [ ]
},
"statisticEntries" : {
"statisticEntry" : [ {
"attributeName" : "String value",
"displayName" : "String value",
"entryValue" : "String value"
}, {
"attributeName" : "Another string value",
"displayName" : "Another string value",
"entryValue" : "Another string value"
} ]
},
"statisticsName" : "DEVICE_TOPN_MEMORY_UTILIZATION"
} ]
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v4/op/pfrMonitoringExt/getAllBorderRouters/{startTime}/{endTime}/{siteName}
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
startTime
Long
|
path
|
Required
Specifies the start time in milli seconds to get the all border routers from.
|
endTime
Long
|
path
|
Required
Specifies the start time in milli seconds to get the all border routers to.
|
siteName
String
|
path
|
Required
Specifies the site name to get the all border routers for specified site.
|
hierarchyPath
String
|
query
|
Optional
OPTIONAL Specifies the site name to get the all border routers for specified site hierarchy.
|
Response Parameters
childStatistics
StatisticsDTO[]
|
The set of nested StatisticsDTO objects.
|
childStatistics
StatisticsDTO[]
|
The set of nested StatisticsDTO objects.
|
statisticEntry
StatisticsEntry[]
|
The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.
|
attributeName
String
|
The name of the attribute.
|
displayName
String
|
The display name of the attribute.
|
entryValue
String
|
|
|
statisticsName
StatisticsOperationTypeEnum
|
The Statistics operation type.
|
|
statisticEntry
StatisticsEntry[]
|
The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.
|
attributeName
String
|
The name of the attribute.
|
displayName
String
|
The display name of the attribute.
|
entryValue
String
|
|
|
statisticsName
StatisticsOperationTypeEnum
|
The Statistics operation type.
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Response Payload
https://localhost/webacs/api/v4/op/pfrMonitoringExt/getAllBorderRouters/1463999256456/1465208856234/Site1?hierarchyPath="Location/All Locations/Site1"
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v4/op/pfrMonitoringExt/getAllBorderRouters/1463999256456/1465208856234/Site1?hierarchyPath=&quot;Location/All Locations/Site1&quot;
" rootUrl="https://localhost/webacs/api/v4/op">
<statisticsDTO>
<childStatistics></childStatistics>
<statisticEntries>
<statisticEntry>
<attributeName>String value</attributeName>
<displayName>String value</displayName>
<entryValue>String value</entryValue>
</statisticEntry>
<statisticEntry>
<attributeName>Another string value</attributeName>
<displayName>Another string value</displayName>
<entryValue>Another string value</entryValue>
</statisticEntry>
</statisticEntries>
<statisticsName>DEVICE_TOPN_CPU_UTILIZATION</statisticsName>
</statisticsDTO>
<statisticsDTO>
<childStatistics></childStatistics>
<statisticEntries>
<statisticEntry>
<attributeName>String value</attributeName>
<displayName>String value</displayName>
<entryValue>String value</entryValue>
</statisticEntry>
<statisticEntry>
<attributeName>Another string value</attributeName>
<displayName>Another string value</displayName>
<entryValue>Another string value</entryValue>
</statisticEntry>
</statisticEntries>
<statisticsName>DEVICE_TOPN_MEMORY_UTILIZATION</statisticsName>
</statisticsDTO>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v4/op/pfrMonitoringExt/getAllBorderRouters/1463999256456/1465208856234/Site1.json?hierarchyPath="Location/All Locations/Site1"
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v4/op/pfrMonitoringExt/getAllBorderRouters/1463999256456/1465208856234/Site1?hierarchyPath="Location/All Locations/Site1"\n\t\t\t\t\t",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v4/op",
"statisticsDTO" : [ {
"childStatistics" : {
"childStatistic" : [ ]
},
"statisticEntries" : {
"statisticEntry" : [ {
"attributeName" : "String value",
"displayName" : "String value",
"entryValue" : "String value"
}, {
"attributeName" : "Another string value",
"displayName" : "Another string value",
"entryValue" : "Another string value"
} ]
},
"statisticsName" : "DEVICE_TOPN_CPU_UTILIZATION"
}, {
"childStatistics" : {
"childStatistic" : [ ]
},
"statisticEntries" : {
"statisticEntry" : [ {
"attributeName" : "String value",
"displayName" : "String value",
"entryValue" : "String value"
}, {
"attributeName" : "Another string value",
"displayName" : "Another string value",
"entryValue" : "Another string value"
} ]
},
"statisticsName" : "DEVICE_TOPN_MEMORY_UTILIZATION"
} ]
}
}