Skip to content

Latest commit

 

History

History
229 lines (178 loc) · 4.34 KB

Get-Process.md

File metadata and controls

229 lines (178 loc) · 4.34 KB
external help file Module Name online version schema
PowerSponse-help.xml
PowerSponse
2.0.0

Get-Process

SYNOPSIS

Find processes based on the on user supplied pid or process name information. Use regex for finding based on patterns.

SYNTAX

ByName (Default)

Get-Process [-ComputerName <String[]>] [-ComputerList <String>] [-Method <String>] [-BinPath <String>]
 [-Session <PSSession[]>] [-Credential <PSCredential>] [-Name <String>] [-OutputFormat <String>] [-WhatIf]
 [-Confirm] [<CommonParameters>]

ByPid

Get-Process [-ComputerName <String[]>] [-ComputerList <String>] [-Method <String>] [-BinPath <String>]
 [-Session <PSSession[]>] [-Credential <PSCredential>] [-Id <Int32>] [-OutputFormat <String>] [-WhatIf]
 [-Confirm] [<CommonParameters>]

DESCRIPTION

The Get-Process function finds processes on the target machine based on the -Pid or -SearchString parameters. It also searches the executable path if available. This allows search for processes started from e.g. AppData.

By default WMI is used for quering the information. You can also use the method ( -method ) "external" for using pslist.

Use the parameter -Credential to supply different credentials.

EXAMPLES

Example 1

PS> Get-Process -Name "p.*shell"

This command searches for everything with the given pattern in the process name or in the executable path.

PARAMETERS

-BinPath

Binary path for external tools.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ComputerList

File with a list of computer names to process.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ComputerName

A list of computer names to process (comma separated).

Type: String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Credential

Credentials to use against remote host.

Type: PSCredential
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Session

PSSession for using instead of credentials.

Type: PSSession[]
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Method

Method to use.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-OutputFormat

...

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Name

Search for a process name. Regex is supported.

Type: String
Parameter Sets: ByName
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Id

Search for a process id.

Type: Int32
Parameter Sets: ByPid
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

PowerSponse Object

NOTES

RELATED LINKS