PowerCLI Reference



This cmdlet updates the specified virtual network.


Set-VMHostNetwork [-Network] <VMHostNetworkInfo[]> [-ConsoleGateway <String>] [-ConsoleGatewayDevice <String>] [-ConsoleV6Gateway <String>] [-ConsoleV6GatewayDevice <String>] [-DnsAddress <String[]>] [-DnsDhcpDevice <Object>] [-DnsFromDhcp <Boolean>] [-DomainName <String>] [-HostName <String>] [-IPv6Enabled <Boolean>] [-SearchDomain <String[]>] [-VMKernelGateway <String>] [-VMKernelGatewayDevice <String>] [-VMKernelV6Gateway <String>] [-VMKernelV6GatewayDevice <String>] [-Confirm] [-WhatIf] [<CommonParameters>]

Related Commands

Online Version

Detailed Description

This cmdlet updates the specified virtual network. The service console and the VMkernel are often not connected to the same network, and therefore each needs its own gateway information. A gateway is needed for connectivity to machines not on the same IP subnet as the service console or VMkernel.


NameTypeDescriptionRequired?Pipeline InputDefault Value
NetworkVMHostNetworkInfo[]Specifies the host network you want to configure.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
ConsoleGatewayStringSpecifies a new console gateway.falseFalse
ConsoleGatewayDeviceStringSpecifies a new console gateway device.falseFalse
ConsoleV6GatewayStringSpecifies a console V6 gateway address. Not supported on ESXi.falseFalse
ConsoleV6GatewayDeviceStringSpecifies a console V6 gateway device. Not supported on ESXi.falseFalse
DnsAddressString[]Specifies a new DNS address.falseFalse
DnsDhcpDeviceObjectThis parameter is mandatory if the value of the DnsFromDhcp parameter is 'true'. Otherwise, it is disregarded. If the DnsDhcpDevice parameter is set, the Dhcp DNS of the service console or VMKernel network adapter will override the system DNS. The parameter takes a ServiceConsoleNIC object, a VMKernelNIC object in case of an ESX visor, or the NIC name as a string.falseFalse
DnsFromDhcpBooleanIndicates that you want to obtain the network settings from a Dhcp server.falseFalse
DomainNameStringSpecifies a new domain name.falseFalse
HostNameStringSpecifies a new host name.falseFalse
IPv6EnabledBooleanIndicates that IPv6 configuration is enabled. Setting this parameter to $false disables the ConsoleV6Gateway, ConsoleV6GatewayDevice, and VMKernelV6Gateway parameters. IPv6 is supported only on vCenter 4.1 and ESX 4.1 or later. To use IPv6 on ESX, you must restart the host after enabling IPv6.falseFalse
SearchDomainString[]Specifies a new search domain.falseFalse
VMKernelGatewayStringSpecifies a new kernel gateway.falseFalse
VMKernelGatewayDeviceStringSpecifies a new kernel gateway device.falseFalse
VMKernelV6GatewayStringSpecifies a VMKernel V6 gateway address. This parameter is supported only on ESX hosts.falseFalse
VMKernelV6GatewayDeviceStringSpecifies a VMKernel V6 gateway device. This parameter is supported only on ESX hosts.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

Zero or more modified VMHostNetworkInfo objects


If "DnsFromDhcp" is enabled "DomainName" and "HostName" cannot be explicitly set. To configure IPv6 settings, you must be working on ESX 4.1 or later, and IPv6 must be enabled on the host system. The new IPv6 settings take effect after the host is restarted.


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

$vmHostNetworkInfo = Get-VmHostNetwork -Host Host

Set-VmHostNetwork -Network $vmHostNetworkInfo -VMKernelGateway -DomainName eng.vmware.com -HostName Host1 -DnsFromDhcp $false

Gets the network configuration of the virtual machine host named Host. Sets the virtual machine kernel gateway, the domain name, the host name, and the Dhcp of the network.

-------------------------- Example 2 --------------------------

Get-VMHost Host | Get-VMHostNetwork | Set-VMHostNetwork -IPv6Enabled $true

Get-VMHost Host | Restart-VMHost -Force -Confirm:$false

Enables IPv6 support on the Host host and restarts the host.

-------------------------- Example 3 --------------------------

Get-VMHost Host | Get-VMHostNetwork | Set-VMHostNetwork -ConsoleV6Gateway $ipv6GatewayAddress -ConsoleV6GatewayDevice "vswif0"

Configures the IPv6 console default gateway on the Host host.

-------------------------- Example 4 --------------------------

Get-VMHost Host | Get-VMHostNetwork | Set-VMHostNetwork -VMKernelV6Gateway $ipv6GatewayAddress

Configures the IPv6 VMKernel default gateway on the Host host.

Copyright © VMware, Inc. All rights reserved.