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 32 SP3, Windows Server 2003 32bit SP2, Windows Server 2003 64bit SP2, Windows 7 64 bit, Windows Server 2008 R2 64bit and Redhat Enterprise 5 operating systems.

To run this cmdlet against vCenter Server/ESX/ESXi versions earlier than 5.0, you need to meet the following requirements:
*You must run the cmdlet on the 32-bit version of Windows PowerShell.
*You must have access to the ESX that hosts the virtual machine over TCP port 902.
*For vCenter Server/ESX/ESXi versions earlier than 4.1, you need VirtualMachine.Interact.ConsoleInteract privilege. For vCenter Server/ESX/ESXi 4.1 and later, you need VirtualMachine.Interact.GuestControl privilege.

To run this cmdlet against vCenter Server/ESXi 5.0 and later, you need VirtualMachine.GuestOperations.Execute and VirtualMachine.GuestOperations.Modify privileges.

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

This cmdlet is experimental and might be changed or removed in a future rel ease.

Examples

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

Get-VMGuestRoute -VM $vm -GuestUser User -GuestPassword pass2

Retrieves the guest route of the $vm virtual machine.


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