Public/Stop-RSJob.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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
Function Stop-RSJob {
    <#
        .SYNOPSIS
            Stops a Windows PowerShell runspace job.
 
        .DESCRIPTION
            Stops a Windows PowerShell background job that has been started using Start-RSJob
 
        .PARAMETER Job
            The job object to stop.
 
        .PARAMETER Name
            The name of the jobs to stop..
 
        .PARAMETER ID
            The ID of the jobs to stop.
 
        .PARAMETER InstanceID
            The GUID of the jobs to stop.
 
        .PARAMETER Batch
            Name of the set of jobs to stop.
 
        .NOTES
            Name: Stop-RSJob
            Author: Boe Prox/Max Kozlov
 
        .EXAMPLE
            Get-RSJob -State Completed | Stop-RSJob
 
            Description
            -----------
            Stop all jobs with a State of Completed.
 
            .EXAMPLE
            Stop-RSJob -ID 1,5,78
 
            Description
            -----------
            Stop jobs with IDs 1,5,78.
    #>

    [cmdletbinding(
        DefaultParameterSetName='Job'
    )]
    Param (
        [parameter(ValueFromPipeline=$True,ValueFromPipelineByPropertyName=$True,
        ParameterSetName='Job', Position=0)]
        [Alias('InputObject')]
        [RSJob[]]$Job,
        [parameter(ValueFromPipeline=$True,ValueFromPipelineByPropertyName=$True,
        ParameterSetName='Name', Position=0)]
        [string[]]$Name,
        [parameter(ValueFromPipeline=$True,ValueFromPipelineByPropertyName=$True,
        ParameterSetName='Id', Position=0)]
        [int[]]$Id,
        [parameter(ValueFromPipelineByPropertyName=$True,
        ParameterSetName='InstanceID')]
        [string[]]$InstanceID,
        [parameter(ValueFromPipelineByPropertyName=$True,
        ParameterSetName='Batch')]
        [string[]]$Batch
    )
    Begin {
        If ($PSBoundParameters['Debug']) {
            $DebugPreference = 'Continue'
        }
        $List = New-Object System.Collections.ArrayList
    }
    Process {
        Write-Debug "ParameterSet: $($PSCmdlet.ParameterSetName)"
        $Property = $PSCmdlet.ParameterSetName
        if ($PSBoundParameters[$Property]) {
            Write-Verbose "Adding $($PSBoundParameters[$Property])"
            [void]$List.AddRange($PSBoundParameters[$Property])
        }
    }
    End {
        if (-not $List.Count) { return } # No jobs selected to search
        $PSBoundParameters[$Property] = $List
        [array]$ToStop = Get-RSJob @PSBoundParameters

        If ($ToStop.Count) {
            [System.Threading.Monitor]::Enter($PoshRS_jobs.syncroot)
            try {
                $ToStop | ForEach-Object {
                    Write-Verbose "Stopping $($_.InstanceId)"
                    if ($_.State -ne 'Completed') {
                        Write-Verbose "Killing job $($_.InstanceId)"
                        [void] $_.InnerJob.Stop()
                    }
                }
            }
            finally {
                [System.Threading.Monitor]::Exit($PoshRS_jobs.syncroot)
            }
        }
    }
}