MSFT_IPAM_ServerConfiguration class

Represents an IPAM server configuration.

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

Syntax

[UMLPackagePath("CIM::Core::Settings"), ClassVersion("1.0.0"), dynamic, provider("IPAMServerPSProvider"), AMENDMENT]
class MSFT_IPAM_ServerConfiguration : CIM_Setting
{
  string Caption;
  string Description;
  string ElementName;
  string SettingID;
  string InstanceID;
  string Version;
  uint16 Port;
  uint16 ProvisioningMethod;
  string GpoPrefix;
  string HMACKey;
};

Members

The MSFT_IPAM_ServerConfiguration class has these types of members:

• Methods
• Properties

Methods

The MSFT_IPAM_ServerConfiguration class has these methods.

Properties

The MSFT_IPAM_ServerConfiguration 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.

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.

GpoPrefix

Data type: string

Access type: Read-only

The GPO prefix to use for Group Policy based provisioning.

HMACKey

Data type: string

Access type: Read-only

The secret key used to encrypt the IPAM data store.

InstanceID

Data type: string

Access type: Read-only

Qualifiers: Override (InstanceID), key

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

Port

Data type: uint16

Access type: Read-only

The incoming port that is configured on the server.

ProvisioningMethod

Data type: uint16

Access type: Read-only

The provisioning method that is configured on the server.

GpoBased (0)

Manual (1)

Requirements

See also

CIM_Setting

IPAM Server WMI Provider Reference