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

The following operations are supported on this resource:

  • GET - Gets a list of parameter details for a CLI configlet
GET /cli-configlets/{configlet-id}/cli-configlet-paramsVersion 1

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

Sample Usage

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


  • Parameters:
    NameTypeURI TypeDescriptionRequired
    idIntegerPath   Y
  • Sample Output XML:
    <cli-configlet-params uri="/api/space/configuration-management/cli-configlets/491596/cli-configlet-params" size="9" total="9">
      <cli-configlet-param href="/api/space/configuration-management/cli-configlets/491596/cli-configlet-params/491597" uri="/api/space/configuration-management/cli-configlets/491596/cli-configlet-params/491597" key="491597">
        <parameter>SnmpViewName</parameter>
        <display-name>Vacm Access View Name</display-name>
        <regex-value>String</regex-value>
        <parameter-type>Text Field</parameter-type>
        <parameter-scope>Global</parameter-scope>
        <order>1</order>
      </cli-configlet-param>
    </cli-configlet-params>

  • Sample Output JSON:
    {
      "cli-configlet-params": {
        "@uri": "/api/space/configuration-management/cli-configlets/491596/cli-configlet-params",
        "@size": "9",
        "@total": "9",
        "cli-configlet-param": [
          {
            "@href": "/api/space/configuration-management/cli-configlets/491596/cli-configlet-params/491597",
            "@uri": "/api/space/configuration-management/cli-configlets/491596/cli-configlet-params/491597",
            "@key": "491597",
            "parameter": "SnmpViewName",
            "display-name": "Vacm Access View Name",
            "regex-value": "String",
            "parameter-type": "Text Field",
            "parameter-scope": "Global",
            "order": "1"
          }
        ]
      }
    }

  • Access Control

    The following capabilities are required to access this API: ViewCliTemplateCap

      For the current version of this API, refer to :
    • version 2