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

The following operation is supported on this resource:

  • POST - Validate the Configlet On Device with the Configlet Parameters if any
POST /cli-configlets/{configlet-id}/validate-cli-configletVersion 1

Validate the Configlet On Device with the Configlet Parameters if any.

Sample Usage

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

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


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


  • Parameters:
    NameTypeURI TypeDescriptionRequired
    configlet-idIntegerPathUnique ID of the Configlet 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:
    <validate-cli-configlet>
         <device href="/api/space/device-management/devices/{id}"/>
         <context>String</context>
         <cli-configlet-params>
               <cli-configlet-param>
                   <parameter href="/api/space/configuration-management/cli-configlets/{configletId}/cli-configlet-params/{paramId}"/>
                   <parameter-value>String</parameter-value>
               </cli-configlet-param>
         </cli-configlet-params>
    </validate-cli-configlet>

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

  • Sample Input JSON:
    {
       "validate-cli-configlet" : {
         "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": {
        "@href":"/api/space/job-management/jobs/3997704",
        "id":3997704
      }
    }

  • Access Control

    The following capabilities are required to access this API: ApplyCliTemplateCap