REST Resources

/api/space/device-management/devices/{device-id}/validate-cli-configlet

The following operation is supported on this resource:

  • POST - Validates the Cli Configlet on the Device with the Parameters if any
POST /devices/{device-id}/validate-cli-configletVersion 5

Validates the Cli Configlet on the Device with the Parameters if any.

Sample Usage

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

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


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


  • Parameters:
    NameTypeURI TypeDescriptionRequired
    device-idIntegerPathUnique ID of the Device 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>
         <configlet href="/api/space/configuration-management/cli-configlets/2588695"/>
         <cli-configlet-params>
               <cli-configlet-param>
                   <parameter href="/api/space/configuration-management/cli-configlets/2588695/cli-configlet-params/2588696"/>
                   <parameter-value>Param_value</parameter-value>
               </cli-configlet-param>
         </cli-configlet-params>
    </validate-cli-configlet>

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

  • Sample Input JSON:
    {
      "validate-cli-configlet": {
        "configlet": {
          "@href": "/api/space/configuration-management/cli-configlets/2588695"
        },
        "cli-configlet-params": {
          "cli-configlet-param": [
            {
              "parameter": {
                "@href": "/api/space/configuration-management/cli-configlets/2588695/cli-configlet-params/2588696"
              },
              "parameter-value": "Param_value"
            }
          ]
        }
      }
    }

  • Sample Output JSON:
    {
      "task": {
        "@href":"/api/space/job-management/jobs/884755",
        "id":"884755"
      }
    }

  • Access Control

    The following capabilities are required to access this API: ApplyCliTemplateCap