Functions/Public/New-AMTask.ps1
|
function New-AMTask { <# .SYNOPSIS Creates a new Automate task. .DESCRIPTION New-AMTask creates a new task object. .PARAMETER Name The name of the new object. .PARAMETER AML The Automate Markup Language (AML) to set on the object. .PARAMETER Notes The notes to set on the object. .PARAMETER Folder The folder to place the object in. .PARAMETER Connection The server to create the object on. .EXAMPLE # Create a new task New-AMTask -Name "Test Task" .LINK https://github.com/AutomatePS/AutomatePS/blob/master/Docs/New-AMTask.md #> [CmdletBinding(SupportsShouldProcess=$true,ConfirmImpact="Low")] param ( [Parameter(Mandatory = $true, Position = 0)] [ValidateNotNullOrEmpty()] [string]$Name, [string]$AML = "", [string]$Notes = "", [ValidateScript({$_.Type -eq "Folder"})] $Folder, [ValidateNotNullOrEmpty()] [ArgumentCompleter([AMConnectionCompleter])] $Connection ) if ($PSBoundParameters.ContainsKey("Connection")) { $Connection = Get-AMConnection -Connection $Connection } else { $Connection = Get-AMConnection } switch (($Connection | Measure-Object).Count) { 1 { if (-not $Folder) { $Folder = Get-AMDefaultFolder -Connection $Connection -Type TASKS } if ($PSBoundParameters.ContainsKey("AML")) { # Validate AML if ($AML -is [string]) { $convertSuccess = $false try { $xml = [xml]$AML $convertSuccess = $true } catch { Write-Warning "Failed to convert AML to XML, this may be normal since AML does not always conform to XML syntax. Validation will be skipped." } if ($convertSuccess) { $amlVersion = [version]$xml.SelectSingleNode("//*[@TaskVersion|@TASKVERSION]").TaskVersion if ($amlVersion.Major -ne $Connection.Version.Major) { Write-Warning "AML version ($($amlVersion.Major)) does not match server version ($($Connection.Version.Major))!" } } } else { throw "AML is not a string!" } } switch ($Connection.Version.Major) { 10 { $newObject = [AMTaskv10]::new($Name, $Folder, $Connection.Alias) } {$_ -in 11,22,23,24} { $newObject = [AMTaskv11]::new($Name, $Folder, $Connection.Alias) } default { throw "Unsupported server major version: $_!" } } $newObject.Notes = $Notes $newObject.AML = $AML $newObject | New-AMObject -Connection $Connection } 0 { throw "No servers are currently connected!" } default { throw "Multiple Automate servers are connected, please specify which server to create the new task on!" } } } |