Reference Guide

/api/TemplateService/Actions/TemplateService.Deploy
POST method for TemplateService.Deploy
This method creates a template-deployment job.
Description Creates a template-deployment job.
Privilege DEVICE_CONFIGURATION
HTTP response
code
200
Example request
body
{
"Id" : <id>,
"TargetIds" : [ <target-device-id>,... ],
"Schedule" : {
"RunNow" : <true-false>,
"RunLater" : <true-false>,
"Cron" : "<cron-string>",
"StartTime" : "<start-time-string>",
"EndTime" : "<end-time-string>"
},
"Attributes" : [
{
"DeviceId" : <device-id>,
"Attributes" : [
{
"Id" : <attribute-id>,
"Value" : "<string-value>",
"IsIgnored" : <true-false>
}, ...
]
},...
],
"Options" : {
"ShutdownType" : <shutdown-type>,
"TimeToWaitBeforeShutdown" : <wait-secs>,
"EndHostPowerState" : <end-power-state>,
"PrecheckOnly" : <true-false>,
"ContinueOnWarning" : <true-false>,
"StrictCheckingVlan" : <true-false>
},
"NetworkBootIsoModel" : {
"BootToNetwork" : <true-false>,
"ShareType" : "<share-type>",
"IsoPath” : "<iso-path>",
"ShareDetail" : {
"IpAddress" : "<share-ip-address>",
"ShareName" : "<share-name>",
"WorkGroup" : "<work-group-name>",
"User" : "<share-user-name>",
"Password" : "<share-password>"
}
}
}
The following is a sample payload for a Deploy Template request:
{
"Id":29,
"TargetIds":[8564,5364],
"NetworkBootIsoModel":{
"BootToNetwork":false,
"ShareType":"CIFS",
"ShareDetail":{
}
},
Configure
219