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

GET groups/deviceGroups

Returns list of Device Type groups, including the count of alarms of each severity for each group. Note that the API can be slow when you have large amount of groups, alarms, and devices. Use noAlarms and noMembersCount parameters to improve the performance of this API resource.

Since Product Version: 2.0

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

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/groups/deviceGroups

Request Parameters

Attribute Source Description

noAlarms Boolean

query

Optional

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

noMembersCount Boolean

query

Optional

If true, the members count won't be calculated and returned. Use the parameter to improve the performance of the API resource. Must be passed along with noAlarms=true.

Response Parameters

Attribute Description

clearedAlarms Integer

Total number of cleared alarms against members of the group.

criticalAlarms Integer

Total number of critical alarms against members of the group.

description String

The description of this group.

groupId long

The internal id of this group.

groupName String

The instance name of this group.

groupType GroupAppTypeEnum

Type of group defined by the application.

  • NETWORK_DEVICE
  • PORT

informationAlarms Integer

Total number of information alarms against members of the group.

isExplicit boolean

Indicates if a group is an explicit member of your active virtual domain. If 'false', you will not be allowed to modify this group.

majorAlarms Integer

Total number of major alarms against members of the group.

membersCount Integer

Number of members statically or dynamically added to a group. Includes member counts of child groups for Device groups. Does not include member counts of child groups for User Defined groups. The members could be: ports (only for Port groups), non-AP devices, Autonomous, Unified and Thirdparty APs.

minorAlarms Integer

Total number of minor alarms against members of the group.

name String

The hierarchical name of the group.

unacknowledgedClearedAlarms Integer

Number of unacknowledged cleared alarms against members of the group.

unacknowledgedCriticalAlarms Integer

Number of unacknowledged critical alarms against members of the group.

unacknowledgedInformationAlarms Integer

Number of unacknowledged information alarms against members of the group.

unacknowledgedMajorAlarms Integer

Number of unacknowledged major alarms against members of the group.

unacknowledgedMinorAlarms Integer

Number of unacknowledged minor alarms against members of the group.

unacknowledgedWarningAlarms Integer

Number of unacknowledged warning alarms against members of the group.

warningAlarms Integer

Total 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://10.56.58.149/webacs/api/v1/op/groups/deviceGroups

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://10.56.58.149/webacs/api/v1/op/groups/deviceGroups" rootUrl="https://10.56.58.149/webacs/api/v1/op">
  <grpDTO>
    <clearedAlarms>15</clearedAlarms>
    <criticalAlarms>15</criticalAlarms>
    <description>String value</description>
    <groupId>2</groupId>
    <groupName>String value</groupName>
    <groupType>NETWORK_DEVICE</groupType>
    <informationAlarms>15</informationAlarms>
    <isExplicit>true</isExplicit>
    <majorAlarms>15</majorAlarms>
    <membersCount>15</membersCount>
    <minorAlarms>15</minorAlarms>
    <name>String value</name>
    <unacknowledgedClearedAlarms>15</unacknowledgedClearedAlarms>
    <unacknowledgedCriticalAlarms>15</unacknowledgedCriticalAlarms>
    <unacknowledgedInformationAlarms>15</unacknowledgedInformationAlarms>
    <unacknowledgedMajorAlarms>15</unacknowledgedMajorAlarms>
    <unacknowledgedMinorAlarms>15</unacknowledgedMinorAlarms>
    <unacknowledgedWarningAlarms>15</unacknowledgedWarningAlarms>
    <warningAlarms>15</warningAlarms>
  </grpDTO>
  <grpDTO>
    <clearedAlarms>25</clearedAlarms>
    <criticalAlarms>25</criticalAlarms>
    <description>Another string value</description>
    <groupId>12</groupId>
    <groupName>Another string value</groupName>
    <groupType>PORT</groupType>
    <informationAlarms>25</informationAlarms>
    <isExplicit>false</isExplicit>
    <majorAlarms>25</majorAlarms>
    <membersCount>25</membersCount>
    <minorAlarms>25</minorAlarms>
    <name>Another string value</name>
    <unacknowledgedClearedAlarms>25</unacknowledgedClearedAlarms>
    <unacknowledgedCriticalAlarms>25</unacknowledgedCriticalAlarms>
    <unacknowledgedInformationAlarms>25</unacknowledgedInformationAlarms>
    <unacknowledgedMajorAlarms>25</unacknowledgedMajorAlarms>
    <unacknowledgedMinorAlarms>25</unacknowledgedMinorAlarms>
    <unacknowledgedWarningAlarms>25</unacknowledgedWarningAlarms>
    <warningAlarms>25</warningAlarms>
  </grpDTO>
</mgmtResponse>

Sample JSON Response Payload

https://10.56.58.149/webacs/api/v1/op/groups/deviceGroups.json

{
  "mgmtResponse" : {
    "@responseType" : "operation",
    "@requestUrl" : "https : \/\/10.56.58.149\/webacs\/api\/v1\/op\/groups\/deviceGroups",
    "@rootUrl" : "https : \/\/10.56.58.149\/webacs\/api\/v1\/op",
    "grpDTO" : [{
      "clearedAlarms" : 15,
      "criticalAlarms" : 15,
      "description" : "String value",
      "groupId" : 2,
      "groupName" : "String value",
      "groupType" : "NETWORK_DEVICE",
      "informationAlarms" : 15,
      "isExplicit" : true,
      "majorAlarms" : 15,
      "membersCount" : 15,
      "minorAlarms" : 15,
      "name" : "String value",
      "unacknowledgedClearedAlarms" : 15,
      "unacknowledgedCriticalAlarms" : 15,
      "unacknowledgedInformationAlarms" : 15,
      "unacknowledgedMajorAlarms" : 15,
      "unacknowledgedMinorAlarms" : 15,
      "unacknowledgedWarningAlarms" : 15,
      "warningAlarms" : 15
    },
    {
      "clearedAlarms" : 25,
      "criticalAlarms" : 25,
      "description" : "Another string value",
      "groupId" : 12,
      "groupName" : "Another string value",
      "groupType" : "PORT",
      "informationAlarms" : 25,
      "isExplicit" : false,
      "majorAlarms" : 25,
      "membersCount" : 25,
      "minorAlarms" : 25,
      "name" : "Another string value",
      "unacknowledgedClearedAlarms" : 25,
      "unacknowledgedCriticalAlarms" : 25,
      "unacknowledgedInformationAlarms" : 25,
      "unacknowledgedMajorAlarms" : 25,
      "unacknowledgedMinorAlarms" : 25,
      "unacknowledgedWarningAlarms" : 25,
      "warningAlarms" : 25
    }]
  }
}