REST Resources
-
/ -
/apply-cli-configlet-job-results /{id} -
/change-requests -
/change-requests /{id} -
/cli-configlets -
/cli-configlets /cli-configlets-by-context -
/cli-configlets /{configlet-id} -
/cli-configlets /{configlet-id} /applicable-devices -
/cli-configlets /{configlet-id} /apply-cli-configlet -
/cli-configlets /{configlet-id} /apply-configlet -
/cli-configlets /{configlet-id} /cli-configlet-pages -
/cli-configlets /{configlet-id} /cli-configlet-pages /{configuration-id} -
/cli-configlets /{configlet-id} /cli-configlet-pages /{configuration-id} /cli-text -
/cli-configlets /{configlet-id} /cli-configlet-params -
/cli-configlets /{configlet-id} /cli-configlet-params /{param-id} -
/cli-configlets /{configlet-id} /cli-configlet-prepopulate-params -
/cli-configlets /{configlet-id} /compute-parameter-values -
/cli-configlets /{configlet-id} /preview-cli-configlet -
/cli-configlets /{configlet-id} /submit-cli-configlet -
/cli-configlets /{configlet-id} /validate-cli-configlet -
/configuration-views -
/configuration-views /{config-viewer-id} -
/configuration-views /{config-viewer-id} /configuration-view-params /{param-id} -
/exec-commands -
/execute-export-device-configuration -
/job-instances /{job-id} /apply-cli-configlet-job-results -
/job-instances /{job-id} /deploy-configuration-job-results -
/job-instances /{job-id} /validate-cli-configlet-job-results -
/jobs /{job-id} /export-configuration-datas -
/match-cli-configlets-by-context -
/push-configuration -
/retry-deploy-configuration
/api/space/configuration-management/cli-configlets/{configlet-id}/cli-configlet-params/{param-id}
The following operations are supported on this resource:
| GET /cli-configlets/{configlet-id}/cli-configlet-params/{param-id} | Version 3 |
This API is used to fetch the specified parameter details of the specified configlet.
Sample Usage
GET /cli-configlets/{configlet-id}/cli-configlet-params/{param-id}
-
Parameters:
Name Type URI Type Description Required configlet-id Integer Path Configlet ID Y param-id Integer Path Param ID Y
-
Accept Headers:
application/vnd.net.juniper.space.configuration-management.cli-configlet-param+xml;version=3
application/vnd.net.juniper.space.configuration-management.cli-configlet-param+json;version=3
<cli-configlet-param uri="/api/space/configuration-management/cli-configlets/{configlet-id}/cli-configlet-params/{param-id}">
<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>
<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}">
<param-id>Integer</param-id>
<name>String</name>
<configlet-id>Integer</configlet-id>
</parameter>
</dependent-parameter>
</dependent-parameter-list>
</cli-configlet-param>
{
"cli-configlet-param" : {
"@uri" : "/api/space/configuration-management/cli-configlets/{configlet-id}/cli-configlet-params/{param-id}",
"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" ,
"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}",
"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-params/{param-id} | Version 2 |
This API is used to get the CLI configlet param by param 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 ID of the CLI configlet param Y
-
Accept Headers:
application/vnd.net.juniper.space.configuration-management.cli-configlet-param+xml;version=2;charset=UTF-8
application/vnd.net.juniper.space.configuration-management.cli-configlet-param+json;version=2;charset=UTF-8
<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>
{
"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 other non-deprecated versions of this API, refer to :