## PowerCLI Reference

# Get-VMGuest

## Synopsis

This cmdlet retrieves the guest operating systems of the specified virtual machines.

Syntax

Get-VMGuest [-VM] <VirtualMachine[]> [-Server <VIServer[]>] [<CommonParameters>]

Related Commands

Online version
Suspend-VMGuest
Stop-VMGuest
Restart-VMGuest

Detailed Description

This cmdlet retrieves the guest operating systems of the specified virtual machines. To specify a server different from the default one, use the Server parameter. When Get-VMGuest is run against a virtual machine that is just starting, the properties of the returned VMGuest object are not filled at one time.

Parameters

Name | Type | Description | Required? | Pipeline Input | Default Value
--- | --- | --- | --- | --- | ---
VM | VirtualMachine[] | Specifies the virtual machines whose guest operating systems you want to retrieve. | true | true (ByValue)
Server | VIServer[] | Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer. | false | false

Return Type

Zero or more VMGuest objects

Notes

Examples

-------------- Example 1 --------------

    Get-VMGuest -VM VM

Retrieves the guest OS of the virtual machine named VM.

Copyright © VMware, Inc. All rights reserved.