Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

PUT groups/groupDevices

Statically assign list of devices to a group (devices are listed by device IDs or IP addresses). Only Location and User Defined device groups are supported.

Since Product Version: 3.0

Resource Information

Rate Limiting?

Yes

Sorting?

No

Paging?

No

Filtering?

No

Group Filtering?

No

Aggregation?

No

Response Formats

xml

json

User Group

NBI Write

HTTP Methods

PUT

DevNet Discussions

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/groupDevices

Request Parameters

Attribute Source Description

groupId Long

query

RequiredId of the group. Either groupId or groupPath must be specified.

groupPath String

query

RequiredFull path and name of the group. Either groupId or groupPath must be specified.

Request Payload Parameters

Attribute Description

deviceIds Long[]

List of device IDs

deviceIps String[]

List of device IP addresses

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 Request Payload

https://localhost/webacs/api/v1/op/groups/groupDevices?groupPath=Location/All Locations/groupName

<?xml version="1.0" ?>
<groupDevicesDTO>
  <deviceIds>
    <deviceId>15</deviceId>
  </deviceIds>
  <deviceIps>
    <deviceIp>String value</deviceIp>
  </deviceIps>
</groupDevicesDTO>

Sample JSON Request Payload

https://localhost/webacs/api/v1/op/groups/groupDevices.json?groupPath=Location/All Locations/groupName

{
  "groupDevicesDTO" : {
    "deviceIds" : {
      "deviceId" : 15
    },
    "deviceIps" : {
      "deviceIp" : "String value"
    }
  }
}