Functions/Stop-ExPerfwiz.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
Function Stop-ExPerfwiz {
    <#
 
    .SYNOPSIS
    Stop a data collector set.
 
    .DESCRIPTION
    Stops a data collector set on the local or remote server.
 
    .PARAMETER Name
    Name of the data collector set to stop.
 
    Default Exchange_Perfwiz
 
    .PARAMETER Server
    Name of the server to stop the collector set on.
 
    Default LocalHost
 
    .OUTPUTS
    Logs all activity into $env:LOCALAPPDATA\ExPefwiz.log file
 
    .EXAMPLE
    Stop the default data collector set on the local server
 
    Stop-ExPerfwiz
 
    .EXAMPLE
    Stop a data colletor set on a remote server
 
    Stop-ExPerfwiz -Name "My Collector Set" -Server RemoteServer-01
 
    #>

    [CmdletBinding(SupportsShouldProcess = $true, ConfirmImpact = 'Medium')]
    param (
        [Parameter(ValueFromPipelineByPropertyName)]    
        [string]
        $Name = "Exchange_Perfwiz",

        [string]
        $Server = $env:ComputerName
    )

    Process {
        Write-Logfile -string ("Stopping ExPerfwiz: " + $server + "\" + $Name)

        # Remove the experfwiz counter set
        if ($PSCmdlet.ShouldProcess("$Server\$Name", "Stopping ExPerfwiz Data Collection")) {
            [string]$logman = logman stop -name $Name -s $server
        }

        # Check if we have an error and throw and error if needed.
        If ($logman | select-string "Error:") {
            # if we are not running already then just move on
            if ($logman | select-string "is not running") {
                Write-LogFile "Collector Not Running"                
            }
            else {
                Write-Logfile "[ERROR] - Unable to Stop Collector"
                Write-Logfile $logman
                Throw $logman                
            }            
        }
        else {
            Write-Logfile "ExPerfwiz Stopped"
        }
    }
}