Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

PUT groups/group

Create or update a device or port group. Only 'Location' and 'User Defined' Device groups and 'User Defined' port groups are supported. You cannot modify the system defined groups except 'Location/All Locations/System Campus' for which you can change only description and geographical location.

Since Product Version: 3.0

Resource Information

Rate Limiting?

Yes

Sorting?

No

Paging?

No

Filtering?

No

Aggregation?

No

Response Formats

xml

json

User Group

NBI Write

HTTP Methods

PUT

DevNet Discussions

Resource URL

/webacs/api/v1/op/groups/group

Request Parameters

Attribute Source Description

groupId Long

query

OptionalID of the group to update, if given. If not, new group will be created.

Request Payload Parameters

Attribute Description

description String

Description of a group (human-readable). Optional. Max length of the description is 255 characters.

name String

Name of a group. Required.

path String

Path to the group (slash-separated, e.g. "group/subgroup/sub_subgroup") relative to the 'User Defined' or 'Location/All Locations' group.

type GroupTypeEnum

Type of a group. Required.

Allowed values:

  • LOCATION
  • USERDEFINED
  • INTERFACEGROUP

Response Parameters

Attribute Description

action String

"CREATED" or "UPDATED". Action permitted by operation.

groupId long

Group ID of updated or created 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 Request Payload

https://localhost/webacs/api/v1/op/groups/group

<?xml version="1.0" ?>
<groupPropertiesDTO>
  <description>String value</description>
  <name>String value</name>
  <path>String value</path>
  <type>LOCATION</type>
</groupPropertiesDTO>

Sample JSON Request Payload

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

{
  "groupPropertiesDTO" : {
    "description" : "String value",
    "name" : "String value",
    "path" : "String value",
    "type" : "LOCATION"
  }
}

Sample XML Response Payload

https://localhost/webacs/api/v1/op/groups/group

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v1/op/groups/group" rootUrl="https://localhost/webacs/api/v1/op">
  <groupUpdateResult>
    <action>String value</action>
    <groupId>2</groupId>
  </groupUpdateResult>
</mgmtResponse>

Sample JSON Response Payload

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

{
  "mgmtResponse" : {
    "@responseType" : "operation",
    "@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op\/groups\/group",
    "@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op",
    "groupUpdateResult" : {
      "action" : "String value",
      "groupId" : 2
    }
  }
}