Configuration Manager API

REST Resources

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

The following operations are supported on this resource:

GET - Gets a CLI configlet parameter

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

Version 1

This API is used to get the CLI configlet parameter by parameter ID and configlet ID.

Sample Usage

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

Parameters:

Name Type URI Type Description Required

configlet-id Integer Path The ID of the CLI configlet. Y

param-id Integer Path The parameter ID of the CLI configlet parameter Y

Accept Headers:
application/vnd.net.juniper.space.configuration-management.cli-configlet-param+xml;version=1;charset=UTF-8
application/vnd.net.juniper.space.configuration-management.cli-configlet-param+json;version=1;charset=UTF-8

XML
JSON

Sample Output XML:

<cli-configlet-param uri="/api/space/configuration-management/cli-configlets/491596/cli-configlet-params/491597">

              <id>491597</id>

              <parameter>SnmpViewName</parameter>

              <display-name>Vacm Access View Name</display-name>

              <description>description</description>

              <parameter-type>Text Field</parameter-type>

              <parameter-scope>Global</parameter-scope>

              <regex-value>regex</regex-value>

              <configured-value-xpath>xpath</configured-value-xpath>

              <default-value>default</default-value>

              <order>1</order>

            </cli-configlet-param>

Sample Output JSON:

{

              "cli-configlet-param": {

                "@uri": "/api/space/configuration-management/cli-configlets/491596/cli-configlet-params/491597",

                "id": "491597",

                "parameter": "SnmpViewName",

                "display-name": "Vacm Access View Name",

                "description": "description",

                "parameter-type": "Text Field",

                "parameter-scope": "Global",

                "regex-value": "regex",

                "configured-value-xpath": "xpath",

                "default-value": "default",

                "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

Name	Type	URI Type	Description	Required
configlet-id	Integer	Path	The ID of the CLI configlet.	Y
param-id	Integer	Path	The parameter ID of the CLI configlet parameter	Y