powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Get-VMGuestRoute



NAME
Get-VMGuestRoute

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

SYNTAX
Get-VMGuestRoute [[-VM] ] [-VMGuest ] [-Server ] [-ToolsWaitSecs ]
[-GuestPassword ] [-GuestUser ] [-GuestCredential ] [-HostPassword g>] [-HostUser ] [-HostCredential ] []


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 6
4bit and Redhat Enterprise 5 operating systems.


PARAMETERS
-VM
Specify the virtual machines for which you want to retrieve the routing configuration.

Required? false
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? true

-VMGuest
Specify the guest operating systems for which you want to retrieve the routing configuration.

Required? false
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false

-Server
Specify the vSphere servers on which you want to run the cmdlet. If no value is given to this parameter, the co
mmand runs on the default servers. For more information about default servers, see the description of Connect-V
IServer.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? true

-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.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-GuestPassword
Specify the password you want to use for authenticating with the guest OS.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-GuestUser
Specify the user name you want to use for authenticating with the guest OS.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-GuestCredential
Specify a PSCredential object that contains credentials for authenticating with the guest OS. Do not use this p
arameter if the -GuestUser and -GuestPassword parameters are used.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-HostPassword
Specify the password you want to use for authenticating with the host. You need to specify host credentials onl
y if the version of the vCenter Server or ESX you are authenticating with is earlier than 4.0, or the VIX versi
on you have installed is earlier than 1.10.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-HostUser
Specify the user name you want to use for authenticating with the host. You need to specify host credentials on
ly if the version of the vCenter Server or ESX you are authenticating with is earlier than 4.0, or the VIX vers
ion you have installed is earlier than 1.10.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-HostCredential
Specify a PSCredential object that contains credentials for authenticating with the host. Do not use this param
eter if the -HostUser and -HostPassword parameters are used. You need to specify host credentials only if the v
ersion of the vCenter Server or ESX you are authenticating with is earlier than 4.0, or the VIX version you hav
e installed is earlier than 1.10.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false


This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS



OUTPUTS
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 release.

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

C:\PS>Get-VMGuestRoute -VM $vm -HostUser Admin -HostPassword pass1 -GuestUser User -GuestPassword pass2


Retrieves the guest route of the $vm virtual machine.






RELATED LINKS
Online version: http://www.vmware.com/support/developer/PowerCLI/PowerCLI501/html/Get-VMGuestRoute.html
New-VMGuestRoute
Remove-VMGuestRoute