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

# GET cliTemplateConfiguration/download

Deprecated

Please use the CLI Configuration Templates resource instead. This operation may be removed in a future release.

Export a template from the system.

Since Product Version: 2.0

- 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 Read
HTTP Methods | GET

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/cliTemplateConfiguration/download

## Request Parameters

Attribute | Source | Description
--- | --- | ---
templateName String | query | Required Template to export.

## Response Parameters

Attribute | Description
--- | ---
content String | The content of the template that will be populated with variable values and sent to devices.
description String | A description of the template
deviceType String | The types of devices this template is applicable for, comma seperated.
name String | The name of the template.
path String | Template path
tags String | Tags list separated by comma. For Troubleshooting template use TroubleshootingTemplate tag like: <tags>TroubleshootingTemplate</tags>
variables CliTemplateVariableDefinition[] | A list of variables needed for this template
Attribute | Description
--- | ---
defaultValue String | A default value if the value is not specified when deployed. Contains comma-separated list of values for following variable types: DB_Dropdown, Dropdown, Radio Button. For other variable types contains single value.
description String | A description of the variable.
displayLabel String | Variable name to be displayed in the UI.
name String | The variable name.
rangeFrom String | The minimum allowed value for Integer variables. For other varaible types this field is ignored.
rangeTo String | The maximum allowed value for Integer variables. For other varaible types this field is ignored.
required boolean | Does the variable have to be set?
type String | The variable type. Supported values: Checkbox, DB, DB_Dropdown, Dropdown, Integer, IPv4 Address, Radio Button, String, Text Area.
validationExpression String | The regular expression for validating variable value. Supported for variable types: DB, Integer, IPv4 Address, String, Text Area.
version String | iOS version

## 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 Response Payload

https://10.64.88.203/webacs/api/v1/op/cliTemplateConfiguration/download?templateName=name

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="https://10.64.88.203/webacs/api/v1/op/cliTemplateConfiguration/download?templateName=name" rootUrl="https://10.64.88.203/webacs/api/v1/op">
      <cliTemplate>
        <content>String value</content>
        <description>String value</description>
        <deviceType>String value</deviceType>
        <name>String value</name>
        <path>String value</path>
        <tags>String value</tags>
        <variables>
          <variable>
            <defaultValue>String value</defaultValue>
            <description>String value</description>
            <displayLabel>String value</displayLabel>
            <name>String value</name>
            <rangeFrom>String value</rangeFrom>
            <rangeTo>String value</rangeTo>
            <required>true</required>
            <type>String value</type>
            <validationExpression>String value</validationExpression>
          </variable>
          <variable>
            <defaultValue>Another string value</defaultValue>
            <description>Another string value</description>
            <displayLabel>Another string value</displayLabel>
            <name>Another string value</name>
            <rangeFrom>Another string value</rangeFrom>
            <rangeTo>Another string value</rangeTo>
            <required>false</required>
            <type>Another string value</type>
            <validationExpression>Another string value</validationExpression>
          </variable>
        </variables>
        <version>String value</version>
      </cliTemplate>
    </mgmtResponse>

### Sample JSON Response Payload

