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

# PUT cliTemplateConfiguration/deploy

Deprecated

This resource deploys templates in a synchronized way which may take a long time to respond. Use the resource Deploy Configuration Template Through Job instead

Deploy a template to a list of devices.

- Does not support ports selection for the 'Ports' type templates.
- Does not uptick deploy count.

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

## Request Payload Parameters

Attribute | Description
--- | ---
options DeployOptionsDTO | The deploy options.
Attribute | Description
--- | ---
copyConfigToStartup boolean | Copy Running Config to Startup. The default value is false. If value is true, the copying will be triggered after success/partial success deployment.
targetDeviceAndVariableValues CliTemplateCommandTarget[] | The devices to execute the template configuration against along with template variable values.
Attribute | Description
--- | ---
targetDeviceID String | The Id of the device to act upon.
variableValues VariableValue[] | The names and values of the variables.
Attribute | Description
--- | ---
name String | The name of the variable.
value String | The value of the variable, as a string.
templateName String | Required The template name to apply.

## Response Parameters

Attribute | Description
--- | ---
deviceResults CliTemplateCommandDeviceResult[] | Results of the template action for each device.
Attribute | Description
--- | ---
copyConfigResult CopyConfigResultEnum | Indicates copying config result. Defined only if the template was deployed with the option "copyConfigToStartup". Allowed values SUCCESS FAILED
deviceId String | The Id of the device for this result.
isSuccess boolean | Indicates the deployment result. If true, the deployment was successfully performed. If false, it ended in some failure condition.
message String | The action status message.
failureCount int | Count of failure results.
message String | Status message for the job.
successCount int | Count of successful results.
totalCount int | Total count of results.

## 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://172.20.127.108/webacs/api/v1/op/cliTemplateConfiguration/deploy

    <?xml version="1.0" ?>
    <cliTemplateCommand>
      <options>
        <copyConfigToStartup>true</copyConfigToStartup>
      </options>
      <targetDevices>
        <targetDevice>
          <targetDeviceID>String value</targetDeviceID>
          <variableValues>
            <variableValue>
              <name>String value</name>
              <value>String value</value>
            </variableValue>
            <variableValue>
              <name>Another string value</name>
              <value>Another string value</value>
            </variableValue>
          </variableValues>
        </targetDevice>
        <targetDevice>
          <targetDeviceID>Another string value</targetDeviceID>
          <variableValues>
            <variableValue>
              <name>String value</name>
              <value>String value</value>
            </variableValue>
            <variableValue>
              <name>Another string value</name>
              <value>Another string value</value>
            </variableValue>
          </variableValues>
        </targetDevice>
      </targetDevices>
      <templateName>String value</templateName>
    </cliTemplateCommand>

### Sample JSON Request Payload

https://172.20.127.108/webacs/api/v1/op/cliTemplateConfiguration/deploy.json

    {
      "cliTemplateCommand" : {
        "options" : {
          "copyConfigToStartup" : true
        },
        "targetDevices" : {
          "targetDevice" : [{
            "targetDeviceID" : "String value",
            "variableValues" : {
              "variableValue" : [{
                "name" : "String value",
                "value" : "String value"
              },
              {
                "name" : "Another string value",
                "value" : "Another string value"
              }]
            }
          },
          {
            "targetDeviceID" : "Another string value",
            "variableValues" : {
              "variableValue" : [{
                "name" : "String value",
                "value" : "String value"
              },
              {
                "name" : "Another string value",
                "value" : "Another string value"
              }]
            }
          }]
        },
        "templateName" : "String value"
      }
    }

### Sample XML Response Payload

https://172.20.127.108/webacs/api/v1/op/cliTemplateConfiguration/deploy

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="../../../../pages/common/login.jsp.html" rootUrl="https://172.20.127.108/webacs/api/v1/op">
      <cliTemplateCommandResult>
        <results>
          <result>
            <copyConfigResult>SUCCESS</copyConfigResult>
            <deviceId>String value</deviceId>
            <isSuccess>true</isSuccess>
            <message>String value</message>
          </result>
          <result>
            <copyConfigResult>FAILED</copyConfigResult>
            <deviceId>Another string value</deviceId>
            <isSuccess>false</isSuccess>
            <message>Another string value</message>
          </result>
        </results>
        <failureCount>1</failureCount>
        <message>String value</message>
        <successCount>1</successCount>
        <totalCount>1</totalCount>
      </cliTemplateCommandResult>
    </mgmtResponse>

### Sample JSON Response Payload

https://172.20.127.108/webacs/api/v1/op/cliTemplateConfiguration/deploy.json

    {
      "mgmtResponse" : {
        "@responseType" : "operation",
        "@requestUrl" : "https : \/\/172.20.127.108\/webacs\/api\/v1\/op\/cliTemplateConfiguration\/deploy",
        "@rootUrl" : "https : \/\/172.20.127.108\/webacs\/api\/v1\/op",
        "cliTemplateCommandResult" : {
          "results" : {
            "result" : [{
              "copyConfigResult" : "SUCCESS",
              "deviceId" : "String value",
              "isSuccess" : true,
              "message" : "String value"
            },
            {
              "copyConfigResult" : "FAILED",
              "deviceId" : "Another string value",
              "isSuccess" : false,
              "message" : "Another string value"
            }]
          },
          "failureCount" : 1,
          "message" : "String value",
          "successCount" : 1,
          "totalCount" : 1
        }
      }
    }

