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 versionDetailed 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.Parameters
| Name | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| VM | VirtualMachine[] | Specify the virtual machines for which you want to retrieve the routing configuration. | false | true (ByValue) | |
| GuestCredential | PSCredential | 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 | |
| GuestPassword | SecureString | Specify the password you want to use for authenticating with the guest OS. | false | false | |
| GuestUser | String | Specify the user name you want to use for authenticating with the guest OS. | false | false | |
| HostCredential | PSCredential | 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. 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. | false | false | |
| HostPassword | SecureString | Specify 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. | false | false | |
| HostUser | String | Specify 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. | false | false | |
| Server | VIServer[] | 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 | Int32 | 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 | |
| VMGuest | VMGuest[] | Specify the guest operating systems for which you want to retrieve the routing configuration. | false | true (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.