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

PUT apService/accessPoint

Modifies an Unified Access Point. For API versions 1 and 2, all parameters should be specified. For API version 3, only the parameters desired to be changed and the ID need to be specified.

Since Product Version: 2.2

Resource Information

Rate Limiting?

No

Sorting?

No

Paging?

No

Filtering?

No

Group Filtering?

No

Aggregation?

No

Response Formats

xml

json

User Group

NBI Write

HTTP Methods

PUT

Resource URL

/webacs/api/v4/op/apService/accessPoint

Unmodified

This resource has not been modified since the previous API version.

Request Payload Parameters

Attribute Description

accessPointId long

Required

ID used to identify the unified access point.

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 Arrow image 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 Arrow image 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 Arrow image 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://10.64.88.203/webacs/api/v4/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://10.64.88.203/webacs/api/v4/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://10.64.88.203/webacs/api/v4/op/apService/accessPoint

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../../pages/common/login.jsp.html" rootUrl="https://10.64.88.203/webacs/api/v4/op">
  <apJobInfo>
    <jobName>String value</jobName>
    <jobType>String value</jobType>
  </apJobInfo>
</mgmtResponse>

Sample JSON Response Payload

https://10.64.88.203/webacs/api/v4/op/apService/accessPoint.json

{
  "mgmtResponse" : {
    "@requestUrl" : "../../../../../pages/common/login.jsp.html",
    "@responseType" : "operation",
    "@rootUrl" : "https://10.64.88.203/webacs/api/v4/op",
    "apJobInfo" : [ {
      "jobName" : "String value",
      "jobType" : "String value"
    } ]
  }
}