Returns a list of AP onboarding profiles
Since Product Version: 3.4
-
Jump To
- AAA/TACACS+ Servers Operations Service (4)
- AP Onboarding Profile Management Service (4)
- API Health Service (6)
- Access Point Operations (5)
- Alarms Management Service (5)
- Application Visibility and Control Service (1)
- CLI Template Configuration (12)
- Clients (7)
- Configuration Archive Service (7)
- Credential Profile Management Service (5)
- Credentials Service (1)
- Device Details (9)
- Device Operations (9)
- Group Management Service (8)
- Group Summary Service (8)
- Guest User Management Service (8)
- Job Operations (6)
- MAC Filters Management Service (5)
- Manage and Monitor Info Service (5)
- Managed Servers Operations (6)
- Plug and Play (11)
- Rate Limits Management Service (2)
- Report Service (4)
- Site Map Service (3)
- Software Updates (2)
- Statistics (91)
- System Settings (26)
- 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)
- v1
- v2
- v3
- v4
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.
This resource was introduced in API version 4.
This resource was introduced in API version 4.
This resource was introduced in API version 4.
Resource Information
|
Rate Limiting? |
Yes |
|
Sorting? |
Yes |
|
Paging? |
Yes |
|
Filtering? |
Yes |
|
Group Filtering? |
No |
|
Aggregation? |
No |
|
Response Formats |
xml json |
|
User Group |
NBI Read |
|
HTTP Methods |
GET |
Resource URL
/webacs/api/v4/data/ApOnboardingProfileResponse Parameters
| Attribute | Description |
|---|---|
|
apName String |
Access point name. If the AP name is not configured the field will be equal 'Not Configured' |
|
apTemplateOne String |
Name of the first lightweight access point template. If the profile hasn't got an first template this field will be equal 'NONE' |
|
apTemplateThree String |
Name of the third lightweight access point template. If the profile hasn't got an third template this field will be equal 'NONE' |
|
apTemplateTwo String |
Name of the second lightweight access point template. If the profile hasn't got an second template this field will be equal 'NONE' |
|
associatedControllerName String |
WLAN controller name associated with the profile. If the profile hasn't got an associated controller this field will be equal 'ANY' |
|
macAddress MacAddress |
MAC Address. A serial number or MAC address should be specified for the profile |
|
nextStage ProfileNextStep |
Next stage
|
|
profileGroup String |
Name of the profile group |
|
profileMode ProfileMode |
Profile mode
|
|
profileStatus ProfileStatus |
Profile status
|
|
reason String |
Status reason |
|
serialNumber String |
Serial number. Serial number is a sequence of 11 letters/digits. Either serial number or MAC address should be specified for the profile |
|
updateTime Date |
Time of the last update. Note: The date has an incorrect UTC offset. Please see the FAQ for details. |
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 Payload
https://localhost/webacs/api/v4/data/ApOnboardingProfile/15
<?xml version="1.0" ?>
<queryResponse type="ApOnboardingProfile" responseType="getEntity" requestUrl="https://localhost/webacs/api/v4/data/ApOnboardingProfile/15" rootUrl="https://localhost/webacs/api/v4/data">
<entity dtoType="apOnboardingProfileDTO" type="ApOnboardingProfile" url="https://localhost/webacs/api/v4/data/ApOnboardingProfile/15">
<apOnboardingProfileDTO displayName="String value" id="15" uuid="String value">
<apName>String value</apName>
<apTemplateOne>String value</apTemplateOne>
<apTemplateThree>String value</apTemplateThree>
<apTemplateTwo>String value</apTemplateTwo>
<associatedControllerName>String value</associatedControllerName>
<macAddress>
<octets>000a959d6816</octets>
</macAddress>
<nextStage>NONE</nextStage>
<profileGroup>String value</profileGroup>
<profileMode>ENABLE</profileMode>
<profileStatus>NOT_INITIATED</profileStatus>
<reason>String value</reason>
<serialNumber>String value</serialNumber>
<updateTime>1986-07-24T00:00:00+08:00</updateTime>
</apOnboardingProfileDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://localhost/webacs/api/v4/data/ApOnboardingProfile/15.json
{
"queryResponse" : {
"@type" : "ApOnboardingProfile",
"@requestUrl" : "https://localhost/webacs/api/v4/data/ApOnboardingProfile/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://localhost/webacs/api/v4/data",
"entity" : [ {
"@dtoType" : "apOnboardingProfileDTO",
"@type" : "ApOnboardingProfile",
"@url" : "https://localhost/webacs/api/v4/data/ApOnboardingProfile/15",
"apOnboardingProfileDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@uuid" : "String value",
"apName" : "String value",
"apTemplateOne" : "String value",
"apTemplateThree" : "String value",
"apTemplateTwo" : "String value",
"associatedControllerName" : "String value",
"macAddress" : {
"octets" : "000a959d6816"
},
"nextStage" : "NONE",
"profileGroup" : "String value",
"profileMode" : "ENABLE",
"profileStatus" : "NOT_INITIATED",
"reason" : "String value",
"serialNumber" : "String value",
"updateTime" : "1986-07-23T16:00:00.000Z"
}
} ]
}
}