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} (v1)
The following operations are supported on this resource:
| GET /cli-configlets/{configlet-id} | Version 1 |
This API is used to get a CLI configlet by its configlet ID.
Sample Usage
GET /cli-configlets/{configlet-id}
-
Parameters:
Name Type URI Type Description Required id int Path CLIConfiglet id The ID of the configlet to retrieve. Y
-
Accept Headers:
application/vnd.net.juniper.space.configuration-management.view-cli-configlet+xml;version=1;charset=UTF-8
application/vnd.net.juniper.space.configuration-management.view-cli-configlet+json;version=1;charset=UTF-8
<cli-configlet uri="/api/space/configuration-management/cli-configlets/3145734">
<id>3145734</id>
<name>ramesh</name>
<category>Examples</category>
<context>tr</context>
<device-family>EX</device-family>
<execution-type>Single</execution-type>
<latest-version>1.0</latest-version>
<creation-time>Nov 27, 2012 3:19:09 PM</creation-time>
<last-updated-time>Nov 28, 2012 4:46:38 PM</last-updated-time>
<last-modified-by>super</last-modified-by>
<preview-show-parameters>true</preview-show-parameters>
<preview-show-configuration>true</preview-show-configuration>
<postview-show-parameters>true</postview-show-parameters>
<postview-show-configuration>true</postview-show-configuration>
<description>Single Execution - Port Description Example</description>
<domain-id>2</domain-id>
<domain-name>Global</domain-name>
<domain href="/api/space/domain-management/domains/2" />
<cli-configlet-params href="/api/space/configuration-management/cli-configlets/3145734/cli-configlet-params" />
<cli-configlet-pages href="/api/space/configuration-management/cli-configlets/3145734/cli-configlet-pages" />
<apply-configlet href="/api/space/configuration-management/cli-configlets/3145734/apply-configlet" />
<preview-cli-configlet href="/api/space/configuration-management/cli-configlets/3145734/preview-cli-configlet" />
<apply-cli-configlet href="/api/space/configuration-management/cli-configlets/3145734/apply-cli-configlet" />
<submit-cli-configlet href="/api/space/configuration-management/cli-configlets/3145734/submit-cli-configlet" />
<applicable-devices href="/api/space/configuration-management/cli-configlets/3145734/applicable-devices" />
<validate-cli-configlet href="/api/space/configuration-management/cli-configlets/3145734/validate-cli-configlet" />
</cli-configlet>
{
"cli-configlet": {
"@uri": "/api/space/configuration-management/cli-configlets/3145734",
"id": "3145734",
"name": "ramesh",
"category": "Examples",
"context": "tr",
"device-family": "EX",
"execution-type": "Single",
"latest-version": "1.0",
"creation-time": "Nov 27, 2012 3:19:09 PM",
"last-updated-time": "Nov 28, 2012 4:46:38 PM",
"last-modified-by": "super",
"preview-show-parameters": "true",
"preview-show-configuration": "true",
"postview-show-parameters": "true",
"postview-show-configuration": "true",
"description": "Single Execution - Port Description Example",
"domain-id": "2",
"domain-name": "Global",
"domain": {
"@href": "/api/space/domain-management/domains/2"
},
"cli-configlet-params": {
"@href": "/api/space/configuration-management/cli-configlets/3145734/cli-configlet-params"
},
"cli-configlet-pages": {
"@href": "/api/space/configuration-management/cli-configlets/3145734/cli-configlet-pages"
},
"apply-configlet": {
"@href": "/api/space/configuration-management/cli-configlets/3145734/apply-configlet"
},
"preview-cli-configlet": {
"@href": "/api/space/configuration-management/cli-configlets/3145734/preview-cli-configlet"
},
"apply-cli-configlet": {
"@href": "/api/space/configuration-management/cli-configlets/3145734/apply-cli-configlet"
},
"submit-cli-configlet": {
"@href": "/api/space/configuration-management/cli-configlets/3145734/submit-cli-configlet"
},
"applicable-devices": {
"@href": "/api/space/configuration-management/cli-configlets/3145734/applicable-devices"
},
"validate-cli-configlet": {
"@href": "/api/space/configuration-management/cli-configlets/3145734/validate-cli-configlet"
}
}
}
Access Control
The following capabilities are required to access this API: ViewCliTemplateCap
For the current version of this API, refer to :
| PUT /cli-configlets/{configlet-id} | Version 1 |
This API is used to update the CLI configlet.
Sample Usage
PUT /cli-configlets/{configlet-id}
-
Parameters:
Name Type URI Type Description Required id Integer Path The ID of the CLI Configlet Y
-
Content-Type Headers:
application/vnd.net.juniper.space.configuration-management.cli-configlet+xml;version=1;charset=UTF-8
application/vnd.net.juniper.space.configuration-management.cli-configlet+json;version=1;charset=UTF-8 -
Accept Headers:
application/vnd.net.juniper.space.configuration-management.view-cli-configlet+xml;version=1;charset=UTF-8
application/vnd.net.juniper.space.configuration-management.view-cli-configlet+json;version=1;charset=UTF-8
<cli-configlet>
<name>m</name>
<category>catmodi</category>
<context>context</context>
<device-family>EX</device-family>
<description>description</description>
<cli-configlet-params>
<cli-configlet-param>
<parameter>variable</parameter>
<xpath>xpath</xpath>
<display-name>dispaly name</display-name>
<default-value>default</default-value>
<param-order>1</param-order>
<param-type>READWRITE</param-type>
</cli-configlet-param>
<cli-configlet-param>
<parameter>variable</parameter>
<xpath>xpath</xpath>
<display-name>dispaly name</display-name>
<default-value>default</default-value>
<param-order>sdfsf</param-order>
<param-type>READWRITE</param-type>
</cli-configlet-param>
</cli-configlet-params>
<cli-configlet-pages>
<cli-configlet-page>
<cli-text>page1</cli-text>
<pagenumber>2</pagenumber>
</cli-configlet-page>
<cli-configlet-page>
<cli-text>page2</cli-text>
<pagenumber>2</pagenumber>
</cli-configlet-page>
</cli-configlet-pages>
</cli-configlet>
<cli-configlet uri="/api/space/configuration-management/cli-configlets/491538">
<id>491538</id>
<name>Example 1</name>
<category>Examples</category>
<context>/device/interface-information/physical-interface|/device/configuration/interfaces/interface</context>
<device-family>ACX/J/M/MX/T/TX/PTX/EX92xx/EX43xx</device-family>
<execution-type>Single</execution-type>
<latest-version>1.0</latest-version>
<creation-time>Jan 18, 2017 4:07:49 PM</creation-time>
<last-updated-time>Jan 18, 2017 4:07:49 PM</last-updated-time>
<last-modified-by>SYSTEM</last-modified-by>
<preview-show-parameters>true</preview-show-parameters>
<preview-show-configuration>true</preview-show-configuration>
<postview-show-parameters>true</postview-show-parameters>
<postview-show-configuration>true</postview-show-configuration>
<description>Single Execution - Port Description Example</description>
<domain-id>2</domain-id>
<domain-name>Global</domain-name>
<domain href="/api/space/domain-management/domains/2" />
<cli-configlet-params href="/api/space/configuration-management/cli-configlets/491538/cli-configlet-params" />
<cli-configlet-pages href="/api/space/configuration-management/cli-configlets/491538/cli-configlet-pages" />
<apply-configlet href="/api/space/configuration-management/cli-configlets/491538/apply-configlet" />
<preview-cli-configlet href="/api/space/configuration-management/cli-configlets/491538/preview-cli-configlet" />
<apply-cli-configlet href="/api/space/configuration-management/cli-configlets/491538/apply-cli-configlet" />
<submit-cli-configlet href="/api/space/configuration-management/cli-configlets/491538/submit-cli-configlet" />
<applicable-devices href="/api/space/configuration-management/cli-configlets/491538/applicable-devices" />
<validate-cli-configlet href="/api/space/configuration-management/cli-configlets/491538/validate-cli-configlet" />
</cli-configlet>
{
"cli-configlet": {
"name": "m",
"category": "catmodi",
"context": "context",
"device-family": "EX",
"description": "description",
"cli-configlet-params": {
"cli-configlet-param": [
{
"parameter": "variable",
"xpath": "xpath",
"display-name": "dispaly name",
"default-value": "default",
"param-order": "1",
"param-type": "READWRITE"
},
{
"parameter": "variable",
"xpath": "xpath",
"display-name": "dispaly name",
"default-value": "default",
"param-order": "sdfsf",
"param-type": "READWRITE"
}
]
},
"cli-configlet-pages": {
"cli-configlet-page": [
{
"cli-text": "page1",
"pagenumber": "2"
},
{
"cli-text": "page2",
"pagenumber": "2"
}
]
}
}
}
{
"cli-configlet": {
"@uri": "/api/space/configuration-management/cli-configlets/491538",
"id": "491538",
"name": "Example 1",
"category": "Examples",
"context": "/device/interface-information/physical-interface|/device/configuration/interfaces/interface",
"device-family": "ACX/J/M/MX/T/TX/PTX/EX92xx/EX43xx",
"execution-type": "Single",
"latest-version": "1.0",
"creation-time": "Jan 18, 2017 4:07:49 PM",
"last-updated-time": "Jan 18, 2017 4:07:49 PM",
"last-modified-by": "SYSTEM",
"preview-show-parameters": "true",
"preview-show-configuration": "true",
"postview-show-parameters": "true",
"postview-show-configuration": "true",
"description": "Single Execution - Port Description Example",
"domain-id": "2",
"domain-name": "Global",
"domain": {
"@href": "/api/space/domain-management/domains/2"
},
"cli-configlet-params": {
"@href": "/api/space/configuration-management/cli-configlets/491538/cli-configlet-params"
},
"cli-configlet-pages": {
"@href": "/api/space/configuration-management/cli-configlets/491538/cli-configlet-pages"
},
"apply-configlet": {
"@href": "/api/space/configuration-management/cli-configlets/491538/apply-configlet"
},
"preview-cli-configlet": {
"@href": "/api/space/configuration-management/cli-configlets/491538/preview-cli-configlet"
},
"apply-cli-configlet": {
"@href": "/api/space/configuration-management/cli-configlets/491538/apply-cli-configlet"
},
"submit-cli-configlet": {
"@href": "/api/space/configuration-management/cli-configlets/491538/submit-cli-configlet"
},
"applicable-devices": {
"@href": "/api/space/configuration-management/cli-configlets/491538/applicable-devices"
},
"validate-cli-configlet": {
"@href": "/api/space/configuration-management/cli-configlets/491538/validate-cli-configlet"
}
}
}
Access Control
The following capabilities are required to access this API: EditCliTemplateCap
For the current version of this API, refer to :
| DELETE /cli-configlets/{configlet-id} | Version 1 |
This API is used to delete the CLI configlet.
Sample Usage
DELETE /cli-configlets/{configlet-id}
-
Parameters:
Name Type URI Type Description Required id Integer Path The ID of the CLI configlet to delete Y
Access Control
The following capabilities are required to access this API: DeleteCliTemplateCap
For the current version of this API, refer to :