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

# POST wlanProvisioning/wlanTemplate

Creates a WLAN template on the server.

Since Product Version: 2.2

- Jump To

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

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/wlanProvisioning/wlanTemplate

## Request Payload Parameters

Attribute | Description
--- | ---
adminStatus boolean | Is the WLAN administratively enabled?
broadcastSsidEnabled boolean | Is SSID broadcasting enabled?
interfaceName String | Denotes the interface, or interface group, for this WLAN. See interfaceType to determine if this is an interface or interface group.
interfaceType InterfaceMappingTypeEnum | Denotes whether an interface or interface group is used for this interface. See interfaceName for the name of the interface or interface group. Allowed values INTERFACE INTERFACEGROUP
lanType LanTypeEnum | Denotes the LAN type. Allowed values WIRELESS GUEST REMOTE
layer2Security WlanLayer2SecurityConfig | Layer 2 Security configuration. Required. No changes in layer 2 security will be made when is not provided.
Attribute | Description
--- | ---
securityMode Layer2SecurityModeEnum | Layer 2 security mode. Allowed values NONE WPAWPA2
wpa2Enabled boolean | Is WPA2 security protocol enabled?
wpa2EncryptionProtocolAes boolean | Is WPA2 AES enabled? Ignored if WPA2 is not enabled.
wpa2EncryptionProtocolTkip boolean | Is WPA2 TKIP enabled? WPA2 TKIP as standalone CIPHER is not allowed from controller with version 8.0 and later. Ignored if WPA2 is not enabled.
wpaAuthenticationKeyManagement8021x boolean | Is the 802.1x authentication key management enabled?
wpaAuthenticationKeyManagementCckm boolean | Is the CCKM authentication key management enabled?
wpaAuthenticationKeyManagementPsk boolean | Is the PSK authentication key management enabled?
wpaControllerSpecificPresharedKeyEnabled boolean | Is the PSK key controller specific? Ignored if PSK auth key management is not used.
wpaEnabled boolean | Is WPA security protocol enabled?
wpaEncryptionProtocolAes boolean | Is WPA AES enabled? Ignored if WPA is not enabled.
wpaEncryptionProtocolTkip boolean | Is WPA TKIP enabled? WPA TKIP can be enabled only with WPA2 AES for controllers with version below 8.3. Ignored if WPA is not enabled.
wpaPresharedKey String | PSK key, in ASCII or HEX format. The key must be of 64 characters length for HEX format, and from 8 to 63 characters length for ASCII format.
wpaPresharedKeyFormat PskFormatEnum | PSK key format. Ignored if PSK auth key management is not used. Allowed values DEFAULT HEX ASCII
profileName String | Profile name of the WLAN.
ssid String | SSID of the WLAN.
templateName String | The name of the WLAN template.

## 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/v1/op/wlanProvisioning/wlanTemplate

    <?xml version="1.0" ?>
    <wlanTemplate>
      <adminStatus>true</adminStatus>
      <broadcastSsidEnabled>true</broadcastSsidEnabled>
      <interfaceName>String value</interfaceName>
      <interfaceType>INTERFACE</interfaceType>
      <lanType>WIRELESS</lanType>
      <layer2Security>
        <securityMode>NONE</securityMode>
        <wpa2Enabled>true</wpa2Enabled>
        <wpa2EncryptionProtocolAes>true</wpa2EncryptionProtocolAes>
        <wpa2EncryptionProtocolTkip>true</wpa2EncryptionProtocolTkip>
        <wpaAuthenticationKeyManagement8021x>true</wpaAuthenticationKeyManagement8021x>
        <wpaAuthenticationKeyManagementCckm>true</wpaAuthenticationKeyManagementCckm>
        <wpaAuthenticationKeyManagementPsk>true</wpaAuthenticationKeyManagementPsk>
        <wpaControllerSpecificPresharedKeyEnabled>true</wpaControllerSpecificPresharedKeyEnabled>
        <wpaEnabled>true</wpaEnabled>
        <wpaEncryptionProtocolAes>true</wpaEncryptionProtocolAes>
        <wpaEncryptionProtocolTkip>true</wpaEncryptionProtocolTkip>
        <wpaPresharedKey>String value</wpaPresharedKey>
        <wpaPresharedKeyFormat>DEFAULT</wpaPresharedKeyFormat>
      </layer2Security>
      <profileName>String value</profileName>
      <ssid>String value</ssid>
      <templateName>String value</templateName>
    </wlanTemplate>

### Sample JSON Request Payload

