Accessing Help

Microsoft Platform Guide
Audience
Public
Source Type
Documentation

To access help for an individual cmdlet perform the following:


Get-Help <cmdlet_name>

After executing the Get-Help cmdlet, the help information will be displayed in the Windows PowerShell console. There are four different options for viewing help:

  1. -Basic - Shows only the essential information for the cmdlet
  2. -Examples -- Shows only examples of how to use a cmdlet.
  3. -Detailed -- Shows all information related to the cmdlet.
  4. -Full -- Shows full parameter information, detailed information and examples.

    Here is an example of using Get-Help Get-Pfa2Array -Detailed (if using version 1.x of the SDK, substitute Get-PfaArray)

    Here is an example of Get-Help New-Pfa2Array -Examples (if using version 1.x of the SDK, substitute New-PfaArray)