NetworkingDsc

8.2.0

DSCResources/DSC_NetIPInterface/en-US/about_NetIPInterface.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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 .NAME
    NetIPInterface
 
.DESCRIPTION
    This resource is used to configure the IP interface settings for a network interface.
 
    ## Known Issues
 
    - If you define a value for `InterfaceMetric`, the `AutomaticMetric`
    setting is ignored. PowerShell ignores `AutomaticMetric` when you
    use both arguments with the `Set-NetIPInterface` cmdlet.
 
.PARAMETER InterfaceAlias
    Key - String
    Alias of the network interface to configure.
 
.PARAMETER AddressFamily
    Key - String
    Allowed values: IPv4, IPv6
    IP address family on the interface to configure.
 
.PARAMETER AdvertiseDefaultRoute
    Write - String
    Allowed values: Enabled, Disabled
    Specifies the default router advertisement for an interface.
 
.PARAMETER Advertising
    Write - String
    Allowed values: Enabled, Disabled
    Specifies the router advertisement value for the IP interface.
 
.PARAMETER AutomaticMetric
    Write - String
    Allowed values: Enabled, Disabled
    Specifies the value for automatic metric calculation.
 
.PARAMETER Dhcp
    Write - String
    Allowed values: Enabled, Disabled
    Specifies the Dynamic Host Configuration Protocol (DHCP) value for an IP interface.
 
.PARAMETER DirectedMacWolPattern
    Write - String
    Allowed values: Enabled, Disabled
    Specifies the wake-up packet value for an IP interface.
 
.PARAMETER EcnMarking
    Write - String
    Allowed values: Disabled, UseEct1, UseEct0, AppDecide
    Specifies the value for Explicit Congestion Notification (ECN) marking.
 
.PARAMETER ForceArpNdWolPattern
    Write - String
    Allowed values: Enabled, Disabled
    Specifies the Wake On LAN (WOL) value for the IP interface.
 
.PARAMETER Forwarding
    Write - String
    Allowed values: Enabled, Disabled
    Specifies the packet forwarding value for the IP interface.
 
.PARAMETER IgnoreDefaultRoutes
    Write - String
    Allowed values: Enabled, Disabled
    Specifies a value for Default Route advertisements.
 
.PARAMETER ManagedAddressConfiguration
    Write - String
    Allowed values: Enabled, Disabled
    Specifies the value for managed address configuration.
 
.PARAMETER NeighborUnreachabilityDetection
    Write - String
    Allowed values: Enabled, Disabled
    Specifies the value for Neighbor Unreachability Detection (NUD).
 
.PARAMETER OtherStatefulConfiguration
    Write - String
    Allowed values: Enabled, Disabled
    Specifies the value for configuration other than addresses.
 
.PARAMETER RouterDiscovery
    Write - String
    Allowed values: Enabled, Disabled, ControlledByDHCP
    Specifies the value for router discovery for an IP interface.
 
.PARAMETER WeakHostReceive
    Write - String
    Allowed values: Enabled, Disabled
    Specifies the receive value for a weak host model.
 
.PARAMETER WeakHostSend
    Write - String
    Allowed values: Enabled, Disabled
    Specifies the send value for a weak host model.
 
.PARAMETER NlMtu
    Write - UInt32
    Specifies the network layer Maximum Transmission Unit (MTU) value, in bytes, for an IP interface.
 
.PARAMETER InterfaceMetric
    Write - UInt32
    Specifies the metric for an IP interface.
 
.EXAMPLE 1
 
This example enables the following settings on the IPv4 network interface with alias
'Ethernet':
- AdvertiseDefaultRoute
- Avertising
- AutomaticMetric
- DirectedMacWolPattern
- ForceArpNdWolPattern
- Forwarding
- IgnoreDefaultRoute
- ManagedAddressConfiguration
- NeighborUnreachabilityDetection
- OtherStatefulConfiguration
- RouterDiscovery
- NlMtu
The EcnMarking parameter will be set to AppDecide.
 
Configuration NetIPInterface_MultipleSettings_Config
{
    Import-DscResource -Module NetworkingDsc
 
    Node localhost
    {
        NetIPInterface MultipleSettings
        {
            InterfaceAlias = 'Ethernet'
            AddressFamily = 'IPv4'
            AdvertiseDefaultRoute = 'Enabled'
            Advertising = 'Enabled'
            AutomaticMetric = 'Enabled'
            DirectedMacWolPattern = 'Enabled'
            EcnMarking = 'AppDecide'
            ForceArpNdWolPattern = 'Enabled'
            Forwarding = 'Enabled'
            IgnoreDefaultRoutes = 'Enabled'
            ManagedAddressConfiguration = 'Enabled'
            NeighborUnreachabilityDetection = 'Enabled'
            OtherStatefulConfiguration = 'Enabled'
            RouterDiscovery = 'Enabled'
            NlMtu = 1576
        }
    }
}
 
.EXAMPLE 2
 
Enabling DHCP for the IPv4 Address and DNS on the adapter with alias 'Ethernet'.
 
Configuration NetIPInterface_EnableDHCP_Config
{
    Import-DscResource -Module NetworkingDsc
 
    Node localhost
    {
        NetIPInterface EnableDhcp
        {
            InterfaceAlias = 'Ethernet'
            AddressFamily = 'IPv4'
            Dhcp = 'Enabled'
        }
 
        DnsServerAddress EnableDhcpDNS
        {
            InterfaceAlias = 'Ethernet'
            AddressFamily = 'IPv4'
        }
    }
}
 
.EXAMPLE 3
 
Disable the weak host receive IPv4 setting for the network adapter with alias 'Ethernet'.
 
Configuration NetIPInterface_DisableWeakHostReceive_Config
{
    Import-DscResource -Module NetworkingDsc
 
    Node localhost
    {
        NetIPInterface DisableWeakHostReceiving
        {
            InterfaceAlias = 'Ethernet'
            AddressFamily = 'IPv4'
            WeakHostReceive = 'Disabled'
        }
    }
}
 
.EXAMPLE 4
 
Disable the weak host send IPv4 setting for the network adapter with alias 'Ethernet'.
 
Configuration NetIPInterface_DisableWeakHostSend_Config
{
    Import-DscResource -Module NetworkingDsc
 
    Node localhost
    {
        NetIPInterface DisableWeakHostSend
        {
            InterfaceAlias = 'Ethernet'
            AddressFamily = 'IPv4'
            WeakHostSend = 'Disabled'
        }
    }
}
 
.EXAMPLE 5
 
Set a specified interface metrics for the network adapters with alias 'Ethernet' and 'Ethernet 2'.
 
Configuration NetIPInterface_SetInterfaceMetric
{
    Import-DscResource -Module NetworkingDsc
 
    Node localhost
    {
        NetIPInterface EthernetMetric
        {
            InterfaceAlias = 'Ethernet'
            AddressFamily = 'IPv4'
            AutomaticMetric = 'Disabled'
            InterfaceMetric = 10
        }
 
        NetIPInterface Ethernet2Metric
        {
            InterfaceAlias = 'Ethernet 2'
            AddressFamily = 'IPv4'
            AutomaticMetric = 'Disabled'
            InterfaceMetric = 20
        }
    }
}