Powershell – Help, Get-Help

PowerShell help
The existing cmdlet to get help regarding Windows Powershell concepts and language is Get-Help.
To display information about Get-Help cmdlet, type:

Get-Help

To display information about all existing Powershell topics (cmdlets providers, functions and scripts), type:

Get-Help *

To display information about all Powershell functions, type:

Get-Help -Category Function

To display basic information about a specific Powershell cmdlet, type (in this example Get-Host cmdlet):

Get-Help -Name Get-Host

Note: The parameter name –name can be omitted as it’s by default the first input parameter for Get-Help cmdlet. The last command could by typed Get-Help Get-Host
 
Specific or detailed help
To display complete information about a specific Powershell cmdlet (example Get-Host), type:

Get-Help -Full Get-Host

To display basic information but with parameters description and examples about a specific Powershell cmdlet (example Get-Host), type:

Get-Help -Detailed Get-Host

To display detailed information about a specific Powershell cmdlet parameter or parameters (example all parameters of Get-Process), type:

Get-Help Get-Process -Parameter *

To display basic information with examples about a specific Powershell cmdlet (example all parameters of Get-Process), type:

Get-Help Get-Process -Examples

 
On-line help with Get-Help
To display online, very detailed information about a specific Powershell cmdlet, type (example all parameters of Get-Process):

Get-Help Get-Process -Online

This online help can be used with cmdlets, functions and scripts.
 
In Depth / References

http://technet.microsoft.com/en-us/library/ee176848.aspx
http://technet.microsoft.com/en-us/library/dd347689.aspx

Tested with

PowerShell 2.0

v0.03

Advertisements
Categories: Powershell | Leave a comment

Post navigation

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s

Blog at WordPress.com.

%d bloggers like this: