Skip to content

IpConfiguration.adoc

Latest commit

 

History

History
144 lines (118 loc) · 4.18 KB

IpConfiguration.adoc

File metadata and controls

144 lines (118 loc) · 4.18 KB

DSC Resource 'IpConfiguration'

IpConfiguration configures network adapter IP addresses, gateways, DNS servers, and adapter settings.

When to use 'IpConfiguration'

Use this resource when you need to set static IP configurations on network adapters, including IP address, subnet mask, default gateway, and DNS server addresses. This is fundamental for server configurations where static IP addressing is required. For more comprehensive network settings including routes and WINS, consider NetworkIpConfiguration instead.

Source

DSC Resource

Documentation
Table 1. Attributes of category 'IpConfiguration'
Parameter Attribute DataType Description Allowed Values

Adapter

Hashtable[]

List of network adapters
Table 2. Attributes of category 'IpConfiguration/Adapter'
Parameter Attribute DataType Description Allowed Values

NewName

Key

String

Specifies the new name of the network adapter. It is the Alias of the network interface.
See NetAdapterName

MacAddress

Mandatory

String

This is the MAC address of the network adapter to find.
See NetAdapterName

IPAddress

String

The desired IP address, optionally including prefix length using CIDR notation.
See IPAddress

AddressFamily

Mandatory if IPAddress, GatewayAddress or DnsServerAddress is specified

String

IP address family.

  • IPv4

  • IPv6

GatewayAddress

String

The desired default gateway address. If not provided default gateway will be removed.
See DefaultGatewayAddress

DnsServerAddress

StringArray

The desired DNS Server address(es). Exclude to enable DHCP.
See DNSServerAddress
Example
IpConfiguration:
  Adapter:
    - MacAddress: 00-17-FB-00-00-0A
      NewName: 1GB1_MGMT
      IPAddress: 10.0.0.33/23
      AddressFamily: IPv4
      GatewayAddress: 1.2.3.4
      DnsServerAddress:
        - 1.2.3.4
        - 2.3.4.5
      DisableIpv6: true

    - MacAddress: 00-17-FB-00-00-0B
      NewName: STORAGE
      IPAddress: 10.2.0.33/24
      AddressFamily: IPv4
      DisableIpv6: true