Public/Invoke-OpenIntrusionDoor.ps1
|
<#
.SYNOPSIS Opens an intrusion door. .DESCRIPTION Opens an intrusion door. If the result returns null, try the parameter "-Verbose" to get more details. .EXAMPLE .LINK https://github.com/erwindevreugd/PSDataConduIT .EXTERNALHELP PSDataConduIT-help.xml #> function Invoke-OpenIntrusionDoor { [CmdletBinding()] param ( [Parameter( Position = 0, Mandatory = $false, ValueFromPipelineByPropertyName = $true, HelpMessage = 'The name of the server where the DataConduIT service is running or localhost.')] [string] $Server = $Script:Server, [Parameter( Position = 1, Mandatory = $false, ValueFromPipelineByPropertyName = $true, HelpMessage = 'The credentials used to authenticate the user to the DataConduIT service.')] [PSCredential] $Credential = $Script:Credential, [Parameter( Mandatory = $true, ValueFromPipelineByPropertyName = $true, HelpMessage = 'Specifies the id of the intrusion door to open.')] [int] $IntrusionDoorID, [Parameter( Mandatory = $false, ValueFromPipelineByPropertyName = $false, HelpMessage = 'Returns an object that represents the intrusion door which was opened. By default, this cmdlet does not generate any output.')] [switch] $PassThru ) process { $parameters = @{ Server = $Server; } if ($Credential -ne $null) { $parameters.Add("Credential", $Credential) } if (($intrusionDoor = Get-IntrusionDoor @parameters -IntrusionDoorID $IntrusionDoorID) -eq $null) { Write-Error -Message ("Intrusion door id '$($IntrusionDoorID)' not found") return } $intrusionDoor.Open.Invoke() | Out-Null Write-Verbose -Message ("Intrusion door '$($intrusionDoor.Name)' opened") if ($PassThru) { Write-Output $intrusionDoor } } } |