Share via

MSFT_IPAM_Address class

  • Article

Manages an IP address in IPAM.

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

Syntax

[UMLPackagePath("CIM::Network::ProtocolEndpoints"), ClassVersion("1.0.0"), dynamic, provider("IPAMServerPSProvider"), AMENDMENT]
class MSFT_IPAM_Address : CIM_IPProtocolEndpoint
{
  string   InstanceID;
  string   Caption;
  string   ElementName;
  datetime InstallDate;
  string   StatusDescriptions[];
  string   Status;
  uint16   HealthState;
  uint16   CommunicationStatus;
  uint16   DetailedStatus;
  uint16   OperatingStatus;
  uint16   PrimaryStatus;
  string   OtherEnabledState;
  uint16   RequestedState = 12;
  uint16   EnabledDefault = 2;
  uint16   AvailableRequestedStates[];
  uint16   TransitioningToState = 12;
  string   SystemCreationClassName;
  string   SystemName;
  string   CreationClassName;
  datetime TimeOfLastStateChange;
  uint16   EnabledState;
  uint16   OperationalStatus[];
  string   Description;
  string   NameFormat;
  uint16   ProtocolType;
  string   OtherTypeDescription;
  uint16   ProtocolIFType = 4096;
  string   IPv4Address;
  string   IPv6Address;
  string   Address;
  string   SubnetMask;
  uint8    PrefixLength;
  uint16   IPVersionSupport;
  uint16   AddressOrigin = 0;
  uint16   AddressType;
  string   Name;
  uint16   NetworkType;
  uint16   AddressCategory;
  boolean  Duplicate;
  uint16   ExpiryStatus;
  string   MacAddress;
  string   ManagedByService;
  string   ServiceInstance;
  string   AddressSpace;
  uint64   AddressSpaceId;
  string   ProviderAddressSpace;
  string   CustomerAddressSpace;
  string   DeviceName;
  string   DeviceType;
  string   IPAddressState;
  uint16   AssignmentType = 0;
  string   IPRange;
  string   NetworkSite;
  string   VmmLogicalNetwork;
  datetime ExpiryDate;
  uint16   DhcpReservationSync;
  uint16   DnsHostRecordSync;
  uint16   DnsPtrRecordSync;
  datetime AssignmentDate;
  datetime LastModifiedTime;
  string   Owner;
  string   SerialNumber;
  string   AssetTag;
  string   ClientID;
  string   Duid;
  uint32   Iaid;
  string   ReservationName;
  string   ReservationDescription;
  uint16   ReservationType;
  string   ReservationServer;
  string   ReservationScopeName;
  string   ReservationScopeID;
  string   ForwardLookupPrimaryServer;
  string   ForwardLookupZone;
  string   ReverseLookupPrimaryServer;
  string   ReverseLookupZone;
  string   CustomConfiguration;
};

Members

The MSFT_IPAM_Address class has these types of members:

Methods

The MSFT_IPAM_Address class has these methods.

Method Description
AddAddress Adds a new IP address to IPAM.
BulkAddOrUpdateAddress Adds or updates a set of IP address objects in IPAM.
BulkDeleteAddress Deletes a set of IP addresses from IPAM.
ExportAddress Exports a set of IP addresses from IPAM to a CSV file.
FindIpamFreeAddress Retrieves an array of IP addresses from a range of IP addresses in IPAM that are not assigned to a device.
ImportAddress Imports a set of IP addresses from a CSV file to IPAM.
RequestStateChange Requests the specified change to the state of the IP address object.
This method is inherited from the CIM_EnabledLogicalElement class.

Properties

The MSFT_IPAM_Address class has these properties.

Address

Data type: string

Access type: Read-only

Qualifiers: Deprecated ("CIM_IPProtocolEndpoint.IPv4Address", "CIM_IPProtocolEndpoint.IPv6Address")

The IP address that this ProtocolEndpoint represents, formatted according to the appropriate convention as defined in the AddressType property of this class (e.g., 171.79.6.40). This single property is deprecated to replace it by specific IPv4 and v6 addresses.

This property is inherited from CIM_IPProtocolEndpoint.

AddressCategory

Data type: uint16

Access type: Read-only

The scope of the IP address, such as public or private.

The possible values are:

None (0)

Public (1)

Private (2)

