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 versionDetailed Description
Adds a new route to the routing table of the provided virtual machines and guests. The cmdlet adds only persistent routes. 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 |
|---|---|---|---|---|---|
| Destination | IPAddress | Specify a destination IP address for the new route. | true | false | |
| Netmask | String | Specify a net mask for the new route. | false | false | |
| Gateway | IPAddress | Specify a gateway for the new route. | true | false | |
| Confirm | SwitchParameter | If 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. | false | false | $true |
| 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 | |
| Interface | Object | Specify a network interface for the new route. For Linux guest operating systems, this parameter is mandatory. | 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 | |
| VM | VirtualMachine[] | Specify the virtual machines to which you want to add the new route. | false | true (ByValue) | |
| VMGuest | VMGuest[] | Specify the guests to which you want to add the new route. | false | true (ByValue) | |
| WhatIf | SwitchParameter | Indicate that the cmdlet is run only to display the changes that would be made and actually no objects are modified. | false | false |
Return Type
VMGuestRouteNotes
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.