< Back
Set-VMHostNetworkAdapter
Post
NAME Set-VMHostNetworkAdapter
SYNOPSIS
This cmdlet configures the specified host network adapter.
SYNTAX
Set-VMHostNetworkAdapter [-AutomaticIPv6 <Boolean>] [-Dhcp] [-FaultToleranceLoggingEnabled <Boolean>] [-IP
<String>] [-IPv6 <String[]>] [-IPv6Enabled <Boolean>] [-IPv6ThroughDhcp <Boolean>] [-Mac <String>]
[-ManagementTrafficEnabled <Boolean>] [-Mtu <Int32>] [-SubnetMask <String>] -VirtualNic <HostVirtualNic[]>
[-VMotionEnabled <Boolean>] [-VsanTrafficEnabled <Boolean>] [-Confirm] [-WhatIf] [<CommonParameters>]
Set-VMHostNetworkAdapter [-AutoNegotiate] [-BitRatePerSecMb <Int32>] [-Duplex <String>] -PhysicalNic
<PhysicalNic[]> [-Confirm] [-WhatIf] [<CommonParameters>]
Set-VMHostNetworkAdapter -PortGroup <DistributedPortGroup> -VirtualNic <HostVirtualNic[]> [-Confirm] [-WhatIf]
[<CommonParameters>]
DESCRIPTION
This cmdlet configures the specified host network adapter. For a physical NIC, you can change the duplex and the
bit rate settings (10, 100, 1000, 10000). For a regular virtual NIC, you can change the IP address and the subnet
mask. For a console virtual NIC, you can modify the IP and the subnet mask, or choose DHCP mode.
PARAMETERS
-AutomaticIPv6 <Boolean>
Indicates that the IPv6 address is obtained through a router advertisement.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-AutoNegotiate [<SwitchParameter>]
Indicates that the host network adapter speed/duplex settings are configured automatically. Use this parameter
only if the Duplex and BitRatePerSecMb parameters are not set.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-BitRatePerSecMb <Int32>
Specifies the bit rate of the link. Only valid when configuring a physical NIC. Use this parameter only if the
AutoNegotiate parameter is not set. Note that updating the speed (BitRatePerSec) of a physical NIC might take
some time due to the hardware configuration being performed, and the returned object might still contain the
current configuration instead of the updated one.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Dhcp [<SwitchParameter>]
Indicates whether the host network adapter uses a Dhcp server. This parameter works only on ESXi hosts. For
VMKernel adapters, Dhcp is supported only on ESX 4.1 and later.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Duplex <String>
Indicates whether the link is capable of full-duplex. The valid values are Full and Half. You can set this
parameter only when updating a PhysicalNIC. Use this parameter only if the AutoNegotiate parameter is not set.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-FaultToleranceLoggingEnabled <Boolean>
Indicates that the network adapter is enabled for Fault Tolerance (FT) logging. This parameter is supported
only on ESX/vCenter Server 4.1 and later.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-IP <String>
Specifies an IP address for the network adapter using an IPv4 dot notation. If the NIC has no subnet mask
previously defined, you must also set the SubnetMask parameter. If the IP parameter is not specified, DHCP
mode is enabled. Only valid when configuring a virtual NIC.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-IPv6 <String[]>
Specifies static addresses using the following format: <IPv6>/<subnet_prefix_length> or <IPv6>. If you skip
<subnet_prefix_length>, the default value of 64 is used. Specifying a value for IPv6 parameter overrides the
current configuration. To clear all configured static IP addresses, pass an empty array to the IPv6 parameter.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-IPv6Enabled <Boolean>
Indicates that IPv6 configuration is enabled. Setting this parameter to $false disables all IPv6-related
parameters. If the value is $true", you need to provide values for at least one of the IPv6ThroughDhcp,
AutomaticIPv6, and IPv6 parameters.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-IPv6ThroughDhcp <Boolean>
Indicates that the IPv6 address is obtained through DHCP.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Mac <String>
Specifies the media access control (MAC) address of the virtual network adapter. Only valid when configuring a
virtual NIC.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ManagementTrafficEnabled <Boolean>
Indicates that you want to enable the network adapter for management traffic. This parameter is supported only
on ESX/ESXi/vCenter Server 4.1 and later.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Mtu <Int32>
Specifies the MTU size.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-PhysicalNic <PhysicalNic[]>
Specifies the PhysicalNIC objects you want to update.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-PortGroup <DistributedPortGroup>
Specifies a distributed port group to which you want to connect the host network adapter. You can use this
parameter only to migrate a virtual network adapter from a standard port group to a distributed port group.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-SubnetMask <String>
Specifies a subnet mask for the NIC. If the NIC has a subnet mask previously defined, specifying the
SubnetMask parameter when configuring the IP address is not mandatory unless you want to modify the mask. Only
valid when configuring a virtual NIC.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-VirtualNic <HostVirtualNic[]>
Provide a list of the host network adapters you want to configure.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-VMotionEnabled <Boolean>
Indicates that you want to use the virtual host/VMKernel network adapter for VMotion.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-VsanTrafficEnabled <Boolean>
Specifies whether Virtual SAN traffic is enabled on this network adapter.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are
modified.
Required? false
Position? named
Default value $true
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are
modified.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
Zero or more modified HostNic objects
NOTES
To configure IPv6 settings, you must be working on ESX 4.1 or later and IPv6 must be enabled on the ESX system.
-------------------------- Example 1 --------------------------
$vswitch = New-VirtualSwitch -VMHost 10.23.112.234 -Name VSwitch
$nic = New-VMHostNetworkAdapter -VMHost 10.23.112.234 -PortGroup PortGroup -VirtualSwitch $vswitch -IP
10.23.123.234 -SubnetMask 255.255.254.0
Set-VMHostNetworkAdapter -VirtualNIC $nic -IP 10.23.112.245 -SubnetMask 255.255.255.0 -Mtu 4000
Updates the network adapter IP address, Subnet mask, and MTU size.
-------------------------- Example 2 --------------------------
Get-VMHost Host | Get-VMHostNetworkAdapter -VMKernel | Set-VMHostNetworkAdapter -VMotionEnabled $true
Enable VMotion on all VMKernel network adapters on the specified host.
-------------------------- Example 3 --------------------------
Get-VMHostNetworkAdapter | where { $_.PortGroupName -eq "Service Console 1" } | Set-VMHostNetworkAdapter
-IPv6Enabled $false
Disables the IPv6 support on a network adapter.
-------------------------- Example 4 --------------------------
Get-VMHostNetworkAdapter | where { $_.PortGroupName -eq "Service Console 1" } | Set-VMHostNetworkAdapter
-IPv6ThroughDhcp $true
Configures a network adapter to obtain IPv6 through DHCP.
-------------------------- Example 5 --------------------------
Get-VMHostNetworkAdapter | where { $_.PortGroupName -eq "Service Console 1" } | Set-VMHostNetworkAdapter
-AutomaticIPv6 $true
Configures a network adapter to obtain IPv6 by a router advertisement.
-------------------------- Example 6 --------------------------
Get-VMHostNetworkAdapter | where { $_.PortGroupName -eq "Service Console 1" } | Set-VMHostNetworkAdapter -IPv6
$ipv6Address
Changes the IPv6 address of a network adapter.
RELATED LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... apter.html
New-VMHostNetworkAdapter
Remove-VMHostNetworkAdapter
SYNOPSIS
This cmdlet configures the specified host network adapter.
SYNTAX
Set-VMHostNetworkAdapter [-AutomaticIPv6 <Boolean>] [-Dhcp] [-FaultToleranceLoggingEnabled <Boolean>] [-IP
<String>] [-IPv6 <String[]>] [-IPv6Enabled <Boolean>] [-IPv6ThroughDhcp <Boolean>] [-Mac <String>]
[-ManagementTrafficEnabled <Boolean>] [-Mtu <Int32>] [-SubnetMask <String>] -VirtualNic <HostVirtualNic[]>
[-VMotionEnabled <Boolean>] [-VsanTrafficEnabled <Boolean>] [-Confirm] [-WhatIf] [<CommonParameters>]
Set-VMHostNetworkAdapter [-AutoNegotiate] [-BitRatePerSecMb <Int32>] [-Duplex <String>] -PhysicalNic
<PhysicalNic[]> [-Confirm] [-WhatIf] [<CommonParameters>]
Set-VMHostNetworkAdapter -PortGroup <DistributedPortGroup> -VirtualNic <HostVirtualNic[]> [-Confirm] [-WhatIf]
[<CommonParameters>]
DESCRIPTION
This cmdlet configures the specified host network adapter. For a physical NIC, you can change the duplex and the
bit rate settings (10, 100, 1000, 10000). For a regular virtual NIC, you can change the IP address and the subnet
mask. For a console virtual NIC, you can modify the IP and the subnet mask, or choose DHCP mode.
PARAMETERS
-AutomaticIPv6 <Boolean>
Indicates that the IPv6 address is obtained through a router advertisement.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-AutoNegotiate [<SwitchParameter>]
Indicates that the host network adapter speed/duplex settings are configured automatically. Use this parameter
only if the Duplex and BitRatePerSecMb parameters are not set.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-BitRatePerSecMb <Int32>
Specifies the bit rate of the link. Only valid when configuring a physical NIC. Use this parameter only if the
AutoNegotiate parameter is not set. Note that updating the speed (BitRatePerSec) of a physical NIC might take
some time due to the hardware configuration being performed, and the returned object might still contain the
current configuration instead of the updated one.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Dhcp [<SwitchParameter>]
Indicates whether the host network adapter uses a Dhcp server. This parameter works only on ESXi hosts. For
VMKernel adapters, Dhcp is supported only on ESX 4.1 and later.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Duplex <String>
Indicates whether the link is capable of full-duplex. The valid values are Full and Half. You can set this
parameter only when updating a PhysicalNIC. Use this parameter only if the AutoNegotiate parameter is not set.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-FaultToleranceLoggingEnabled <Boolean>
Indicates that the network adapter is enabled for Fault Tolerance (FT) logging. This parameter is supported
only on ESX/vCenter Server 4.1 and later.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-IP <String>
Specifies an IP address for the network adapter using an IPv4 dot notation. If the NIC has no subnet mask
previously defined, you must also set the SubnetMask parameter. If the IP parameter is not specified, DHCP
mode is enabled. Only valid when configuring a virtual NIC.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-IPv6 <String[]>
Specifies static addresses using the following format: <IPv6>/<subnet_prefix_length> or <IPv6>. If you skip
<subnet_prefix_length>, the default value of 64 is used. Specifying a value for IPv6 parameter overrides the
current configuration. To clear all configured static IP addresses, pass an empty array to the IPv6 parameter.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-IPv6Enabled <Boolean>
Indicates that IPv6 configuration is enabled. Setting this parameter to $false disables all IPv6-related
parameters. If the value is $true", you need to provide values for at least one of the IPv6ThroughDhcp,
AutomaticIPv6, and IPv6 parameters.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-IPv6ThroughDhcp <Boolean>
Indicates that the IPv6 address is obtained through DHCP.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Mac <String>
Specifies the media access control (MAC) address of the virtual network adapter. Only valid when configuring a
virtual NIC.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ManagementTrafficEnabled <Boolean>
Indicates that you want to enable the network adapter for management traffic. This parameter is supported only
on ESX/ESXi/vCenter Server 4.1 and later.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Mtu <Int32>
Specifies the MTU size.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-PhysicalNic <PhysicalNic[]>
Specifies the PhysicalNIC objects you want to update.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-PortGroup <DistributedPortGroup>
Specifies a distributed port group to which you want to connect the host network adapter. You can use this
parameter only to migrate a virtual network adapter from a standard port group to a distributed port group.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-SubnetMask <String>
Specifies a subnet mask for the NIC. If the NIC has a subnet mask previously defined, specifying the
SubnetMask parameter when configuring the IP address is not mandatory unless you want to modify the mask. Only
valid when configuring a virtual NIC.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-VirtualNic <HostVirtualNic[]>
Provide a list of the host network adapters you want to configure.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-VMotionEnabled <Boolean>
Indicates that you want to use the virtual host/VMKernel network adapter for VMotion.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-VsanTrafficEnabled <Boolean>
Specifies whether Virtual SAN traffic is enabled on this network adapter.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are
modified.
Required? false
Position? named
Default value $true
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are
modified.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
Zero or more modified HostNic objects
NOTES
To configure IPv6 settings, you must be working on ESX 4.1 or later and IPv6 must be enabled on the ESX system.
-------------------------- Example 1 --------------------------
$vswitch = New-VirtualSwitch -VMHost 10.23.112.234 -Name VSwitch
$nic = New-VMHostNetworkAdapter -VMHost 10.23.112.234 -PortGroup PortGroup -VirtualSwitch $vswitch -IP
10.23.123.234 -SubnetMask 255.255.254.0
Set-VMHostNetworkAdapter -VirtualNIC $nic -IP 10.23.112.245 -SubnetMask 255.255.255.0 -Mtu 4000
Updates the network adapter IP address, Subnet mask, and MTU size.
-------------------------- Example 2 --------------------------
Get-VMHost Host | Get-VMHostNetworkAdapter -VMKernel | Set-VMHostNetworkAdapter -VMotionEnabled $true
Enable VMotion on all VMKernel network adapters on the specified host.
-------------------------- Example 3 --------------------------
Get-VMHostNetworkAdapter | where { $_.PortGroupName -eq "Service Console 1" } | Set-VMHostNetworkAdapter
-IPv6Enabled $false
Disables the IPv6 support on a network adapter.
-------------------------- Example 4 --------------------------
Get-VMHostNetworkAdapter | where { $_.PortGroupName -eq "Service Console 1" } | Set-VMHostNetworkAdapter
-IPv6ThroughDhcp $true
Configures a network adapter to obtain IPv6 through DHCP.
-------------------------- Example 5 --------------------------
Get-VMHostNetworkAdapter | where { $_.PortGroupName -eq "Service Console 1" } | Set-VMHostNetworkAdapter
-AutomaticIPv6 $true
Configures a network adapter to obtain IPv6 by a router advertisement.
-------------------------- Example 6 --------------------------
Get-VMHostNetworkAdapter | where { $_.PortGroupName -eq "Service Console 1" } | Set-VMHostNetworkAdapter -IPv6
$ipv6Address
Changes the IPv6 address of a network adapter.
RELATED LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... apter.html
New-VMHostNetworkAdapter
Remove-VMHostNetworkAdapter