Share via

MSFT_IPAM_Subnet class

  • Article

Represents a subnet that contains IP protocol endpoints in IPAM.

The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.

Syntax

[UMLPackagePath("CIM::Network::Collections"), ClassVersion("1.0.0"), dynamic, provider("IPAMServerPSProvider"), AMENDMENT]
class MSFT_IPAM_Subnet : CIM_IPConnectivitySubnet
{
  string   Caption;
  string   Description;
  string   ElementName;
  uint16   ConnectivityStatus;
  string   SubnetNumber;
  string   SubnetMask;
  uint8    PrefixLength;
  uint16   AddressType;
  string   InstanceID;
  string   Name;
  string   NetworkId;
  uint16   NetworkType;
  boolean  Overlapping;
  string   NetworkSite;
  string   VmmLogicalNetwork;
  string   AddressSpace;
  uint64   AddressSpaceId;
  string   ProviderAddressSpace;
  string   CustomerAddressSpace;
  string   Owner;
  datetime LastModifiedTime;
  real64   PercentageUtilized;
  real64   TotalAddresses;
  real64   AssignedAddresses;
  real64   UtilizedAddresses;
  uint16   Utilization;
  uint16   VlanId[];
  uint32   VirtualSubnetId;
  string   CustomConfiguration;
  string   AccessScopePath;
  boolean  IsInheritedAccessScope;
};

Members

The MSFT_IPAM_Subnet class has these types of members:

Methods

The MSFT_IPAM_Subnet class has these methods.

Method Description
AddIpamSubnet Adds a new subnet object to IPAM.
BulkAddOrUpdateSubnet Adds or updates a set of subnets in IPAM.
BulkDeleteSubnet Deletes a set of IP address objects from IPAM.
ExportSubnet Exports the subnets from IPAM server to a CSV file.
FindIpamFreeSubnet Retrieves unassigned IP subnets from IPAM.
Windows Server 2012 R2: This method is not available until Windows Server 2016.
ImportSubnet Imports subnets into IPAM from a CSV file.

Properties

The MSFT_IPAM_Subnet class has these properties.

AccessScopePath

Data type: string

Access type: Read-only

Access scope path for this subnet.

Windows Server 2012 R2: This property is unavailable prior to Windows Server 2016.

AddressSpace

Data type: string

Access type: Read-only

The address space of the subnet.

AddressSpaceId

Data type: uint64

Access type: Read-only

The ID of the address space of the subnet.

AddressType

Data type: uint16

Access type: Read-only

An enumeration that describes the format of the address properties in the subnet.

This property is inherited from CIM_IPConnectivitySubnet.

The possible values are.

Unknown (0)

IPv4 (1)

IPv6 (2)

AssignedAddresses

Data type: real64

Access type: Read-only

The number of IP addresses in the subnet, that map to an address range in IPAM.

Caption

Data type: string

Access type: Read-only

Qualifiers: MaxLen (64)

The Caption property is a short textual description (one- line string) of the object.

This property is inherited from CIM_ManagedElement.

ConnectivityStatus

Data type: uint16

Access type: Read-only

An enumeration that describes the connectivity between the endpoints in the collection.

This property is inherited from CIM_ConnectivityCollection.

The possible values are.

Unknown (0)

The system couldn't retrieve the state of the connection.

Connectivity/Up (2)

The connection is up.

No Connectivity/Down (3)

The connection is down.

Partitioned (4)

The connection is partitioned.

CustomConfiguration

Data type: string

Access type: Read-only

A set of custom metadata associated with the subnet address. This is specified as a semi-colon separated name=value pairs.

Note

This property is formatted with semi-colon separated name=value pairs.

CustomerAddressSpace

Data type: string

Access type: Read-only

The customer address space associated with the subnet.

Description

Data type: string

Access type: Read-only

The Description property provides a textual description of the object.

This property is inherited from CIM_ManagedElement.

ElementName

Data type: string

Access type: Read-only