Global (3)

AddressOrigin

Data type: uint16

Access type: Read-only

AddressOrigin identifies the method by which the IP Address, Subnet Mask, and Gateway were assigned to the IPProtocolEndpoint.A value of 3 "Static" shall indicate the values were assigned manually. A value of 4 "DHCP" shall indicate the values were assigned utilizing the Dynamic Host Configuration Protocol. See RFC 2131 and related.

A value of 5 "BOOTP" shall indicate the values were assigned utilizing BOOTP. See RFC 951 and related.

A value of 6 "IPv4 Link Local" shall indicate the values were assigned using the IPv4 Link Local protocol. See RFC 3927.

A value of 7 "DHCPv6" shall indicate the values were assigned using DHCPv6. See RFC 3315.

A value of 8 "IPv6 AutoConfig" shall indicate the values were assinged using the IPv6 AutoConfig Protocol. See RFC 4862.

This property is inherited from CIM_IPProtocolEndpoint.

Unknown (0)

Other (1)

Not Applicable (2)

Static (3)

DHCP (4)

BOOTP (5)

IPv4 Link Local (6)

DHCPv6 (7)

IPv6AutoConfig (8)

DMTF Reserved

9 32767

Vendor Reserved

32768 65535

AddressSpace

Data type: string

Access type: Read-only

The address space associated with the IP Address.

AddressSpaceId

Data type: uint64

Access type: Read-only

The ID of the address space associated with this IP Address.

AddressType

Data type: uint16

Access type: Read-only

Qualifiers: Override ("AddressType")

An enumeration that describes the format of the Address property. It is deprecated since it is not needed, as the class contains both IPv4 and v6 addresses).

Unknown (0)

IPV4 (1)

IPV6 (2)

AssetTag

Data type: string

Access type: Read-only

The asset tag for the device associated with the IP address.

AssignmentDate

Data type: datetime

Access type: Read-only

The latest date and time on which the IP address was assigned to a device.

AssignmentType

Data type: uint16

Access type: Read-only

The type of address assignment used by IPAM to assign the IP address.

The possible values are:

None (0)

Static (1)

Dynamic (2)

Auto (3)

VIP (4)

Reserved (5)

AvailableRequestedStates

Data type: uint16 array

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.RequestStateChange", "CIM_EnabledLogicalElementCapabilities.RequestedStatesSupported")

AvailableRequestedStates indicates the possible values for the RequestedState parameter of the method RequestStateChange, used to initiate a state change. The values listed shall be a subset of the values contained in the RequestedStatesSupported property of the associated instance of CIM_EnabledLogicalElementCapabilities where the values selected are a function of the current state of the CIM_EnabledLogicalElement. This property may be non-null if an implementation is able to advertise the set of possible values as a function of the current state. This property shall be null if an implementation is unable to determine the set of possible values as a function of the current state.

This property is inherited from CIM_EnabledLogicalElement.

Enabled (2)

Disabled (3)

Shut Down (4)

Offline (6)

Test (7)

Defer (8)

Quiesce (9)

Reboot (10)

Reset (11)

DMTF Reserved

12 65535

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.

ClientID

Data type: string

Access type: Read-only

The identifier of the client node assigned to the IP address. This identifier is used by DHCP server to identify client nodes on a network.

CommunicationStatus

Data type: uint16

Access type: Read-only

Indicates the ability of the instrumentation to communicate with the underlying managed element.

A Null return indicates the implementation (provider) does not implement this property.

This property is inherited from CIM_ManagedSystemElement.

Unknown (0)

The implementation is in general capable of returning this property, but is unable to do so at this time.

Not Available (1)

The implementation (provider) is capable of returning a value for this property, but not ever for this particular piece of hardware/software or the property is intentionally not used because it adds no meaningful information (as in the case of a property that is intended to add additional info to another property).

Communication OK (2)

Communication is established with the element, but does not convey any quality of service.

Lost Communication (3)

The Managed Element is known to exist and has been contacted successfully in the past, but is currently unreachable.

No Contact (4)

The monitoring system has knowledge of this element, but has never been able to establish communications with it.

DMTF Reserved

Vendor Reserved

CreationClassName

Data type: string

Access type: Read-only

Qualifiers: key, MaxLen (256)

