PowerCLI Reference



This cmdlet creates a new route in the routing table of a host.


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

Related Commands

Online Version

Detailed Description

This cmdlet creates a new route in the routing table of a host.


NameTypeDescriptionRequired?Pipeline InputDefault Value
VMHostVMHostSpecifies the host for which you want to create a new route. Passing multiple values to this parameter is obsolete.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
DestinationIPAddressSpecifies a destination IP address for the new route.trueFalse
GatewayIPAddressSpecifies a gateway IP address for the new route.trueFalse
PrefixLengthInt32Specifies 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[]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.falseFalse
WhatIfSwitchParameterIndicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.falseFalse

Return Type

The one or more newly created VMHostRoute objects


Supported only on ESX 4.1/ vCenter Server 4.1 and later.


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

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

Creates a route for the specified host.

Copyright © VMware, Inc. All rights reserved.