A user-friendly name for the object. This property allows each instance to define a user-friendly name in addition to its key properties, identity data, and description information.

This property is inherited from CIM_ManagedElement.

InstanceID

Data type: string

Access type: Read-only

Qualifiers: key, Override ("InstanceID")

Uniquely and opaquely identifies an instance of this class within the scope of the containing namespace.

[!Important]

In order to ensure uniqueness within the namespace, the value of the InstanceID property should be constructed in the following pattern: OrgID:LocalID

OrgID must include a copyrighted, trademarked or otherwise unique name that is owned by the business entity that defines the InstanceID, or be a registered ID that is assigned by a recognized global authority. This pattern is similar to the structure of schema class names. In addition, to ensure uniqueness, the first colon in InstanceID must be between the OrgID andLocalID. Therefore the OrgID must not contain a colon (':').

LocalID is chosen by the business entity and should not be re-used to identify different underlying real-world elements.

If the above pattern is not used, the defining entity must assure that the resultant InstanceID value is not re-used across any InstanceID properties that are produced by this provider or other providers for this namespace.

For Distributed Management Task Force (DMTF) defined instances, the pattern must be used with the OrgID set to CIM.

IsInheritedAccessScope

Data type: boolean

Access type: Read-only

Whether the access scope for this subnet is inherited from parent.

Windows Server 2012 R2: This property is unavailable prior to Windows Server 2016.

LastModifiedTime

Data type: datetime

Access type: Read-only

The latest date and time when a property of the subnet was modified.

Name

Data type: string

Access type: Read-only

The user specified name of the subnet.

NetworkId

Data type: string

Access type: Read-only

The network ID of the subnet.

Note

The NetworkID property uses the format: NetworkId / Prefix Length.

NetworkSite

Data type: string

Access type: Read-only

The name of a network site in the physical network.

NetworkType

Data type: uint16

Access type: Read-only

Indicates whether the IP address is a virtual address.

The possible values are.

NonVirtualized (1)

Provider (2)

Customer (4)

Overlapping

Data type: boolean

Access type: Read-only

True if this subnet overlaps with another subnet in IPAM; otherwise, false.

Owner

Data type: string

Access type: Read-only

The owner of the subnet.

PercentageUtilized

Data type: real64

Access type: Read-only

The percentage of IP addresses in the subnet that are in use.

PrefixLength

Data type: uint8

Access type: Read-only

The prefix length for IPv6 addresses in the subnet.

This property is inherited from CIM_IPConnectivitySubnet.

ProviderAddressSpace

Data type: string

Access type: Read-only

The provider address space associated with the subnet.

SubnetMask

Data type: string

Access type: Read-only

The mask for the starting IPv4 address of the subnet.

This property is inherited from CIM_IPConnectivitySubnet.

SubnetNumber

Data type: string

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_IPConnectivitySubnet.AddressType")

The IP address of the subnet.

This property is inherited from CIM_IPConnectivitySubnet.

TotalAddresses

Data type: real64

Access type: Read-only

The number of IP addresses in the subnet.

Utilization

Data type: uint16

Access type: Read-only

The usage level of the subnet.

The possible values are.

None (0)

Under (1)

Optimal (2)

Over (3)

UtilizedAddresses

Data type: real64

Access type: Read-only

The number of IP addresses in the subnet that are in use.

VirtualSubnetId

Data type: uint32

Access type: Read-only

The virtual subnet ID to use for network virtualization.

VlanId

Data type: uint16 array

Access type: Read-only

An array that contains the IDs of VLANs that contain the subnet.

VmmLogicalNetwork

Data type: string

Access type: Read-only

The name of an abstraction of a physical network that describes a particular function in an environment. A logical network can contain multiple network sites.

Requirements
Minimum supported client
 None supported
Minimum supported server
 Windows Server 2012 R2
Namespace
 RootMicrosoftIPAM
MOF
IPAMServerPSProvider.mof
DLL
IPAMServerPSProvider.dll

See also

CIM_IPConnectivitySubnet

IPAM Server WMI Provider Reference