CreationClassName indicates the name of the class or the subclass used in the creation of an instance. When used with the other key properties of this class, this property allows all instances of this class and its subclasses to be uniquely identified.

This property is inherited from CIM_ServiceAccessPoint.

CustomConfiguration

Data type: string

Access type: Read-only

A set of custom metadata for the IP address. The metadata is formatted with semicolon-separated name/value pairs.

CustomerAddressSpace

Data type: string

Access type: Read-only

The customer address of the IP Address. This property only contains a value when the NetworkType property is set to Customer ("3").

Description

Data type: string

Access type: Read-only

The Description property provides a textual description of the object.

This property is inherited from CIM_ProtocolEndpoint.

DetailedStatus

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.PrimaryStatus", "CIM_ManagedSystemElement.HealthState")

Compliments PrimaryStatus with additional status detail.

A Null return indicates the implementation (provider) does not implement this property.

This property is inherited from CIM_ManagedSystemElement.

Not Available (0)

The implementation (provider) is capable of returning a value for this property, but not ever for this particular piece of hardware/software or the property is intentionally not used because it adds no meaningful information (as in the case of a property that is intended to add additional info to another property).

No Additional Information (1)

The element is functioning normally as indicated by PrimaryStatus = "OK".

Stressed (2)

The element is functioning, but needs attention. Examples of "Stressed" states are overload, overheated, and so on.

Predictive Failure (3)

An element is functioning normally but a failure is predicted in the near future.

Non-Recoverable Error (4)

This element is in an error condition that requires human intervention.

Supporting Entity in Error (5)

This element might be "OK" but that another element, on which it is dependent, is in error. An example is a network service or endpoint that cannot function due to lower-layer networking problems.

DMTF Reserved

Vendor Reserved

DeviceName

Data type: string

Access type: Read-only

The name of the device to which the IP address is assigned.

DeviceType

Data type: string

Access type: Read-only

The type of device to which this IP address is assigned. The value must be a valid built in or custom field device type. The default value is "Host".

DhcpReservationSync

Data type: uint16

Access type: Read-only

The synchronization status of a reservation for the IP address.

None (0)

NotAttempted (1)

CreateSuccess (2)

CreateFailure (3)

DeleteSuccess (4)

DeleteFailure (5)

DnsHostRecordSync

Data type: uint16

Access type: Read-only

The synchronization status of a DNS host record for the IP address.

None (0)

NotAttempted (1)

CreateSuccess (2)

CreateFailure (3)

DeleteSuccess (4)

DeleteFailure (5)

DnsPtrRecordSync

Data type: uint16

Access type: Read-only

The synchronization status of a reverse DNS record for the IP address.

None (0)

NotAttempted (1)

CreateSuccess (2)

CreateFailure (3)

DeleteSuccess (4)

DeleteFailure (5)

Duid

Data type: string

Access type: Read-only

The DHCP unique identifier for the device associated with this IP address. This is used by the clients to get an IPv6 address from a DHCP server.

Duplicate

Data type: boolean

Access type: Read-only

True if the address is a duplicate; otherwise false.

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.

EnabledDefault

Data type: uint16

Access type: Read/write

An enumerated value indicating an administrator\'s default or startup configuration for the Enabled State of an element. By default, the element is "Enabled" (value=2).

This property is inherited from CIM_EnabledLogicalElement.

Enabled (2)

Disabled (3)

Not Applicable (5)

Enabled but Offline (6)

No Default (7)

Quiesce (9)

DMTF Reserved

10 32767

Vendor Reserved

32768 65535

EnabledState

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.OtherEnabledState")

EnabledState is an integer enumeration that indicates the enabled and disabled states of an element. It can also indicate the transitions between these requested states. For example, shutting down (value=4) and starting (value=10) are transient states between enabled and disabled. The following text briefly summarizes the various enabled and disabled states:

Enabled (2) indicates that the element is or could be executing commands, will process any queued commands, and queues new requests.

Disabled (3) indicates that the element will not execute commands and will drop any new requests.

Shutting Down (4) indicates that the element is in the process of going to a Disabled state.

Not Applicable (5) indicates the element does not support being enabled or disabled.

Enabled but Offline (6) indicates that the element might be completing commands, and will drop any new requests.

Test (7) indicates that the element is in a test state.

Deferred (8) indicates that the element might be completing commands, but will queue any new requests.

