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

# PUT wlanProvisioning/deployTemplate

Schedules a job to deploy a WLAN template onto a Wlan Controller, creating a WLAN profile.

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

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/deployTemplate

## Request Payload Parameters

Attribute | Description
--- | ---
controllerConfig DeployWlanTemplateControllerConfigDTO | Controller specific configuration
Attribute | Description
--- | ---
wpaPresharedKey String | Pre-shared key in ASCII or HEX format. Both wpaPresharedKey and wpaPresharedKeyFormat must be specified when the WLAN template is configured with controller-specific pre-shared key.
wpaPresharedKeyFormat PskFormatEnum | Pre-shared key format, ASCII or HEX. Both wpaPresharedKey and wpaPresharedKeyFormat must be specified when the WLAN template is configured with controller-specific pre-shared key. Allowed values DEFAULT HEX ASCII
controllerId Long | Identifies the controller to apply the changes to. Either controllerId or controllerName must be specified.
controllerName String | Identifies the controller to apply the changes to. Either controllerId or controllerName must be specified.
templateName String | The name of the template to deploy.

## 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://10.64.88.203/webacs/api/v1/op/wlanProvisioning/deployTemplate

    <?xml version="1.0" ?>
    <deployWlanTemplateDTO>
      <controllerId>15</controllerId>
      <controllerName>String value</controllerName>
      <controllerConfig>
        <wpaPresharedKey>String value</wpaPresharedKey>
        <wpaPresharedKeyFormat>DEFAULT</wpaPresharedKeyFormat>
      </controllerConfig>
      <templateName>String value</templateName>
    </deployWlanTemplateDTO>

### Sample JSON Request Payload

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

    {
      "deployWlanTemplateDTO" : {
        "controllerId" : 15,
        "controllerName" : "String value",
        "controllerConfig" : {
          "wpaPresharedKey" : "String value",
          "wpaPresharedKeyFormat" : "DEFAULT"
        },
        "templateName" : "String value"
      }
    }

### Sample XML Response Payload

https://10.64.88.203/webacs/api/v1/op/wlanProvisioning/deployTemplate

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="../../../../../pages/common/login.jsp.html" rootUrl="https://10.64.88.203/webacs/api/v1/op">
      <jobInformation>
        <jobName>String value</jobName>
        <jobType>String value</jobType>
      </jobInformation>
    </mgmtResponse>

