Getting started with PowerShell Loops Operators Using ShouldProcess PowerShell Classes Switch statement Working with Objects Using existing static classes Basic Set Operations PowerShell Functions Sending Email Handling Secrets and Credentials Powershell Remoting PowerShell "Streams"; Debug, Verbose, Warning, Error, Output and Information Variables in PowerShell Communicating with RESTful APIs Working with the PowerShell pipeline PowerShell Background Jobs Return behavior in PowerShell Working with XML Files Introduction to Psake Using the progress bar Strings TCP Communication with PowerShell SharePoint Module Aliases Automatic Variables Environment Variables Powershell profiles Enforcing script prerequisites Using the Help System Splatting Desired State Configuration Signing Scripts Security and Cryptography CSV parsing Introduction to Pester Modules, Scripts and Functions PowerShell.exe Command-Line Common parameters Parameter sets Regular Expressions PowerShell Dynamic Parameters WMI and CIM GUI in Powershell Conditional logic URL Encode/Decode MongoDB Running Executables Error handling HashTables ActiveDirectory module powershell sql queries Automatic Variables - part 2 Package management Cmdlet Naming Built-in variables Creating DSC Class-Based Resources Powershell Modules PowerShell Workflows How to download latest artifact from Artifactory using Powershell script (v2.0 or below)?Calculated Properties Special Operators Anonymize IP (v4 and v6) in text file with Powershell Comment-based help Amazon Web Services (AWS) Simple Storage Service (S3)Amazon Web Services (AWS) Rekognition PSScriptAnalyzer - PowerShell Script Analyzer Naming Conventions Embedding Managed Code (C# | VB)Archive Module Infrastructure Automation Scheduled tasks module ISE module

Using the Help System

Remarks:

Get-Help is a cmdlet for reading help topics in PowerShell.

Updating the Help System

3.0

Beginning with PowerShell 3.0, you can download and update the offline help documentation using a single cmdlet.

Update-Help

To update help on multiple computers (or computers not connected to the internet).

Run the following on a computer with the help files

Save-Help -DestinationPath \\Server01\Share\PSHelp -Credential $Cred

To run on many computers remotely

Invoke-Command -ComputerName (Get-Content Servers.txt) -ScriptBlock {Update-Help -SourcePath \\Server01\Share\Help -Credential $cred}

Using Get-Help

Get-Help can be used to view help in PowerShell. You can search for cmdlets, functions, providers or other topics.

In order to view the help documentation about jobs, use:

Get-Help about_Jobs

You can search for topics using wildcards. If you want to list available help topics with a title starting with about_, try:

Get-Help about_*

If you wanted help on Select-Object, you would use:

Get-Help Select-Object

You can also use the aliases help or man.

Viewing online version of a help topic

You can access online help documentation using:

Get-Help Get-Command -Online

Viewing Examples

Show usage examples for a specific cmdlet.

Get-Help Get-Command -Examples

Viewing the Full Help Page

View the full documentation for the topic.

Get-Help Get-Command -Full

Viewing help for a specific parameter

You can view help for a specific parameter using:

Get-Help Get-Content -Parameter Path

Contributors

Topic Id: 5644

Example Ids: 20014,20015,20016,20017,20018,20020

This site is not affiliated with any of the contributors.