The following operation is supported on this resource:

  • POST - This API is used to apply a configlet on the device
POST /cli-configlets/{configlet-id}/apply-cli-configletVersion 3

This API is used to apply a configlet on the device.

Sample Usage

This API makes an asynchronous method call; so, you can optionally specify queue and schedule parameters:

POST /cli-configlets/{configlet-id}/apply-cli-configlet?queue=<queue>&schedule=<schedule>

Note: The queue URL denoted by <queue> must have been created already.

  • Parameters:
    NameTypeURI TypeDescriptionRequired
    configlet-idIntegerPathConfiglet ID Y
    queueQueue URLQueryA fully qualified queue URL, where job progress notifications will be sent (See Asynchronous API Usage)N
    schedulecron-like-expressionQuerySchedule this API in the future, by specifying a cron-like-expression (See Job Scheduling)N
  • Sample Input XML:
         <device href="/api/space/device-management/devices/{id}"/>
                   <parameter href="/api/space/configuration-management/cli-configlets/{configletId}/cli-configlet-params/{paramId}"/>

  • Sample Output XML:
    <task href="/api/space/job-management/jobs/3997704">

  • Sample Input JSON:
       "apply-cli-configlet-request" : {
         "device" : {
           "@href" : "/api/space/device-management/devices/{id}"
         "context" : "String" ,
         "cli-configlet-params" : {
           "cli-configlet-param" : [
               "parameter" : {
                 "@href" : "/api/space/configuration-management/cli-configlets/{configletId}/cli-configlet-params/{paramId}"
               "parameter-value" : "String"

  • Sample Output JSON:
      "task": {

  • Access Control

    The following capabilities are required to access this API: ApplyCliTemplateCap