vSphere PowerCLI Reference



Creates a new route in the routing table of a host.


New-VMHostRoute [-VMHost] <VMHost[]> -Destination <IPAddress> -Gateway <IPAddress> -PrefixLength <Int32> [-Server <VIServer[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

Related Commands

Online version

Detailed Description

Creates a new route in the routing table of a host.


NameTypeDescriptionRequired?Pipeline InputDefault Value
VMHostVMHost[]Specify the host for which you want to create a new route.truetrue (ByValue)
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
DestinationIPAddressSpecify a destination IP address for the new route.truefalse
GatewayIPAddressSpecify a gateway IP address for the new route.truefalse
PrefixLengthInt32Specify the prefix length of the destination IP address. For IPv4, the valid values are from 0 to 32, and for IPv6 - from 0 to 128.truefalse
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
WhatIfSwitchParameterIndicate that the cmdlet is run only to display the changes that would be made and actually no objects are modified.falsefalse

Return Type



Supported only on ESX 4.0/ vCenter Server 4.0 and newer.


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

New-VMHostRoute -VMHost -Destination -PrefixLength 32 -Gateway

Creates a route for the specified host.

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