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
-
Jump To
- AAA/TACACS+ Servers Operations Service (4)
- AP Onboarding Profile Management Service (4)
- API Health Service (6)
- Access Point Operations (4)
- Alarms Management Service (5)
- Application Visibility and Control Service (1)
- BNG IP Pool Statistics (3)
- BNG Sessions Statistics (3)
- CEM Statistics (3)
- CLI Template Configuration (12)
- Circuit Statistics (4)
- Clients (7)
- Configuration Archive Service (7)
- Credential Profile Management Service (5)
- Credentials Service (1)
- Device Details (9)
- Device Operations (9)
- Device Sensors Statistics (3)
- Group Management Service (8)
- Group Summary Service (8)
- Guest User Management Service (8)
- IPSLA (ICMP JITTER) Statistics (3)
- IPSLA Y1731 Statistics (3)
- Interface CRC Errors Statistics (3)
- Job Operations (6)
- Link Statistics (3)
- MAC Filters Management Service (5)
- Manage and Monitor Info Service (5)
- Managed Servers Operations (6)
- Me1200 Quality of Service Statistics (3)
- Network Topology Layout (2)
- Optical Ethernet Statistics (3)
- Optical OTN Data Statistics (3)
- Optical Physical Statistics (3)
- Optical SFP Statistics (3)
- Optical Sonet SDH Statistics (3)
- PTP Clock Statistics (3)
- PTP and SyncE settings (5)
- Plug and Play (7)
- Quality of Service Statistics (3)
- Rate Limits Management Service (2)
- Report Service (5)
- Site Map Service (3)
- Software Updates (2)
- Statistics (91)
- SyncE Statistics (3)
- System Settings (26)
- TDM and Sonet Port Statistics (3)
- Trap Receivers (4)
- User Defined Field Management (3)
- User Management Service (5)
- VNF Provisioning (16)
- Virtual Domains Management Service (10)
- Virtual Image Repository (8)
- WLAN Provisioning (16)
- Wireless Device Details (22)
- Y1731 Bins Statistics (3)
- v1
- v2
- v3
- v4
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 |
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/apService/accessPointRequest Payload Parameters
Attribute | Description | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
accessPointId long |
ID used to identify the unified access point. |
|||||||||||||||
adminStatus boolean |
Administrative status of the access point. |
|||||||||||||||
mapLocation String |
Location of the access point. |
|||||||||||||||
name String |
Name of the access point. |
|||||||||||||||
|
||||||||||||||||
|
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://172.20.127.108/webacs/api/v1/op/apService/accessPoint
<?xml version="1.0" ?>
<accessPoint>
<accessPointId>2</accessPointId>
<adminStatus>true</adminStatus>
<mapLocation>String value</mapLocation>
<name>String value</name>
<unifiedApInfo>
<primaryMwar>String value</primaryMwar>
<primaryMwarAddress>
<address>192.168.115.243</address>
</primaryMwarAddress>
<secondaryMwar>String value</secondaryMwar>
<secondaryMwarAddress>
<address>192.168.115.243</address>
</secondaryMwarAddress>
<tertiaryMwar>String value</tertiaryMwar>
<tertiaryMwarAddress>
<address>192.168.115.243</address>
</tertiaryMwarAddress>
</unifiedApInfo>
</accessPoint>
Sample JSON Request Payload
https://172.20.127.108/webacs/api/v1/op/apService/accessPoint.json
{
"accessPoint" : {
"accessPointId" : 2,
"adminStatus" : true,
"mapLocation" : "String value",
"name" : "String value",
"unifiedApInfo" : {
"primaryMwar" : "String value",
"primaryMwarAddress" : {
"address" : "192.168.115.243"
},
"secondaryMwar" : "String value",
"secondaryMwarAddress" : {
"address" : "192.168.115.243"
},
"tertiaryMwar" : "String value",
"tertiaryMwarAddress" : {
"address" : "192.168.115.243"
}
}
}
}
Sample XML Response Payload
https://172.20.127.108/webacs/api/v1/op/apService/accessPoint
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../pages/common/login.jsp.html" rootUrl="https://172.20.127.108/webacs/api/v1/op">
<apJobInfo>
<jobName>String value</jobName>
<jobType>String value</jobType>
</apJobInfo>
</mgmtResponse>
Sample JSON Response Payload
https://172.20.127.108/webacs/api/v1/op/apService/accessPoint.json
{
"mgmtResponse" : {
"@responseType" : "operation",
"@requestUrl" : "https : \/\/172.20.127.108\/webacs\/api\/v1\/op\/apService\/accessPoint",
"@rootUrl" : "https : \/\/172.20.127.108\/webacs\/api\/v1\/op",
"apJobInfo" : {
"jobName" : "String value",
"jobType" : "String value"
}
}
}
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/v2/op/apService/accessPointUnmodified
This resource has not been modified since the previous API version.
Request Payload Parameters
Attribute | Description | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
accessPointId long |
ID used to identify the unified access point. |
|||||||||||||||
adminStatus boolean |
Administrative status of the access point. |
|||||||||||||||
mapLocation String |
Location of the access point. |
|||||||||||||||
name String |
Name of the access point. |
|||||||||||||||
|
||||||||||||||||
|
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://172.20.127.108/webacs/api/v2/op/apService/accessPoint
<?xml version="1.0" ?>
<accessPoint>
<accessPointId>2</accessPointId>
<adminStatus>true</adminStatus>
<mapLocation>String value</mapLocation>
<name>String value</name>
<unifiedApInfo>
<primaryMwar>String value</primaryMwar>
<primaryMwarAddress>
<address>192.168.115.243</address>
</primaryMwarAddress>
<secondaryMwar>String value</secondaryMwar>
<secondaryMwarAddress>
<address>192.168.115.243</address>
</secondaryMwarAddress>
<tertiaryMwar>String value</tertiaryMwar>
<tertiaryMwarAddress>
<address>192.168.115.243</address>
</tertiaryMwarAddress>
</unifiedApInfo>
</accessPoint>
Sample JSON Request Payload
https://172.20.127.108/webacs/api/v2/op/apService/accessPoint.json
{
"accessPoint" : {
"accessPointId" : 2,
"adminStatus" : true,
"mapLocation" : "String value",
"name" : "String value",
"unifiedApInfo" : {
"primaryMwar" : "String value",
"primaryMwarAddress" : {
"address" : "192.168.115.243"
},
"secondaryMwar" : "String value",
"secondaryMwarAddress" : {
"address" : "192.168.115.243"
},
"tertiaryMwar" : "String value",
"tertiaryMwarAddress" : {
"address" : "192.168.115.243"
}
}
}
}
Sample XML Response Payload
https://172.20.127.108/webacs/api/v2/op/apService/accessPoint
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../pages/common/login.jsp.html" rootUrl="https://172.20.127.108/webacs/api/v2/op">
<apJobInfo>
<jobName>String value</jobName>
<jobType>String value</jobType>
</apJobInfo>
</mgmtResponse>
Sample JSON Response Payload
https://172.20.127.108/webacs/api/v2/op/apService/accessPoint.json
{
"mgmtResponse" : {
"@requestUrl" : "../../../../pages/common/login.jsp.html",
"@responseType" : "operation",
"@rootUrl" : "https://172.20.127.108/webacs/api/v2/op",
"apJobInfo" : [ {
"jobName" : "String value",
"jobType" : "String value"
} ]
}
}
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/v3/op/apService/accessPointUpdated
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 |
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. |
|||||||
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. |
||||||||
|
||||||||
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. |
||||||||
|
||||||||
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://172.20.127.108/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://172.20.127.108/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://172.20.127.108/webacs/api/v3/op/apService/accessPoint
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../pages/common/login.jsp.html" rootUrl="https://172.20.127.108/webacs/api/v3/op">
<apJobInfo>
<jobName>String value</jobName>
<jobType>String value</jobType>
</apJobInfo>
</mgmtResponse>
Sample JSON Response Payload
https://172.20.127.108/webacs/api/v3/op/apService/accessPoint.json
{
"mgmtResponse" : {
"@requestUrl" : "../../../../pages/common/login.jsp.html",
"@responseType" : "operation",
"@rootUrl" : "https://172.20.127.108/webacs/api/v3/op",
"apJobInfo" : [ {
"jobName" : "String value",
"jobType" : "String value"
} ]
}
}
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/accessPointUnmodified
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. |
|||||||
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. |
||||||||
|
||||||||
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. |
||||||||
|
||||||||
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://172.20.127.108/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://172.20.127.108/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://172.20.127.108/webacs/api/v4/op/apService/accessPoint
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../pages/common/login.jsp.html" rootUrl="https://172.20.127.108/webacs/api/v4/op">
<apJobInfo>
<jobName>String value</jobName>
<jobType>String value</jobType>
</apJobInfo>
</mgmtResponse>
Sample JSON Response Payload
https://172.20.127.108/webacs/api/v4/op/apService/accessPoint.json
{
"mgmtResponse" : {
"@requestUrl" : "../../../../pages/common/login.jsp.html",
"@responseType" : "operation",
"@rootUrl" : "https://172.20.127.108/webacs/api/v4/op",
"apJobInfo" : [ {
"jobName" : "String value",
"jobType" : "String value"
} ]
}
}