https://10.64.88.203/webacs/api/v1/op/cliTemplateConfiguration/download.json?templateName=name

    {
      "mgmtResponse" : {
        "@responseType" : "operation",
        "@requestUrl" : "https : //10.64.88.203/webacs/api/v1/op/cliTemplateConfiguration/download?templateName=name",
        "@rootUrl" : "https : //10.64.88.203/webacs/api/v1/op",
        "cliTemplate" : {
          "content" : "String value",
          "description" : "String value",
          "deviceType" : "String value",
          "name" : "String value",
          "path" : "String value",
          "tags" : "String value",
          "variables" : {
            "variable" : [{
              "defaultValue" : "String value",
              "description" : "String value",
              "displayLabel" : "String value",
              "name" : "String value",
              "rangeFrom" : "String value",
              "rangeTo" : "String value",
              "required" : true,
              "type" : "String value",
              "validationExpression" : "String value"
            },
            {
              "defaultValue" : "Another string value",
              "description" : "Another string value",
              "displayLabel" : "Another string value",
              "name" : "Another string value",
              "rangeFrom" : "Another string value",
              "rangeTo" : "Another string value",
              "required" : false,
              "type" : "Another string value",
              "validationExpression" : "Another string value"
            }]
          },
          "version" : "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 Read
HTTP Methods | GET

## Resource URL

/webacs/api/v2/op/cliTemplateConfiguration/download

Unmodified

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

## Request Parameters

Attribute | Source | Description
--- | --- | ---
templateName String | query | Required Template to export.

## Response Parameters

Attribute | Description
--- | ---
content String | The content of the template that will be populated with variable values and sent to devices.
description String | A description of the template
deviceType String | The types of devices this template is applicable for, comma seperated.
name String | The name of the template.
path String | Template path
tags String | Tags list separated by comma. For Troubleshooting template use TroubleshootingTemplate tag like: <tags>TroubleshootingTemplate</tags>
variables CliTemplateVariableDefinition[] | A list of variables needed for this template
Attribute | Description
--- | ---
defaultValue String | A default value if the value is not specified when deployed. Contains comma-separated list of values for following variable types: DB_Dropdown, Dropdown, Radio Button. For other variable types contains single value.
description String | A description of the variable.
displayLabel String | Variable name to be displayed in the UI.
name String | The variable name.
rangeFrom String | The minimum allowed value for Integer variables. For other varaible types this field is ignored.
rangeTo String | The maximum allowed value for Integer variables. For other varaible types this field is ignored.
required boolean | Does the variable have to be set?
type String | The variable type. Supported values: Checkbox, DB, DB_Dropdown, Dropdown, Integer, IPv4 Address, Radio Button, String, Text Area.
validationExpression String | The regular expression for validating variable value. Supported for variable types: DB, Integer, IPv4 Address, String, Text Area.
version String | iOS version

## 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 Response Payload

https://10.64.88.203/webacs/api/v2/op/cliTemplateConfiguration/download?templateName=name

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="https://10.64.88.203/webacs/api/v2/op/cliTemplateConfiguration/download?templateName=name" rootUrl="https://10.64.88.203/webacs/api/v2/op">
      <cliTemplate>
        <content>String value</content>
        <description>String value</description>
        <deviceType>String value</deviceType>
        <name>String value</name>
        <path>String value</path>
        <tags>String value</tags>
        <variables>
          <variable>
            <defaultValue>String value</defaultValue>
            <description>String value</description>
            <displayLabel>String value</displayLabel>
            <name>String value</name>
            <rangeFrom>String value</rangeFrom>
            <rangeTo>String value</rangeTo>
            <required>true</required>
            <type>String value</type>
            <validationExpression>String value</validationExpression>
          </variable>
          <variable>
            <defaultValue>Another string value</defaultValue>
            <description>Another string value</description>
            <displayLabel>Another string value</displayLabel>
            <name>Another string value</name>
            <rangeFrom>Another string value</rangeFrom>
            <rangeTo>Another string value</rangeTo>
            <required>false</required>
            <type>Another string value</type>
            <validationExpression>Another string value</validationExpression>
          </variable>
        </variables>
        <version>String value</version>
      </cliTemplate>
    </mgmtResponse>

### Sample JSON Response Payload

https://10.64.88.203/webacs/api/v2/op/cliTemplateConfiguration/download.json?templateName=name

    {
      "mgmtResponse" : {
        "@requestUrl" : "https://10.64.88.203/webacs/api/v2/op/cliTemplateConfiguration/download?templateName=name",
        "@responseType" : "operation",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v2/op",
        "cliTemplate" : [ {
          "content" : "String value",
          "description" : "String value",
          "deviceType" : "String value",
          "name" : "String value",
          "path" : "String value",
          "tags" : "String value",
          "variables" : {
            "variable" : [ {
              "defaultValue" : "String value",
              "description" : "String value",
              "displayLabel" : "String value",
              "name" : "String value",
              "rangeFrom" : "String value",
              "rangeTo" : "String value",
              "required" : true,
              "type" : "String value",
              "validationExpression" : "String value"
            }, {
              "defaultValue" : "Another string value",
              "description" : "Another string value",
              "displayLabel" : "Another string value",
              "name" : "Another string value",
              "rangeFrom" : "Another string value",
              "rangeTo" : "Another string value",
              "required" : false,
              "type" : "Another string value",
              "validationExpression" : "Another string value"
            } ]
          },
          "version" : "String value"
        } ]
      }
    }

Resource unavailable for this API version

This resource was removed in API version 3.

Resource unavailable for this API version

This resource was removed in API version 3.