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

The following operations are supported on this resource:

  • POST - Applies a CLI configlet to a device
  • POST - Applies a CLI configlet to a device
POST /cli-configlets/{configlet-id}/apply-configletVersion 2

This API is used to apply the CLI configlet to the device.

Sample Usage

POST /cli-configlets/{configlet-id}/apply-configlet


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

    <cli-configlet-mgmt>
      <deviceId>393218</deviceId>
      <cli-configlet-param>
        <parameter>param1</parameter>
        <param-value>value2</param-value>
      </cli-configlet-param>
      <cli-configlet-param>
        <parameter>param2</parameter>
        <param-value>value2</param-value>
      </cli-configlet-param>
    </cli-configlet-mgmt>

  • Sample Output XML:

    <task href="/api/space/job-management/jobs/688132">
      <id>917507</id>
    </task>

  • Sample Input JSON:
      "cli-configlet-mgmt":{
        "deviceId":"123456",
        "cli-configlet-param":[{
         "parameter":"param1",
         "param-value":"param1value",
         },
         "{parameter":"param2",
         "param-value":"param2value",
        }]
      }

  • Sample Output JSON:

    {
      "task":{
        "@href":"/api/space/job-management/jobs/688132",
        "id":917507
      }

  • Access Control

    The following capabilities are required to access this API: ApplyCliTemplateCap

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


    POST /cli-configlets/{configlet-id}/apply-configlet
    (Deprecated)
    Version 3

    This API is used to apply the CLI configlet to the device.

    Sample Usage

    POST /cli-configlets/{configlet-id}/apply-configlet


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

    <cli-configlet-mgmt>
      <deviceId>393218</deviceId>
      <cli-configlet-param>
        <parameter>param1</parameter>
        <param-value>value2</param-value>
      </cli-configlet-param>
      <cli-configlet-param>
        <parameter>param2</parameter>
        <param-value>value2</param-value>
      </cli-configlet-param>
    </cli-configlet-mgmt>

  • Sample Output XML:

    <task href="/api/space/job-management/jobs/688132">
      <id>917507</id>
    </task>

  • Sample Input JSON:
      "cli-configlet-mgmt":{
        "deviceId":"123456",
        "cli-configlet-param":[{
         "parameter":"param1",
         "param-value":"param1value"
         },
         "{parameter":"param2",
         "param-value":"param2value"
        }]
      }

  • Sample Output JSON:

    {
      "task":{
        "@href":"/api/space/job-management/jobs/688132",
        "id":917507
      }

  • Access Control

    The following capabilities are required to access this API: ApplyCliTemplateCap