AutoMatePS

5.1.0

Functions/Public/Set-AMTask.ps1

function Set-AMTask {
    <#
        .SYNOPSIS
            Sets properties of an Automate task.
 
        .DESCRIPTION
            Set-AMTask can change properties of a task object.
 
        .PARAMETER InputObject
            The object to modify.
 
        .PARAMETER Instance
            The task object to save directly to the server. This parameter takes a task that has been manually modified to be saved as-is to the server.
 
        .PARAMETER Notes
            The new notes to set on the object.
 
        .PARAMETER AML
            The new Automate Markup Language (AML) to set on the object.
 
        .PARAMETER CompletionState
            The completion state (staging level) to set on the object.
 
        .INPUTS
            The following Automate object types can be modified by this function:
            Task
 
        .EXAMPLE
            # Change notes for a task
            Get-AMTask "Delete Log Files" | Set-AMTask -Notes "Deletes old log files"
 
        .EXAMPLE
            # Change AML for a task
            Get-AMTask "Some Task" | Set-AMTask -AML (Get-AMTask "Some Other Task").AML
 
        .LINK
            https://github.com/AutomatePS/AutomatePS/blob/master/Docs/Set-AMTask.md
    #>
    [CmdletBinding(SupportsShouldProcess=$true,ConfirmImpact="Medium")]
    param (
        [Parameter(Mandatory = $true, ValueFromPipeline = $true, ParameterSetName = "ByInputObject")]
        [ValidateNotNullOrEmpty()]
        $InputObject,

        [Parameter(Mandatory = $true, ParameterSetName = "ByInstance")]
        [ValidateScript({
            if ($_.Type -eq "Task") {
                $true
            } else {
                throw [System.Management.Automation.PSArgumentException]"Instance is not a Task!"
            }
        })]
        $Instance,

        [Parameter(ParameterSetName = "ByInputObject")]
        [AllowEmptyString()]
        [string]$Notes,

        [Parameter(ParameterSetName = "ByInputObject")]
        [string]$AML,

        [Parameter(ParameterSetName = "ByInputObject")]
        [AMCompletionState]$CompletionState
    )

    PROCESS {
        switch ($PSCmdlet.ParameterSetName) {
            "ByInputObject" {
                foreach ($obj in $InputObject) {
                    if ($obj.Type -eq "Task") {
                        $updateObject = Get-AMTask -ID $obj.ID -Connection $obj.ConnectionAlias
                        $shouldUpdate = $false
                        if ($PSBoundParameters.ContainsKey("Notes")) {
                            if ($updateObject.Notes -ne $Notes) {
                                $updateObject.Notes = $Notes
                                $shouldUpdate = $true
                            }
                        }
                        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) {
                                    $serverVersion = (Get-AMConnection -ConnectionAlias $obj.ConnectionAlias).Version
                                    $amlVersion = [version]$xml.SelectSingleNode("//*[@TaskVersion|@TASKVERSION]").TaskVersion
                                    if ($amlVersion.Major -ne $serverVersion.Major) {
                                        throw "AML version ($($amlVersion.Major)) does not match server version ($($serverVersion.Major))!"
                                    }
                                }
                            } else {
                                throw "AML is not a string!"
                            }
                            if ($updateObject.AML -ne $AML) {
                                $updateObject.AML = $AML
                                $shouldUpdate = $true
                            }
                        }
                        if ($PSBoundParameters.ContainsKey("CompletionState")) {
                            if ($updateObject.CompletionState -ne $CompletionState) {
                                $updateObject.CompletionState = $CompletionState
                                $shouldUpdate = $true
                            }
                        }
                        if ($shouldUpdate) {
                            $updateObject | Set-AMObject
                        } else {
                            Write-Verbose "$($obj.Type) '$($obj.Name)' already contains the specified values."
                        }
                    } else {
                        Write-Error -Message "Unsupported input type '$($obj.Type)' encountered!" -TargetObject $obj
                    }
                }
            }
            "ByInstance" {
                $updateObject = $Instance.PSObject.Copy()
                $validated = $true
                if ($updateObject.ID -notmatch $AMGuidRegex) {
                    $validated = $false
                    throw "$($Instance.Type) '$($Instance.Name)' has an ID that is not a valid GUID!"
                }
                if (($updateObject.AML -is [string]) -and ($updateObject.AML.Trim() -notlike "<AMTASK>*</AMTASK>")) {
                    $validated = $false
                    throw "$($Instance.Type) '$($Instance.Name)' has invalid AML!"
                }
                if ($validated) {
                    $updateObject | Set-AMObject
                }
            }
        }
    }
}