vSphere PowerCLI Cmdlets Reference

Get-VMGuestRoute

Synopsis

Retrieves the routing configuration of the specified virtual machines or guests.

Syntax

Get-VMGuestRoute [[-VM] <VirtualMachine[]>] [-VMGuest <VMGuest[]>] [-Server <VIServer[]>] [-ToolsWaitSecs <Int32>] [-GuestPassword <SecureString>] [-GuestUser <String>] [-GuestCredential <PSCredential>] [-HostPassword <SecureString>] [-HostUser <String>] [-HostCredential <PSCredential>] [<CommonParameters>]

Related Commands

Online version
New-VMGuestRoute
Remove-VMGuestRoute
Set-VMGuestRoute

Detailed Description

Retrieves the routing configuration of the specified virtual machines or guests. This cmdlet supports only Windows XP, Windows Server 2003, and Linux RedHat Enterprise 5. You can enhance this cmdlet to support other guest operating systems by modifying or adding custom scripts. The custom scripts are located in the "Scripts" folder in the PowerCLI installation directory and their names have the following format:

<CmdletName>_<OS_Identifier>

<OSIdentifier> is the guest family or the guest ID as returned by Get-VMGuest.
<CmdletName> is the name of the cmdlet without a hyphen, for example GetVMGuestRoute.

Parameters

Name	Description	Required?	Pipeline Input
VM	Specify the virtual machines for which you want to retrieve the routing configuration.	false	true (ByValue)
VMGuest	Specify the guest operating systems for which you want to retrieve the routing configuration.	false	true (ByValue)
Server	Specify the vSphere servers on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.	false	false
ToolsWaitSecs	Specify the time in seconds to wait for a response from the VMware Tools. If a non-positive value is provided, the system waits infinitely long time.	false	false
GuestPassword	Specify the password you want to use for authenticating with the guest OS.	false	false
GuestUser	Specify the user name you want to use for authenticating with the guest OS.	false	false
GuestCredential	Specify a PSCredential object that contains credentials for authenticating with the guest OS. Do not use this parameter if the -GuestUser and -GuestPassword parameters are used.	false	false
HostPassword	Specify the password you want to use for authenticating with the host.	false	false
HostUser	Specify the user name you want to use for authenticating with the host.	false	false
HostCredential	Specify a PSCredential object that contains credentials for authenticating with the host. Do not use this parameter if the -HostUser and -HostPassword parameters are used.	false	false

Return Type

VMGuestRoute[]

Notes

Supported on ESX 3.5 Update 2 and newer. Consider that this functionality i s experimental.

Examples

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

Get-VMGuestRoute -VM $vm -HostUser Admin -HostPassword pass1 -GuestUser User -GuestPassword pass2

Retrieves the guest route of the $vm virtual machine.