Skip to content

NetIPInterface

Daniel Scott-Raynsford edited this page Dec 1, 2018 · 7 revisions

NetIPInterface

Parameters

Parameter Attribute DataType Description Allowed Values
InterfaceAlias Key string Alias of the network interface to configure.
AddressFamily Key string IP address family on the interface to configure. IPv4, IPv6
AdvertiseDefaultRoute Write String Specifies the default router advertisement for an interface. Enabled, Disabled
Advertising Write String Specifies the router advertisement value for the IP interface. Enabled, Disabled
AutomaticMetric Write String Specifies the value for automatic metric calculation. Enabled, Disabled
DirectedMacWolPattern Write String Specifies the wake-up packet value for an IP interface. Enabled, Disabled
EcnMarking Write String Specifies the value for Explicit Congestion Notification (ECN) marking. Disabled, UseEct1, UseEct0, AppDecide
ForceArpNdWolPattern Write String Specifies the Wake On LAN (WOL) value for the IP interface. Enabled, Disabled
Forwarding Write String Specifies the packet forwarding value for the IP interface. Enabled, Disabled
IgnoreDefaultRoutes Write String Specifies a value for Default Route advertisements. Enabled, Disabled
ManagedAddressConfiguration Write String Specifies the value for managed address configuration. Enabled, Disabled
NeighborUnreachabilityDetection Write String Specifies the value for Neighbor Unreachability Detection (NUD). Enabled, Disabled
OtherStatefulConfiguration Write String Specifies the value for configuration other than addresses. Enabled, Disabled
RouterDiscovery Write String Specifies the value for router discovery for an IP interface. Enabled, Disabled, ControlledByDHCP

Description

This resource is used to configure the IP interface settings for a network interface.

Examples

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 The EcnMarking parameter will be set to AppDecide.
Configuration Example
{
    Import-DscResource -Module NetworkingDsc

    Node localhost
    {
        NetIPInterface EnableSettings
        {
            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'
        }
    }
}