MSFT_IPAM_Range class

Article
05/31/2018

Represents an IP address range in IPAM. An IP address range contains the IP addresses that are between the start and end address of the range.

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_Range : CIM_RangeOfIPAddresses
{
  string   Caption;
  string   Description;
  string   ElementName;
  string   StartAddress;
  string   EndAddress;
  uint16   AddressType;
  string   InstanceID;
  uint16   NetworkType;
  uint16   AddressCategory;
  boolean  Overlapping;
  string   NetworkID;
  string   ManagedByService;
  string   ServiceInstance;
  string   AddressSpace;
  uint64   AddressSpaceId;
  string   ProviderAddressSpace;
  string   CustomerAddressSpace;
  string   Owner;
  real64   PercentageUtilized;
  string   SubnetMask;
  uint16   AssignmentType;
  datetime AssignmentDate;
  datetime LastModifiedTime;
  string   NetworkSite;
  string   VmmLogicalNetwork;
  string   DhcpServerName;
  string   DhcpScopeName;
  uint16   Utilization;
  uint16   UtilizationCalculation;
  real64   UtilizedAddresses;
  uint64   AssignedAddresses;
  string   ExclusionRanges[];
  datetime LastReclaimRunTime;
  string   DnsServers[];
  string   WinsServers[];
  string   VIP[];
  string   ReservedIPAddresses[];
  string   DnsSuffixes[];
  string   ConnectionSpecificDnsSuffix;
  string   CustomConfiguration;
  string   AssociatedReverseLookupZone;
  string   AccessScopePath;
  boolean  IsInheritedAccessScope;
  string   Gateway[];
};

Members

The MSFT_IPAM_Range class has these types of members:

Methods
Properties

Methods

The MSFT_IPAM_Range class has these methods.

Method	Description
AddRange	Adds a new IP address range to IPAM.
BulkAddOrUpdateRange	Adds or updates a set of IP address ranges in IPAM.
BulkDeleteRange	Deletes a set of IP address range from IPAM.
ExportRange	Exports a set of IP address ranges from IPAM to a CSV file.
FindIpamFreeRange	Retrieves unassigned IP address ranges from IPAM. Windows Server 2012 R2: This method is not available until Windows Server 2016.
ImportRange	Imports a set of IP address ranges into IPAM from a CSV file.

Properties

The MSFT_IPAM_Range class has these properties.

AccessScopePath

Data type: string
Access type: Read-only

Access scope path for this range.

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

AddressCategory

Data type: uint16
Access type: Read-only

The privacy scope of address range, such as public or private.

The possible values are.

None (0)

Public (1)

Private (2)

Global (3)

AddressSpace

Data type: string
Access type: Read-only

The name of the address space associated with the address range.

AddressSpaceId

Data type: uint64
Access type: Read-only

The ID of the address space associated with the address range.

AddressType

Data type: uint16
Access type: Read-only
Qualifiers: Override ("AddressType")

An enumeration that defines how the address and mask properties are formatted.

The possible values are.

Unknown (0)

IPv4 (1)

IPv6 (2)

AssignedAddresses

Data type: uint64
Access type: Read-only

The number of IP addresses in the address range.

AssignmentDate

Data type: datetime
Access type: Read-only

The date when addresses were assigned to the address range.

AssignmentType

Data type: uint16
Access type: Read-only

The format of the IP address assignment.

The possible values are.

None (0)

Static (1)

Dynamic (2)

Auto (3)

VIP (4)

Reserved (5)

AssociatedReverseLookupZone

Data type: string
Access type: Read-only

The associated reverse lookup zone name for this range.

Windows Server 2012 R2: This parameter not supported before Windows Server 2016.

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.

ConnectionSpecificDnsSuffix

Data type: string
Access type: Read-only

The Connection specific DNS suffix that is associated with the address range.

CustomConfiguration

Data type: string
Access type: Read-only

The custom data associated with the address range. This is formatted as semi-colon separated name=value pairs.

