Retrieves the device port summary.
Resource URL
/webacs/api/v1/op/statisticsService/device/portSummary
Since : 1.2
Request Parameters
String
|
ipAddress
required
|
The IP Address of the device.
|
String
|
type
optional
|
An filter parameter with possible values: SUMMARY (to return a summary of count of ports that are Up, Administratively down or Operationally down), or ALARMSEVERITY (to return the minimum Alarm severity of all the down ports). By default, if this parameter not provided, it returns the status summary of the ports.
|
Response Parameters
StatisticsDTO[]
|
childStatistics
|
The set of nested StatisticsDTO objects.
|
StatisticsDTO[]
|
childStatistics
|
The set of nested StatisticsDTO objects.
|
StatisticsEntry[]
|
statisticEntry
|
The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.
|
String
|
attributeName
|
The name of the attribute.
|
String
|
displayName
|
The display name of the attribute.
|
String
|
entryValue
|
|
|
StatisticsOperationTypeEnum
|
statisticsName
|
The Statistics operation type.
Allowed values:
DEVICE_TOPN_CPU_UTILIZATION
DEVICE_TOPN_MEMORY_UTILIZATION
DEVICE_TOPN_TEMPERATURE
DEVICE_AVAILABILITY
DEVICE_AVAILABILITY_SUMMARY
DEVICE_CPU_UTILIZATION_TREND
DEVICE_MEMORY_UTILIZATION_TREND
DEVICE_HEALTH_INFO
DEVICE_REACHABILITY_STATUS
DEVICE_PORT_SUMMARY
DEVICE_AVAILABILITY_MESSAGE
DEVICE_DOWN_MESSAGE
DEVICE_CPU_UTILIZATION_SUMMARY
INTERFACE_AVAILABILITY
INTERFACE_DETAILS
INTERFACE_OUT_ERRORS
INTERFACE_DISCARDS
INTERFACE_UTILIZATION
INTERFACE_TOPN_UTILIZATION
INTERFACE_TOPN_ERRORS
INTERFACE_TOPN_WAN_UTILIZATION
INTERFACE_UTILIZATION_SUMMARY
INTERFACE_AVAILABILITY_SUMMARY
INTERFACE_STATUS_SUMMARY
INTERFACE_AVAILABILITY_MESSAGE
INTERFACE_DOWN_MESSAGE
INTERFACE_TOPN_WAN_ISSUES
INTERFACE_CLASSMAP_QOS
APPLICATION_TOPN_WORST_HOSTS
APPLICATION_TOPN_WORST_SITES
APPLICATION_TOPN_HOSTS
APPLICATION_TOPN_APP_PERFORMANCE
APPLICATION_TOPN_TRAFFIC_ANALYSIS
APPLICATION_NUMBER_OF_USERS
SYSTEM_INFO
SYSTEM_HEALTH
|
|
StatisticsEntry[]
|
statisticEntry
|
The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.
|
String
|
attributeName
|
The name of the attribute.
|
String
|
displayName
|
The display name of the attribute.
|
String
|
entryValue
|
|
|
StatisticsOperationTypeEnum
|
statisticsName
|
The Statistics operation type.
Allowed values:
DEVICE_TOPN_CPU_UTILIZATION
DEVICE_TOPN_MEMORY_UTILIZATION
DEVICE_TOPN_TEMPERATURE
DEVICE_AVAILABILITY
DEVICE_AVAILABILITY_SUMMARY
DEVICE_CPU_UTILIZATION_TREND
DEVICE_MEMORY_UTILIZATION_TREND
DEVICE_HEALTH_INFO
DEVICE_REACHABILITY_STATUS
DEVICE_PORT_SUMMARY
DEVICE_AVAILABILITY_MESSAGE
DEVICE_DOWN_MESSAGE
DEVICE_CPU_UTILIZATION_SUMMARY
INTERFACE_AVAILABILITY
INTERFACE_DETAILS
INTERFACE_OUT_ERRORS
INTERFACE_DISCARDS
INTERFACE_UTILIZATION
INTERFACE_TOPN_UTILIZATION
INTERFACE_TOPN_ERRORS
INTERFACE_TOPN_WAN_UTILIZATION
INTERFACE_UTILIZATION_SUMMARY
INTERFACE_AVAILABILITY_SUMMARY
INTERFACE_STATUS_SUMMARY
INTERFACE_AVAILABILITY_MESSAGE
INTERFACE_DOWN_MESSAGE
INTERFACE_TOPN_WAN_ISSUES
INTERFACE_CLASSMAP_QOS
APPLICATION_TOPN_WORST_HOSTS
APPLICATION_TOPN_WORST_SITES
APPLICATION_TOPN_HOSTS
APPLICATION_TOPN_APP_PERFORMANCE
APPLICATION_TOPN_TRAFFIC_ANALYSIS
APPLICATION_NUMBER_OF_USERS
SYSTEM_INFO
SYSTEM_HEALTH
|
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://192.168.116.207/webacs/api/v1/op/statisticsService/device/portSummary?ipAddress="192.168.0.1"
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<mgmtResponse rootUrl="https://192.168.116.207/webacs/api/v1/op/statisticsService/device/statisticsService/device/portSummary" requestUrl="https://192.168.116.207/webacs/api/v1/op/statisticsService/device/portSummary?ipAddress="192.168.0.1"" responseType="operation">
<statisticsDTO>
<childStatistics>
<childStatistic>
<childStatistics>
<childStatistic>
<childStatistics>
<childStatistic>
<childStatistics>
<childStatistic>
<statisticEntries>
<statisticEntry>
<attributeName>String value</attributeName>
<displayName>String value</displayName>
<entryValue>String value</entryValue>
</statisticEntry>
</statisticEntries>
<statisticsName>DEVICE_TOPN_CPU_UTILIZATION</statisticsName>
</childStatistic>
</childStatistics>
<statisticEntries>
<statisticEntry>
<attributeName>String value</attributeName>
<displayName>String value</displayName>
<entryValue>String value</entryValue>
</statisticEntry>
</statisticEntries>
<statisticsName>DEVICE_TOPN_CPU_UTILIZATION</statisticsName>
</childStatistic>
</childStatistics>
<statisticEntries>
<statisticEntry>
<attributeName>String value</attributeName>
<displayName>String value</displayName>
<entryValue>String value</entryValue>
</statisticEntry>
</statisticEntries>
<statisticsName>DEVICE_TOPN_CPU_UTILIZATION</statisticsName>
</childStatistic>
</childStatistics>
<statisticEntries>
<statisticEntry>
<attributeName>String value</attributeName>
<displayName>String value</displayName>
<entryValue>String value</entryValue>
</statisticEntry>
</statisticEntries>
<statisticsName>DEVICE_TOPN_CPU_UTILIZATION</statisticsName>
</childStatistic>
</childStatistics>
<statisticsName>DEVICE_TOPN_CPU_UTILIZATION</statisticsName>
</statisticsDTO>
</mgmtResponse>
Sample JSON Response Payload
https://192.168.116.207/webacs/api/v1/op/statisticsService/device/portSummary?ipAddress="192.168.0.1".json
{
"mgmtResponse" : {
"@rootUrl" : "https : \/\/192.168.116.207\/webacs\/api\/v1\/op\/statisticsService\/device\/statisticsService\/device\/portSummary",
"@requestUrl" : "https : \/\/192.168.116.207\/webacs\/api\/v1\/op\/statisticsService\/device\/portSummary?ipAddress=\"192.168.0.1\"",
"@responseType" : "operation",
"statisticsDTO" : {
"childStatistics" : {
"childStatistic" : {
"childStatistics" : {
"childStatistic" : {
"childStatistics" : {
"childStatistic" : {
"childStatistics" : {
"childStatistic" : {
"statisticEntries" : {
"statisticEntry" : {
"attributeName" : "String value",
"displayName" : "String value",
"entryValue" : "String value"
}
},
"statisticsName" : "DEVICE_TOPN_CPU_UTILIZATION"
}
},
"statisticEntries" : {
"statisticEntry" : {
"attributeName" : "String value",
"displayName" : "String value",
"entryValue" : "String value"
}
},
"statisticsName" : "DEVICE_TOPN_CPU_UTILIZATION"
}
},
"statisticEntries" : {
"statisticEntry" : {
"attributeName" : "String value",
"displayName" : "String value",
"entryValue" : "String value"
}
},
"statisticsName" : "DEVICE_TOPN_CPU_UTILIZATION"
}
},
"statisticEntries" : {
"statisticEntry" : {
"attributeName" : "String value",
"displayName" : "String value",
"entryValue" : "String value"
}
},
"statisticsName" : "DEVICE_TOPN_CPU_UTILIZATION"
}
},
"statisticsName" : "DEVICE_TOPN_CPU_UTILIZATION"
}
}
}