Quiesce (9) indicates that the element is enabled but in a restricted mode.

Starting (10) indicates that the element is in the process of going to an Enabled state. New requests are queued.

This property is inherited from CIM_ProtocolEndpoint.

Unknown (0)

Other (1)

Enabled (2)

Disabled (3)

Shutting Down (4)

Not Applicable (5)

Enabled but Offline (6)

In Test (7)

Deferred (8)

Quiesce (9)

Starting (10)

DMTF Reserved

11 32767

Vendor Reserved

32768 65535

ExpiryDate

Data type: datetime

Access type: Read-only

Indicates the and time on which an IP address expires. IPAM displays an alert when an IP address expires, and does not automatically reclaim expired addresses.

ExpiryStatus

Data type: uint16

Access type: Read-only

Indicates whether the IP address is expired.

The possible values are:

None (0)

Active (1)

Alert (2)

Expired (3)

ForwardLookupPrimaryServer

Data type: string

Access type: Read-only

The name of the DNS server that IPAM uses to resolve host names to IP addresses.

ForwardLookupZone

Data type: string

Access type: Read-only

The name of the forward lookup zone that contains a mapping of host names to IP addresses.

HealthState

Data type: uint16

Access type: Read-only

Indicates the current health of the element. This attribute expresses the health of this element but not necessarily that of its subcomponents.

This property is inherited from CIM_ManagedSystemElement.

Unknown (0)

The implementation cannot report on HealthState at this time.

OK (5)

The element is fully functional and is operating within normal operational parameters and without error.

Degraded/Warning (10)

The element is in working order and all functionality is provided. However, the element is not working to the best of its abilities. For example, the element might not be operating at optimal performance or it might be reporting recoverable errors.

Minor failure (15)

All functionality is available but some might be degraded.

Major failure (20)

The element is failing. It is possible that some or all of the functionality of this component is degraded or not working.

Critical failure (25)

The element is non-functional and recovery might not be possible.

Non-recoverable error (30)

The element has completely failed, and recovery is not possible. All functionality provided by this element has been lost.

DMTF Reserved

DMTF has reserved the unused portion of the continuum for additional HealthStates in the future.

Iaid

Data type: uint32

Access type: Read-only

The Identity association identifier (IAID) for the device associated with this IP address.

InstallDate

Data type: datetime

Access type: Read-only

A datetime value that indicates when the object was installed. Lack of a value does not indicate that the object is not installed.

This property is inherited from CIM_ManagedSystemElement.

InstanceID

Data type: string

Access type: Read-only

An optional property that may be used to opaquely and uniquely identify an instance of this class within the scope of the instantiating Namespace. Various subclasses of this class may override this property to make it required, or a key. Such subclasses may also modify the preferred algorithms for ensuring uniqueness that are defined below.

To ensure uniqueness within the namespace, the value of InstanceID should be constructed using the following "preferred" algorithm:

<OrgID>:<LocalID>

Where <OrgID> and <LocalID> are separated by a colon (:), and where <OrgID> must include a copyrighted, trademarked, or otherwise unique name that is owned by the business entity that is creating or defining the InstanceID or that is a registered ID assigned to the business entity by a recognized global authority. (This requirement is similar to the <Schema Name>_<Class Name> structure of schema class names.) In addition, to ensure uniqueness, <OrgID> must not contain a colon (:). When using this algorithm, the first colon to appear in InstanceID must appear between <OrgID> and <LocalID>.

<LocalID> is chosen by the business entity and should not be reused to identify different underlying (real-world) elements. If not null and the above "preferred" algorithm is not used, the defining entity must assure that the resulting InstanceID is not reused across any InstanceIDs produced by this or other providers for the namespace of this instance.

If not set to null for DMTF-defined instances, the "preferred" algorithm must be used with the <OrgID> set to CIM.

This property is inherited from CIM_ManagedElement.

IPAddressState

Data type: string

Access type: Read-only

Specifies the usage state of the IP address. By default the address will be marked as 'In-Use'. Custom values can also be defined for this field.

IPRange

Data type: string

Access type: Read-only

The IP address range associated with the IP address.

IPv4Address

Data type: string

Access type: Read-only

The IPv4 address that this ProtocolEndpoint represents.

This property is inherited from CIM_IPProtocolEndpoint.

