ScheduleOsdByApi

Modified on Fri, 17 Nov 2023 at 04:26 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
pat	string, mandatory the Personal Access Token
computerData	PSCustomObject arrray, mandatory a list of target devices with ComputerIdn and NewHostName e.g. [{ "ComputerIdn ":2, "NewHostName":"newHostnamePeter5" }, { "ComputerIdn ":8, "NewHostName":"newHostnameTom9" }]
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 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"