Dell EMC OpenManage Enterprise 3.9 RESTful API Guide

PDF

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":{  

      }
   },
   "Attributes":[  
      {  
         "DeviceId":0,
         "Attributes":[  
            {  
               "Id":2536,
               "IsIgnored":true
            }
         ]
      }
   ],
   "Options":{  
      "ShutdownType":0,
      "TimeToWaitBeforeShutdown":300,
      "EndHostPowerState":1
   }
}

Example response body

ID of created task

Deployment using Boot to ISO method

{
   {
"Id": 51,
"TargetIds": [10068],
"NetworkBootIsoModel": {
"BootToNetwork": true,
"ShareType": "CIFS",
"IsoPath": "/share/OS/Windows_Svrs_2019_English_StdDC_FPPOEM.iso",
"IsoTimeout": 240 -->default
"isoTimeoutUnit": -> 1: hours (default), 2 : minutes
"ShareDetail": 

{ "IpAddress": "100.97.203.77", "ShareName": "<>", "User": "sharuser", "Password": "dell_1234" }
    },
    "Attributes": [],
    "Options":

 

}

Table 1. AttributesThis table lists the attributes that this method supports.
Attribute	Description
IsoTimeout	Valid values are: 1 Hour 2 Hours 4 Hours 8 Hours 16 Hours If BootToISO is specified, then a value for IsoTimeout should also be specified. The default timeout value is 240 minutes. The minimum value is 10 minutes and the maximum value, 960 minutes.