https://10.64.88.203/webacs/api/v1/op/wlanProvisioning/wlanTemplate.json

    {
      "wlanTemplate" : {
        "adminStatus" : true,
        "broadcastSsidEnabled" : true,
        "interfaceName" : "String value",
        "interfaceType" : "INTERFACE",
        "lanType" : "WIRELESS",
        "layer2Security" : {
          "securityMode" : "NONE",
          "wpa2Enabled" : true,
          "wpa2EncryptionProtocolAes" : true,
          "wpa2EncryptionProtocolTkip" : true,
          "wpaAuthenticationKeyManagement8021x" : true,
          "wpaAuthenticationKeyManagementCckm" : true,
          "wpaAuthenticationKeyManagementPsk" : true,
          "wpaControllerSpecificPresharedKeyEnabled" : true,
          "wpaEnabled" : true,
          "wpaEncryptionProtocolAes" : true,
          "wpaEncryptionProtocolTkip" : true,
          "wpaPresharedKey" : "String value",
          "wpaPresharedKeyFormat" : "DEFAULT"
        },
        "profileName" : "String value",
        "ssid" : "String value",
        "templateName" : "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 | POST

## Resource URL

/webacs/api/v2/op/wlanProvisioning/wlanTemplate

Unmodified

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

## Request Payload Parameters

Attribute | Description
--- | ---
adminStatus boolean | Is the WLAN administratively enabled?
broadcastSsidEnabled boolean | Is SSID broadcasting enabled?
interfaceName String | Denotes the interface, or interface group, for this WLAN. See interfaceType to determine if this is an interface or interface group.
interfaceType InterfaceMappingTypeEnum | Denotes whether an interface or interface group is used for this interface. See interfaceName for the name of the interface or interface group. Allowed values INTERFACE INTERFACEGROUP
lanType LanTypeEnum | Denotes the LAN type. Allowed values WIRELESS GUEST REMOTE
layer2Security WlanLayer2SecurityConfig | Layer 2 Security configuration. Required. No changes in layer 2 security will be made when is not provided.
Attribute | Description
--- | ---
securityMode Layer2SecurityModeEnum | Layer 2 security mode. Allowed values NONE WPAWPA2
wpa2Enabled boolean | Is WPA2 security protocol enabled?
wpa2EncryptionProtocolAes boolean | Is WPA2 AES enabled? Ignored if WPA2 is not enabled.
wpa2EncryptionProtocolTkip boolean | Is WPA2 TKIP enabled? WPA2 TKIP as standalone CIPHER is not allowed from controller with version 8.0 and later. Ignored if WPA2 is not enabled.
wpaAuthenticationKeyManagement8021x boolean | Is the 802.1x authentication key management enabled?
wpaAuthenticationKeyManagementCckm boolean | Is the CCKM authentication key management enabled?
wpaAuthenticationKeyManagementPsk boolean | Is the PSK authentication key management enabled?
wpaControllerSpecificPresharedKeyEnabled boolean | Is the PSK key controller specific? Ignored if PSK auth key management is not used.
wpaEnabled boolean | Is WPA security protocol enabled?
wpaEncryptionProtocolAes boolean | Is WPA AES enabled? Ignored if WPA is not enabled.
wpaEncryptionProtocolTkip boolean | Is WPA TKIP enabled? WPA TKIP can be enabled only with WPA2 AES for controllers with version below 8.3. Ignored if WPA is not enabled.
wpaPresharedKey String | PSK key, in ASCII or HEX format. The key must be of 64 characters length for HEX format, and from 8 to 63 characters length for ASCII format.
wpaPresharedKeyFormat PskFormatEnum | PSK key format. Ignored if PSK auth key management is not used. Allowed values DEFAULT HEX ASCII
profileName String | Profile name of the WLAN.
ssid String | SSID of the WLAN.
templateName String | The name of the WLAN template.

## 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/v2/op/wlanProvisioning/wlanTemplate

    <?xml version="1.0" ?>
    <wlanTemplate>
      <adminStatus>true</adminStatus>
      <broadcastSsidEnabled>true</broadcastSsidEnabled>
      <interfaceName>String value</interfaceName>
      <interfaceType>INTERFACE</interfaceType>
      <lanType>WIRELESS</lanType>
      <layer2Security>
        <securityMode>NONE</securityMode>
        <wpa2Enabled>true</wpa2Enabled>
        <wpa2EncryptionProtocolAes>true</wpa2EncryptionProtocolAes>
        <wpa2EncryptionProtocolTkip>true</wpa2EncryptionProtocolTkip>
        <wpaAuthenticationKeyManagement8021x>true</wpaAuthenticationKeyManagement8021x>
        <wpaAuthenticationKeyManagementCckm>true</wpaAuthenticationKeyManagementCckm>
        <wpaAuthenticationKeyManagementPsk>true</wpaAuthenticationKeyManagementPsk>
        <wpaControllerSpecificPresharedKeyEnabled>true</wpaControllerSpecificPresharedKeyEnabled>
        <wpaEnabled>true</wpaEnabled>
        <wpaEncryptionProtocolAes>true</wpaEncryptionProtocolAes>
        <wpaEncryptionProtocolTkip>true</wpaEncryptionProtocolTkip>
        <wpaPresharedKey>String value</wpaPresharedKey>
        <wpaPresharedKeyFormat>DEFAULT</wpaPresharedKeyFormat>
      </layer2Security>
      <profileName>String value</profileName>
      <ssid>String value</ssid>
      <templateName>String value</templateName>
    </wlanTemplate>

### Sample JSON Request Payload

https://10.64.88.203/webacs/api/v2/op/wlanProvisioning/wlanTemplate.json

    {
      "wlanTemplate" : {
        "adminStatus" : true,
        "broadcastSsidEnabled" : true,
        "interfaceName" : "String value",
        "interfaceType" : "INTERFACE",
        "lanType" : "WIRELESS",
        "layer2Security" : {
          "securityMode" : "NONE",
          "wpa2Enabled" : true,
          "wpa2EncryptionProtocolAes" : true,
          "wpa2EncryptionProtocolTkip" : true,
          "wpaAuthenticationKeyManagement8021x" : true,
          "wpaAuthenticationKeyManagementCckm" : true,
          "wpaAuthenticationKeyManagementPsk" : true,
          "wpaControllerSpecificPresharedKeyEnabled" : true,
          "wpaEnabled" : true,
          "wpaEncryptionProtocolAes" : true,
          "wpaEncryptionProtocolTkip" : true,
          "wpaPresharedKey" : "String value",
          "wpaPresharedKeyFormat" : "DEFAULT"
        },
        "profileName" : "String value",
        "ssid" : "String value",
        "templateName" : "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 | POST

## Resource URL

/webacs/api/v3/op/wlanProvisioning/wlanTemplate

Unmodified

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

## Request Payload Parameters

Attribute | Description
--- | ---
adminStatus boolean | Is the WLAN administratively enabled?
broadcastSsidEnabled boolean | Is SSID broadcasting enabled?
interfaceName String | Denotes the interface, or interface group, for this WLAN. See interfaceType to determine if this is an interface or interface group.
interfaceType InterfaceMappingTypeEnum | Denotes whether an interface or interface group is used for this interface. See interfaceName for the name of the interface or interface group. Allowed values INTERFACE INTERFACEGROUP
lanType LanTypeEnum | Denotes the LAN type. Allowed values WIRELESS GUEST REMOTE
layer2Security WlanLayer2SecurityConfig | Layer 2 Security configuration. Required. No changes in layer 2 security will be made when is not provided.
Attribute | Description
--- | ---
securityMode Layer2SecurityModeEnum | Layer 2 security mode. Allowed values NONE WPAWPA2
wpa2Enabled boolean | Is WPA2 security protocol enabled?
wpa2EncryptionProtocolAes boolean | Is WPA2 AES enabled? Ignored if WPA2 is not enabled.
wpa2EncryptionProtocolTkip boolean | Is WPA2 TKIP enabled? WPA2 TKIP as standalone CIPHER is not allowed from controller with version 8.0 and later. Ignored if WPA2 is not enabled.
wpaAuthenticationKeyManagement8021x boolean | Is the 802.1x authentication key management enabled?
wpaAuthenticationKeyManagementCckm boolean | Is the CCKM authentication key management enabled?
wpaAuthenticationKeyManagementPsk boolean | Is the PSK authentication key management enabled?
wpaControllerSpecificPresharedKeyEnabled boolean | Is the PSK key controller specific? Ignored if PSK auth key management is not used.
wpaEnabled boolean | Is WPA security protocol enabled?
wpaEncryptionProtocolAes boolean | Is WPA AES enabled? Ignored if WPA is not enabled.
wpaEncryptionProtocolTkip boolean | Is WPA TKIP enabled? WPA TKIP can be enabled only with WPA2 AES for controllers with version below 8.3. Ignored if WPA is not enabled.
wpaPresharedKey String | PSK key, in ASCII or HEX format. The key must be of 64 characters length for HEX format, and from 8 to 63 characters length for ASCII format.
wpaPresharedKeyFormat PskFormatEnum | PSK key format. Ignored if PSK auth key management is not used. Allowed values DEFAULT HEX ASCII
profileName String | Profile name of the WLAN.
ssid String | SSID of the WLAN.
templateName String | The name of the WLAN template.

## 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/v3/op/wlanProvisioning/wlanTemplate

    <?xml version="1.0" ?>
    <wlanTemplate>
      <adminStatus>true</adminStatus>
      <broadcastSsidEnabled>true</broadcastSsidEnabled>
      <interfaceName>String value</interfaceName>
      <interfaceType>INTERFACE</interfaceType>
      <lanType>WIRELESS</lanType>
      <layer2Security>
        <securityMode>NONE</securityMode>
        <wpa2Enabled>true</wpa2Enabled>
        <wpa2EncryptionProtocolAes>true</wpa2EncryptionProtocolAes>
        <wpa2EncryptionProtocolTkip>true</wpa2EncryptionProtocolTkip>
        <wpaAuthenticationKeyManagement8021x>true</wpaAuthenticationKeyManagement8021x>
        <wpaAuthenticationKeyManagementCckm>true</wpaAuthenticationKeyManagementCckm>
        <wpaAuthenticationKeyManagementPsk>true</wpaAuthenticationKeyManagementPsk>
        <wpaControllerSpecificPresharedKeyEnabled>true</wpaControllerSpecificPresharedKeyEnabled>
        <wpaEnabled>true</wpaEnabled>
        <wpaEncryptionProtocolAes>true</wpaEncryptionProtocolAes>
        <wpaEncryptionProtocolTkip>true</wpaEncryptionProtocolTkip>
        <wpaPresharedKey>String value</wpaPresharedKey>
        <wpaPresharedKeyFormat>DEFAULT</wpaPresharedKeyFormat>
      </layer2Security>
      <profileName>String value</profileName>
      <ssid>String value</ssid>
      <templateName>String value</templateName>
    </wlanTemplate>

### Sample JSON Request Payload

https://10.64.88.203/webacs/api/v3/op/wlanProvisioning/wlanTemplate.json

    {
      "wlanTemplate" : {
        "adminStatus" : true,
        "broadcastSsidEnabled" : true,
        "interfaceName" : "String value",
        "interfaceType" : "INTERFACE",
        "lanType" : "WIRELESS",
        "layer2Security" : {
          "securityMode" : "NONE",
          "wpa2Enabled" : true,
          "wpa2EncryptionProtocolAes" : true,
          "wpa2EncryptionProtocolTkip" : true,
          "wpaAuthenticationKeyManagement8021x" : true,
          "wpaAuthenticationKeyManagementCckm" : true,
          "wpaAuthenticationKeyManagementPsk" : true,
          "wpaControllerSpecificPresharedKeyEnabled" : true,
          "wpaEnabled" : true,
          "wpaEncryptionProtocolAes" : true,
          "wpaEncryptionProtocolTkip" : true,
          "wpaPresharedKey" : "String value",
          "wpaPresharedKeyFormat" : "DEFAULT"
        },
        "profileName" : "String value",
        "ssid" : "String value",
        "templateName" : "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 | POST

## Resource URL

/webacs/api/v4/op/wlanProvisioning/wlanTemplate

Unmodified

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

## Request Payload Parameters

Attribute | Description
--- | ---
adminStatus boolean | Is the WLAN administratively enabled?
broadcastSsidEnabled boolean | Is SSID broadcasting enabled?
interfaceName String | Denotes the interface, or interface group, for this WLAN. See interfaceType to determine if this is an interface or interface group.
interfaceType InterfaceMappingTypeEnum | Denotes whether an interface or interface group is used for this interface. See interfaceName for the name of the interface or interface group. Allowed values INTERFACE INTERFACEGROUP
lanType LanTypeEnum | Denotes the LAN type. Allowed values WIRELESS GUEST REMOTE
layer2Security WlanLayer2SecurityConfig | Layer 2 Security configuration. Required. No changes in layer 2 security will be made when is not provided.
Attribute | Description
--- | ---
securityMode Layer2SecurityModeEnum | Layer 2 security mode. Allowed values NONE WPAWPA2
wpa2Enabled boolean | Is WPA2 security protocol enabled?
wpa2EncryptionProtocolAes boolean | Is WPA2 AES enabled? Ignored if WPA2 is not enabled.
wpa2EncryptionProtocolTkip boolean | Is WPA2 TKIP enabled? WPA2 TKIP as standalone CIPHER is not allowed from controller with version 8.0 and later. Ignored if WPA2 is not enabled.
wpaAuthenticationKeyManagement8021x boolean | Is the 802.1x authentication key management enabled?
wpaAuthenticationKeyManagementCckm boolean | Is the CCKM authentication key management enabled?
wpaAuthenticationKeyManagementPsk boolean | Is the PSK authentication key management enabled?
wpaControllerSpecificPresharedKeyEnabled boolean | Is the PSK key controller specific? Ignored if PSK auth key management is not used.
wpaEnabled boolean | Is WPA security protocol enabled?
wpaEncryptionProtocolAes boolean | Is WPA AES enabled? Ignored if WPA is not enabled.
wpaEncryptionProtocolTkip boolean | Is WPA TKIP enabled? WPA TKIP can be enabled only with WPA2 AES for controllers with version below 8.3. Ignored if WPA is not enabled.
wpaPresharedKey String | PSK key, in ASCII or HEX format. The key must be of 64 characters length for HEX format, and from 8 to 63 characters length for ASCII format.
wpaPresharedKeyFormat PskFormatEnum | PSK key format. Ignored if PSK auth key management is not used. Allowed values DEFAULT HEX ASCII
profileName String | Profile name of the WLAN.
ssid String | SSID of the WLAN.
templateName String | The name of the WLAN template.

## 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/wlanProvisioning/wlanTemplate

    <?xml version="1.0" ?>
    <wlanTemplate>
      <adminStatus>true</adminStatus>
      <broadcastSsidEnabled>true</broadcastSsidEnabled>
      <interfaceName>String value</interfaceName>
      <interfaceType>INTERFACE</interfaceType>
      <lanType>WIRELESS</lanType>
      <layer2Security>
        <securityMode>NONE</securityMode>
        <wpa2Enabled>true</wpa2Enabled>
        <wpa2EncryptionProtocolAes>true</wpa2EncryptionProtocolAes>
        <wpa2EncryptionProtocolTkip>true</wpa2EncryptionProtocolTkip>
        <wpaAuthenticationKeyManagement8021x>true</wpaAuthenticationKeyManagement8021x>
        <wpaAuthenticationKeyManagementCckm>true</wpaAuthenticationKeyManagementCckm>
        <wpaAuthenticationKeyManagementPsk>true</wpaAuthenticationKeyManagementPsk>
        <wpaControllerSpecificPresharedKeyEnabled>true</wpaControllerSpecificPresharedKeyEnabled>
        <wpaEnabled>true</wpaEnabled>
        <wpaEncryptionProtocolAes>true</wpaEncryptionProtocolAes>
        <wpaEncryptionProtocolTkip>true</wpaEncryptionProtocolTkip>
        <wpaPresharedKey>String value</wpaPresharedKey>
        <wpaPresharedKeyFormat>DEFAULT</wpaPresharedKeyFormat>
      </layer2Security>
      <profileName>String value</profileName>
      <ssid>String value</ssid>
      <templateName>String value</templateName>
    </wlanTemplate>

### Sample JSON Request Payload

https://10.64.88.203/webacs/api/v4/op/wlanProvisioning/wlanTemplate.json

    {
      "wlanTemplate" : {
        "adminStatus" : true,
        "broadcastSsidEnabled" : true,
        "interfaceName" : "String value",
        "interfaceType" : "INTERFACE",
        "lanType" : "WIRELESS",
        "layer2Security" : {
          "securityMode" : "NONE",
          "wpa2Enabled" : true,
          "wpa2EncryptionProtocolAes" : true,
          "wpa2EncryptionProtocolTkip" : true,
          "wpaAuthenticationKeyManagement8021x" : true,
          "wpaAuthenticationKeyManagementCckm" : true,
          "wpaAuthenticationKeyManagementPsk" : true,
          "wpaControllerSpecificPresharedKeyEnabled" : true,
          "wpaEnabled" : true,
          "wpaEncryptionProtocolAes" : true,
          "wpaEncryptionProtocolTkip" : true,
          "wpaPresharedKey" : "String value",
          "wpaPresharedKeyFormat" : "DEFAULT"
        },
        "profileName" : "String value",
        "ssid" : "String value",
        "templateName" : "String value"
      }
    }