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

The following operations are supported on this resource:

  • GET - This API is used to fetch all the parameters exist in the specified configlet
  • GET - Gets a list of parameter details for a CLI configlet
GET /cli-configlets/{configlet-id}/cli-configlet-paramsVersion 3

This API is used to fetch all the parameters exist in the specified configlet.

Sample Usage

GET /cli-configlets/{configlet-id}/cli-configlet-params


  • Parameters:
    NameTypeURI TypeDescriptionRequired
    configlet-idIntegerPathConfiglet ID Y
  • Sample Output XML:
    <cli-configlet-params total="Integer" uri="/api/space/configuration-management/cli-configlets/{configlet-id}/cli-configlet-params">
         <cli-configlet-param
               href="/api/space/configuration-management/cli-configlets/{configletId}/cli-configlet-params/{id}" uri="/api/space/configuration-management/cli-configlets/{configlet-id}/cli-configlet-params">
               <id>Integer</id>
               <configlet-id>Integer</configlet-id>
               <parameter>String</parameter>
               <display-name>String</display-name>
               <description>String</description>
               <parameter-scope>GLOBAL</parameter-scope>
               <parameter-type>READWRITE</parameter-type>
               <regex-value>String</regex-value>
               <configured-value-xpath>String</configured-value-xpath>
               <default-value>String</default-value>
               <selection-values-xpath>String</selection-values-xpath>
               <selection-values>String</selection-values>
               <order>Integer</order>
               <read-only>Boolean</read-only>
               <dependent-parameter-list>
                   <dependent-parameter>
                         <parameter
                             href="/api/space/configuration-management/cli-configlets/{configletId}/cli-configlet-params/{paramId}" uri="/api/space/configuration-management/cli-configlets/{configlet-id}/cli-configlet-params">
                             <param-id>Integer</param-id>
                             <name>String</name>
                             <configlet-id>Integer</configlet-id>
                         </parameter>
                   </dependent-parameter>
               </dependent-parameter-list>
         </cli-configlet-param>
    </cli-configlet-params>

  • Sample Output JSON:
    {
       "cli-configlet-params" : {
         "@total" : "Integer" ,
         "@uri" :
         "/api/space/configuration-management/cli-configlets/{configlet-id}/cli-configlet-params"
         ,
         "cli-configlet-param" : {
           "@href" :
           "/api/space/configuration-management/cli-configlets/{configletId}/cli-configlet-params/{id}"
           ,
           "@uri" :
           "/api/space/configuration-management/cli-configlets/{configlet-id}/cli-configlet-params"
           ,
           "id" : "Integer" ,
           "configlet-id" : "Integer" ,
           "parameter" : "String" ,
           "display-name" : "String" ,
           "description" : "String" ,
           "parameter-scope" : "GLOBAL" ,
           "parameter-type" : "READWRITE" ,
           "regex-value" : "String" ,
           "configured-value-xpath" : "String" ,
           "default-value" : "String" ,
           "selection-values-xpath" : "String" ,
           "selection-values" : "String" ,
           "order" : "Integer" ,
           "read-only" : "Boolean" ,
           "dependent-parameter-list" : {
             "dependent-parameter" : {
               "parameter" : {
                 "@href" :
                 "/api/space/configuration-management/cli-configlets/{configletId}/cli-configlet-params/{paramId}"
                 ,
                 "@uri" :
                 "/api/space/configuration-management/cli-configlets/{configlet-id}/cli-configlet-params"
                 ,
                 "param-id" : "Integer" ,
                 "name" : "String" ,
                 "configlet-id" : "Integer"
               }
             }
           }
         }
       }
    }

  • Access Control

    The following capabilities are required to access this API: ViewCliTemplateCap

    GET /cli-configlets/{configlet-id}/cli-configlet-paramsVersion 2

    This API is used to get a list of parameter details for a CLI configlet.

    Sample Usage

    GET /cli-configlets/{configlet-id}/cli-configlet-params


    • Parameters:
      NameTypeURI TypeDescriptionRequired
      idIntegerPathThe ID of the CLI configlet for wich a list of parameer details will be retrieved. Y
  • Sample Output XML:

    <cli-configlet-params uri="/api/space/configuration-management/cli-configlets /3670027/cli-configlet-params">
      <cli-configlet-param href="/api/space/configuration-management/cli -configlets/3670027/cli-configlet-params/3670030" uri="/api/space/configuration -management/cli-configlets/3670027/cli-configlet-params/3670030" key="3670030">
        <parameter>variable</parameter>
        <param-order>1</param-order>
        <display-name>dispaly name</display-name>
      </cli-configlet-param>
    </cli-configlet-params>

  • Access Control

    The following capabilities are required to access this API: ViewCliTemplateCap

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