MSFT_IPAM_DBConfig, ROOT\Microsoft\IPAM

Class | Methods (2) | Properties (11) | Qualifiers (6) | Instances | Namespaces (2)
Samples: VB Script | C# | VB.Net | Search on:Microsoft

Description

The CIM_DatabaseParameter class extends from CIM_ScopedSettingData. This abstract class specifies the database and service configuration parameters that are common across database models and vendor implementations. The SNMP RDBMS MIB defines database and service parameters as name and value pair combinations rather than as specific named properties of the class. In order to maintain a consistent mapping between SNMP and CIM, a CIM_SNMPDatabaseParameter class extends from the abstract CIM_DatabaseParameter class, which defines parameters as a name value pair. In a future release of the database MOF, the working group can choose to create a new class that extends from CIM_DatabaseParameter, which specifies properties for common configuration parameters. The parameter context for a specific database or database service is established by collecting the SettingData using the CIM_ElementProfile association. The SNMP RDBMS MIB defines generic tables that contain rows of named database or service configuration entries. A parameter entry contains a parameter name, description, and value. See the description of the rdbmsDbParamTable or the rdbmsSrvParamTable for more information on the SNMP definitions.

MSFT_IPAM_DBConfig methods

MSFT_IPAM_DBConfig has 2 methods (2 Local)

NameOriginReturn
MoveDatabaseConfigMSFT_IPAM_DBConfiguint32 {'out':True}
SetDatabaseConfigMSFT_IPAM_DBConfiguint32 {'out':True}

MSFT_IPAM_DBConfig properties

MSFT_IPAM_DBConfig has 11 properties (7 Local, 4 Derived)

NameOriginCIMType
CaptionCIM_ManagedElement8 [string]
DatabaseAuthTypeMSFT_IPAM_DBConfig18 [uint16]
DatabaseNameMSFT_IPAM_DBConfig8 [string]
DatabasePortMSFT_IPAM_DBConfig18 [uint16]
DatabaseServerMSFT_IPAM_DBConfig8 [string]
DatabaseTypeMSFT_IPAM_DBConfig18 [uint16]
DatabaseUserMSFT_IPAM_DBConfig8 [string]
DescriptionCIM_ManagedElement8 [string]
ElementNameCIM_ManagedElement8 [string]
key
InstanceID
CIM_ManagedElement8 [string]
WidSchemaPathMSFT_IPAM_DBConfig8 [string]

Detailed description of MSFT_IPAM_DBConfig methods

Local methods (2) of MSFT_IPAM_DBConfig class

MoveDatabaseConfig method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
DatabaseServerstring0-{'In':True}
DatabaseNamestring1-{'In':True}
DatabasePortuint162-{'In':True}
DatabaseAuthTypeuint163-{'In':True}
DatabaseCredentialstring4-{'In':True}
Outputobject:MSFT_IPAM_DBConfig5-{'EmbeddedInstance':'MSFT_IPAM_DBConfig','Out':True}
Description'Migrates IPAM database from Windows Internal Database to Microsoft Sql Server. This can also be used to move IPAM database from one Microsoft Sql Server to another.'
implementedTrue
staticTrue
MoveDatabaseConfig method is in 1 class (MSFT_IPAM_DBConfig) of ROOT\Microsoft\IPAM and in 2 namespaces
SetDatabaseConfig method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
DatabaseServerstring0-{'In':True}
DatabaseNamestring1-{'In':True}
DatabasePortuint162-{'In':True}
DatabaseAuthTypeuint163-{'In':True}
DatabaseCredentialstring4-{'In':True}
Outputobject:MSFT_IPAM_DBConfig5-{'EmbeddedInstance':'MSFT_IPAM_DBConfig','Out':True}
Description'Configures settings used by IPAM server to connect to a database server. IPAM can be configured to use either IPAM machine account or a SQL user account to connect to the database.'
implementedTrue
staticTrue
SetDatabaseConfig method is in 1 class (MSFT_IPAM_DBConfig) of ROOT\Microsoft\IPAM and in 2 namespaces

Detailed description of MSFT_IPAM_DBConfig properties

Local properties (7) of MSFT_IPAM_DBConfig class

