functions/Remove-SyslogServer.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
function Remove-SyslogServer
{
<#
    .SYNOPSIS
        Stop and remove a syslog server.
     
    .DESCRIPTION
        Stop and remove a syslog server.
     
    .PARAMETER Server
        The server object to remove.
        Provide a 'Syslog.Server' object returned by Get-SyslogServer.
     
    .PARAMETER EnableException
        This parameters disables user-friendly warnings and enables the throwing of exceptions.
        This is less user friendly, but allows catching exceptions in calling scripts.
     
    .PARAMETER Confirm
        If this switch is enabled, you will be prompted for confirmation before executing any operations that change state.
     
    .PARAMETER WhatIf
        If this switch is enabled, no actions are performed but informational messages will be displayed that explain what would happen if the command were to run.
     
    .EXAMPLE
        PS C:\> Get-SyslogServer | Remove-SyslogServer
     
        Stops and removes all currently existing syslog servers.
#>

    [CmdletBinding(SupportsShouldProcess = $true)]
    Param (
        [Parameter(Mandatory = $true, ValueFromPipeline = $true)]
        [Syslog.Server[]]
        $Server,
        
        [switch]
        $EnableException
    )
    
    process
    {
        foreach ($serverObject in $Server) {
            if ($serverObject.State -eq 'Running') {
                Invoke-PSFProtectedCommand -Action "Stopping Server from $($serverObject.ListenOn):$($serverObject.InPort) to $($serverObject.OutServer):$($serverObject.OutPort)" -ScriptBlock {
                    $serverObject.Stop()
                } -Target $serverObject -EnableException $EnableException -PSCmdlet $PSCmdlet -Continue
            }
            Invoke-PSFProtectedCommand -Action "Removing Server from $($serverObject.ListenOn):$($serverObject.InPort) to $($serverObject.OutServer):$($serverObject.OutPort)" -ScriptBlock {
                $script:servers.Remove($serverObject)
            } -Target $serverObject -EnableException $EnableException -PSCmdlet $PSCmdlet -Continue
        }
    }
}