IPv6Address

Data type: string

Access type: Read-only

The IPv6 address that this ProtocolEndpoint represents.

This property is inherited from CIM_IPProtocolEndpoint.

IPVersionSupport

Data type: uint16

Access type: Read-only

Qualifiers: Deprecated ("CIM_ProtocolEndpoint.ProtocolIFType")

This property explicitly defines support for different versions of the IP protocol, for this Endpoint. It is deprecated since the ProtocolIFType also provides this functionality by describing an endpoint as IPv4 only (value=4096), IPv6 only (value=4097), or IPv4/v6 (value=4098).

This property is inherited from CIM_IPProtocolEndpoint.

Unknown (0)

IPv4 Only (1)

IPv6 Only (2)

Both IPv4 and IPv6 (3)

LastModifiedTime

Data type: datetime

Access type: Read-only

The latest date and time on which any property of this IP Address was modified.

MacAddress

Data type: string

Access type: Read-only

The mac address of the device to which the IP address is assigned.

ManagedByService

Data type: string

Access type: Read-only

The name of the service that manages the IP address.

Name

Data type: string

Access type: Read-only

Qualifiers: MaxLen (256), key, Override ("Name")

A string that identifies this ProtocolEndpoint with either a port or an interface on a device. To ensure uniqueness, the Name property should be prepended or appended with information from the Type or OtherTypeDescription properties. The method selected is described in the NameFormat property of this class.

NameFormat

Data type: string

Access type: Read-only

Qualifiers: MaxLen (256)

NameFormat contains the naming heuristic that is selected to ensure that the value of the Name property is unique. For example, you might choose to prepend the name of the port or interface with the Type of ProtocolEndpoint (for example, IPv4) of this instance followed by an underscore.

This property is inherited from CIM_ProtocolEndpoint.

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

Indicates whether the address is a virtual address.

The possible values are:

NonVirtualized (1)

Provider (2)

Customer (4)

OperatingStatus

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")

Provides a current status value for the operational condition of the element and can be used for providing more detail with respect to the value of EnabledState. It can also provide the transitional states when an element is transitioning from one state to another, such as when an element is transitioning between EnabledState and RequestedState, as well as other transitional conditions.

A Null return indicates the implementation (provider) does not implement this property.

This property is inherited from CIM_ManagedSystemElement.

Unknown (0)

The implementation (ie, the provider) is in general capable of returning this property, but is unable to do so at this time.

Not Available (1)

The implementation (provider) is capable of returning a value for this property, but not ever for this particular piece of hardware/software or the property is intentionally not used because it adds no meaningful information (as in the case of a property that is intended to add additional info to another property)

Servicing (2)

An element is being configured, maintained, cleaned, or otherwise administered.

Starting (3)

The element is being initialized.

Stopping (4)

An element is being brought to an orderly stop.

Stopped (5)

A clean and orderly stop has occurred.

Aborted (6)

An abrupt stop, where the state and configuration of the element might need to be updated, has occurred.

Dormant (7)

The element is inactive or quiesced.

Completed (8)

The element has completed its operation. This value should be combined with either OK, Error, or Degraded in the PrimaryStatus so that a client can tell if the complete operation Completed with OK (passed), Completed with Error (failed), or Completed with Degraded (the operation finished, but it did not complete OK or did not report an error).

Migrating (9)

The element is being moved between host elements.

Emigrating (10)

The element is being moved away from host element.

Immigrating (11)

The element is being moved to new host element.

Snapshotting (12)

Shutting Down (13)

The element is being brought to an abrupt stop.

In Test (14)

The managed element is performing test functions.

Transitioning (15)

The element that is between states, that is, it is not fully available in either its previous state or its next state. This value should be used if other values indicating a transition to a specific state are not applicable.

In Service (16)

The element is in service and operational.

DMTF Reserved

Vendor Reserved

OperationalStatus

Data type: uint16 array

Access type: Read-only

Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ManagedSystemElement.StatusDescriptions")

Indicates the current statuses of the element. Various operational statuses are defined. Many of the enumeration\'s values are self-explanatory. However, a few are not and are described here in more detail.

"Stressed" indicates that the element is functioning, but needs attention. Examples of "Stressed" states are overload, overheated, and so on.

