MSFT_IPAM_DBConfig class
Represents an IPAM database configuration.
The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.
Syntax
[UMLPackagePath("CIM::Database::System"), ClassVersion("1.0.0"), dynamic, provider("IPAMServerPSProvider"), AMENDMENT]
class MSFT_IPAM_DBConfig : CIM_DatabaseParameter
{
string Caption;
string Description;
string ElementName;
string InstanceID;
uint16 DatabaseType;
string WidSchemaPath;
string DatabaseServer;
string DatabaseName;
uint16 DatabasePort;
uint16 DatabaseAuthType;
string DatabaseUser;
};
Members
The MSFT_IPAM_DBConfig class has these types of members:
Methods
The MSFT_IPAM_DBConfig class has these methods.
| Method | Description |
|---|---|
| MoveDatabaseConfig | Migrates an IPAM database. |
| SetDatabaseConfig | Updates an IPAM database configuration. |
Properties
The MSFT_IPAM_DBConfig 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.
-
-
DatabaseAuthType
-
-
Data type: uint16
-
Access type: Read-only
The type of authentication to use to connect to the IPAM database.
The possible values are:
-
-
Authentication Not Configured (0)
-
Authentication Not Configured.
-
Windows Authentication (1)
-
Windows Authentication.
Note
If you use Windows authentication, IPAM will use the server machine account to connect to the database.
-
SQL Authentication (2)
-
SQL Authentication.
Note
If you use Windows SQL authentication, specify a username and password to connect to the database.
DatabaseName
-
Data type: string
-
Access type: Read-only
The name of the IPAM database.
DatabasePort
-
Data type: uint16
-
Access type: Read-only
The port used to run the SQL service.
DatabaseServer
-
Data type: string
-
Access type: Read-only
The IP address or FQDN of the database server.
DatabaseType
-
Data type: uint16
-
Access type: Read-only
The type of database to configure.
Database Not Configured (0)
Windows Internal Database (1)
Microsoft SQL Server (2)
DatabaseUser
-
Data type: string
-
Access type: Read-only
The user name for SQL authentication.
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
-
Qualifiers: Required
The user-friendly name for this instance of SettingData. In addition, the user-friendly name can be used as an index property for a search or query. (Note: The name does not have to be unique within a namespace.)
This property is inherited from CIM_SettingData.
InstanceID
-
Data type: string
-
Access type: Read-only
-
Qualifiers: key
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.
This property is inherited from CIM_SettingData.
WidSchemaPath
-
Data type: string
-
Access type: Read-only
The path to the schema and log files for a Windows Internal Database.
Requirements
| Minimum supported client |
None supported |
| Minimum supported server |
Windows Server 2012 R2 |
| Namespace |
Root\Microsoft\IPAM |
| MOF |
|
| DLL |
|