11/11/2008

You can use the Get-Helpand Get-Commandcmdlets to access Help information for each Mobile Device Manager (MDM) Shell cmdlet.

Get-Help Cmdlet

The following examples show you how to use the Get-Helpcmdlet. For more information about the Get-Helpcmdlet, at the MDM Shell command prompt, type Get-Help Get-Help -full.

Cmdlet Description

Get-Help

Displays basic instructions about how to use MDM Shell Help.

Get-Help <cmdlet>

Displays Help for a specified cmdlet. For example, to view Help for the Get-MDMDevicecmdlet, at the MDM Shell command prompt, type Get-Help Get-MDMDevice.

Get-Help <*cmdlet*>

Displays the cmdlets that match the provided text. You can use several methods to retrieve a list of MDM Shell cmdlets. For example, by typing Get-Help *-WipeRequest, you can view a list of all the cmdlets available for managing wipe requests.

Get-Help About_*

Displays the general MDM Shell Help topics. To learn more about a topic, at the MDM Shell command prompt, type Get-Help About_<feature>. For example, if you want to learn more about the Wherestatement, at the MDM Shell Command Prompt window, type Get-Help About_Where.

Get-Help <cmdlet> -Detailed

Displays some details for a specified cmdlet. For more information, see the Detailed column in the following Help View table.

Get-Help <cmdlet> -Full

Displays the full details for a specified cmdlet. For more information, see the Full column in the following Help View table.

Get-Help <cmdlet> -Examples

Displays examples for a specified cmdlet. For more information, see the Examples column in the following Help view table.

You can view Help for specific cmdlets by using that cmdlet as a parameter of the Get-Helpcmdlet. In some cases, you may only want to view specific information. However, the information that returns can be extensive. You can view specific information about a cmdlet without having to sort through information that you may not want.

The MDM Shell provides four views that present only the information that you want. Additionally, you can retrieve a specific parameter, or set of similar parameters, by using the Parameteroption.

The following shows the sections that display for each type of Help view.

Help view Default view Detailed Full Examples

Synopsis

X

X

X

X

Syntax

X

X

X

 

Detailed description

X

X

X

 

Parameters without metadata

 

X

 

 

Parameters with metadata

 

 

X

 

Input type

 

 

X

 

Return type

 

 

X

 

Errors

 

 

X

 

Notes

 

 

X

 

Examples

 

X

X

X

Related links

X

 

X

 

Remarks

X

X

 

 

Get-Command Cmdlet

The following examples show you how to use the Get-Commandcmdlet. For more information about the Get-Commandcmdlet, at the MDM Shell command prompt, type Get-Help Get-Command -full.

Cmdlet Description

Get-Command

Displays a list of all the cmdlets available to the MDM Shell. Similar to the Get-Helpcmdlet, the Get-Commandcmdlet lets you use wildcard character expansion. You can use this cmdlet with the Format-Listand Format-Tablecmdlets to provide a more readable format view. For example, use Get-Command | Format-Listto display the cmdlet Help in a list format.

Get-Command <Cmdlet>

Displays detailed information about the parameters and other components of the specified cmdlet. You can use this command together with the Format-Listand Format-Tablecmdlets to provide a more readable format view. For example, use Get-Command Get-MDMDevice | Format-Listto display the cmdlet Help in a list format.

Get-Command -Noun <CmdletNoun>

Displays all the cmdlets that perform actions on the noun specified. This command is useful when you want to view a list of all cmdlets that are associated with a particular feature. For example, the Get-Command -Noun EnrollmentRequestcommand returns all the cmdlets that manage enrollment requests. You can use this command together with the Format-Listand Format-Tablecmdlets to provide a more readable format view. For example, use Get-Command -Verb Get | Format-Listto display the command Help in a list format.

Get-Command -Verb <CmdletVerb>

Displays all the cmdlets that perform actions with the verb specified. This command is useful when you want to view a list of all cmdlets that are associated with a particular action. For example, the Get-Command -Verb Setcommand returns all cmdlets available that perform the set action. You can use this command together with the Format-Listand Format-Tablecmdlets to provide a more readable format view. For example, use Get-Command -Verb Set | Format-Listto display the command Help in a list format.

MDM Shell includes the built-in function Get-MDMCommandthat displays the same information as Get-Command, but for MDM cmdlets only. Without parameters, the function displays all the MDM cmdlets. You can also display information about a specific cmdlet, as in the following example.

Copy Code 
Get-MDMCommand New-WipeRequest | format-list

Parameters

Included in the Parameters section of the information that the Get-Helpcmdlet retrieves are details, also known as metadata, for each parameter. The following example is from the New-WipeRequestcmdlet.

Copy Code 
PARAMETERS
	-deviceId <DeviceIdParameter>
		Required?					true
		Position?					1
		Default value				variable
		Accept pipeline input?	 true (ByValue, ByPropertyName)
		Accept wildcard characters?  true

The following describes the details displayed for cmdlet parameters. Not all cmdlets include such details. However, most cmdlets do include some settings for each parameter as described in the following.

Setting Description

Required?

Indicates whether the cmdlet will run if you do not supply the parameter. When Required?is set to True, the MDM Console prompts you for the value if the parameter is not supplied on the command line.

Position?

Indicates whether you must put the parameter name in front of the parameter value. When Position?is set to Named, the parameter name is required.

When Position?is set to an integer, the name is not required, only the value.

Default value

Indicates the default value for this parameter if you do not provide another value.

Accept pipeline input?

Indicates whether the parameter can receive its value as input through a pipeline from another cmdlet. When Accept pipeline input?is set to ByValue, the cmdlet accepts the value of the parameter directly. For example, if the parameter is of type String, the cmdlet accepts a string through the pipeline.

When Accept pipeline input?is set to ByProperty, the cmdlet accepts an object through the pipeline that has a property of the same name as the parameter.

Accept wildcard characters?

Indicates whether the value of the parameter can contain wildcard characters and match to multiple objects.

See Also

Concepts

Overview of MDM Shell

Other Resources

MDM Shell