Cisco Evolved Programmable Network Manager API
Evolved Programmable Network Manager API Documentation

GET groups/userDefinedGroups

Resource Information

Rate Limiting?

Yes

Sorting?

No

Paging?

No

Filtering?

No

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

Returns list of User Defined groups for both Network Device Groups and Port Groups, including the count of alarms of each severity for each group.

Since Product Version: 2.0

Resource URL

/webacs/api/v1/op/groups/userDefinedGroups

Request Parameters

Type Attribute Name Source Description

String

groupType optional

query

An filter parameter with possible values: NETWORK_DEVICE (to return Network Device user defined groups), or PORT (to return Port user defined groups). By default, if this parameter not provided, it returns both Network Device groups and Port groups.

Boolean

noAlarms optional

query

If true, the alarms summary data won't be calculated and returned

Response Parameters

Type Attribute Name Description

Integer

clearedAlarms

Number of cleared alarms against members of the group.

Integer

criticalAlarms

Number of critical alarms against members of the group.

long

groupId

The internal id of this group.

String

groupName

The instance name of this group.

GroupAppTypeEnum

groupType

Type of group defined by the application.

Allowed values:

  • NETWORK_DEVICE
  • PORT

Integer

informationAlarms

Number of information alarms against members of the group.

Integer

majorAlarms

Number of major alarms against members of the group.

Integer

minorAlarms

Number of minor alarms against members of the group.

String

name

The hierarchical name of the group.

Integer

warningAlarms

Number of warning alarms against members of the group.

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.25.123.114/webacs/api/v1/op/groups/userDefinedGroups

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../pages/common/login.jsp.html" rootUrl="https://172.25.123.114/webacs/api/v1/op/">
  <grpDTO>
    <clearedAlarms>15</clearedAlarms>
    <criticalAlarms>15</criticalAlarms>
    <groupId>2</groupId>
    <groupName>String value</groupName>
    <groupType>NETWORK_DEVICE</groupType>
    <informationAlarms>15</informationAlarms>
    <majorAlarms>15</majorAlarms>
    <minorAlarms>15</minorAlarms>
    <name>String value</name>
    <warningAlarms>15</warningAlarms>
  </grpDTO>
</mgmtResponse>

Sample JSON Response Payload

https://172.25.123.114/webacs/api/v1/op/groups/userDefinedGroups.json

{
  "mgmtResponse" : {
    "@responseType" : "operation",
    "@requestUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/groups\/userDefinedGroups",
    "@rootUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/",
    "grpDTO" : {
      "clearedAlarms" : 15,
      "criticalAlarms" : 15,
      "groupId" : 2,
      "groupName" : "String value",
      "groupType" : "NETWORK_DEVICE",
      "informationAlarms" : 15,
      "majorAlarms" : 15,
      "minorAlarms" : 15,
      "name" : "String value",
      "warningAlarms" : 15
    }
  }
}