PowerCLI Reference

New-VMGuestRoute

Synopsis

This cmdlet 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

This cmdlet is deprecated. Use Invoke-VMGuestScript instead.

This cmdlet adds a new route to the routing table of the provided virtual machines and guests. The cmdlet adds only persistent routes. For a list of supported operating systems, see the PowerCLI User's Guide.

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

Name	Type	Description	Required?	Pipeline Input
Destination	IPAddress	Specifies a destination IP address for the new route.	true	false
Netmask	String	Specifies a network mask for the new route.	false	false
Gateway	IPAddress	Specifies 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
GuestCredential	PSCredential	Specifies 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	Specifies the password you want to use for authenticating with the guest OS.	false	false
GuestUser	String	Specifies the user name you want to use for authenticating with the guest OS.	false	false
HostCredential	PSCredential	Specifies 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	Specifies 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	Specifies 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	Specifies a network interface for the new route. For Linux guest operating systems, this parameter is mandatory.	false	false
Server	VIServer[]	Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is passed 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	Specifies the time in seconds to wait for a response from VMware Tools. If a non-positive value is provided, the system waits infinitely long time.	false	false
VM	VirtualMachine[]	Specifies the virtual machines to which you want to add the new route.	false	true (ByValue)
VMGuest	VMGuest[]	Specifies the guests to which you want to add the new route.	false	true (ByValue)
WhatIf	SwitchParameter	Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.	false	false

Return Type

The newly created VMGuestRoute object

Notes

Consider that New-VMGuestRoute might behave inconsistently and create different types of routes depending on the OS type - Windows or Linux. This cmdlet is not compatible with IPv6 environments.

Examples

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

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