Datasheet

Part I: PowerShell for Exchange Fundamentals
20
The command Get-Help < cmdlet name > -Full displays the entire contents of the help file for the
cmdlet including detailed information about each parameter.
The command
Get-Help < cmdlet name > -Examples displays the Examples topic along with the
Synopsis topic.
The command
Get-Help < cmdlet name > -Parameter < parameter name > displays the detailed
information about the specified parameter. Wildcards are permitted.
Although the descriptions and examples included in the help files are useful, you may find that the most
beneficial information for learning how to use a cmdlet are the details contained in the Syntax and
Parameter topics.
Syntax Details
The information included in the Syntax topic contains one or more syntax diagrams showing how the
cmdlet and its parameters are used. Some cmdlets can have more than one syntax diagram depending
on how the parameters work in combination with each other.
For example, the
Get-PublicFolderDatabase cmdlet has three distinct syntax diagrams in its help file.
Each diagram shows a different way to run the cmdlet depending on the parameters being used:
Get-PublicFolderDatabase [-Identity < DatabaseIdParameter > ] [-DomainControll
er < Fqdn > ] [-IncludePreExchange2007 < SwitchParameter > ] [-Status < SwitchPara
meter > ] [ < CommonParameters > ]
Get-PublicFolderDatabase -Server < ServerIdParameter > [-DomainController < Fq
dn > ] [-IncludePreExchange2007 < SwitchParameter > ] [-Status < SwitchParameter >
] [ < CommonParameters > ]
Get-PublicFolderDatabase -StorageGroup < StorageGroupIdParameter > [-DomainCo
ntroller < Fqdn > ] [-IncludePreExchange2007 < SwitchParameter > ] [-Status < Swit
chParameter > ] [ < CommonParameters > ]
The Get-PublicFolderDatabase can be used with the Identity parameter to identify a
specific database, the
Server parameter to specify the server where the database is located, and the
StorageGroup parameter to specify the storage group that holds the database. Each of these parameters
is exclusive and cannot be used in combination with one another, therefore the separate syntax diagrams
are necessary to show how each is used.
Parameter Details
Two levels of parameter details can be displayed using Get-Help . The Detailed parameter causes the
output to include the name and description of each parameter, but omits technical details. The
Full
parameter results in the display of all parameter details. To display the full details of a single given
parameter, the
Parameter parameter is used followed by the name of the parameter. The Detail , Full ,
and
Parameter parameters cannot be used in conjunction with one another.
c01.indd 20c01.indd 20 12/17/07 3:19:29 PM12/17/07 3:19:29 PM