This is the built-in help made by Microsoft for the command 'Stop-Process', in PowerShell version 5 - as retrieved from
Windows version 'Microsoft Windows Server 2012 R2 Standard' PowerShell help files on 2016-06-23.
For PowerShell version 3 and up, where you have Update-Help, this command was run just before creating the web pages from the help files.
Stops one or more running processes.
Stop-Process [-Id] <Int32[]> [-Force] [-InformationAction {SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend}] [-InformationVariable [<System.String>]]
[-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>]
Stop-Process [-InputObject] <Process[]> [-Force] [-InformationAction {SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend}] [-InformationVariable
[<System.String>]] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>]
Stop-Process [-Force] [-InformationAction {SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend}] [-InformationVariable [<System.String>]] [-PassThru] -Name
<String[]> [-Confirm] [-WhatIf] [<CommonParameters>]
The Stop-Process cmdlet stops one or more running processes. You can specify a process by process name or process ID (PID), or pass a process object to Stop-Process.
Stop-Process works only on processes running on the local computer.
On Windows Vista and later versions of Windows, to stop a process that is not owned by the current user, you must start Windows PowerShell with the "Run as administrator"
option. Also, you are prompted for confirmation unless you use the Force parameter.
<
Online Version: http://go.microsoft.com/fwlink/p/?linkid=293922
Debug-Process
Get-Process
Start-Process
Stop-Process
Wait-Process
<
-------------------------- EXAMPLE 1 --------------------------
PS C:\>stop-process -name notepad
This command stops all instances of the Notepad process on the computer. (Each instance of Notepad runs in its own process.) It uses the Name parameter to specify the
processes, all of which have the same name. If you were to use the ID parameter to stop the same processes, you would have to list the process IDs of each instance of
Notepad.
-------------------------- EXAMPLE 2 --------------------------
PS C:\>stop-process -id 3952 -confirm -passthru
Confirm
Are you sure you want to perform this action?
Performing operation "Stop-Process" on Target "notepad (3952)".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help
(default is "Y"):y
Handles NPM(K) PM(K) WS(K) VM(M) CPU(s) Id ProcessName
------- ------ ----- ----- ----- ------ -- -----------
41 2 996 3212 31 3952 notepad
This command stops a particular instance of the Notepad process. It uses the process ID, 3952, to identify the process. The Confirm parameter directs Windows PowerShell to
prompt the user before stopping the process. Because the prompt includes the process name, as well as its ID, this is best practice. The PassThru parameter passes the
process object to the formatter for display. Without this parameter, there would be no display after a Stop-Process command.
-------------------------- EXAMPLE 3 --------------------------
PS C:\>calc
PS C:\>$p = get-process calc
PS C:\>stop-process -inputobject $p
PS C:\>get-process | where-object {$_.HasExited}
This series of commands starts and stops the Calc process and then detects processes that have stopped.
The first command ("calc") starts an instance of the calculator. The second command ("$p = get-process calc"), uses the Get-Process cmdlet to get an object representing the
Calc process and store it in the $p variable. The third command ("stop-process -inputobject $p") uses the Stop-Process cmdlet to stop the Calc process. It uses the
InputObject parameter to pass the object to Stop-Process.
The last command gets all of the processes on the computer that were running but that are now stopped. It uses the Get-Process cmdlet to get all of the processes on the
computer. The pipeline operator (|) passes the results to the Where-Object cmdlet, which selects the ones where the value of the HasExited property is TRUE. HasExited is
just one property of process objects. To find all the properties, type "get-process | get-member".
-------------------------- EXAMPLE 4 --------------------------
PS C:\>get-process lsass | stop-process
Stop-Process : Cannot stop process 'lsass (596)' because of the following error: Access is denied
At line:1 char:34
+ get-process lsass | stop-process <<<<
[ADMIN]: PS C:\>get-process lsass | stop-process
Warning!
Are you sure you want to perform this action?
Performing operation 'Stop-Process' on Target 'lsass(596)'
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
[ADMIN]: PS C:\>get-process lsass | stop-process -force
[ADMIN]: PS C:\>
These commands show the effect of using the Force parameter to stop a process that is not owned by the user.
The first command uses the Get-Process cmdlet to get the Lsass process. A pipeline operator sends the process to the Stop-Process cmdlet to stop it. As shown in the sample
output, the first command fails with an "Access denied" message, because this process can be stopped only by a member of the Administrator's group on the computer.
When Windows PowerShell is opened with the "Run as administrator" option, and the command is repeated, Windows PowerShell prompts you for confirmation.
The second command uses the Force parameter to suppress the prompt. As a result, the process is stopped without confirmation.