"Predictive Failure" indicates that an element is functioning nominally but predicting a failure in the near future.

"In Service" describes an element being configured, maintained, cleaned, or otherwise administered.

"No Contact" indicates that the monitoring system has knowledge of this element, but has never been able to establish communications with it.

"Lost Communication" indicates that the ManagedSystem Element is known to exist and has been contacted successfully in the past, but is currently unreachable.

"Stopped" and "Aborted" are similar, although the former implies a clean and orderly stop, while the latter implies an abrupt stop where the state and configuration of the element might need to be updated.

"Dormant" indicates that the element is inactive or quiesced.

"Supporting Entity in Error" indicates that this element might be "OK" but that another element, on which it is dependent, is in error. An example is a network service or endpoint that cannot function due to lower-layer networking problems.

"Completed" indicates that the element has completed its operation. This value should be combined with either OK, Error, or Degraded so that a client can tell if the complete operation Completed with OK (passed), Completed with Error (failed), or Completed with Degraded (the operation finished, but it did not complete OK or did not report an error).

"Power Mode" indicates that the element has additional power model information contained in the Associated PowerManagementService association.

OperationalStatus replaces the Status property on ManagedSystemElement to provide a consistent approach to enumerations, to address implementation needs for an array property, and to provide a migration path from today\'s environment to the future. This change was not made earlier because it required the deprecated qualifier. Due to the widespread use of the existing Status property in management applications, it is strongly recommended that providers or instrumentation provide both the Status and OperationalStatus properties. Further, the first value of OperationalStatus should contain the primary status for the element. When instrumented, Status (because it is single-valued) should also provide the primary status of the element.

This property is inherited from CIM_ProtocolEndpoint.

Unknown (0)

Other (1)

OK (2)

Degraded (3)

Stressed (4)

Predictive Failure (5)

Error (6)

Non-Recoverable Error (7)

Starting (8)

Stopping (9)

Stopped (10)

In Service (11)

No Contact (12)

Lost Communication (13)

Aborted (14)

Dormant (15)

Supporting Entity in Error (16)

Completed (17)

Power Mode (18)

DMTF Reserved

19 32767

Vendor Reserved

32768 65535

OtherEnabledState

Data type: string

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")

A string that describes the enabled or disabled state of the element when the EnabledState property is set to 1 ("Other"). This property must be set to null when EnabledState is any value other than 1.

This property is inherited from CIM_EnabledLogicalElement.

OtherTypeDescription

Data type: string

Access type: Read-only

Qualifiers: MaxLen (64), ModelCorrespondence ("CIM_ProtocolEndpoint.ProtocolType", "CIM_ProtocolEndpoint.ProtocolIFType")

A string that describes the type of ProtocolEndpoint when the Type property of this class (or any of its subclasses) is set to 1 (Other). This property should be set to null when the Type property is any value other than 1.

This property is inherited from CIM_ProtocolEndpoint.

Owner

Data type: string

Access type: Read-only

The owner of the IP address.

PrefixLength

Data type: uint8

Access type: Read-only

The prefix length for the IPv6 address of this Protocol Endpoint, if one is defined.

This property is inherited from CIM_IPProtocolEndpoint.

PrimaryStatus

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_ManagedSystemElement.DetailedStatus", "CIM_ManagedSystemElement.HealthState")

Provides a high level status value, intended to align with Red-Yellow-Green type representation of status. It should be used in conjunction with DetailedStatus to provide high level and detailed health status of the managed element and its subcomponents.

This property is inherited from CIM_ManagedSystemElement.

Unknown (0)

The implementation is in general capable of returning this property, but is unable to do so at this time.

OK (1)

The managed element is functioning normally.

Degraded (2)

The managed element is functioning below normal.

Error (3)

The managed element is in an Error condition.

DMTF Reserved

Vendor Reserved

ProtocolIFType

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_ProtocolEndpoint.OtherTypeDescription")

ProtocolIFType\'s enumeration is limited to IP-related and reserved values for this subclass of ProtocolEndpoint.

This property is inherited from CIM_IPProtocolEndpoint.

Other (1)

IANA Reserved

225 4095

IPv4 (4096)

IPv6 (4097)

IPv4/v6 (4098)

DMTF Reserved

4301 32767

Vendor Reserved

32768 65535

ProtocolType

Data type: uint16

