Share via

MSFT_IPAM_ServerInventory class

  • Article

Represents a managed infrastructure server in the IPAM server inventory.

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

Syntax

[UMLPackagePath("CIM::Core::CoreElements"), ClassVersion("1.0.0"), dynamic, provider("IPAMServerPSProvider"), AMENDMENT]
class MSFT_IPAM_ServerInventory : CIM_LogicalElement
{
  string   Caption;
  string   Description;
  string   ElementName;
  datetime InstallDate;
  string   Name;
  uint16   OperationalStatus[];
  string   StatusDescriptions[];
  string   Status;
  uint16   HealthState;
  uint16   CommunicationStatus;
  uint16   DetailedStatus;
  uint16   OperatingStatus;
  uint16   PrimaryStatus;
  string   InstanceID;
  string   RecommendedAction;
  uint16   ManageabilityStatus;
  uint16   IPAMAccessStatus;
  string   ServerName;
  uint16   ServerType[];
  string   DnsSuffix;
  string   DomainName;
  uint16   ServerStatus;
  uint16   DataRetrievalStatus;
  string   IPv4Address[];
  string   IPv6Address[];
  string   OperatingSystem;
  uint16   DhcpRpcAccessStatus;
  uint16   DnsRpcAccessStatus;
  uint16   DhcpAuditShareAccessStatus;
  uint16   EventLogAccessStatus;
  string   ForestName;
  string   Owner;
  string   ServerGuid;
  string   CustomConfiguration;
};

Members

The MSFT_IPAM_ServerInventory class has these types of members:

Methods

The MSFT_IPAM_ServerInventory class has these methods.

Method Description
AddIpamServerInventory Adds an infrastructure server to the IPAM server inventory.
RemoveIpamServerInventory Deletes an infrastructure server from the IPAM server inventory.
SetIpamServerInventory Updates an infrastructure server in the IPAM server inventory.

Properties

The MSFT_IPAM_ServerInventory class has these properties.

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.

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.

The possible values are.

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

CustomConfiguration

Data type: string

Access type: Read-only

The custom metadata assigned to the server.

DataRetrievalStatus

Data type: uint16

Access type: Read-only

Indicates whether IPAM was able to retrieve data from the server.

The possible values are.

None (0)

Not started (1)

In progress (2)

Completed (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_ManagedElement.

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.

The possible values are.

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

DhcpAuditShareAccessStatus

Data type: uint16

Access type: Read-only

Indicates if IPAM can access the audit share on the DHCP server.

The possible values are.

None (0)

Not Checked (1)

Not Applicable (2)

Blocked (3)

Unblocked (4)

Unknown (5)

DhcpRpcAccessStatus

Data type: uint16

Access type: Read-only

Indicates whether IPAM can make RPC (Remote Procedure Call) calls to the DHCP server.

The possible values are.

None (0)

Not Checked (1)

Not Applicable (2)

Blocked (3)

Unblocked (4)

Unknown (5)

DnsRpcAccessStatus

Data type: uint16

Access type: Read-only

Indicates whether IPAM can make RPC calls to the DNS server.

The possible values are.

None (0)

Not Checked (1)

Not Applicable (2)

Blocked (3)

Unblocked (4)

Unknown (5)

DnsSuffix

Data type: string

Access type: Read-only

The DNS suffix of the server.

DomainName

Data type: string

Access type: Read-only

The domain name of the server.

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.

EventLogAccessStatus

Data type: uint16

Access type: Read-only

Indicates whether IPAM can access event logs on the DHCP server.

The possible values are.

None (0)

Not Checked (1)

Not Applicable (2)

Blocked (3)

Unblocked (4)

Unknown (5)

ForestName

Data type: string

Access type: Read-only

The forest name for this server.

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

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.

The possible values are.

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.

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

Qualifiers: Override (InstanceID), key

InstanceID is 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.

IPAMAccessStatus

Data type: uint16

Access type: Read-only

Indicates whether IPAM can access the managed server.

The possible values are.

None (0)

Not Checked (1)

Not Applicable (2)

Blocked (3)

Unblocked (4)

Unknown (5)

IPv4Address

Data type: string array

Access type: Read-only

An array that contains the IPv4 addresses assigned to the server.

IPv6Address

Data type: string array

Access type: Read-only

An array that contains the IPv6 addresses assigned to the server.

ManageabilityStatus

Data type: uint16

Access type: Read-only

Indicates whether IPAM is managing the server.

The possible values are.

Managed (1)

IPAM is managing the server.

Unmanaged (2)

IPAM is not managing the server.

Name

Data type: string

Access type: Read-only

Qualifiers: MaxLen (1024)

The Name property defines the label by which the object is known. When subclassed, the Name property can be overridden to be a Key property.

This property is inherited from CIM_ManagedSystemElement.

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 transitions 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.

The possible values are.

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

OperatingSystem

Data type: string

Access type: Read-only

The operating system that the server is running.

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.

OperationalStatus replaces the Status property 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_ManagedSystemElement.

Unknown (0)

Other (1)

OK (2)

Degraded (3)

Stressed (4)

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

Predictive Failure (5)

An element is functioning nominally but predicting a failure in the near future.

Error (6)

Non-Recoverable Error (7)

Starting (8)

Stopping (9)

Stopped (10)

A clean and orderly stop has occurred.

In Service (11)

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

No Contact (12)

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

Lost Communication (13)

The managed system element is known to exist and has been contacted successfully in the past, but is currently unreachable.

Aborted (14)

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

Dormant (15)

The element is inactive or quiesced.

Supporting Entity in Error (16)

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 (17)

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 (18)

The element has additional power model information contained in the Associated PowerManagementService association.

DMTF Reserved

Vendor Reserved

Owner

Data type: string

Access type: Read-only

The owner of the server.

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.

The possible values are.

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

RecommendedAction

Data type: string

Access type: Read-only

The recommended action to take if the server becomes unreachable.

ServerGuid

Data type: string

Access type: Read-only

The GUID that uniquely identifies the server.

ServerName

Data type: string

Access type: Read-only

The server name.

ServerStatus

Data type: uint16

Access type: Read-only

The service availability status of the server.

The possible values are.

None (0)

New (1)

Changed (2)

No change (3)

ServerType

Data type: uint16 array

Access type: Read-only

An array that contains the server roles that are running on the server.

The possible values are.

None (0)

Dc (1)

Domain Controller

Dns (2)

Domain Name System (DNS)

Dhcp (3)

Dynamic Host Configuration Protocol (DHCP)

Nps (4)

Network Policy Server (NPS)

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 property is inherited from CIM_ManagedSystemElement.

The possible values are.

"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.

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_LogicalElement

IPAM Server WMI Provider Reference