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}
The following operations are supported on this resource:
- GET - This API is used to fetch a specific configlet details based on the configlet ID
- GET - Gets a CLI configlet by ID
- PUT - This API is used to update/modify the existing configlet
- PUT - Updates a CLI configlet
- PATCH - This API is used to update the configlet partially
- DELETE - This API is used to delete a configlet
GET /cli-configlets/{configlet-id} | Version 3 |
This API is used to fetch a specific configlet details based on the configlet ID.
Sample Usage
GET /cli-configlets/{configlet-id}
-
Parameters:
Name Type URI Type Description Required configlet-id Integer Path Configlet ID Y
-
Accept Headers:
application/vnd.net.juniper.space.configuration-management.cli-configlet+xml;version=3
application/vnd.net.juniper.space.configuration-management.cli-configlet+json;version=3
<cli-configlet
href="/api/space/configuration-management/cli-configlets/{id}" uri="/api/space/configuration-management/cli-configlets/{configlet-id}">
<id>Integer</id>
<name>String</name>
<latest-version>String</latest-version>
<category>String</category>
<description>String</description>
<context>String</context>
<reference-number>Integer</reference-number>
<device-family>String</device-family>
<execution-type>SINGLE</execution-type>
<preview-show-parameters>Boolean</preview-show-parameters>
<preview-show-configuration>Boolean</preview-show-configuration>
<postview-show-parameters>Boolean</postview-show-parameters>
<postview-show-configuration>Boolean</postview-show-configuration>
<domain-id>Integer</domain-id>
<domain-name>String</domain-name>
<creation-time>java.util.Date</creation-time>
<last-updated-time>java.util.Date</last-updated-time>
<last-modified-by>String</last-modified-by>
<cli-text>String</cli-text>
<cli-configlet-params total="Integer" uri="/api/space/configuration-management/cli-configlets/{configlet-id}/cli-configlet-params">
<cli-configlet-param>
<id>Integer</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>
</cli-configlet-param>
</cli-configlet-params>
<compute-parameter-values href="/api/space/configuration-management/cli-configlets/{id}/compute-parameter-values"/>
<apply-cli-configlet href="/api/space/configuration-management/cli-configlets/{id}/apply-cli-configlet"/>
</cli-configlet>
{
"cli-configlet" : {
"@href" : "/api/space/configuration-management/cli-configlets/{id}" ,
"@uri" : "/api/space/configuration-management/cli-configlets/{configlet-id}",
"id" : "Integer" ,
"name" : "String" ,
"latest-version" : "String" ,
"category" : "String" ,
"description" : "String" ,
"context" : "String" ,
"reference-number" : "Integer" ,
"device-family" : "String" ,
"execution-type" : "SINGLE" ,
"preview-show-parameters" : "Boolean" ,
"preview-show-configuration" : "Boolean" ,
"postview-show-parameters" : "Boolean" ,
"postview-show-configuration" : "Boolean" ,
"domain-id" : "Integer" ,
"domain-name" : "String" ,
"creation-time" : "java.util.Date" ,
"last-updated-time" : "java.util.Date" ,
"last-modified-by" : "String" ,
"cli-text" : "String" ,
"cli-configlet-params" : {
"@total" : "Integer" ,
"@uri" :"/api/space/configuration-management/cli-configlets/{configlet-id}/cli-configlet-params",
"cli-configlet-param" : [
{
"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"
}
]
} ,
"compute-parameter-values" : {
"@href" :
"/api/space/configuration-management/cli-configlets/{id}/compute-parameter-values"
} ,
"apply-cli-configlet" : {
"@href" :
"/api/space/configuration-management/cli-configlets/{id}/apply-cli-configlet"
}
}
}
Access Control
The following capabilities are required to access this API: ViewCliTemplateCap
GET /cli-configlets/{configlet-id} | Version 2 |
This API is used to get the CLI configlet by configlet ID.
Sample Usage
GET /cli-configlets/{configlet-id}
-
Parameters:
Name Type URI Type Description Required id int Path The ID of the CLI configlet to be retrieved. Y
-
Accept Headers:
application/vnd.net.juniper.space.configuration-management.view-cli-configlet+xml;version=2;charset=UTF-8
application/vnd.net.juniper.space.configuration-management.view-cli-configlet+json;version=2;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>
<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>Global</domain>
<cli-configlet-params href="/api/space/configuration-management/cli-configlets/3145734/cli-configlet-params"/>
<cli-configlet-prepopulate-params href="/api/space/configuration-management/cli-configlets/3145734/cli-configlet-prepopulate-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",
"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": "Global",
"cli-configlet-params": {
"@href": "/api/space/configuration-management/cli-configlets/3145734/cli-configlet-params"
},
"cli-configlet-prepopulate-params": {
"@href": "/api/space/configuration-management/cli-configlets/3145734/cli-configlet-prepopulate-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 other non-deprecated versions of this API, refer to :
PUT /cli-configlets/{configlet-id} | Version 3 |
This API is used to update/modify the existing configlet.
Sample Usage
PUT /cli-configlets/{configlet-id}
-
Parameters:
Name Type URI Type Description Required configlet-id Integer Path Configlet ID Y
-
Content-Type Headers:
application/vnd.net.juniper.space.configuration-management.cli-configlet+xml;version=3;charset=UTF-8
application/vnd.net.juniper.space.configuration-management.cli-configlet+json;version=3;charset=UTF-8 -
Accept Headers:
application/vnd.net.juniper.space.configuration-management.cli-configlet+xml;version=3
application/vnd.net.juniper.space.configuration-management.cli-configlet+json;version=3
<cli-configlet>
<name>String</name>
<category>String</category>
<description>String</description>
<context>String</context>
<reference-number>Integer</reference-number>
<device-family>String</device-family>
<execution-type>SINGLE</execution-type>
<preview-show-parameters>Boolean</preview-show-parameters>
<preview-show-configuration>Boolean</preview-show-configuration>
<postview-show-parameters>Boolean</postview-show-parameters>
<postview-show-configuration>Boolean</postview-show-configuration>
<cli-text>String</cli-text>
<cli-configlet-params total="Integer">
<cli-configlet-param>
<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>
</cli-configlet-param>
</cli-configlet-params>
</cli-configlet>
<cli-configlet
href="/api/space/configuration-management/cli-configlets/{id}" uri="/api/space/configuration-management/cli-configlets/{configlet-id}">
<id>Integer</id>
<name>String</name>
<latest-version>String</latest-version>
<category>String</category>
<description>String</description>
<context>String</context>
<reference-number>Integer</reference-number>
<device-family>String</device-family>
<execution-type>SINGLE</execution-type>
<preview-show-parameters>Boolean</preview-show-parameters>
<preview-show-configuration>Boolean</preview-show-configuration>
<postview-show-parameters>Boolean</postview-show-parameters>
<postview-show-configuration>Boolean</postview-show-configuration>
<domain-id>Integer</domain-id>
<domain-name>String</domain-name>
<creation-time>java.util.Date</creation-time>
<last-updated-time>java.util.Date</last-updated-time>
<last-modified-by>String</last-modified-by>
<cli-text>String</cli-text>
<cli-configlet-params total="Integer" uri="/api/space/configuration-management/cli-configlets/{configlet-id}/cli-configlet-params">
<cli-configlet-param>
<id>Integer</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>
</cli-configlet-param>
</cli-configlet-params>
</cli-configlet>
{
"cli-configlet" : {
"name" : "String" ,
"category" : "String" ,
"description" : "String" ,
"context" : "String" ,
"reference-number" : "Integer" ,
"device-family" : "String" ,
"execution-type" : "SINGLE" ,
"preview-show-parameters" : "Boolean" ,
"preview-show-configuration" : "Boolean" ,
"postview-show-parameters" : "Boolean" ,
"postview-show-configuration" : "Boolean" ,
"cli-text" : "String" ,
"cli-configlet-params" : {
"@total" : "Integer" ,
"cli-configlet-param" : [
{
"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"
}
]
}
}
}
{
"cli-configlet" : {
"@href" : "/api/space/configuration-management/cli-configlets/{id}" ,
"@uri" : "/api/space/configuration-management/cli-configlets/{configlet-id}",
"id" : "Integer" ,
"name" : "String" ,
"latest-version" : "String" ,
"category" : "String" ,
"description" : "String" ,
"context" : "String" ,
"reference-number" : "Integer" ,
"device-family" : "String" ,
"execution-type" : "SINGLE" ,
"preview-show-parameters" : "Boolean" ,
"preview-show-configuration" : "Boolean" ,
"postview-show-parameters" : "Boolean" ,
"postview-show-configuration" : "Boolean" ,
"domain-id" : "Integer" ,
"domain-name" : "String" ,
"creation-time" : "java.util.Date" ,
"last-updated-time" : "java.util.Date" ,
"last-modified-by" : "String" ,
"cli-text" : "String" ,
"cli-configlet-params" : {
"@total" : "Integer" ,
"@uri" : "/api/space/configuration-management/cli-configlets/{configlet-id}/cli-configlet-params",
"cli-configlet-param" : [
{
"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"
}
]
}
}
}
Access Control
The following capabilities are required to access this API: EditCliTemplateCap
PUT /cli-configlets/{configlet-id} | Version 2 |
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=2;charset=UTF-8
application/vnd.net.juniper.space.configuration-management.cli-configlet+json;version=2;charset=UTF-8 -
Accept Headers:
application/vnd.net.juniper.space.configuration-management.view-cli-configlet+xml;version=2;charset=UTF-8
application/vnd.net.juniper.space.configuration-management.view-cli-configlet+json;version=2;charset=UTF-8
<cli-configlet>
<name>CLI_Configlet</name>
<category>Device</category>
<context>/device</context>
<device-family>EX</device-family>
<description>Sample CLI Configlets</description>
<execution-type>Single</execution-type>
<reference-number>12</reference-number>
<cli-configlet-params>
<cli-configlet-param>
<parameter>DESCRIPTION</parameter>
<xpath> xpath</xpath>
<display-name>DESCRIPTION name</display-name>
<default-value>default</default-value>
<parameter-order>1</parameter-order>
<parameter-type>Text Field</parameter-type>
</cli-configlet-param>
<cli-configlet-param>
<parameter>DESC</parameter>
<xpath> xpath</xpath>
<display-name>DESC name</display-name>
<default-value>default</default-value>
<parameter-order>sdfsf</parameter-order>
<parameter-type>Invisible Field</parameter-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/{configlet-id}">
<id>{configlet-id}</id>
<name>String</name>
<category>category</category>
<context>/device/interface-information/physical-interface|/device/configuration/interfaces/interface</context>
<device-family>EX</device-family>
<execution-type>Single</execution-type>
<creation-time>Date</creation-time>
<last-updated-time>Date</last-updated-time>
<last-modified-by>String</last-modified-by>
<preview-show-parameters>Boolean</preview-show-parameters>
<preview-show-configuration>Boolean</preview-show-configuration>
<postview-show-parameters>Boolean</postview-show-parameters>
<postview-show-configuration>Boolean</postview-show-configuration>
<reference-number>Integer</reference-number>
<description>description</description>
<domain />
<cli-configlet-params href="/api/space/configuration-management/cli-configlets/{configlet-id}/cli-configlet-params" />
<cli-configlet-prepopulate-params href="/api/space/configuration-management/cli-configlets/{configlet-id}/cli-configlet-prepopulate-params" />
<cli-configlet-pages href="/api/space/configuration-management/cli-configlets/{configlet-id}/cli-configlet-pages" />
<apply-configlet href="/api/space/configuration-management/cli-configlets/{configlet-id}/apply-configlet" />
<preview-cli-configlet href="/api/space/configuration-management/cli-configlets/{configlet-id}/preview-cli-configlet" />
<apply-cli-configlet href="/api/space/configuration-management/cli-configlets/{configlet-id}/apply-cli-configlet" />
<submit-cli-configlet href="/api/space/configuration-management/cli-configlets/{configlet-id}/submit-cli-configlet" />
<applicable-devices href="/api/space/configuration-management/cli-configlets/{configlet-id}/applicable-devices" />
<validate-cli-configlet href="/api/space/configuration-management/cli-configlets/{configlet-id}/validate-cli-configlet" />
</cli-configlet>
{
"cli-configlet": {
"name": "CLI_Configlet",
"category": "Device",
"context": "/device",
"device-family": "EX",
"description": "Sample CLI Configlets",
"execution-type": "Single",
"reference-number": "12",
"cli-configlet-params": {
"cli-configlet-param": [
{
"parameter": "DESCRIPTION",
"xpath": "xpath",
"display-name": "DESCRIPTION name",
"default-value": "default",
"parameter-order": "1",
"parameter-type": "Text Field"
},
{
"parameter": "DESC",
"xpath": "xpath",
"display-name": "DESC name",
"default-value": "default",
"parameter-order": "2",
"parameter-type": "Invisible Field"
}
]
},
"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/{configlet-id}",
"id": "{configlet-id}",
"name": "String",
"category": "category",
"context": "/device/interface-information/physical-interface|/device/configuration/interfaces/interface",
"device-family": "EX",
"execution-type": "Single",
"creation-time": "Date",
"last-updated-time": "Date",
"last-modified-by": "String",
"preview-show-parameters": "Boolean",
"preview-show-configuration": "Boolean",
"postview-show-parameters": "Boolean",
"postview-show-configuration": "Boolean",
"reference-number": "Integer",
"description": "description",
"cli-configlet-params": {
"@href": "/api/space/configuration-management/cli-configlets/{configlet-id}/cli-configlet-params"
},
"cli-configlet-prepopulate-params": {
"@href": "/api/space/configuration-management/cli-configlets/{configlet-id}/cli-configlet-prepopulate-params"
},
"cli-configlet-pages": {
"@href": "/api/space/configuration-management/cli-configlets/{configlet-id}/cli-configlet-pages"
},
"apply-configlet": {
"@href": "/api/space/configuration-management/cli-configlets/{configlet-id}/apply-configlet"
},
"preview-cli-configlet": {
"@href": "/api/space/configuration-management/cli-configlets/{configlet-id}/preview-cli-configlet"
},
"apply-cli-configlet": {
"@href": "/api/space/configuration-management/cli-configlets/{configlet-id}/apply-cli-configlet"
},
"submit-cli-configlet": {
"@href": "/api/space/configuration-management/cli-configlets/{configlet-id}/submit-cli-configlet"
},
"applicable-devices": {
"@href": "/api/space/configuration-management/cli-configlets/{configlet-id}/applicable-devices"
},
"validate-cli-configlet": {
"@href": "/api/space/configuration-management/cli-configlets/{configlet-id}/validate-cli-configlet"
}
}
}
Access Control
The following capabilities are required to access this API: EditCliTemplateCap
For other non-deprecated versions of this API, refer to :
PATCH /cli-configlets/{configlet-id} | Version 3 |
This API is used to update the configlet partially.
Sample Usage
PATCH /cli-configlets/{configlet-id}
-
Parameters:
Name Type URI Type Description Required configlet-id Integer Path Configlet ID Y
-
Content-Type Headers:
application/vnd.net.juniper.space.configuration-management.cli-configlet_patch+xml;version=3;charset=UTF-8 -
Accept Headers:
application/vnd.net.juniper.space.configuration-management.cli-configlet+xml;version=3
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<diff>
<!--What you see below are just samples of patch operations that may be performed on this DTO.-->
<!--For more information about patch document format please look at http://http://www.rfc-editor.org/rfc/rfc5261.txt-->
<replace sel="cli-configlet/name">
<name>String</name>
</replace>
<replace sel="cli-configlet/category">
<category>String</category>
</replace>
<replace sel="cli-configlet/description">
<description>String</description>
</replace>
<replace sel="cli-configlet/context">
<context>String</context>
</replace>
<replace sel="cli-configlet/reference-number">
<reference-number>Integer</reference-number>
</replace>
<replace sel="cli-configlet/device-family">
<device-family>String</device-family>
</replace>
<replace sel="cli-configlet/execution-type">
<execution-type>SINGLE</execution-type>
</replace>
<replace sel="cli-configlet/preview-show-parameters">
<preview-show-parameters>Boolean</preview-show-parameters>
</replace>
<replace sel="cli-configlet/preview-show-configuration">
<preview-show-configuration>Boolean</preview-show-configuration>
</replace>
<replace sel="cli-configlet/postview-show-parameters">
<postview-show-parameters>Boolean</postview-show-parameters>
</replace>
<replace sel="cli-configlet/postview-show-configuration">
<postview-show-configuration>Boolean</postview-show-configuration>
</replace>
<replace sel="cli-configlet/cli-text">
<cli-text>String</cli-text>
</replace>
<replace sel="cli-configlet/cli-configlet-params">
<cli-configlet-params>
<cli-configlet-param>
<parameter>String</parameter>
<display-name>String</display-name>
<parameter-type>READWRITE</parameter-type>
<order>Integer</order>
</cli-configlet-param>
</cli-configlet-params>
</replace>
</diff>
<cli-configlet
href="/api/space/configuration-management/cli-configlets/{id}" uri="/api/space/configuration-management/cli-configlets/{configlet-id}">
<id>Integer</id>
<name>String</name>
<latest-version>String</latest-version>
<category>String</category>
<description>String</description>
<context>String</context>
<reference-number>Integer</reference-number>
<device-family>String</device-family>
<execution-type>SINGLE</execution-type>
<preview-show-parameters>Boolean</preview-show-parameters>
<preview-show-configuration>Boolean</preview-show-configuration>
<postview-show-parameters>Boolean</postview-show-parameters>
<postview-show-configuration>Boolean</postview-show-configuration>
<domain-id>Integer</domain-id>
<domain-name>String</domain-name>
<creation-time>java.util.Date</creation-time>
<last-updated-time>java.util.Date</last-updated-time>
<last-modified-by>String</last-modified-by>
<cli-text>String</cli-text>
<cli-configlet-params total="Integer" uri="/api/space/configuration-management/cli-configlets/{configlet-id}/cli-configlet-params">
<cli-configlet-param>
<id>Integer</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>
</cli-configlet-param>
</cli-configlet-params>
<compute-parameter-values href="/api/space/configuration-management/cli-configlets/{id}/compute-parameter-values"/>
<apply-cli-configlet href="/api/space/configuration-management/cli-configlets/{id}/apply-cli-configlet"/>
</cli-configlet>
{
"cli-configlet" : {
"@href" : "/api/space/configuration-management/cli-configlets/{id}" ,
"@uri" : "/api/space/configuration-management/cli-configlets/{configlet-id}",
"id" : "Integer" ,
"name" : "String" ,
"latest-version" : "String" ,
"category" : "String" ,
"description" : "String" ,
"context" : "String" ,
"reference-number" : "Integer" ,
"device-family" : "String" ,
"execution-type" : "SINGLE" ,
"preview-show-parameters" : "Boolean" ,
"preview-show-configuration" : "Boolean" ,
"postview-show-parameters" : "Boolean" ,
"postview-show-configuration" : "Boolean" ,
"domain-id" : "Integer" ,
"domain-name" : "String" ,
"creation-time" : "java.util.Date" ,
"last-updated-time" : "java.util.Date" ,
"last-modified-by" : "String" ,
"cli-text" : "String" ,
"cli-configlet-params" : {
"@total" : "Integer" ,
"@uri" : "/api/space/configuration-management/cli-configlets/{configlet-id}/cli-configlet-params",
"cli-configlet-param" : [
{
"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"
}
]
},
"compute-parameter-values" : {
"@href" : "/api/space/configuration-management/cli-configlets/{id}/compute-parameter-values"
},
"apply-cli-configlet" : {
"@href" : "/api/space/configuration-management/cli-configlets/{id}/apply-cli-configlet"
}
}
}
Access Control
The following capabilities are required to access this API: EditCliTemplateCap, DeleteCliTemplateCap, NewCliTemplateCap
DELETE /cli-configlets/{configlet-id} | Version 3 |
This API is used to delete a configlet.
Sample Usage
DELETE /cli-configlets/{configlet-id}
-
Parameters:
Name Type URI Type Description Required configlet-id Integer Path Configlet ID Y
Access Control
The following capabilities are required to access this API: DeleteCliTemplateCap