Access type: Read-only

Qualifiers: Deprecated ("CIM_ProtocolEndpoint.ProtocolIFType"), ModelCorrespondence ("CIM_ProtocolEndpoint.OtherTypeDescription")

Note: This property is deprecated in lieu of the ProtocolIFType enumeration. This deprecation was done to have better alignment between the IF-MIB of the IETF and this CIM class.

Deprecated description: ProtocolType is an enumeration that provides information to categorize and classify different instances of this class. For most instances, information in this enumeration and the definition of the subclass overlap. However, there are several cases where a specific subclass of ProtocolEndpoint is not required (for example, there is no Fibre Channel subclass of ProtocolEndpoint). Therefore, this property is needed to define the type of Endpoint.

This property is inherited from CIM_ProtocolEndpoint.

Unknown (0)

Other (1)

IPv4 (2)

IPv6 (3)

IPX (4)

AppleTalk (5)

DECnet (6)

SNA (7)

CONP (8)

CLNP (9)

VINES (10)

XNS (11)

ATM (12)

Frame Relay (13)

Ethernet (14)

TokenRing (15)

FDDI (16)

Infiniband (17)

Fibre Channel (18)

ISDN BRI Endpoint (19)

ISDN B Channel Endpoint (20)

ISDN D Channel Endpoint (21)

IPv4/v6 (22)

BGP (23)

OSPF (24)

MPLS (25)

UDP (26)

TCP (27)

ProviderAddressSpace

Data type: string

Access type: Read-only

The provider address space of the IP address. This property only contains a value when the NetworkType property is set to Provider ("2") or NonVirtualized ("1").

RequestedState

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")

RequestedState is an integer enumeration that indicates the last requested or desired state for the element, irrespective of the mechanism through which it was requested. The actual state of the element is represented by EnabledState. This property is provided to compare the last requested and current enabled or disabled states. Note that when EnabledState is set to 5 ("Not Applicable"), then this property has no meaning. Refer to the EnabledState property description for explanations of the values in the RequestedState enumeration.

"Unknown" (0) indicates the last requested state for the element is unknown.

Note that the value "No Change" (5) has been deprecated in lieu of indicating the last requested state is "Unknown" (0). If the last requested or desired state is unknown, RequestedState should have the value "Unknown" (0), but may have the value "No Change" (5).Offline (6) indicates that the element has been requested to transition to the Enabled but Offline EnabledState.

It should be noted that there are two new values in RequestedState that build on the statuses of EnabledState. These are "Reboot" (10) and "Reset" (11). Reboot refers to doing a "Shut Down" and then moving to an "Enabled" state. Reset indicates that the element is first "Disabled" and then "Enabled". The distinction between requesting "Shut Down" and "Disabled" should also be noted. Shut Down requests an orderly transition to the Disabled state, and might involve removing power, to completely erase any existing state. The Disabled state requests an immediate disabling of the element, such that it will not execute or accept any commands or processing requests.

This property is set as the result of a method invocation (such as Start or StopService on CIM_Service), or can be overridden and defined as WRITEable in a subclass. The method approach is considered superior to a WRITEable property, because it allows an explicit invocation of the operation and the return of a result code.

If knowledge of the last RequestedState is not supported for the EnabledLogicalElement, the property shall be NULL or have the value 12 "Not Applicable".

This property is inherited from CIM_EnabledLogicalElement.

Unknown (0)

Enabled (2)

Disabled (3)

Shut Down (4)

No Change (5)

Offline (6)

Test (7)

Deferred (8)

Quiesce (9)

Reboot (10)

Reset (11)

Not Applicable (12)

DMTF Reserved

13 32767

Vendor Reserved

32768 65535

ReservationDescription

Data type: string

Access type: Read-only

The description of the DHCP reservation for the IP address.

ReservationName

Data type: string

Access type: Read-only

The user defined unique name of the DHCP reservation for the IP address.

ReservationScopeID

Data type: string

Access type: Read-only

The ID of DHCP scope for the DHCP reservation.

ReservationScopeName

Data type: string

Access type: Read-only

The name of DHCP scope for the DHCP reservation.

ReservationServer

Data type: string

Access type: Read-only

The DHCP server on which to create the reservation.

ReservationType

Data type: uint16

Access type: Read-only

This specifies the protocols supported by the reservation.

