en-US/about_xNetworkTeam.help.txt

.NAME
    xNetworkTeam
 
# Description
     
    This resource is used to setup network teams on a node.
     
.PARAMETER Name
    Key - String
    Specifies the name of the network team to create.
 
.PARAMETER TeamMembers
    Required - String
    Specifies the network interfaces that should be a part of the network team. This is a comma-separated list.
 
.PARAMETER TeamingMode
    Write - String
    Allowed values: SwitchIndependent, LACP, Static
    Specifies the teaming mode configuration.
 
.PARAMETER LoadBalancingAlgorithm
    Write - String
    Allowed values: Dynamic, HyperVPort, IPAddresses, MacAddresses, TransportPorts
    Specifies the load balancing algorithm for the network team.
 
.PARAMETER Ensure
    Write - String
    Allowed values: Present, Absent
    Specifies if the network team should be created or deleted.
 
 
    .EXAMPLE
    Creates the Host Team with the NIC1 and NIC2 Interfaces
 
Configuration Example
{
    param
    (
        [Parameter()]
        [System.String[]]
        $NodeName = 'localhost'
    )
 
    Import-DSCResource -ModuleName xNetworking
 
    Node $NodeName
    {
        xNetworkTeam HostTeam
        {
            Name = 'HostTeam'
            TeamingMode = 'SwitchIndependent'
            LoadBalancingAlgorithm = 'HyperVPort'
            TeamMembers = 'NIC1','NIC2'
            Ensure = 'Present'
        }
    }
}
 
 
    .EXAMPLE
    Removes the NIC Team for the listed interfacess.
 
Configuration Example
{
    param
    (
        [Parameter()]
        [System.String[]]
        $NodeName = 'localhost'
    )
 
    Import-DSCResource -ModuleName xNetworking
 
    Node $NodeName
    {
        xNetworkTeam HostTeam
        {
            Name = 'HostTeam'
            Ensure = 'Absent'
            TeamMembers = 'NIC1','NIC2','NIC3'
        }
    }
}