vSphere PowerCLI Reference

New-VMGuestRoute

Synopsis

Adds a new route to the routing table of the provided virtual machines and guests.

Syntax

New-VMGuestRoute [-VM <VirtualMachine[]>] [-Destination] <IPAddress> [[-Netmask] <String>] [-Gateway] <IPAddress> [-Interface <Object>] [-VMGuest <VMGuest[]>] [-Server <VIServer[]>] [-ToolsWaitSecs <Int32>] [-GuestPassword <SecureString>] [-GuestUser <String>] [-GuestCredential <PSCredential>] [-HostPassword <SecureString>] [-HostUser <String>] [-HostCredential <PSCredential>] [-WhatIf] [-Confirm] [<CommonParameters>]

Related Commands

Online version
Get-VMGuestRoute
Remove-VMGuestRoute

Detailed Description

Adds a new route to the routing table of the provided virtual machines and guests. The cmdlet adds only persistent routes.
New-VMGuestRoute 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 NewVMGuestRoute.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
DestinationIPAddressSpecify a destination IP address for the new route.truefalse
NetmaskStringSpecify a net mask for the new route.falsefalse
GatewayIPAddressSpecify a gateway for the new route.truefalse
ConfirmSwitchParameterIf the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.falsefalse$true
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
InterfaceObjectSpecify a network interface for the new route. For Linux guest operating systems, this parameter is mandatory.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
VMVirtualMachine[]Specify the virtual machines to which you want to add the new route.falsetrue (ByValue)
VMGuestVMGuest[]Specify the guests to which you want to add the new route.falsetrue (ByValue)
WhatIfSwitchParameterIndicate that the cmdlet is run only to display the changes that would be made and actually no objects are modified.falsefalse

Return Type

VMGuestRoute

Notes

Supported on ESX 3.5 Update 2 and newer. Consider that New-VMGuestRoute mig ht behave inconsistently and create different types of routes depending on the OS type - Windows or Linux. 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 --------------

New-VMGuestRoute -HostUser admin -HostPassword pass1 -GuestUser user -GuestPassword pass2 -VM $vm -Destination '192.168.100.10' -Netmask '255.255.255.255' -Gateway '10.23.112.58'

Creates a new guest route with the specified parameters.


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