REST Resources
/api/space/software-management/packages/{id}/exec-deploy
The following operations are supported on this resource:
POST /packages/{id}/exec-deploy | Version 1 |
This API deploys the software package on the real device (that is, on the physical device).
Sample Usage
This API makes an asynchronous method call; so, you can optionally specify queue and schedule parameters:
POST /packages/{id}/exec-deploy?queue=<queue>&schedule=<schedule>
Note: The queue URL denoted by <queue> must have been created already.
-
Parameters:
Name Type URI Type Description Required software-package-id int Path The ID for the software package under operation. Y 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.software-management.exec-deploy+xml;version=1;charset=UTF-8
application/vnd.net.juniper.space.software-management.exec-deploy+json;version=1;charset=UTF-8 -
Accept Headers:
application/vnd.net.juniper.space.software-management.exec-deploy+xml;version=1
application/vnd.net.juniper.space.software-management.exec-deploy+json;version=1
<exec-deploy>
<devices>
<device href=
"/api/space/device-management/devices/458753" />
</devices>
<deployOptions>
<useAlreadyDownloaded>true</useAlreadyDownloaded>
<snapShotRequired>false</snapShotRequired>
<validate>false</validate>
<bestEffortLoad>false</bestEffortLoad>
<removePkgAfterInstallation>false</removePkgAfterInstallation>
<rebootDevice>false</rebootDevice>
<rebootAfterXMinutes>0</rebootAfterXMinutes>
<upgradePrimaryPartition>false</upgradePrimaryPartition>
<cleanUpExistingOnDevice>false</cleanUpExistingOnDevice>
<forceHostUpgrade>false</forceHostUpgrade>
</deployOptions>
</exec-deploy>
<task href="/api/space/job-management/jobs/3997704">
<id>3997704</id>
</task>
{
"exec-deploy": {
"devices": [
{
"device":
{
"@href":"/api/space/device-management/devices/458753"
}
}
 ],
"deployOptions":
{
"useAlreadyDownloaded":"true",
"snapShotRequired":"false",
"validate":"false",
"bestEffortLoad":"false",
"removePkgAfterInstallation":"false",
"rebootDevice":"false",
"rebootAfterXMinutes":"0",
"upgradePrimaryPartition":"false",
"cleanUpExistingOnDevice":"false",
"forceHostUpgrade":"false"
}
}
}
{"task":
{
"@href":"/api/space/job-management/jobs/3997704",
"id":3997704
}
}
Access Control
The following capabilities are required to access this API: DeployImageCap
POST /packages/{id}/exec-deploy | Version 1 |
Deploys the JAM Package on the Devices ( JAM supported Devices - MX240, MX480, MX960, MX2010 and MX2020 ).
Sample Usage
This API makes an asynchronous method call; so, you can optionally specify queue and schedule parameters:
POST /packages/{id}/exec-deploy?queue=<queue>&schedule=<schedule>
Note: The queue URL denoted by <queue> must have been created already.
-
Parameters:
Name Type URI Type Description Required device-image-id Integer Path The ID for the software package under operation. Y 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.software-management.exec-deploy-jam-request+xml;version=1;charset=UTF-8
application/vnd.net.juniper.space.software-management.exec-deploy-jam-request+json;version=1;charset=UTF-8 -
Accept Headers:
application/vnd.net.juniper.space.job-management.task+xml;version=1
application/vnd.net.juniper.space.job-management.task+json;version=1
<exec-deploy-jam-request>
<devices>
<device href="/api/space/device-management/devices/25755665"/>
</devices>
<deployOptions>
<use-already-downloaded-jam>true</use-already-downloaded-jam>
</deployOptions>
</exec-deploy-jam-request>
<task href="/api/space/job-management/jobs/688128">
<id>688128</id>
</task>
{
"exec-deploy-jam-request" : {
"devices" : [
{
"device" : {
"@href" : "/api/space/device-management/devices/25755665"
}
}
],
"deployOptions" : {
"use-already-downloaded-jam" : "true"
}
}
}
{
"task":{
"@href":"/api/space/job-management/jobs/688128",
"id":688132
}
}
Access Control
The following capabilities are required to access this API: DeployImageCap