< Back
Set-NicTeamingPolicy
Post
NAME Set-NicTeamingPolicy
SYNOPSIS
This cmdlet modifies the specified NIC teaming policy.
SYNTAX
Set-NicTeamingPolicy [-VirtualSwitchPolicy] <NicTeamingVirtualSwitchPolicy[]> [-BeaconInterval <Int32>]
[-FailbackEnabled <Boolean>] [-LoadBalancingPolicy <LoadBalancingPolicy>] [-MakeNicActive <PhysicalNic[]>]
[-MakeNicStandby <PhysicalNic[]>] [-MakeNicUnused <PhysicalNic[]>] [-NetworkFailoverDetectionPolicy
<NetworkFailoverDetectionPolicy>] [-NotifySwitches <Boolean>] [-Confirm] [-WhatIf] [<CommonParameters>]
Set-NicTeamingPolicy [-VirtualPortGroupPolicy] <NicTeamingVirtualPortGroupPolicy[]> [-FailbackEnabled <Boolean>]
[-InheritFailback <Boolean>] [-InheritFailoverOrder <Boolean>] [-InheritLoadBalancingPolicy <Boolean>]
[-InheritNetworkFailoverDetectionPolicy <Boolean>] [-InheritNotifySwitches <Boolean>] [-LoadBalancingPolicy
<LoadBalancingPolicy>] [-MakeNicActive <PhysicalNic[]>] [-MakeNicStandby <PhysicalNic[]>] [-MakeNicUnused
<PhysicalNic[]>] [-NetworkFailoverDetectionPolicy <NetworkFailoverDetectionPolicy>] [-NotifySwitches <Boolean>]
[-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
This cmdlet modifies the specified NIC teaming policy. You can change the load balancing and failover settings.
Default NIC teaming policies are set for the entire virtual switch and can be overridden at port group level.
PARAMETERS
-BeaconInterval <Int32>
Specifies the interval at which the server sends out beacon probes on all NICs in the team. The value must be
a positive integer. This parameter is used when the value of the NetworkFailoverDetectionPolicy parameter is
BeaconProbing.
Required? false
Position? named
Default value $null
Accept pipeline input? False
Accept wildcard characters? false
-FailbackEnabled <Boolean>
Specifies how a physical adapter is returned to active duty after recovering from a failure. If the value is
$true, the adapter is returned to active duty immediately on recovery, displacing the standby adapter that
took over its slot, if any. If the value is $false, a failed adapter is left inactive even after recovery
until another active adapter fails, requiring its replacement.
Required? false
Position? named
Default value $true
Accept pipeline input? False
Accept wildcard characters? false
-InheritFailback <Boolean>
Indicates that the value of the FailbackEnabled parameter is inherited from the virtual switch.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-InheritFailoverOrder <Boolean>
Indicates that the value of the MakeNicActive, MakeNicStandBy, and MakeNicUnused parameters are inherited from
the virtual switch.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-InheritLoadBalancingPolicy <Boolean>
Indicates that the value of the LoadBalancingPolicy parameter is inherited from the virtual switch.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-InheritNetworkFailoverDetectionPolicy <Boolean>
Indicates that the value of the NetworkFailoverDetectionPolicy parameter is inherited from the virtual switch.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-InheritNotifySwitches <Boolean>
Indicates that the value of the NotifySwitches parameter is inherited from the virtual switch.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-LoadBalancingPolicy <LoadBalancingPolicy>
Determines how network traffic is distributed between the network adapters assigned to a switch. The following
values are valid:
LoadBalanceIP - Route based on IP hash. Choose an uplink based on a hash of the source and destination IP
addresses of each packet. For non-IP packets, whatever is at those offsets is used to compute the hash.
LoadBalanceSrcMac - Route based on source MAC hash. Choose an uplink based on a hash of the source Ethernet.
LoadBalanceSrcId - Route based on the originating port ID. Choose an uplink based on the virtual port where
the traffic entered the virtual switch.
ExplicitFailover - Always use the highest order uplink from the list of Active adapters that passes failover
detection criteria.
Required? false
Position? named
Default value $null
Accept pipeline input? False
Accept wildcard characters? false
-MakeNicActive <PhysicalNic[]>
Specifies the adapters you want to continue to use when the network adapter connectivity is available and
active.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-MakeNicStandby <PhysicalNic[]>
Specifies the adapters you want to use if one of the active adapter's connectivity is unavailable.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-MakeNicUnused <PhysicalNic[]>
Specifies the adapters you do not want to use.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-NetworkFailoverDetectionPolicy <NetworkFailoverDetectionPolicy>
Specifies how to reroute traffic in the event of an adapter failure. The following values are valid:
LinkStatus - Relies solely on the link status that the network adapter provides. This option detects failures,
such as cable pulls and physical switch power failures, but not configuration errors, such as a physical
switch port being blocked by spanning tree or misconfigured to the wrong VLAN or cable pulls on the other side
of a physical switch.
BeaconProbing - Sends out and listens for beacon probes on all NICs in the team and uses this information, in
addition to link status, to determine link failure. This option detects many of the failures mentioned above
that are not detected by link status alone.
Required? false
Position? named
Default value $null
Accept pipeline input? False
Accept wildcard characters? false
-NotifySwitches <Boolean>
Indicates that whenever a virtual NIC is connected to the virtual switch or whenever that virtual NIC's
traffic is routed over a different physical NIC in the team because of a failover event, a notification is
sent over the network to update the lookup tables on the physical switches.
Required? false
Position? named
Default value $true
Accept pipeline input? False
Accept wildcard characters? false
-VirtualPortGroupPolicy <NicTeamingVirtualPortGroupPolicy[]>
Specifies the virtual port group policy to configure.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-VirtualSwitchPolicy <NicTeamingVirtualSwitchPolicy[]>
Specifies the virtual switch policy to configure.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? 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.
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 NicTeamingVirtualSwitchPolicy or NicTeamingVirtualPortGroupPolicy objects
NOTES
-------------------------- Example 1 --------------------------
$policy = Get-VirtualSwitch -VMHost (Get-VMHost *.128) -Name vSwitch1 | Get-NicTeamingPolicy
$policy | Set-NicTeamingPolicy -LoadBalancingPolicy LoadBalanceSrcMac
Configures the NicTeaming policy of the vSwitch1 virtual switch.
RELATED LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... olicy.html
Get-NicTeamingPolicy
SYNOPSIS
This cmdlet modifies the specified NIC teaming policy.
SYNTAX
Set-NicTeamingPolicy [-VirtualSwitchPolicy] <NicTeamingVirtualSwitchPolicy[]> [-BeaconInterval <Int32>]
[-FailbackEnabled <Boolean>] [-LoadBalancingPolicy <LoadBalancingPolicy>] [-MakeNicActive <PhysicalNic[]>]
[-MakeNicStandby <PhysicalNic[]>] [-MakeNicUnused <PhysicalNic[]>] [-NetworkFailoverDetectionPolicy
<NetworkFailoverDetectionPolicy>] [-NotifySwitches <Boolean>] [-Confirm] [-WhatIf] [<CommonParameters>]
Set-NicTeamingPolicy [-VirtualPortGroupPolicy] <NicTeamingVirtualPortGroupPolicy[]> [-FailbackEnabled <Boolean>]
[-InheritFailback <Boolean>] [-InheritFailoverOrder <Boolean>] [-InheritLoadBalancingPolicy <Boolean>]
[-InheritNetworkFailoverDetectionPolicy <Boolean>] [-InheritNotifySwitches <Boolean>] [-LoadBalancingPolicy
<LoadBalancingPolicy>] [-MakeNicActive <PhysicalNic[]>] [-MakeNicStandby <PhysicalNic[]>] [-MakeNicUnused
<PhysicalNic[]>] [-NetworkFailoverDetectionPolicy <NetworkFailoverDetectionPolicy>] [-NotifySwitches <Boolean>]
[-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
This cmdlet modifies the specified NIC teaming policy. You can change the load balancing and failover settings.
Default NIC teaming policies are set for the entire virtual switch and can be overridden at port group level.
PARAMETERS
-BeaconInterval <Int32>
Specifies the interval at which the server sends out beacon probes on all NICs in the team. The value must be
a positive integer. This parameter is used when the value of the NetworkFailoverDetectionPolicy parameter is
BeaconProbing.
Required? false
Position? named
Default value $null
Accept pipeline input? False
Accept wildcard characters? false
-FailbackEnabled <Boolean>
Specifies how a physical adapter is returned to active duty after recovering from a failure. If the value is
$true, the adapter is returned to active duty immediately on recovery, displacing the standby adapter that
took over its slot, if any. If the value is $false, a failed adapter is left inactive even after recovery
until another active adapter fails, requiring its replacement.
Required? false
Position? named
Default value $true
Accept pipeline input? False
Accept wildcard characters? false
-InheritFailback <Boolean>
Indicates that the value of the FailbackEnabled parameter is inherited from the virtual switch.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-InheritFailoverOrder <Boolean>
Indicates that the value of the MakeNicActive, MakeNicStandBy, and MakeNicUnused parameters are inherited from
the virtual switch.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-InheritLoadBalancingPolicy <Boolean>
Indicates that the value of the LoadBalancingPolicy parameter is inherited from the virtual switch.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-InheritNetworkFailoverDetectionPolicy <Boolean>
Indicates that the value of the NetworkFailoverDetectionPolicy parameter is inherited from the virtual switch.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-InheritNotifySwitches <Boolean>
Indicates that the value of the NotifySwitches parameter is inherited from the virtual switch.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-LoadBalancingPolicy <LoadBalancingPolicy>
Determines how network traffic is distributed between the network adapters assigned to a switch. The following
values are valid:
LoadBalanceIP - Route based on IP hash. Choose an uplink based on a hash of the source and destination IP
addresses of each packet. For non-IP packets, whatever is at those offsets is used to compute the hash.
LoadBalanceSrcMac - Route based on source MAC hash. Choose an uplink based on a hash of the source Ethernet.
LoadBalanceSrcId - Route based on the originating port ID. Choose an uplink based on the virtual port where
the traffic entered the virtual switch.
ExplicitFailover - Always use the highest order uplink from the list of Active adapters that passes failover
detection criteria.
Required? false
Position? named
Default value $null
Accept pipeline input? False
Accept wildcard characters? false
-MakeNicActive <PhysicalNic[]>
Specifies the adapters you want to continue to use when the network adapter connectivity is available and
active.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-MakeNicStandby <PhysicalNic[]>
Specifies the adapters you want to use if one of the active adapter's connectivity is unavailable.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-MakeNicUnused <PhysicalNic[]>
Specifies the adapters you do not want to use.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-NetworkFailoverDetectionPolicy <NetworkFailoverDetectionPolicy>
Specifies how to reroute traffic in the event of an adapter failure. The following values are valid:
LinkStatus - Relies solely on the link status that the network adapter provides. This option detects failures,
such as cable pulls and physical switch power failures, but not configuration errors, such as a physical
switch port being blocked by spanning tree or misconfigured to the wrong VLAN or cable pulls on the other side
of a physical switch.
BeaconProbing - Sends out and listens for beacon probes on all NICs in the team and uses this information, in
addition to link status, to determine link failure. This option detects many of the failures mentioned above
that are not detected by link status alone.
Required? false
Position? named
Default value $null
Accept pipeline input? False
Accept wildcard characters? false
-NotifySwitches <Boolean>
Indicates that whenever a virtual NIC is connected to the virtual switch or whenever that virtual NIC's
traffic is routed over a different physical NIC in the team because of a failover event, a notification is
sent over the network to update the lookup tables on the physical switches.
Required? false
Position? named
Default value $true
Accept pipeline input? False
Accept wildcard characters? false
-VirtualPortGroupPolicy <NicTeamingVirtualPortGroupPolicy[]>
Specifies the virtual port group policy to configure.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-VirtualSwitchPolicy <NicTeamingVirtualSwitchPolicy[]>
Specifies the virtual switch policy to configure.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? 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.
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 NicTeamingVirtualSwitchPolicy or NicTeamingVirtualPortGroupPolicy objects
NOTES
-------------------------- Example 1 --------------------------
$policy = Get-VirtualSwitch -VMHost (Get-VMHost *.128) -Name vSwitch1 | Get-NicTeamingPolicy
$policy | Set-NicTeamingPolicy -LoadBalancingPolicy LoadBalanceSrcMac
Configures the NicTeaming policy of the vSwitch1 virtual switch.
RELATED LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... olicy.html
Get-NicTeamingPolicy