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

# POST apOnboarding/profile

Adds AP Onboarding Profiles

Since Product Version: 3.4

- Jump To

- v1
- v2
- v3
- v4

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 unavailable for this API version

This resource was introduced in API version 4.

Resource unavailable for this API version

This resource was introduced in API version 4.

Resource unavailable for this API version

This resource was introduced in API version 4.

### 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 | POST

## Resource URL

/webacs/api/v4/op/apOnboarding/profile

## Request Parameters

Attribute | Source | Description
--- | --- | ---
overrideOption Boolean | query | Optional Override existing profiles

## Request Payload Parameters

Attribute | Description
--- | ---
profiles CreateApOnBoardingProfileDTO[] | Required AP Onboarding Profiles
Attribute | Description
--- | ---
apName String | Access point name. Optional
apTemplateOne String | Name of the first lightweight access point template. Optional
apTemplateThree String | Name of the third lightweight access point template. Optional
apTemplateTwo String | Name of the second lightweight access point template. Optional
associatedControllerName String | WLAN controller name associated with the profile. Optional
macAddress MacAddress | MAC Address. A serial number or MAC address should be specified for the profile
profileGroup String | Name of the profile group. Optional. If the group name is not specified the profile will be included in the "Unassigned" group.
profileMode ProfileMode | Required Profile mode Allowed values ENABLE DISABLE COMPLETE
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. If a serial number is defined the MAC Address will be ignored

## Response Parameters

Attribute | Description
--- | ---
operation ApOnboardingProfileOperation | Operation type Allowed values ADD_PROFILES DELETE_PROFILES
results ApOnboardingProfileOpResult[] | Result list
Attribute | Description
--- | ---
key String | This field contains a profile identifier: ID, MAC address or serial number.
message String | Result message
success boolean | Indicates an operation status. True if the operation was finished successfully and false if the operation failed

## 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/apOnboarding/profile

    <?xml version="1.0" ?>
    <createApOnBoardingProfilesDTO>
      <profiles>
        <profile>
          <apName>String value</apName>
          <apTemplateOne>String value</apTemplateOne>
          <apTemplateThree>String value</apTemplateThree>
          <apTemplateTwo>String value</apTemplateTwo>
          <associatedControllerName>String value</associatedControllerName>
          <profileGroup>String value</profileGroup>
          <profileMode>ENABLE</profileMode>
          <macAddress>
            <octets>000a959d6816</octets>
          </macAddress>
          <serialNumber>String value</serialNumber>
        </profile>
        <profile>
          <apName>Another string value</apName>
          <apTemplateOne>Another string value</apTemplateOne>
          <apTemplateThree>Another string value</apTemplateThree>
          <apTemplateTwo>Another string value</apTemplateTwo>
          <associatedControllerName>Another string value</associatedControllerName>
          <profileGroup>Another string value</profileGroup>
          <profileMode>DISABLE</profileMode>
          <macAddress>
            <octets>000a959d6817</octets>
          </macAddress>
          <serialNumber>Another string value</serialNumber>
        </profile>
      </profiles>
    </createApOnBoardingProfilesDTO>

### Sample JSON Request Payload

https://10.64.88.203/webacs/api/v4/op/apOnboarding/profile.json

    {
      "createApOnBoardingProfilesDTO" : {
        "profiles" : {
          "profile" : [ {
            "apName" : "String value",
            "apTemplateOne" : "String value",
            "apTemplateThree" : "String value",
            "apTemplateTwo" : "String value",
            "associatedControllerName" : "String value",
            "macAddress" : {
              "octets" : "000a959d6816"
            },
            "profileGroup" : "String value",
            "profileMode" : "ENABLE",
            "serialNumber" : "String value"
          }, {
            "apName" : "Another string value",
            "apTemplateOne" : "Another string value",
            "apTemplateThree" : "Another string value",
            "apTemplateTwo" : "Another string value",
            "associatedControllerName" : "Another string value",
            "macAddress" : {
              "octets" : "000a959d6817"
            },
            "profileGroup" : "Another string value",
            "profileMode" : "DISABLE",
            "serialNumber" : "Another string value"
          } ]
        }
      }
    }

### Sample XML Response Payload

https://10.64.88.203/webacs/api/v4/op/apOnboarding/profile

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="../../../../../pages/common/login.jsp.html" rootUrl="https://10.64.88.203/webacs/api/v4/op">
      <apOnboardingProfileOpResults>
        <operation>ADD_PROFILES</operation>
        <results>
          <result>
            <key>String value</key>
            <message>String value</message>
            <success>true</success>
          </result>
          <result>
            <key>Another string value</key>
            <message>Another string value</message>
            <success>false</success>
          </result>
        </results>
      </apOnboardingProfileOpResults>
    </mgmtResponse>

### Sample JSON Response Payload

https://10.64.88.203/webacs/api/v4/op/apOnboarding/profile.json

    {
      "mgmtResponse" : {
        "@requestUrl" : "../../../../../pages/common/login.jsp.html",
        "@responseType" : "operation",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v4/op",
        "apOnboardingProfileOpResults" : [ {
          "operation" : "ADD_PROFILES",
          "results" : {
            "result" : [ {
              "key" : "String value",
              "message" : "String value",
              "success" : true
            }, {
              "key" : "Another string value",
              "message" : "Another string value",
              "success" : false
            } ]
          }
        } ]
      }
    }