forked from dsccommunity/xPSDesiredStateConfiguration
-
Notifications
You must be signed in to change notification settings - Fork 0
/
xWindowsProcess_StopProcessConfig.ps1
72 lines (61 loc) · 2.02 KB
/
xWindowsProcess_StopProcessConfig.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
<#PSScriptInfo
.VERSION 1.0.1
.GUID 6ee000de-f0c1-4aca-8423-33d35d3288e1
.AUTHOR Microsoft Corporation
.COMPANYNAME Microsoft Corporation
.COPYRIGHT
.TAGS DSCConfiguration
.LICENSEURI https://github.com/dsccommunity/xPSDesiredStateConfiguration/blob/main/LICENSE
.PROJECTURI https://github.com/dsccommunity/xPSDesiredStateConfiguration
.ICONURI
.EXTERNALMODULEDEPENDENCIES
.REQUIREDSCRIPTS
.EXTERNALSCRIPTDEPENDENCIES
.RELEASENOTES First version.
.PRIVATEDATA 2016-Datacenter,2016-Datacenter-Server-Core
#>
#Requires -module 'xPSDesiredStateConfiguration'
<#
.SYNOPSIS
Configuration that stops a process.
.DESCRIPTION
Configuration that stops the process that is provided in the given file
path, where the argument matches, and if the process is running.
.PARAMETER FilePath
The path to the executable file to (process) to stop.
.PARAMETER Argument
The arguments for the process to stop. Defaults to no argument.
.NOTES
The FilePath could be set to just the process name only if the number of
returned processed is less than or equal to 8. If more than 8 processes
are returned, another filter is used to optimize performance, and that
filter needs the full path to the executable file.
.EXAMPLE
xWindowsProcess_StopProcessConfig -FilePath 'C:\WINDOWS\system32\PING.EXE' -Argument '-t localhost'
Compiles a configuration that stops a 'ping' process if the process exist.
#>
Configuration xWindowsProcess_StopProcessConfig
{
[CmdletBinding()]
param
(
[Parameter(Mandatory = $true)]
[ValidateNotNullOrEmpty()]
[System.String]
$FilePath,
[Parameter()]
[ValidateNotNullOrEmpty()]
[System.String]
$Argument
)
Import-DSCResource -ModuleName 'xPSDesiredStateConfiguration'
Node localhost
{
xWindowsProcess 'StopProcess'
{
Path = $FilePath
Arguments = $Argument
Ensure = 'Absent'
}
}
}