/api/space/configuration-management/cli-configlets (v1)

The following operations are supported on this resource:

  • GET - Gets all CLI configlets
  • POST - Adds a CLI configlet
GET /cli-configletsVersion 1

This API is used to get all CLI configlets.

Sample Usage

GET /cli-configlets


  • Sample Output XML:
    <cli-configlets total="1" size="1"
      uri="/api/space/configuration-management/cli-configlets">
     <cli-configlet key="65859" uri= "/api/space/configuration-management/cli-configlets/65859"
      href= "/api/space/configuration-management/cli-configlets/65859">
      <category>test</category>
      <device-family>EX</device-family>
      <name>ramesh</name>
     </cli-configlet>
    </cli-configlets>

  • Sample Output JSON:
    {"cli-configlets": 
    {"@size":"1","@total":"1","@uri": "/api/space/configuration-management/cli-configlets"
     "cli-configlet":[{"@key":"65859",
      "@uri": "/api/space/configuration-management/cli-configlets/65859",
      "@href": "/api/space/configuration-management/cli-configlets/65859",
      "category":"test",
      "device-family":"EX",
      "name":"ramesh"
     }]
    }}

  • Access Control

    The following capabilities are required to access this API: ManageCliTemplatesCap

      For the current version of this API, refer to :
    • version 2

    POST /cli-configletsVersion 1

    This API is used to add a CLI configlet.

    Sample Usage

    POST /cli-configlets


  • Sample Input XML:
    <cli-configlet>
      <name>CLI_Configlet</name>
      <category>Device</category>
      <context>/device</context>
      <device-family>EX</device-family>
      <description>Sample CLI Configlets</description>
      <execution-type>Single</execution-type>
      <cli-configlet-params>
        <cli-configlet-param>
          <parameter>DESCRIPTION</parameter>
          <xpath>xpath</xpath>
          <display-name>DESCRIPTION name</display-name>
          <default-value>default</default-value>
          <parameter-order>1</parameter-order>
          <parameter-type>Text Field</parameter-type>
        </cli-configlet-param>
        <cli-configlet-param>
          <parameter>DESC</parameter>
          <xpath>xpath</xpath>
          <display-name>DESC name</display-name>
          <default-value>default</default-value>
          <parameter-order>sdfsf</parameter-order>
          <parameter-type>Invisible Field</parameter-type>
        </cli-configlet-param>
      </cli-configlet-params>
      <cli-configlet-pages>
        <cli-configlet-page>
          <cli-text>page1</cli-text>
          <pagenumber>2</pagenumber>
        </cli-configlet-page>
        <cli-configlet-page>
          <cli-text>page2</cli-text>
          <pagenumber>2</pagenumber>
        </cli-configlet-page>
      </cli-configlet-pages>
    </cli-configlet>

  • Sample Output XML:
    <cli-configlet uri="/api/space/configuration-management/cli-configlets/10715138">
      <id>10715138</id>
      <name>CLI_Configlet</name>
      <category>Device</category>
      <context>/device</context>
      <device-family>EX</device-family>
      <execution-type>Single</execution-type>
      <creation-time>Mar 9, 2017 5:18:55 PM</creation-time>
      <last-updated-time>Mar 9, 2017 5:18:55 PM</last-updated-time>
      <last-modified-by>super</last-modified-by>
      <preview-show-parameters>true</preview-show-parameters>
      <preview-show-configuration>true</preview-show-configuration>
      <postview-show-parameters>true</postview-show-parameters>
      <postview-show-configuration>true</postview-show-configuration>
      <description>Sample CLI Configlets</description>
      <domain />
      <cli-configlet-params href="/api/space/configuration-management/cli-configlets/10715138/cli-configlet-params" />
      <cli-configlet-pages href="/api/space/configuration-management/cli-configlets/10715138/cli-configlet-pages" />
      <apply-configlet href="/api/space/configuration-management/cli-configlets/10715138/apply-configlet" />
      <preview-cli-configlet href="/api/space/configuration-management/cli-configlets/10715138/preview-cli-configlet" />
      <apply-cli-configlet href="/api/space/configuration-management/cli-configlets/10715138/apply-cli-configlet" />
      <submit-cli-configlet href="/api/space/configuration-management/cli-configlets/10715138/submit-cli-configlet" />
      <applicable-devices href="/api/space/configuration-management/cli-configlets/10715138/applicable-devices" />
      <validate-cli-configlet href="/api/space/configuration-management/cli-configlets/10715138/validate-cli-configlet" />
    </cli-configlet>

  • Sample Input JSON:
    {
      "cli-configlet": {
        "name": "CLI_Configlet",
        "category": "Device",
        "context": "/device",
        "device-family": "EX",
        "description": "Sample CLI Configlets",
        "execution-type": "Single",
        "cli-configlet-params": {
          "cli-configlet-param": [
            {
              "parameter": "DESCRIPTION",
              "xpath": "xpath",
              "display-name": "DESCRIPTION name",
              "default-value": "default",
              "parameter-order": "1",
              "parameter-type": "Text Field"
            },
            {
              "parameter": "DESC",
              "xpath": "xpath",
              "display-name": "DESC name",
              "default-value": "default",
              "parameter-order": "2",
              "parameter-type": "Invisible Field"
            }
          ]
        },
        "cli-configlet-pages": {
          "cli-configlet-page": [
            {
              "cli-text": "page1",
              "pagenumber": "2"
            },
            {
              "cli-text": "page2",
              "pagenumber": "2"
            }
          ]
        }
      }
    }

  • Sample Output JSON:
    {
      "cli-configlet": {
        "@uri": "/api/space/configuration-management/cli-configlets/10715138",
        "id": "10715138",
        "name": "CLI_Configlet",
        "category": "Device",
        "context": "Device",
        "device-family": "EX",
        "execution-type": "Single",
        "creation-time": "Mar 9, 2017 5:18:55 PM",
        "last-updated-time": "Mar 9, 2017 5:18:55 PM",
        "last-modified-by": "super",
        "preview-show-parameters": "true",
        "preview-show-configuration": "true",
        "postview-show-parameters": "true",
        "postview-show-configuration": "true",
        "description": "Sample CLI Configlets",
        "cli-configlet-params": {
          "@href": "/api/space/configuration-management/cli-configlets/10715138/cli-configlet-params"
        },
        "cli-configlet-pages": {
          "@href": "/api/space/configuration-management/cli-configlets/10715138/cli-configlet-pages"
        },
        "apply-configlet": {
          "@href": "/api/space/configuration-management/cli-configlets/10715138/apply-configlet"
        },
        "preview-cli-configlet": {
          "@href": "/api/space/configuration-management/cli-configlets/10715138/preview-cli-configlet"
        },
        "apply-cli-configlet": {
          "@href": "/api/space/configuration-management/cli-configlets/10715138/apply-cli-configlet"
        },
        "submit-cli-configlet": {
          "@href": "/api/space/configuration-management/cli-configlets/10715138/submit-cli-configlet"
        },
        "applicable-devices": {
          "@href": "/api/space/configuration-management/cli-configlets/10715138/applicable-devices"
        },
        "validate-cli-configlet": {
          "@href": "/api/space/configuration-management/cli-configlets/10715138/validate-cli-configlet"
        }
      }
    }

  • Access Control

    The following capabilities are required to access this API: NewCliTemplateCap

      For the current version of this API, refer to :
    • version 2