ScheduleOsdByApi

Modified on Mon, 1 Sep at 1:22 PM

Can be used for creating a scheduled Operating System Deployment job with software packages and software profiles.

For ease of use, you need to import the Console-API-Module.

All documentation can also be seen in the API Module.

Parameter:	Description:
uri	string, optional web Service URL e.g.: http://coreservername/five9sWS/five9sWS.asmx (default is http://localhost/five9sWS/five9sWS.asmx?wsdl)
pat	string, mandatory the Personal Access Token
computerData	PSCustomObject array, mandatory a list of target devices with ComputerIdn and NewHostName e.g. [{ "ComputerIdn ":2, "NewHostName":"newHostnamePeter5" }, { "ComputerIdn ":8, "NewHostName":"newHostnameTom9" }] since Console Version 5.1.30+ you can also use: Hostname or Serialnumber instead of ComputerIdn
operatingSystemName	string, mandatory the name of the target operating system OS needs to be managed and selectable
provisioningTemplateName	string, optional the target provisioning template that will be used for the process needs to be assigned to the OS so we can validate if the template can be used for the given OS (if none given we will use the default template of the given OS)
profileNames	string array, optional a list of software profile names to assign
softwarePackageNames	string array, optional a list of software package names to assign
startDateUtc	string, optional the scheduled date for the execution of the OSD job. The current date will be used if none is given, which will result in immediate execution. e.g. "2021-04-16T09:42:19Z"
requester	string, optional name of the user / process / 3rd party system that assigned the software to diplay in console device history

Get started with the following PowerShell:

Import-Module $PSScriptRoot\Console-API-Module.psm1 -Verbose #you need to execute this line once, so that powershell can offer intelliSense support

# Arrange the parameters
$wsdlUrl = "http://coreserver/five9sWS.asmx?wsdl" # web service URL, you need to replace the 'coreserver' with your actual value
$pat = "879067F0F16_YourPatHere_024214A4"
$keywords = @("adobe", "zip")

# Action
Invoke-GetSoftwareProducts -uri $wsdlUrl -pat $pat -keywords $keywords

The result from the request will look like this:

Returns a string with the message "Thank you for using this service"