MSFT_IPAM_Block class
Represents and IP address block 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_Block : CIM_RangeOfIPAddresses
{
string Caption;
string Description;
string ElementName;
string StartAddress;
string EndAddress;
uint16 AddressType;
string InstanceID;
uint16 AddressCategory;
string Rir;
string NetworkId;
datetime RirReceivedDate;
datetime LastAssignedDate;
datetime LastModifiedTime;
string Owner;
uint16 Utilization;
uint64 TotalAddresses;
uint64 AssignedAddresses;
uint64 UtilizedAddresses;
real32 PercentageUtilized;
real32 PercentageAssigned;
string AccessScopePath;
boolean IsInheritedAccessScope;
};
Members
The MSFT_IPAM_Block class has these types of members:
Methods
The MSFT_IPAM_Block class has these methods.
| Method | Description |
|---|---|
| AddIpamBlock | Adds a new IP address block to IPAM. |
Properties
The MSFT_IPAM_Block class has these properties.
-
AccessScopePath
-
-
Data type: string
-
Access type: Read-only
Access scope path for this block.
Windows Server 2012 R2: This property is unavailable prior to Windows Server 2016.
-
-
AddressCategory
-
-
Data type: uint16
-
Access type: Read-only
Specifies whether the IP address block is public or private.
The possible values are.
-
-
Public (1)
-
Private (2)
-
Global (3)
AddressType
-
Data type: uint16
-
Access type: Read-only
Indicates the format of the IP addresses and masks within the range.
This property is inherited from CIM_RangeOfIPAddresses.
The possible values are.
Unknown (0)
IPv4 (1)
IPv6 (2)
AssignedAddresses
-
Data type: uint64
-
Access type: Read-only
The number of IP addresses assigned to child ranges.
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.
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.
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.
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 block is inherited from parent.
Windows Server 2012 R2: This property is unavailable prior to Windows Server 2016.
LastAssignedDate
-
Data type: datetime
-
Access type: Read-only
The date when the address block was assigned to the IPAM server.
LastModifiedTime
-
Data type: datetime
-
Access type: Read-only
The latest date and time when any property of the address block was modified.
NetworkId
-
Data type: string
-
Access type: Read-only
The network address and prefix length of the address block. The value is formatted as: NetworkId/Prefix.
Owner
-
Data type: string
-
Access type: Read-only
The owner of the address block.
PercentageAssigned
-
Data type: real32
-
Access type: Read-only
The percentage of assigned IP addresses in the address block.
PercentageUtilized
-
Data type: real32
-
Access type: Read-only
The percentage of used IP addresses in the address block.
Rir
-
Data type: string
-
Access type: Read-only
The Regional Internet Registries (RIR) for public IP addresses.
Note
This property is required for a public address block.
The possible values are.
AFRINIC
African Network Information Centre (AfriNIC)
APNIC
Asia-Pacific Network Information Centre (APNIC)
ARIN
American Registry for Internet Numbers (ARIN)
LACNIC
Latin America and Caribbean Network Information Centre (LACNIC)
RIPE
R seaux IP Europ ens Network Coordination Centre (RIPE NCC)
RirReceivedDate
-
Data type: datetime
-
Access type: Read-only
The date when a public address block was obtained from an RIR.
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.
TotalAddresses
-
Data type: uint64
-
Access type: Read-only
The number of IP addresses in the address block.
Utilization
-
Data type: uint16
-
Access type: Read-only
Indicates the IP address utilization of the block, as a threshold.
The possible values are.
None (0)
Under (1)
Optimal (2)
Over (3)
UtilizedAddresses
-
Data type: uint64
-
Access type: Read-only
The number of used IP addresses in the address block.
Requirements
| Minimum supported client |
None supported |
| Minimum supported server |
Windows Server 2012 R2 |
| Namespace |
RootMicrosoftIPAM |
| MOF |
|
| DLL |
|