DSCResources/DSC_NetAdapterAdvancedProperty/en-US/about_NetAdapterAdvancedProperty.help.txt

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
.NAME
    NetAdapterAdvancedProperty
 
.DESCRIPTION
    This resource is used to set advanced properties on a network adapter
    by setting the value of a registry keyword.
    The list of available registry keywords will be dependent on the network
    adapter driver.
    **Please check the supported registry keywords for your adapter before
    creating a configuration.**
 
    The following is a list of common registry keywords that may apply to
    your network adapter:
 
    - AdaptiveIFS
    - ITR
    - LogLinkStateEvent
    - MasterSlave
    - NetworkAddress
    - MaxRxRing1Length
    - NumRxBuffersSmall
    - RxIntModeration
    - RxIntModerationProfile
    - TxIntModerationProfile
    - VlanID
    - WaitAutoNegComplete
    - *DcbxMode
    - *EncapsulatedPacketTaskOffload
    - *FlowControl
    - *InterruptModeration
    - *IPChecksumOffloadIPv4
    - *JumboPacket
    - *LsoV2IPv4
    - *LsoV2IPv6
    - *MaxRssProcessors
    - *NetworkDirect
    - *NumaNodeId
    - *NumRssQueues
    - *PacketDirect
    - *PriorityVLANTag
    - *QOS
    - *ReceiveBuffers
    - *RecvCompletionMethod
    - *RoceMaxFrameSize
    - *RscIPv4
    - *RSS
    - *RssBaseProcNumber
    - *RssMaxProcNumber
    - *RssOnHostVPorts
    - *RSSProfile
    - *SpeedDuplex
    - *Sriov
    - *TCPChecksumOffloadIPv4
    - *TCPChecksumOffloadIPv6
    - *TCPUDPChecksumOffloadIPv4
    - *TCPUDPChecksumOffloadIPv6
    - *TransmitBuffers
    - *UDPChecksumOffloadIPv4
    - *UDPChecksumOffloadIPv6
    - *VMQ
    - *VMQVlanFiltering
 
    The following table shows configuration overlap with https://github.com/dsccommunity/NetworkingDsc/wiki/NetAdapterLso.
 
    | NetAdapterLso | | NetAdapterAdvancedProperty |
    | -------------------- | ---- | ------------------------------------ |
    | V1IPv4 | = | Not Available |
    | IPv4 | = | *LsoV2IPv4 |
    | IPv6 | = | *LsoV2IPv6 |
 
.PARAMETER NetworkAdapterName
    Key - String
    Specifies the name of the network adapter to set the advanced property for.
 
.PARAMETER RegistryKeyword
    Key - String
    Specifies the registry keyword that should be in desired state.
 
.PARAMETER RegistryValue
    Required - String
    Specifies the value of the registry keyword.
 
.PARAMETER DisplayValue
    Read - String
    Output Display value of selected RegistryKeyword.
 
.EXAMPLE 1
 
This configuration changes the JumboPacket Size.
 
Configuration NetAdapterAdvancedProperty_JumboPacket_Config
{
    Import-DSCResource -ModuleName NetworkingDsc
 
    Node localhost
    {
        NetAdapterAdvancedProperty JumboPacket9014
        {
            NetworkAdapterName = 'Ethernet'
            RegistryKeyword = "*JumboPacket"
            RegistryValue = 9014
        }
    }
}