vSphere PowerCLI 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

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

NameTypeDescriptionRequired?Pipeline InputDefault Value
VMVirtualMachine[]Specify the virtual machines for which you want to retrieve the routing configuration.falsetrue (ByValue)
GuestCredentialPSCredentialSpecify 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.falsefalse
GuestPasswordSecureStringSpecify the password you want to use for authenticating with the guest OS.falsefalse
GuestUserStringSpecify the user name you want to use for authenticating with the guest OS.falsefalse
HostCredentialPSCredentialSpecify a PSCredential object that contains credentials for authenticating with the host. Do not use this parameter if the -HostUser and -HostPassword parameters are used. You need to specify host credentials only if the version of the vCenter Server or ESX you are authenticating with is earlier than 4.0, or the VIX version you have installed is earlier than 1.10.falsefalse
HostPasswordSecureStringSpecify the password you want to use for authenticating with the host. You need to specify host credentials only if the version of the vCenter Server or ESX you are authenticating with is earlier than 4.0, or the VIX version you have installed is earlier than 1.10.falsefalse
HostUserStringSpecify the user name you want to use for authenticating with the host. You need to specify host credentials only if the version of the vCenter Server or ESX you are authenticating with is earlier than 4.0, or the VIX version you have installed is earlier than 1.10.falsefalse
ServerVIServer[]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.falsefalse
ToolsWaitSecsInt32Specify 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.falsefalse
VMGuestVMGuest[]Specify the guest operating systems for which you want to retrieve the routing configuration.falsetrue (ByValue)

Return Type

VMGuestRoute[]

Notes

Supported on ESX 3.5 Update 2 and newer. This cmdlet works only in 32-bit mode. This cmdlet is experimental and might be changed or removed in a future rel ease.

Examples

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

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

Retrieves the guest route of the $vm virtual machine.


Copyright © 1998 - 2011 VMware, Inc. All rights reserved.