### Sample JSON Response Payload

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

    {
      "mgmtResponse" : {
        "@responseType" : "operation",
        "@requestUrl" : "https : //10.64.88.203/webacs/api/v1/op/wlanProvisioning/deployTemplate",
        "@rootUrl" : "https : //10.64.88.203/webacs/api/v1/op",
        "jobInformation" : {
          "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/wlanProvisioning/deployTemplate

Unmodified

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

## Request Payload Parameters

Attribute | Description
--- | ---
controllerConfig DeployWlanTemplateControllerConfigDTO | Controller specific configuration
Attribute | Description
--- | ---
wpaPresharedKey String | Pre-shared key in ASCII or HEX format. Both wpaPresharedKey and wpaPresharedKeyFormat must be specified when the WLAN template is configured with controller-specific pre-shared key.
wpaPresharedKeyFormat PskFormatEnum | Pre-shared key format, ASCII or HEX. Both wpaPresharedKey and wpaPresharedKeyFormat must be specified when the WLAN template is configured with controller-specific pre-shared key. Allowed values DEFAULT HEX ASCII
controllerId Long | Identifies the controller to apply the changes to. Either controllerId or controllerName must be specified.
controllerName String | Identifies the controller to apply the changes to. Either controllerId or controllerName must be specified.
templateName String | The name of the template to deploy.

## 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://10.64.88.203/webacs/api/v2/op/wlanProvisioning/deployTemplate

    <?xml version="1.0" ?>
    <deployWlanTemplateDTO>
      <controllerId>15</controllerId>
      <controllerName>String value</controllerName>
      <controllerConfig>
        <wpaPresharedKey>String value</wpaPresharedKey>
        <wpaPresharedKeyFormat>DEFAULT</wpaPresharedKeyFormat>
      </controllerConfig>
      <templateName>String value</templateName>
    </deployWlanTemplateDTO>

### Sample JSON Request Payload

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

    {
      "deployWlanTemplateDTO" : {
        "controllerConfig" : {
          "wpaPresharedKey" : "String value",
          "wpaPresharedKeyFormat" : "DEFAULT"
        },
        "controllerId" : 15,
        "controllerName" : "String value",
        "templateName" : "String value"
      }
    }

### Sample XML Response Payload

https://10.64.88.203/webacs/api/v2/op/wlanProvisioning/deployTemplate

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="../../../../../pages/common/login.jsp.html" rootUrl="https://10.64.88.203/webacs/api/v2/op">
      <jobInformation>
        <jobName>String value</jobName>
        <jobType>String value</jobType>
      </jobInformation>
    </mgmtResponse>

### Sample JSON Response Payload

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

    {
      "mgmtResponse" : {
        "@requestUrl" : "../../../../../pages/common/login.jsp.html",
        "@responseType" : "operation",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v2/op",
        "jobInformation" : [ {
          "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/wlanProvisioning/deployTemplate

Unmodified

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

## Request Payload Parameters

Attribute | Description
--- | ---
controllerConfig DeployWlanTemplateControllerConfigDTO | Controller specific configuration
Attribute | Description
--- | ---
wpaPresharedKey String | Pre-shared key in ASCII or HEX format. Both wpaPresharedKey and wpaPresharedKeyFormat must be specified when the WLAN template is configured with controller-specific pre-shared key.
wpaPresharedKeyFormat PskFormatEnum | Pre-shared key format, ASCII or HEX. Both wpaPresharedKey and wpaPresharedKeyFormat must be specified when the WLAN template is configured with controller-specific pre-shared key. Allowed values DEFAULT HEX ASCII
controllerId Long | Identifies the controller to apply the changes to. Either controllerId or controllerName must be specified.
controllerName String | Identifies the controller to apply the changes to. Either controllerId or controllerName must be specified.
templateName String | The name of the template to deploy.

## 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://10.64.88.203/webacs/api/v3/op/wlanProvisioning/deployTemplate

    <?xml version="1.0" ?>
    <deployWlanTemplateDTO>
      <controllerId>15</controllerId>
      <controllerName>String value</controllerName>
      <controllerConfig>
        <wpaPresharedKey>String value</wpaPresharedKey>
        <wpaPresharedKeyFormat>DEFAULT</wpaPresharedKeyFormat>
      </controllerConfig>
      <templateName>String value</templateName>
    </deployWlanTemplateDTO>

### Sample JSON Request Payload

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

    {
      "deployWlanTemplateDTO" : {
        "controllerConfig" : {
          "wpaPresharedKey" : "String value",
          "wpaPresharedKeyFormat" : "DEFAULT"
        },
        "controllerId" : 15,
        "controllerName" : "String value",
        "templateName" : "String value"
      }
    }

### Sample XML Response Payload

https://10.64.88.203/webacs/api/v3/op/wlanProvisioning/deployTemplate

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="../../../../../pages/common/login.jsp.html" rootUrl="https://10.64.88.203/webacs/api/v3/op">
      <jobInformation>
        <jobName>String value</jobName>
        <jobType>String value</jobType>
      </jobInformation>
    </mgmtResponse>

### Sample JSON Response Payload

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

    {
      "mgmtResponse" : {
        "@requestUrl" : "../../../../../pages/common/login.jsp.html",
        "@responseType" : "operation",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v3/op",
        "jobInformation" : [ {
          "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/wlanProvisioning/deployTemplate

Unmodified

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

## Request Payload Parameters

Attribute | Description
--- | ---
controllerConfig DeployWlanTemplateControllerConfigDTO | Controller specific configuration
Attribute | Description
--- | ---
wpaPresharedKey String | Pre-shared key in ASCII or HEX format. Both wpaPresharedKey and wpaPresharedKeyFormat must be specified when the WLAN template is configured with controller-specific pre-shared key.
wpaPresharedKeyFormat PskFormatEnum | Pre-shared key format, ASCII or HEX. Both wpaPresharedKey and wpaPresharedKeyFormat must be specified when the WLAN template is configured with controller-specific pre-shared key. Allowed values DEFAULT HEX ASCII
controllerId Long | Identifies the controller to apply the changes to. Either controllerId or controllerName must be specified.
controllerName String | Identifies the controller to apply the changes to. Either controllerId or controllerName must be specified.
templateName String | The name of the template to deploy.

## 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://10.64.88.203/webacs/api/v4/op/wlanProvisioning/deployTemplate

    <?xml version="1.0" ?>
    <deployWlanTemplateDTO>
      <controllerId>15</controllerId>
      <controllerName>String value</controllerName>
      <controllerConfig>
        <wpaPresharedKey>String value</wpaPresharedKey>
        <wpaPresharedKeyFormat>DEFAULT</wpaPresharedKeyFormat>
      </controllerConfig>
      <templateName>String value</templateName>
    </deployWlanTemplateDTO>

### Sample JSON Request Payload

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

    {
      "deployWlanTemplateDTO" : {
        "controllerConfig" : {
          "wpaPresharedKey" : "String value",
          "wpaPresharedKeyFormat" : "DEFAULT"
        },
        "controllerId" : 15,
        "controllerName" : "String value",
        "templateName" : "String value"
      }
    }

### Sample XML Response Payload

https://10.64.88.203/webacs/api/v4/op/wlanProvisioning/deployTemplate

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="../../../../../pages/common/login.jsp.html" rootUrl="https://10.64.88.203/webacs/api/v4/op">
      <jobInformation>
        <jobName>String value</jobName>
        <jobType>String value</jobType>
      </jobInformation>
    </mgmtResponse>

### Sample JSON Response Payload

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

    {
      "mgmtResponse" : {
        "@requestUrl" : "../../../../../pages/common/login.jsp.html",
        "@responseType" : "operation",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v4/op",
        "jobInformation" : [ {
          "jobName" : "String value",
          "jobType" : "String value"
        } ]
      }
    }