Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

GET CliTemplate

CLI configuration templates.

Since Product Version: 2.2

Resource Information

Rate Limiting?

Yes

Sorting?

Yes

Paging?

Yes

Filtering?

Yes

Group Filtering?

No

Aggregation?

No

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

Resource URL

/webacs/api/v3/data/CliTemplate

Unmodified

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

Deprecated

This version has been deprecated in favor of the v4 version, which allows for easier filtering of tags.

Response Parameters

Attribute Description

author String

Template author

configContainerId long

Config container ID

content String

Content of the template.

Filtering/sorting does not work on this property.

createdOn Date

Time when template was created or uploaded

deployCount long

Number of deployments of this template

deployJobCount long

Number of jobs to deploy this template

description String

Human-readable description of the template

deviceType String

Comma-separated list of devices on which the template is allowed to be deployed

lastDeployTime Date

Time of last successful deployment of this template

name String

Name of the template

path String

Full name of folder where the template is stored

tags String

Tag list separated by comma

templateId long

Template ID

userTags String[]

User-defined tags list

variable Arrow image CliTemplateVariable[]

CLI Template variables used in content. Variables have the same order in which they were created.

Filtering/sorting does not work on this property.

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 Payload

https://localhost/webacs/api/v3/data/CliTemplate/15

<?xml version="1.0" ?>
<queryResponse type="CliTemplate" responseType="getEntity" requestUrl="https://localhost/webacs/api/v3/data/CliTemplate/15" rootUrl="https://localhost/webacs/api/v3/data">
  <entity dtoType="cliTemplateDTO" type="CliTemplate" url="https://localhost/webacs/api/v3/data/CliTemplate/15">
    <cliTemplateDTO displayName="String value" id="15" uuid="String value">
      <author>String value</author>
      <configContainerId>2</configContainerId>
      <content>String value</content>
      <createdOn>1986-07-24T00:00:00+08:00</createdOn>
      <deployCount>2</deployCount>
      <deployJobCount>2</deployJobCount>
      <description>String value</description>
      <deviceType>String value</deviceType>
      <lastDeployTime>1986-07-24T00:00:00+08:00</lastDeployTime>
      <name>String value</name>
      <path>String value</path>
      <tags>String value</tags>
      <templateId>2</templateId>
      <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>String value</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>Another string value</required>
          <type>Another string value</type>
          <validationExpression>Another string value</validationExpression>
        </variable>
      </variables>
      <version>String value</version>
      <userTags>
        <userTag>String value</userTag>
        <userTag>Another string value</userTag>
      </userTags>
    </cliTemplateDTO>
  </entity>
</queryResponse>

Sample JSON Payload

https://localhost/webacs/api/v3/data/CliTemplate/15.json

{
  "queryResponse" : {
    "@type" : "CliTemplate",
    "@requestUrl" : "https://localhost/webacs/api/v3/data/CliTemplate/15",
    "@responseType" : "getEntity",
    "@rootUrl" : "https://localhost/webacs/api/v3/data",
    "entity" : [ {
      "@dtoType" : "cliTemplateDTO",
      "@type" : "CliTemplate",
      "@url" : "https://localhost/webacs/api/v3/data/CliTemplate/15",
      "cliTemplateDTO" : {
        "@displayName" : "String value",
        "@id" : 15,
        "@uuid" : "String value",
        "author" : "String value",
        "configContainerId" : 2,
        "content" : "String value",
        "createdOn" : "1986-07-23T16:00:00.000Z",
        "deployCount" : 2,
        "deployJobCount" : 2,
        "description" : "String value",
        "deviceType" : "String value",
        "lastDeployTime" : "1986-07-23T16:00:00.000Z",
        "name" : "String value",
        "path" : "String value",
        "tags" : "String value",
        "templateId" : 2,
        "userTags" : {
          "userTag" : [ "String value", "Another string value" ]
        },
        "variables" : {
          "variable" : [ {
            "defaultValue" : "String value",
            "description" : "String value",
            "displayLabel" : "String value",
            "name" : "String value",
            "rangeFrom" : "String value",
            "rangeTo" : "String value",
            "required" : "String value",
            "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" : "Another string value",
            "type" : "Another string value",
            "validationExpression" : "Another string value"
          } ]
        },
        "version" : "String value"
      }
    } ]
  }
}