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

The following operation is supported on this resource:

  • POST - Preview CLI Congilget
POST /cli-configlets/{configlet-id}/preview-cli-configletVersion 3

Preview CLI Congilget.

Sample Usage

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


  • Parameters:
    NameTypeURI TypeDescriptionRequired
    configlet-idIntegerPathConfiglet ID Y
  • Sample Input XML:
    <preview-cli-configlet-request>
         <context>String</context>
         <cli-configlet-params>
               <cli-configlet-param>
                   <parameter href="/api/space/configuration-management/cli-configlets/{configletId}/cli-configlet-params/{paramId}"/>
                   <param-value>String</param-value>
               </cli-configlet-param>
         </cli-configlet-params>
         <device href="/api/space/device-management/devices/{id}"/>
    </preview-cli-configlet-request>

  • Sample Output XML:
    <preview-cli-configlet-response>
      <value>String</value>
    </preview-cli-configlet-response>

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

  • Sample Output JSON:
    {
      "preview-cli-configlet-response": {
        "value": "String"
      }
    }

  • Access Control

    The following capabilities are required to access this API: ApplyCliTemplateCap