Functions/Public/Copy-AMTask.ps1
|
function Copy-AMTask { <# .SYNOPSIS Copies an Automate task. .DESCRIPTION Copy-AMTask can copy a task object within, or between servers. .PARAMETER InputObject The object to copy. .PARAMETER Name The new name to set on the object. .PARAMETER Folder The folder to place the object in. .PARAMETER Connection The server to copy the object to. .INPUTS The following Automate object types can be modified by this function: Task .OUTPUTS Task .EXAMPLE # Copy task "Start Service" from server1 to server2 Get-AMTask "Start Service" -Connection server1 | Copy-AMTask -Folder (Get-AMFolder TASKS -Connection server2) -Connection server2 .EXAMPLE # Copy task "Start Service" with new name "Restart Service" Get-AMTask "Start Service" | Copy-AMTask -Name "Restart Service" .LINK https://github.com/AutomatePS/AutomatePS/blob/master/Docs/Copy-AMTask.md #> [CmdletBinding()] param ( [Parameter(Mandatory = $true, ValueFromPipeline = $true)] [ValidateNotNullOrEmpty()] $InputObject, [ValidateNotNullOrEmpty()] [string]$Name, [ValidateScript({$_.Type -eq "Folder"})] $Folder, [ValidateNotNullOrEmpty()] [ArgumentCompleter([AMConnectionCompleter])] $Connection ) BEGIN { if ($PSBoundParameters.ContainsKey("Connection")) { $Connection = Get-AMConnection -Connection $Connection if (($Connection | Measure-Object).Count -eq 0) { throw "No Automate server specified!" } elseif (($Connection | Measure-Object).Count -gt 1) { throw "Multiple Automate servers specified, please specify one server to copy the task to!" } $user = Get-AMUser -Connection $Connection | Where-Object {$_.Name -ieq $Connection.Credential.UserName} } } PROCESS { foreach ($obj in $InputObject) { if ($obj.Type -eq "Task") { if ($PSBoundParameters.ContainsKey("Connection")) { # Copy from one Automate server to another if ($obj.ConnectionAlias -ne $Connection.Alias) { if ((Get-AMConnection -ConnectionAlias $obj.ConnectionAlias).Version.Major -ne $Connection.Version.Major) { throw "Source server and destination server are different versions! This module does not support changing task versions." } if ($PSBoundParameters.ContainsKey("Folder")) { if ($Folder.ConnectionAlias -ne $Connection.Alias) { throw "Folder specified exists on $($Folder.ConnectionAlias), the folder must exist on $($Connection.Name)!" } } else { $Folder = Get-AMFolder -ID $user.TaskFolderID -Connection $Connection } } } else { $Connection = Get-AMConnection -ConnectionAlias $obj.ConnectionAlias if (-not $PSBoundParameters.ContainsKey("Folder")) { $Folder = Get-AMFolder -ID $obj.ParentID -Connection $obj.ConnectionAlias } $user = Get-AMUser -Connection $Connection | Where-Object {$_.Name -ieq $Connection.Credential.UserName} } if (-not $PSBoundParameters.ContainsKey("Name")) { $Name = $obj.Name } switch ($Connection.Version.Major) { 10 { $copyObject = [AMTaskv10]::new($Name, $Folder, $Connection.Alias) } 11 { $copyObject = [AMTaskv11]::new($Name, $Folder, $Connection.Alias) } default { throw "Unsupported server major version: $_!" } } if ($PSBoundParameters.ContainsKey("Connection") -and $obj.ConnectionAlias -ne $Connection.Alias) { # If an object with the same ID doesn't already exist, use the same ID (when copying between servers) if ((Get-AMTask -ID $obj.ID -Connection $Connection -ErrorAction SilentlyContinue | Measure-Object).Count -eq 0) { $copyObject.ID = $obj.ID } } $copyObject.CreatedBy = $user.ID $currentObject = Get-AMTask -ID $obj.ID -Connection $obj.ConnectionAlias $copyObject.AML = $currentObject.AML $copyObject.CompletionState = $currentObject.CompletionState $copyObject.Enabled = $currentObject.Enabled $copyObject.LockedBy = $currentObject.LockedBy $copyObject.Notes = $currentObject.Notes $copyObject | New-AMObject -Connection $Connection } else { Write-Error -Message "Unsupported input type '$($obj.Type)' encountered!" -TargetObject $obj } } } } |