Create method of the MSFT_NetIPAddress class

Creates the IPAddress.

Syntax

uint32 Create(
  [in]  uint32            InterfaceIndex,
  [in]  string            InterfaceAlias,
  [in]  string            IPAddress,
  [in]  uint16            AddressFamily,
  [in]  uint8             PrefixLength,
  [in]  uint8             Type,
  [in]  uint16            PrefixOrigin,
  [in]  uint16            SuffixOrigin,
  [in]  uint16            AddressState,
  [in]  datetime          ValidLifetime,
  [in]  datetime          PreferredLifetime,
  [in]  boolean           SkipAsSource,
  [in]  string            DefaultGateway,
  [in]  string            PolicyStore,
  [in]  boolean           PassThru,
  [out] MSFT_NetIPAddress CmdletOutput[]
);

Parameters

InterfaceIndex [in]

The user-friendly interface index.

InterfaceAlias [in]

The user-friendly interface name.

IPAddress [in]

The IP address.

AddressFamily [in]

Indicates whether the address family for this IP address is v4 or v6.

Value Meaning
2
IPv4
The address family is IPv4
23
IPv6
The address family is IPv6

PrefixLength [in]

The type of address.

Value Meaning
1
Unicast
Marks the address as a unicast address. This is the default
2
Anycast
Marks the address as an anycast address

Type [in]

The type of address.

Value Meaning
1
Unicast
Marks the address as a unicast address. This is the default
2
Anycast
Marks the address as an anycast address

PrefixOrigin [in]

Prefix origin of this address.

0 (Other)

1 (Manual)

2 (WellKnown)

3 (Dhcp)

4 (RouterAdvertisement)

SuffixOrigin [in]

Suffix origin of this address.

0 (Other)

1 (Manual)

2 (WellKnown)

3 (Dhcp)

4 (Link)

5 (Random)

AddressState [in]

Address lifetime state.

0 (Invalid)

1 (Tentative)

2 (Duplicate)

3 (Deprecated)

4 (Preferred)

ValidLifetime [in]

Lifetime over which the address is valid. The default value is infinite.

PreferredLifetime [in]

Lifetime over which the address is preferred. The default value is infinite.

SkipAsSource [in]

true to not use the address as source address for any outgoing packet unless explicitly asked to.

DefaultGateway [in]

TBD

PolicyStore [in]

TBD

PassThru [in]

Specifies whether the method should output an object that represents the newly created IP address in the CmdletOutput parameter.

CmdletOutput [out]

An embedded instance of the MSFT_NetIPAddress class.

Requirements

Minimum supported client
Windows 8
Minimum supported server
Windows Server 2012
Namespace
Root\StandardCimv2
Header
Spcollec.h (include Dxtmpl.h)
MOF
NetTCPIP.mof
DLL
NetTCPIP.dll

See also

MSFT_NetIPAddress