• Article

Getting Help for VMM Cmdlets

 

Updated: May 13, 2016

Applies To: System Center 2012 R2 Virtual Machine Manager, System Center 2012 - Virtual Machine Manager

Help topics are provided for each System Center 2012 – Virtual Machine Manager (VMM) cmdlet and describe what the cmdlet does and how to use it. Additionally, about topics provide additional information about VMM and using the VMM command shell.

Displaying the VMM cmdlets

You can display a list of all of the VMM cmdlets by using the Get-Commnand cmdlet. To view all of the VMM cmdlets, type the following in the VMM command shell:

Get-Command -Module VirtualMachineManager -CommandType Cmdlet

You can also use Get-Command to view all VMM cmdlets that contain specific nouns or verbs. For example, to display only those cmdlets that you can use with an SCVMHost object, type the following in the VMM command shell:

Get-Command -Module VirtualMachineManager -Noun SCVMHost

Or, you can see which objects you can create by displaying only those cmdlets that use the "New" verb:

Get-Command -Module VirtualMachineManager -Verb New

Displaying Cmdlet Help Topics in the VMM Command Shell

After you have established which VMM cmdlets you would like to obtain more information about, you can use the Get-Help cmdlet to display the help topic available for that cmdlet. For example, to view the cmdlet help for New-SCVMHost, type the following at the command prompt:

Get-Help New-SCVMHost

Get-Help Parameters

When you use Get-Help to view a help topic for a cmdlet, basic information is returned on that cmdlet. However, you can change how the help is displayed by using Get-Help with the following parameters:

  • Full

    Displays all available help for the cmdlet.

  • Detailed

    Displays the Synopsis, syntax, detailed description, parameter descriptions, and examples.

  • Examples

    Displays only the synopsis and examples.

  • Online

    Opens the online version of the help topic in your browser.

About Topics

To view the available about topics for System Center 2012 – Virtual Machine Manager, type the following in the VMM command shell:

Get-Help about_VMM*

This command displays a list of all the about topics. To view an individual about topic, type the following in the VMM command shell:

Get-Help about_VMM_2012_Virtual_Networking

Displaying Cmdlet Help Topics Online

The System Center 2012 – Virtual Machine Manager cmdlet help topics and about topics are available online in the TechNet Library.