/api/space/configuration-management/cli-configlets/{id}

The following operations are supported on this resource:

  • GET - Gets a CLI configlet by ID
  • PUT - Updates a CLI configlet
  • DELETE - Deletes a CLI configlet
GET /cli-configlets/{id}Version 2

This API is used to get the CLI configlet by configlet ID.

Sample Usage

GET /cli-configlets/{id}


  • Parameters:
    NameTypeURI TypeDescriptionRequired
    idintPathThe ID of the CLI configlet to be retrieved. Y
  • Sample Output XML:

    <cli-configlet uri="/api/space/configuration-management/cli-configlets/3145734">
      <id>3145734</id>
      <name>ramesh</name>
      <context>tr</context>
      <device-family>EX</device-family>
      <reference-number>12</reference-number>
      <description>mb</description>
      <creation-time>Nov 27, 2012 3:19:09 PM</creation-time>
      <last-updated-time>Nov 28, 2012 4:46:38 PM</last-updated-time>
      <last-modified-by>super</last-modified-by>
      <cli-configlet-params href= "/api/space/configuration-management/cli-configlets/3145734/cli-configlet-params"; rel="view cli configlet params"/>
      <cli-configlet-pages href= "/api/space/configuration-management/cli-configlets/3145734/cli-configlet-pages" rel="view configuration pages";/>
      <apply-configlet href="/api/space/configuration-management/cli-configlets/3145734/apply-configlet" rel="apply cli configlet";/>
    </cli-configlet>

  • Access Control

    The following capabilities are required to access this API: ViewCliTemplateCap

      For other non-deprecated versions of this API, refer to :
    • version 1


    PUT /cli-configlets/{id}Version 2

    This API is used to update the CLI configlet.

    Sample Usage

    PUT /cli-configlets/{id}


    • Parameters:
      NameTypeURI TypeDescriptionRequired
      idIntegerPathThe ID of the CLI configlet. Y
  • Sample Input XML:

    <cli-configlet>
      <name>m</name>
      <category>catmodi</category>
      <context>context</context>
      <device-family>EX</device-family>
      <reference-number>12</reference-number>
      <description>description</description>
      <cli-configlet-params>
        <cli-configlet-param>
          <parameter> variable </parameter>
          <xpath> xpath</xpath>
          <display-name> dispaly name </display-name>
          <default-value> default </default-value>
          <param-order>1</param-order>
          <param-type>READWRITE</param-type>
        </cli-configlet-param>
        <cli-configlet-param>
          <parameter> variable </parameter>
          <xpath> xpath</xpath>
          <display-name> dispaly name </display-name>
          <default-value> default </default-value>
          <param-order>sdfsf</param-order>
          <param-type>READWRITE</param-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>

  • Access Control

    The following capabilities are required to access this API: EditCliTemplateCap

      For other non-deprecated versions of this API, refer to :
    • version 1


    DELETE /cli-configlets/{id}Version 2

    This API is used to delete the CLI configlet.

    Sample Usage

    DELETE /cli-configlets/{id}


    • Parameters:
      NameTypeURI TypeDescriptionRequired
      idIntegerPathThe ID of the CLI configlet to delete Y

    Access Control

    The following capabilities are required to access this API: DeleteCliTemplateCap