DatabaseAuthType property
CIMTYPE'uint16'
Description'Authentication type to be used while connecting to the database server. If Windows authentication is used, the IPAM server´┐Żs machine credentials will be used. For SQL authentication, the user can specify a username and password to be used to connect to the database server.'
ValueMap['0', '1', '2']
Values['Authentication Not Configured', 'Windows Authentication', 'SQL Authentication']
DatabaseAuthType property is in 1 class (MSFT_IPAM_DBConfig) of ROOT\Microsoft\IPAM and in 2 namespaces
DatabaseName property
CIMTYPE'string'
Description'The name of the database to which IPAM will connect.'
DatabaseName property is in 1 class (MSFT_IPAM_DBConfig) of ROOT\Microsoft\IPAM and in 4 namespaces
DatabasePort property
CIMTYPE'uint16'
Description'Port on which the SQL service is running.'
DatabasePort property is in 1 class (MSFT_IPAM_DBConfig) of ROOT\Microsoft\IPAM and in 2 namespaces
DatabaseServer property
CIMTYPE'string'
Description'The IP address or FQDN of the database server.'
DatabaseServer property is in 1 class (MSFT_IPAM_DBConfig) of ROOT\Microsoft\IPAM and in 2 namespaces
DatabaseType property
CIMTYPE'uint16'
Description'Specifies whether IPAM is configured to use WID or MSSQL.'
ValueMap['0', '1', '2']
Values['Database Not Configured', 'Windows Internal Database', 'Microsoft SQL Server']
DatabaseType property is in 1 class (MSFT_IPAM_DBConfig) of ROOT\Microsoft\IPAM and in 2 namespaces
DatabaseUser property
CIMTYPE'string'
Description'User name used for SQL authentication.'
DatabaseUser property is in 1 class (MSFT_IPAM_DBConfig) of ROOT\Microsoft\IPAM and in 2 namespaces
WidSchemaPath property
CIMTYPE'string'
Description'The location where IPAM will store the schema and log files for Windows Internal Database.'
WidSchemaPath property is in 1 class (MSFT_IPAM_DBConfig) of ROOT\Microsoft\IPAM and in 2 namespaces

Derived properties (4) of MSFT_IPAM_DBConfig class

Caption property
CIMTYPE'string'
Description'The Caption property is a short textual description (one- line string) of the object.'
MaxLen64
Caption property is in 45 classes of ROOT\Microsoft\IPAM and in 37 namespaces
Description property
CIMTYPE'string'
Description'The Description property provides a textual description of the object.'
Description property is in 46 classes of ROOT\Microsoft\IPAM and in 142 namespaces
ElementName property
CIMTYPE'string'
Description'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.)'
RequiredTrue
ElementName property is in 45 classes of ROOT\Microsoft\IPAM and in 21 namespaces
InstanceID property
CIMTYPE'string'
Description'Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class. To ensure uniqueness within the NameSpace, the value of InstanceID should be constructed using the following "preferred" algorithm:
:
Where and are separated by a colon (:), and where 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 _ structure of Schema class names.) In addition, to ensure uniqueness, must not contain a colon (:). When using this algorithm, the first colon to appear in InstanceID must appear between and .
is chosen by the business entity and should not be reused to identify different underlying (real-world) elements. If 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.
For DMTF-defined instances, the "preferred" algorithm must be used with the set to CIM.'
keyTrue
InstanceID property is in 45 classes of ROOT\Microsoft\IPAM and in 21 namespaces

MSFT_IPAM_DBConfig Qualifiers

NameValueToInstanceToSubclassOverridableAmendedLocal
ClassVersion'1.0.0'
Description'The CIM_DatabaseParameter class extends from CIM_ScopedSettingData. This abstract class specifies the database and service configuration parameters that are common across database models and vendor implementations.
The SNMP RDBMS MIB defines database and service parameters as name and value pair combinations rather than as specific named properties of the class. In order to maintain a consistent mapping between SNMP and CIM, a CIM_SNMPDatabaseParameter class extends from the abstract CIM_DatabaseParameter class, which defines parameters as a name value pair.
In a future release of the database MOF, the working group can choose to create a new class that extends from CIM_DatabaseParameter, which specifies properties for common configuration parameters.
The parameter context for a specific database or database service is established by collecting the SettingData using the CIM_ElementProfile association.
The SNMP RDBMS MIB defines generic tables that contain rows of named database or service configuration entries. A parameter entry contains a parameter name, description, and value. See the description of the rdbmsDbParamTable or the rdbmsSrvParamTable for more information on the SNMP definitions.'
dynamicTrue
locale'MS_409'
provider'IPAMServerPSProvider'
UMLPackagePath'CIM::Database::System'

MSFT_IPAM_DBConfig System properties

NameValueOriginCIMTypeLocalArray
__PATH'\\.\ROOT\Microsoft\IPAM:MSFT_IPAM_DBConfig'___SYSTEM8
__NAMESPACE'ROOT\Microsoft\IPAM'___SYSTEM8
__SERVER'.'___SYSTEM8
__DERIVATION['CIM_DatabaseParameter', 'CIM_ScopedSettingData', 'CIM_SettingData', 'CIM_ManagedElement']___SYSTEM8
__PROPERTY_COUNT11___SYSTEM3
__RELPATH'MSFT_IPAM_DBConfig'___SYSTEM8
__DYNASTY'CIM_ManagedElement'___SYSTEM8
__SUPERCLASS'CIM_DatabaseParameter'___SYSTEM8
__CLASS'MSFT_IPAM_DBConfig'___SYSTEM8
__GENUS1___SYSTEM3
comments powered by Disqus
WUtils.com