Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

PUT apService/accessPoint

Modifies an Unified Access Point's name, location, controller affinity, or admin status. All parameters should be provided. If some parameter isn't specified it will be considered as an empty value.

Since Product Version: 2.2

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

Resource URL

/webacs/api/v3/op/apService/accessPoint

Updated

Since API v3, this resource allows for changes only to provided parameters (for example, only the name, only the location, only the admin status, only the controller affinity or any combination of them). If a parameter is not specified then it will not be updated. This is a change from the previous behavior, which required that all parameters be specified.

Request Payload Parameters

Attribute Description

accessPointId long

ID used to identify the access point. Required.

adminStatus Boolean

Administrative status of the access point.

location String

User specified location of the access point. While configuring AP, user should specify a location for the AP so that its easy to figure out for some one where the AP is located.

name String

Name of the access point. Can not be empty or contain spaces.

primaryMwar UnifiedApControllerAffinityDTO

Primary controller this access point has affinity to, which is supposed to be the Primary MWAR(switch) of the AP with which AP should associate.

secondaryMwar UnifiedApControllerAffinityDTO

Secondary controller this access point has affinity to, which is supposed to be the Secondary MWAR(switch) of the AP with which AP should associate.

tertiaryMwar UnifiedApControllerAffinityDTO

Tertiary controller this access point has affinity to, which is supposed to be the Tertiary MWAR(switch) of the AP with which AP should associate.

Response Parameters

Attribute Description

jobName String

The unique job name for this job.

jobType String

The non-unique job type for this job.

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/v3/op/apService/accessPoint

<?xml version="1.0" ?>
<unifiedApDetailsDTO>
  <accessPointId>2</accessPointId>
  <adminStatus>true</adminStatus>
  <location>String value</location>
  <name>String value</name>
  <primaryMwar>
    <ipAddress>
      <address>192.168.115.243</address>
    </ipAddress>
    <sysName>String value</sysName>
  </primaryMwar>
  <secondaryMwar>
    <ipAddress>
      <address>192.168.115.243</address>
    </ipAddress>
    <sysName>String value</sysName>
  </secondaryMwar>
  <tertiaryMwar>
    <ipAddress>
      <address>192.168.115.243</address>
    </ipAddress>
    <sysName>String value</sysName>
  </tertiaryMwar>
</unifiedApDetailsDTO>

Sample JSON Request Payload

https://localhost/webacs/api/v3/op/apService/accessPoint.json

{
  "unifiedApDetailsDTO" : {
    "accessPointId" : 2,
    "adminStatus" : true,
    "location" : "String value",
    "name" : "String value",
    "primaryMwar" : {
      "ipAddress" : {
        "address" : "192.168.115.243"
      },
      "sysName" : "String value"
    },
    "secondaryMwar" : {
      "ipAddress" : {
        "address" : "192.168.115.243"
      },
      "sysName" : "String value"
    },
    "tertiaryMwar" : {
      "ipAddress" : {
        "address" : "192.168.115.243"
      },
      "sysName" : "String value"
    }
  }
}

Sample XML Response Payload

https://localhost/webacs/api/v3/op/apService/accessPoint

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v3/op/apService/accessPoint" rootUrl="https://localhost/webacs/api/v3/op">
  <apJobInfo>
    <jobName>String value</jobName>
    <jobType>String value</jobType>
  </apJobInfo>
</mgmtResponse>

Sample JSON Response Payload

https://localhost/webacs/api/v3/op/apService/accessPoint.json

{
  "mgmtResponse" : {
    "@requestUrl" : "https://localhost/webacs/api/v3/op/apService/accessPoint",
    "@responseType" : "operation",
    "@rootUrl" : "https://localhost/webacs/api/v3/op",
    "apJobInfo" : [ {
      "jobName" : "String value",
      "jobType" : "String value"
    } ]
  }
}