Scripts/New-BPAIdleCondition.ps1
|
function New-BPAIdleCondition { <# .SYNOPSIS Creates a new AutoMate BPA idle condition. .DESCRIPTION New-BPAIdleCondition creates a new idle condition. .PARAMETER Name The name of the new object. .PARAMETER Delay The duration the agent must be idle before triggering this condition. .PARAMETER Measure The unit for Delay (Minutes by default). .PARAMETER Wait Wait for the condition, or evaluate immediately. .PARAMETER Timeout If wait is specified, the amount of time before the condition times out. .PARAMETER TimeoutUnit The unit for Timeout (Seconds by default). .PARAMETER TriggerAfter The number of times the condition should occur before the trigger fires. .PARAMETER Notes The new notes to set on the object. .PARAMETER Folder The folder to place the object in. .PARAMETER BPAServer The server to create the object on. .NOTES Author(s): : David Seibel Contributor(s) : Date Created : 10/17/2017 Date Modified : 02/12/2018 .LINK https://github.com/davidseibel/PoshBPA #> [CmdletBinding()] param( [Parameter(Mandatory = $true, Position = 0)] [ValidateNotNullOrEmpty()] [string]$Name, [int]$Delay = 1, [BPATimeMeasure]$Measure = [BPATimeMeasure]::Minutes, [switch]$Wait = $true, [int]$Timeout = 0, [BPATimeMeasure]$TimeoutUnit = [BPATimeMeasure]::Seconds, [int]$TriggerAfter = 1, [string]$Notes = "", [ValidateScript({$_.TypeName -eq "Folder"})] $Folder, [string]$BPAServer ) $guid = "{$((New-Guid).Guid)}" if (-not $BPAServer -and $global:BPAConnectionInfo.Count -gt 1) { throw "Multiple BPA Servers are connected, please specify which server to create a new condition on!" } elseif (-not $BPAServer) { $BPAServer = $BPAConnectionInfo.Server } $user = Get-BPAUser -BPAServer $BPAServer | Where-Object {$_.Name -ieq ($BPAConnectionInfo | Where-Object {$_.Server -eq $BPAServer}).Credential.UserName} if (-not $Folder) { # Place the task in the users condition folder $Folder = $user | Get-BPAFolder -Type CONDITIONS } # Get the template object from the PoshBPA\ObjectTemplates folder, and configure the object $newObject = Get-BPAObjectTemplate -ConditionType ([BPATriggerType]::Idle) -BPAServer $BPAServer $newObject.ID = $guid $newObject.Name = $Name $newObject.ParentID = $Folder.ID $newObject.Path = Join-Path -Path $Folder.Path -ChildPath $Folder.Name $newObject.CreatedBy = $user.ID $newObject.Notes = $Notes $newObject.Wait = $Wait.ToBool() if ($newObject.Wait) { $newObject.Timeout = $Timeout $newObject.TimeoutUnit = $TimeoutUnit.value__ $newObject.TriggerAfter = $TriggerAfter } $newObject.Delay = $Delay $newObject.Measure = $Measure $newObject | New-BPAObject -BPAServer $BPAServer return (Get-BPACondition -ID $guid -BPAServer $BPAServer) } |