Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

GET groups/userDefinedGroups

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.

This operation returns groups explicitly or implicitly assigned to your active virtual domain. Explicit groups have been created or later added to your active virtual domain (or were a child group of a group added to your active virtual domain). Implicit groups are groups with a close relation to an explicit group, for example, parents of explicit groups.

Note that Port Groups do not support virtual domain based filtering. You will be allowed to modify a Port group, even if it is implicitly assigned to your active virtual domain.

Since Product Version: 2.0

Resource Information

Rate Limiting?

Yes

Sorting?

No

Paging?

No

Filtering?

No

Aggregation?

No

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

DevNet Discussions

Resource URL

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

Request Parameters

Attribute Source Description

groupType String

query

OptionalAn 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.

noAlarms Boolean

query

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

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.

Allowed values:

  • 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 int

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://localhost/webacs/api/v1/op/groups/userDefinedGroups

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v1/op/groups/userDefinedGroups" rootUrl="https://localhost/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>1</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>
</mgmtResponse>

Sample JSON Response Payload

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

{
  "mgmtResponse" : {
    "@responseType" : "operation",
    "@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op\/groups\/userDefinedGroups",
    "@rootUrl" : "https : \/\/localhost\/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" : 1,
      "minorAlarms" : 15,
      "name" : "String value",
      "unacknowledgedClearedAlarms" : 15,
      "unacknowledgedCriticalAlarms" : 15,
      "unacknowledgedInformationAlarms" : 15,
      "unacknowledgedMajorAlarms" : 15,
      "unacknowledgedMinorAlarms" : 15,
      "unacknowledgedWarningAlarms" : 15,
      "warningAlarms" : 15
    }
  }
}