Since Product Version: 1.2
-
Jump To
- AAA/TACACS+ Servers Operations Service (4)
- AP Onboarding Profile Management Service (4)
- API Health Service (6)
- Access Point Operations (4)
- Alarms Management Service (5)
- Application Visibility and Control Service (1)
- BNG IP Pool Statistics (3)
- BNG Sessions Statistics (3)
- CEM Statistics (3)
- CLI Template Configuration (12)
- Circuit Statistics (4)
- Clients (7)
- Configuration Archive Service (7)
- Credential Profile Management Service (5)
- Credentials Service (1)
- Device Details (9)
- Device Operations (9)
- Device Sensors Statistics (3)
- Group Management Service (8)
- Group Summary Service (8)
- Guest User Management Service (8)
- IPSLA (ICMP JITTER) Statistics (3)
- IPSLA Y1731 Statistics (3)
- Interface CRC Errors Statistics (3)
- Job Operations (6)
- Link Statistics (3)
- MAC Filters Management Service (5)
- Manage and Monitor Info Service (5)
- Managed Servers Operations (6)
- Me1200 Quality of Service Statistics (3)
- Network Topology Layout (2)
- Optical Ethernet Statistics (3)
- Optical OTN Data Statistics (3)
- Optical Physical Statistics (3)
- Optical SFP Statistics (3)
- Optical Sonet SDH Statistics (3)
- PTP Clock Statistics (3)
- PTP and SyncE settings (5)
- Plug and Play (7)
- Quality of Service Statistics (3)
- Rate Limits Management Service (2)
- Report Service (5)
- Site Map Service (3)
- Software Updates (2)
- Statistics (91)
- SyncE Statistics (3)
- System Settings (26)
- TDM and Sonet Port Statistics (3)
- Trap Receivers (4)
- User Defined Field Management (3)
- User Management Service (5)
- VNF Provisioning (16)
- Virtual Domains Management Service (10)
- Virtual Image Repository (8)
- WLAN Provisioning (16)
- Wireless Device Details (22)
- Y1731 Bins Statistics (3)
- v1
- v2
- v3
- v4
Resource Information
Rate Limiting? |
No |
Sorting? |
No |
Paging? |
No |
Filtering? |
No |
Group Filtering? |
No |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Read |
HTTP Methods |
GET |
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/statisticsService/device/portSummaryRequest Parameters
Attribute | Source | Description |
---|---|---|
ipAddress String |
query |
Required The IP Address of the device. |
type String |
query |
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
Attribute | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
The set of nested StatisticsDTO objects. |
|||||||||||||||||||||
|
|||||||||||||||||||||
The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics. |
|||||||||||||||||||||
|
|||||||||||||||||||||
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://172.20.127.108/webacs/api/v1/op/statisticsService/device/portSummary?ipAddress=192.168.0.1
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://172.20.127.108/webacs/api/v1/op/statisticsService/device/portSummary?ipAddress=192.168.0.1" rootUrl="https://172.20.127.108/webacs/api/v1/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>
</mgmtResponse>
Sample JSON Response Payload
https://172.20.127.108/webacs/api/v1/op/statisticsService/device/portSummary.json?ipAddress=192.168.0.1
{
"mgmtResponse" : {
"@responseType" : "operation",
"@requestUrl" : "https : \/\/172.20.127.108\/webacs\/api\/v1\/op\/statisticsService\/device\/portSummary?ipAddress=192.168.0.1",
"@rootUrl" : "https : \/\/172.20.127.108\/webacs\/api\/v1\/op",
"statisticsDTO" : {
"childStatistics" : "",
"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"
}
}
}
Resource Information
Rate Limiting? |
No |
Sorting? |
No |
Paging? |
No |
Filtering? |
No |
Group Filtering? |
No |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Read |
HTTP Methods |
GET |
Resource URL
/webacs/api/v2/op/statisticsService/device/portSummaryUnmodified
This resource has not been modified since the previous API version.
Request Parameters
Attribute | Source | Description |
---|---|---|
ipAddress String |
query |
Required The IP Address of the device. |
type String |
query |
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
Attribute | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
The set of nested StatisticsDTO objects. |
|||||||||||||||||||||
|
|||||||||||||||||||||
The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics. |
|||||||||||||||||||||
|
|||||||||||||||||||||
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://172.20.127.108/webacs/api/v2/op/statisticsService/device/portSummary?ipAddress=192.168.0.1
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://172.20.127.108/webacs/api/v2/op/statisticsService/device/portSummary?ipAddress=192.168.0.1" rootUrl="https://172.20.127.108/webacs/api/v2/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>
</mgmtResponse>
Sample JSON Response Payload
https://172.20.127.108/webacs/api/v2/op/statisticsService/device/portSummary.json?ipAddress=192.168.0.1
{
"mgmtResponse" : {
"@requestUrl" : "https://172.20.127.108/webacs/api/v2/op/statisticsService/device/portSummary?ipAddress=192.168.0.1",
"@responseType" : "operation",
"@rootUrl" : "https://172.20.127.108/webacs/api/v2/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"
} ]
}
}
Resource Information
Rate Limiting? |
No |
Sorting? |
No |
Paging? |
No |
Filtering? |
No |
Group Filtering? |
No |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Read |
HTTP Methods |
GET |
Resource URL
/webacs/api/v3/op/statisticsService/device/portSummaryUnmodified
This resource has not been modified since the previous API version.
Request Parameters
Attribute | Source | Description |
---|---|---|
ipAddress String |
query |
Required The IP Address of the device. |
type String |
query |
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
Attribute | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
The set of nested StatisticsDTO objects. |
|||||||||||||||||||||
|
|||||||||||||||||||||
The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics. |
|||||||||||||||||||||
|
|||||||||||||||||||||
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://172.20.127.108/webacs/api/v3/op/statisticsService/device/portSummary?ipAddress=192.168.0.1
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://172.20.127.108/webacs/api/v3/op/statisticsService/device/portSummary?ipAddress=192.168.0.1" rootUrl="https://172.20.127.108/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>
</mgmtResponse>
Sample JSON Response Payload
https://172.20.127.108/webacs/api/v3/op/statisticsService/device/portSummary.json?ipAddress=192.168.0.1
{
"mgmtResponse" : {
"@requestUrl" : "https://172.20.127.108/webacs/api/v3/op/statisticsService/device/portSummary?ipAddress=192.168.0.1",
"@responseType" : "operation",
"@rootUrl" : "https://172.20.127.108/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"
} ]
}
}
Resource Information
Rate Limiting? |
No |
Sorting? |
No |
Paging? |
No |
Filtering? |
No |
Group Filtering? |
No |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Read |
HTTP Methods |
GET |
Resource URL
/webacs/api/v4/op/statisticsService/device/portSummaryUnmodified
This resource has not been modified since the previous API version.
Request Parameters
Attribute | Source | Description |
---|---|---|
ipAddress String |
query |
Required The IP Address of the device. |
type String |
query |
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
Attribute | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
The set of nested StatisticsDTO objects. |
|||||||||||||||||||||
|
|||||||||||||||||||||
The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics. |
|||||||||||||||||||||
|
|||||||||||||||||||||
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://172.20.127.108/webacs/api/v4/op/statisticsService/device/portSummary?ipAddress=192.168.0.1
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://172.20.127.108/webacs/api/v4/op/statisticsService/device/portSummary?ipAddress=192.168.0.1" rootUrl="https://172.20.127.108/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>
</mgmtResponse>
Sample JSON Response Payload
https://172.20.127.108/webacs/api/v4/op/statisticsService/device/portSummary.json?ipAddress=192.168.0.1
{
"mgmtResponse" : {
"@requestUrl" : "https://172.20.127.108/webacs/api/v4/op/statisticsService/device/portSummary?ipAddress=192.168.0.1",
"@responseType" : "operation",
"@rootUrl" : "https://172.20.127.108/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"
} ]
}
}