### 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/cliTemplateConfiguration/deploy

Unmodified

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

## Request Payload Parameters

Attribute | Description
--- | ---
options DeployOptionsDTO | The deploy options.
Attribute | Description
--- | ---
copyConfigToStartup boolean | Copy Running Config to Startup. The default value is false. If value is true, the copying will be triggered after success/partial success deployment.
targetDeviceAndVariableValues CliTemplateCommandTarget[] | The devices to execute the template configuration against along with template variable values.
Attribute | Description
--- | ---
targetDeviceID String | The Id of the device to act upon.
variableValues VariableValue[] | The names and values of the variables.
Attribute | Description
--- | ---
name String | The name of the variable.
value String | The value of the variable, as a string.
templateName String | Required The template name to apply.

## Response Parameters

Attribute | Description
--- | ---
deviceResults CliTemplateCommandDeviceResult[] | Results of the template action for each device.
Attribute | Description
--- | ---
copyConfigResult CopyConfigResultEnum | Indicates copying config result. Defined only if the template was deployed with the option "copyConfigToStartup". Allowed values SUCCESS FAILED
deviceId String | The Id of the device for this result.
isSuccess boolean | Indicates the deployment result. If true, the deployment was successfully performed. If false, it ended in some failure condition.
message String | The action status message.
failureCount int | Count of failure results.
message String | Status message for the job.
successCount int | Count of successful results.
totalCount int | Total count of results.

## 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://172.20.127.108/webacs/api/v2/op/cliTemplateConfiguration/deploy

    <?xml version="1.0" ?>
    <cliTemplateCommand>
      <options>
        <copyConfigToStartup>true</copyConfigToStartup>
      </options>
      <targetDevices>
        <targetDevice>
          <targetDeviceID>String value</targetDeviceID>
          <variableValues>
            <variableValue>
              <name>String value</name>
              <value>String value</value>
            </variableValue>
            <variableValue>
              <name>Another string value</name>
              <value>Another string value</value>
            </variableValue>
          </variableValues>
        </targetDevice>
        <targetDevice>
          <targetDeviceID>Another string value</targetDeviceID>
          <variableValues>
            <variableValue>
              <name>String value</name>
              <value>String value</value>
            </variableValue>
            <variableValue>
              <name>Another string value</name>
              <value>Another string value</value>
            </variableValue>
          </variableValues>
        </targetDevice>
      </targetDevices>
      <templateName>String value</templateName>
    </cliTemplateCommand>

### Sample JSON Request Payload

https://172.20.127.108/webacs/api/v2/op/cliTemplateConfiguration/deploy.json

    {
      "cliTemplateCommand" : {
        "options" : {
          "copyConfigToStartup" : true
        },
        "targetDevices" : {
          "targetDevice" : [ {
            "targetDeviceID" : "String value",
            "variableValues" : {
              "variableValue" : [ {
                "name" : "String value",
                "value" : "String value"
              }, {
                "name" : "Another string value",
                "value" : "Another string value"
              } ]
            }
          }, {
            "targetDeviceID" : "Another string value",
            "variableValues" : {
              "variableValue" : [ {
                "name" : "String value",
                "value" : "String value"
              }, {
                "name" : "Another string value",
                "value" : "Another string value"
              } ]
            }
          } ]
        },
        "templateName" : "String value"
      }
    }

### Sample XML Response Payload

https://172.20.127.108/webacs/api/v2/op/cliTemplateConfiguration/deploy

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="../../../../pages/common/login.jsp.html" rootUrl="https://172.20.127.108/webacs/api/v2/op">
      <cliTemplateCommandResult>
        <results>
          <result>
            <copyConfigResult>SUCCESS</copyConfigResult>
            <deviceId>String value</deviceId>
            <isSuccess>true</isSuccess>
            <message>String value</message>
          </result>
          <result>
            <copyConfigResult>FAILED</copyConfigResult>
            <deviceId>Another string value</deviceId>
            <isSuccess>false</isSuccess>
            <message>Another string value</message>
          </result>
        </results>
        <failureCount>1</failureCount>
        <message>String value</message>
        <successCount>1</successCount>
        <totalCount>1</totalCount>
      </cliTemplateCommandResult>
    </mgmtResponse>

### Sample JSON Response Payload

https://172.20.127.108/webacs/api/v2/op/cliTemplateConfiguration/deploy.json

    {
      "mgmtResponse" : {
        "@requestUrl" : "../../../../pages/common/login.jsp.html",
        "@responseType" : "operation",
        "@rootUrl" : "https://172.20.127.108/webacs/api/v2/op",
        "cliTemplateCommandResult" : [ {
          "failureCount" : 1,
          "message" : "String value",
          "results" : {
            "result" : [ {
              "copyConfigResult" : "SUCCESS",
              "deviceId" : "String value",
              "isSuccess" : true,
              "message" : "String value"
            }, {
              "copyConfigResult" : "FAILED",
              "deviceId" : "Another string value",
              "isSuccess" : false,
              "message" : "Another string value"
            } ]
          },
          "successCount" : 1,
          "totalCount" : 1
        } ]
      }
    }

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.