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
|
|
User Group
|
NBI Write
|
HTTP Methods
|
|
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/apService/accessPoint
Request Payload Parameters
accessPointId
long
|
|
adminStatus
boolean
|
Administrative status of the access point.
|
mapLocation
String
|
Location of the access point.
|
name
String
|
Name of the access point.
|
unifiedApInfo
AccessPointUnifiedDetails
|
|
primaryMwar
String
|
Primary controller this access point has affinity to. Should be provided when the primary controller IP address is configured.
|
primaryMwarAddress
InetAddress
|
IP address of the primary controller this access point has affinity to. Optional.
|
secondaryMwar
String
|
Secondary controller this access point has affinity to. Should be provided when the secondary controller IP address is configured.
|
secondaryMwarAddress
InetAddress
|
IP address of the secondary controller this access point has affinity to. Optional.
|
tertiaryMwar
String
|
Tertiary controller this access point has affinity to. Should be provided when the tertiary controller IP address is configured.
|
tertiaryMwarAddress
InetAddress
|
IP address of the tertiary controller this access point has affinity to. Optional.
|
|
Response Parameters
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
|
|
User Group
|
NBI Write
|
HTTP Methods
|
|
Resource URL
/webacs/api/v2/op/apService/accessPoint
Unmodified
This resource has not been modified since the previous API version.
Request Payload Parameters
accessPointId
long
|
|
adminStatus
boolean
|
Administrative status of the access point.
|
mapLocation
String
|
Location of the access point.
|
name
String
|
Name of the access point.
|
unifiedApInfo
AccessPointUnifiedDetails
|
|
primaryMwar
String
|
Primary controller this access point has affinity to. Should be provided when the primary controller IP address is configured.
|
primaryMwarAddress
InetAddress
|
IP address of the primary controller this access point has affinity to. Optional.
|
secondaryMwar
String
|
Secondary controller this access point has affinity to. Should be provided when the secondary controller IP address is configured.
|
secondaryMwarAddress
InetAddress
|
IP address of the secondary controller this access point has affinity to. Optional.
|
tertiaryMwar
String
|
Tertiary controller this access point has affinity to. Should be provided when the tertiary controller IP address is configured.
|
tertiaryMwarAddress
InetAddress
|
IP address of the tertiary controller this access point has affinity to. Optional.
|
|
Response Parameters
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
|
|
User Group
|
NBI Write
|
HTTP Methods
|
|
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
accessPointId
long
|
|
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.
|
ipAddress
InetAddress
|
IP address of the WLAN controller.
If the controller is outside the mobility group to which the access point is connected then you need to provide the IP address of the controller. The controller sysName and IP address must belong to the same controller. Otherwise, the access point cannot join the backup controller.
|
sysName
String
|
The system name of the WLAN controller.
|
|
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.
|
ipAddress
InetAddress
|
IP address of the WLAN controller.
If the controller is outside the mobility group to which the access point is connected then you need to provide the IP address of the controller. The controller sysName and IP address must belong to the same controller. Otherwise, the access point cannot join the backup controller.
|
sysName
String
|
The system name of the WLAN controller.
|
|
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.
|
ipAddress
InetAddress
|
IP address of the WLAN controller.
If the controller is outside the mobility group to which the access point is connected then you need to provide the IP address of the controller. The controller sysName and IP address must belong to the same controller. Otherwise, the access point cannot join the backup controller.
|
sysName
String
|
The system name of the WLAN controller.
|
|
Response Parameters
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
|
|
User Group
|
NBI Write
|
HTTP Methods
|
|
Resource URL
/webacs/api/v4/op/apService/accessPoint
Unmodified
This resource has not been modified since the previous API version.
Request Payload Parameters
accessPointId
long
|
|
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.
|
ipAddress
InetAddress
|
IP address of the WLAN controller.
If the controller is outside the mobility group to which the access point is connected then you need to provide the IP address of the controller. The controller sysName and IP address must belong to the same controller. Otherwise, the access point cannot join the backup controller.
|
sysName
String
|
The system name of the WLAN controller.
|
|
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.
|
ipAddress
InetAddress
|
IP address of the WLAN controller.
If the controller is outside the mobility group to which the access point is connected then you need to provide the IP address of the controller. The controller sysName and IP address must belong to the same controller. Otherwise, the access point cannot join the backup controller.
|
sysName
String
|
The system name of the WLAN controller.
|
|
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.
|
ipAddress
InetAddress
|
IP address of the WLAN controller.
If the controller is outside the mobility group to which the access point is connected then you need to provide the IP address of the controller. The controller sysName and IP address must belong to the same controller. Otherwise, the access point cannot join the backup controller.
|
sysName
String
|
The system name of the WLAN controller.
|
|
Response Parameters
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"
} ]
}
}