powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Set-NicTeamingPolicy



NAME
Set-NicTeamingPolicy

SYNOPSIS
Configures the specified NIC teaming policy.

SYNTAX
Set-NicTeamingPolicy [-VirtualSwitchPolicy] [-BeaconInterval ] [-LoadBalan
cingPolicy ] [-NetworkFailoverDetectionPolicy ] [-NotifySwitch
es []] [-FailbackEnabled []] [-MakeNicActive ] [-MakeNicStandby ] [
-MakeNicUnused ] [-WhatIf] [-Confirm] []

Set-NicTeamingPolicy [-VirtualPortGroupPolicy] [-InheritLoadBalancingPolicy [<
Boolean>]] [-InheritNetworkFailoverDetectionPolicy []] [-InheritNotifySwitches []] [-InheritFailb
ack []] [-InheritFailoverOrder []] [-LoadBalancingPolicy ] [-NetworkFailover
DetectionPolicy ] [-NotifySwitches []] [-FailbackEnabled []] [-Ma
keNicActive ] [-MakeNicStandby ] [-MakeNicUnused ] [-WhatIf] [-Confirm
] []


DESCRIPTION
Configures the specified NIC teaming policy. You can change the load balancing and failover settings. Default NIC t
eaming policies are set for the entire virtual switch and can be overridden at port group level.


PARAMETERS
-VirtualSwitchPolicy
Specifies the virtual switch policy to configure.

Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false

-BeaconInterval
Specify the interval at which the server sends out beacon probes on all NICs in the team. The value must be a p
ositive integer. This parameter is used when the value of the -NetworkFailoverDetectionPolicy parameter is Beac
onProbing.

Required? false
Position? named
Default value $null
Accept pipeline input? false
Accept wildcard characters? false

-LoadBalancingPolicy
Determine how network traffic is distributed between the network adapters assigned to a switch. The following v
alues are valid:

LoadBalanceIP - Route based on IP hash. Choose an uplink based on a hash of the source and destination IP addre
sses 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 de
tection criteria.

Required? false
Position? named
Default value $null
Accept pipeline input? false
Accept wildcard characters? false

-NetworkFailoverDetectionPolicy
Specify 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 p
hysical switch.

BeaconProbing - Sends out and listens for beacon probes on all NICs in the team and uses this information, in a
ddition to link status, to determine link failure. This option detects many of the failures mentioned above tha
t are not detected by link status alone.

Required? false
Position? named
Default value $null
Accept pipeline input? false
Accept wildcard characters? false

-NotifySwitches []
Indicate 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 th
e 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

-FailbackEnabled []
Specify how a physical adapter is returned to active duty after recovering from a failure. If the value is $tru
e, the adapter is returned to active duty immediately on recovery, displacing the standby adapter that took ove
r 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

-MakeNicActive
Specify the adapters you want to continue to use when the network adapter connectivity is available and active.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-MakeNicStandby
Specify the adapters you want to use if one of the active adapter's connectivity is unavailable.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-MakeNicUnused
Specify the adapters you do not want to use.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-WhatIf
Indicate that the cmdlet is run only to display the changes that would be made and actually no objects are modi
fied.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Confirm
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

-VirtualPortGroupPolicy
Specifies the virtual port group policy to configure.

Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false

-InheritLoadBalancingPolicy []
Indicate that the value of the -LoadBalancingPolicy parameter is inherited from the virtual switch.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-InheritNetworkFailoverDetectionPolicy []
Indicate that the value of the -NetworkFailoverDetectionPolicy parameter is inherited from the virtual switch.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-InheritNotifySwitches []
Indicate that the value of the -NotifySwitches parameter is inherited from the virtual switch.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-InheritFailback []
Indicate that the value of the -FailbackEnabled parameter is inherited from the virtual switch.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-InheritFailoverOrder []
Indicate that the value of the -MakeNicActive, -MakeNicStandBy, and -MakeNicUnused parameters are inherited fro
m the virtual switch.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false


This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS



OUTPUTS
NicTeamingVirtualSwitchPolicy/ NicTeamingVirtualPortGroupPolicy


NOTES




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

C:\PS>$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: http://www.vmware.com/support/developer/PowerCLI/PowerCLI501/html/Set-NicTeamingPolicy.html
Get-NicTeamingPolicy