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/change-requests (v1)
The following operations are supported on this resource:
(Deprecated) | Version 1 |
This API retrieves all change requests present in the system.
Sample Usage
GET /change-requests
-
Accept Headers:
application/vnd.net.juniper.space.configuration-management.change-requests+xml;version=1
application/vnd.net.juniper.space.configuration-management.change-requests+json;version=1
<change-requests size="1"
uri="/api/space/configuration-management/change-requests">
<change-request key="790"
uri="/configuration-management/change-requests/790">
<deviceId>8</deviceId>
<name>ChangeRequestName_1</name>
<description>testDesc_1</description>
</change-request>
<change-request key="791"
uri="/configuration-management/change-requests/791">
<deviceId>80</deviceId>
<name>ChangeRequestName_2</name>
<description>testDesc_2</description>
</change-request>
</change-requests>
{
"change-requests": {
"@size": "1",
"@uri":
"/api/space/configuration-management/change-requests",
"change-request": [
{
"@key": "790",
"@uri":
"/configuration-management/change-requests/790",
"deviceId": "8",
"name": "ChangeRequestName_1",
"description" : "testDesc_1"
},
{
"@key": "791",
"@uri":
"/configuration-management/change-requests/791",
"deviceId": "80",
"name": "ChangeRequestName_2",
"description": "testDesc_2"
}
]
}
}
Access Control
The following capabilities are required to access this API: ViewChangeRequestsCap
For the current version of this API, refer to :
(Deprecated) | Version 1 |
This API creates a schedulable change request for a particular device based on input parameters.
Sample Usage
This API makes an asynchronous method call; so, you can optionally specify queue and schedule parameters:
POST /change-requests?queue=<queue>&schedule=<schedule>
Note: The queue URL denoted by <queue> must have been created already.
-
Parameters:
Name Type URI Type Description Required queue Queue URL Query A fully qualified queue URL, where job progress notifications will be sent (See Asynchronous API Usage) N schedule cron-like-expression Query Schedule this API in the future, by specifying a cron-like-expression (See Job Scheduling) N
-
Content-Type Headers:
application/vnd.net.juniper.space.configuration-management.change-request+xml;version=1;charset=UTF-8
application/vnd.net.juniper.space.configuration-management.change-request+json;version=1;charset=UTF-8 -
Accept Headers:
application/vnd.net.juniper.space.configuration-management.change-request+xml;version=1
application/vnd.net.juniper.space.configuration-management.change-request+json;version=1
<change-request>
<device href="/api/space/device-management/devices/458753" >
</device>
<name>TEST_NAME</name>
<description>TEST_DESC</description>
<xmlData>
<![CDATA[
Sample input for merging configuration elements
<configuration>
<interfaces>
<interface>
<name>so-3/0/0</name>
<unit>
<name>0</name>
<family>
<inet>
<address>
<name>10.0.0.1/8</name>
</address>
</inet>
</family>
</unit>
</interface>
</interfaces>
</configuration>
Sample input for replacing configuration elements
<configuration>
<system>
<login>
<class operation="replace">
<name>operator</name>
<permissions>configure</permissions>
<permissions>admin-control</permissions>
</class>
</login>
</system>
</configuration>
Sample input for creating configuration elements
<configuration>
<protocols>
<ospf operation="create">
<area>
<name>0</name>
<interface>
<name>at-0/1/0.100</name>
</interface>
</area>
</ospf>
</protocols>
</configuration>
Sample input for deleting configuration elements
<configuration>
<system>
<login>
<user operation="delete">
<name>barbara</name>
</user>
</login>
</system>
</configuration>
]]>
</xmlData>
<syncAfterPush>true</syncAfterPush> </change-request>
<task>
<id>917507</id>
</task>
Sample Input for merging configuration elements:
{
"change-request":
{
"device":
{
"@href":"/api/space/device-management/devices/4587531"
},
"name":"TEST_NAME",
"description":"TEST_DESC",
"xmlData":"<configuration><interfaces>
<interface><name>so-3/0/0</name>
<unit>
<name>0</name>
<family><inet><address>
<name>10.0.0.1/8</name></address></inet>
</family></unit></interface></
interfaces><
/configuration>",
"syncAfterPush":"true"
}
}
Sample input for replacing configuration elements
{
"change-request":
{
"device":
{
"@href":"/api/space/device-management/devices/4587531"
},
"name":"TEST_NAME",
"description":"TEST_DESC",
"xmlData":"<configuration><system>
<login><class operation=\"replace\">
<name>operator</name><permissions>
configure</permissions>
<permissions>admin-control</permissions></class></login>
</system></configuration>"
"syncAfterPush":"true"
}
}
Sample input for creating configuration elements
{
"change-request":
{
"device":
{
"@href":"/api/space/device-management/devices/4587531"
},
"name":"TEST_NAME",
"description":"TEST_DESC",
"xmlData":"<configuration><protocols><ospf
operation=\"create\"><area>
<name>0</name><interface>
<name>at-0/1/0.100</name></interface> ;
</area></ospf></protocols></
configuration>",
"syncAfterPush":"true"
}
}
Sample input for deleting configuration elements
{
"change-request":
{
"device":
{
"@href":"/api/space/device-management/devices/4587531"
},
"name":"TEST_NAME",
"description":"TEST_DESC",
"xmlData":"<configuration><protocols><ospf
operation=\"delete\"></protocols>
</configuration>",
"syncAfterPush":"true"
}
}
{"task":{"id":917507}}
Access Control
The following capabilities are required to access this API: ExecuteChangeRequestsCap
For the current version of this API, refer to :