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

The following operation is supported on this resource:

  • POST - Gets a list list of CLI configlet params
POST /cli-configlets/{configlet-id}/cli-configlet-prepopulate-paramsVersion 2

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

Sample Usage

POST /cli-configlets/{configlet-id}/cli-configlet-prepopulate-params


  • Parameters:
    NameTypeURI TypeDescriptionRequired
    idIntegerPathThe ID of the CLI configlet for which a list of CLI configlet details will be retrieved. Y
  • Sample Input XML:
    <cli-configlet-mgmt>
      <deviceId>123</deviceId>
      <cli-configlet-param>
        <parameter>param1</parameter>
        <param-value>1</param-value>
      </cli-configlet-param>
      <cli-configlet-param>
        <parameter>param2</parameter>
        <param-value>2</param-value>
      </cli-configlet-param>
    </cli-configlet-mgmt>

  • Sample Output XML:
    <cli-configlet-prepopulate-params uri="/api/space/configuration-management/cli-configlets/491596/cli-configlet-prepopulate-params" size="8" total="8">
      <cli-configlet-param key="491601">
        <parameter>param1</parameter>
        <display-name>Display Name</display-name>
        <param-values-list>
          <param-value>1</param-value>
        </param-values-list>
      </cli-configlet-param>
      <cli-configlet-param key="491601">
        <parameter>param2</parameter>
        <display-name>Display Name</display-name>
        <param-values-list>
          <param-value>2</param-value>
        </param-values-list>
      </cli-configlet-param>
    </cli-configlet-prepopulate-params>

  • Sample Input JSON:
    {
      "cli-configlet-mgmt": {
        "deviceId": "123",
        "cli-configlet-param": [
          {
            "parameter": "param1",
            "param-value": "1"
          },
          {
            "parameter": "param2",
            "param-value": "2"
          }
        ]
      }
    }

  • Sample Output JSON:
    {
      "cli-configlet-prepopulate-params": {
        "@uri": "/api/space/configuration-management/cli-configlets/491596/cli-configlet-prepopulate-params",
        "@size": "8",
        "@total": "8",
        "cli-configlet-param": [
          {
            "@key": "491601",
            "parameter": "param1",
            "display-name": "Display Name",
            "param-values-list": [
              {
                "param-value": "1"
              }
            ]
          },
          {
            "@key": "491601",
            "parameter": "param2",
            "display-name": "Display Name",
            "param-values-list": [
              {
                "param-value": "2"
              }
            ]
          }
        ]
      }
    }

  • Access Control

    The following capabilities are required to access this API: ApplyCliTemplateCap