The possible values are:

None (0)

Dhcp (1)

Bootp (2)

Both (3)

ReverseLookupPrimaryServer

Data type: string

Access type: Read-only

The DNS server that IPAM uses to resolve IP addresses to host names.

ReverseLookupZone

Data type: string

Access type: Read-only

The reverse lookup zone that contains the mapping from IP addresses to fully qualified domain names (FQDNs).

SerialNumber

Data type: string

Access type: Read-only

The serial number of the device associated with the IP address.

ServiceInstance

Data type: string

Access type: Read-only

The instance of the service that manages the IP address.

Status

Data type: string

Access type: Read-only

Qualifiers: Deprecated ("CIM_ManagedSystemElement.OperationalStatus"), MaxLen (10)

A string indicating the current status of the object. Various operational and non-operational statuses are defined. This property is deprecated in lieu of OperationalStatus, which includes the same semantics in its enumeration. This change is made for 3 reasons:

  1. Status is more correctly defined as an array. This definition overcomes the limitation of describing status using a single value, when it is really a multi-valued property (for example, an element might be OK AND Stopped.

  2. A MaxLen of 10 is too restrictive and leads to unclear enumerated values.

  3. The change to a uint16 data type was discussed when CIM V2.0 was defined. However, existing V1.0 implementations used the string property and did not want to modify their code. Therefore, Status was grandfathered into the Schema. Use of the deprecated qualifier allows the maintenance of the existing property, but also permits an improved definition using OperationalStatus.

This property is inherited from CIM_ManagedSystemElement.

("OK")

("Error")

("Degraded")

("Unknown")

("Pred Fail")

("Starting")

("Stopping")

("Service")

("Stressed")

("NonRecover")

("No Contact")

("Lost Comm")

("Stopped")

StatusDescriptions

Data type: string array

Access type: Read-only

Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ManagedSystemElement.OperationalStatus")

Strings describing the various OperationalStatus array values. For example, if "Stopping" is the value assigned to OperationalStatus, then this property may contain an explanation as to why an object is being stopped. Note that entries in this array are correlated with those at the same array index in OperationalStatus.

This property is inherited from CIM_ManagedSystemElement.

SubnetMask

Data type: string

Access type: Read-only

The mask for the IPv4 address of this ProtocolEndpoint, if one is defined.

This property is inherited from CIM_IPProtocolEndpoint.

SystemCreationClassName

Data type: string

Access type: Read-only

Qualifiers: key, MaxLen (256), Propagated ("CIM_System.CreationClassName")

The CreationClassName of the scoping System.

This property is inherited from CIM_ServiceAccessPoint.

SystemName

Data type: string

Access type: Read-only

Qualifiers: key, MaxLen (256), Propagated ("CIM_System.Name")

The Name of the scoping System.

This property is inherited from CIM_ServiceAccessPoint.

TimeOfLastStateChange

Data type: datetime

Access type: Read-only

The date or time when the EnabledState of the element last changed. If the state of the element has not changed and this property is populated, then it must be set to a 0 interval value. If a state change was requested, but rejected or not yet processed, the property must not be updated.

This property is inherited from CIM_ProtocolEndpoint.

TransitioningToState

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.RequestStateChange", "CIM_EnabledLogicalElement.RequestedState", "CIM_EnabledLogicalElement.EnabledState")

TransitioningToState indicates the target state to which the instance is transitioning.

A value of 5 "No Change" shall indicate that no transition is in progress.A value of 12 "Not Applicable" shall indicate the implementation does not support representing ongoing transitions.

A value other than 5 or 12 shall identify the state to which the element is in the process of transitioning.

This property is inherited from CIM_EnabledLogicalElement.

Unknown (0)

Enabled (2)

Disabled (3)

Shut Down (4)

No Change (5)

Offline (6)

Test (7)

Defer (8)

Quiesce (9)

Reboot (10)

Reset (11)

Not Applicable (12)

DMTF Reserved

13 65535

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.

Requirements
Minimum supported client
 None supported
Minimum supported server
 Windows Server 2012 R2
Namespace
 Root\Microsoft\IPAM
MOF
IPAMServerPSProvider.mof
DLL
IPAMServerPSProvider.dll

See also

CIM_IPProtocolEndpoint

IPAM Server WMI Provider Reference