CustomerAddressSpace

Data type: string
Access type: Read-only

The customer address space that contains the address range.

Note

This property is only populated when the NetworkType property is set to "3" (Customer).

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.

DhcpScopeName

Data type: string
Access type: Read-only

The name of the DHCP scope that is synchronized with the range.

DhcpServerName

Data type: string
Access type: Read-only

The name of the DHCP server that is synchronized with the range.

DnsServers

Data type: string array
Access type: Read-only

An array that contains the names of the DNS servers that are associated with the address range.

DnsSuffixes

Data type: string array
Access type: Read-only

An array that contains the DNS search suffixes that are associated with the address range. These search suffixes are used to resolve a DNS query.

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.

EndAddress

Data type: string
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_RangeOfIPAddresses.AddressType")

The ending IP address of the address range.

This property is inherited from CIM_RangeOfIPAddresses.

ExclusionRanges

Data type: string array
Access type: Read-only

An array that contains the exclusion ranges of the DHCP scope that is synchronized with the address range.

Gateway

Data type: string array
Access type: Read-only

An array that contains the names of gateway servers and corresponding metrics associated with the address range.

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 range 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 last date and time when any property of the address was modified.

LastReclaimRunTime

Data type: datetime
Access type: Read-only

The last time IP addresses were reclaimed from the address range.

ManagedByService

Data type: string
Access type: Read-only

The service that manages the address range.

NetworkID

Data type: string
Access type: Read-only

The network address and prefix length of the address range. This property is formatted as NetworkId / Prefix Length.

NetworkSite

Data type: string
Access type: Read-only

This field, along with a logical network, forms an abstraction of the physical network. A given logical network can contain many network sites. This property is inherited from the subnet to which this range maps.

NetworkType

Data type: uint16
Access type: Read-only

The network type of the address range.

The possible values are.

NonVirtualized (1)

Provider (2)

Customer (4)

Overlapping

Data type: boolean
Access type: Read-only

True if the range overlaps with another range in IPAM; otherwise, false.

Owner

Data type: string
Access type: Read-only

The owner of this address IP range.

PercentageUtilized

Data type: real64
Access type: Read-only

The percentage of used IP addresses in the address range.

ProviderAddressSpace

Data type: string
Access type: Read-only

The provider address space that contains the address range.

Note

This property is only populated when the NetworkType property is set to "2" (Provider).

ReservedIPAddresses

Data type: string array
Access type: Read-only

An array that contains the reserved IP addresses in the address range.

Note

These IP addresses are excluded from queries, when searching for free IP addresses.

ServiceInstance

Data type: string
Access type: Read-only

The instance of Managed By Service that manages the address range.

StartAddress

Data type: string
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_RangeOfIPAddresses.AddressType")

The starting IP address of the address range.

This property is inherited from CIM_RangeOfIPAddresses.

SubnetMask

Data type: string
Access type: Read-only

The subnet mask associated with the address range.

Utilization

Data type: uint16
Access type: Read-only

Indicates the IP address utilization of the range, as a threshold.

The possible values are.

None (0)

Under (1)

Optimal (2)

Over (3)

UtilizationCalculation

Data type: uint16
Access type: Read-only

Indicates whether the utilization thresholds are set by the user.

The possible values are.

Auto (1)

Static (2)

UtilizedAddresses

Data type: real64
Access type: Read-only

The number of used IP addresses in the address range.

VIP

Data type: string array
Access type: Read-only

An array that contains the virtual IP addresses in the address range.

Note

These IP addresses are excluded from queries, when searching for free IP addresses.

VmmLogicalNetwork

Data type: string
Access type: Read-only

An network abstraction defined for your environment. This property is inherited from the subnet to which this range maps.

WinsServers

Data type: string array
Access type: Read-only

An array that contains the WINS servers associated with the address range.

Requirements


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

MSFT_IPAM_Range class

Syntax

Members

Methods

Properties

Requirements

See also

Additional resources