SetDatabaseConfig method of the MSFT_IPAM_DBConfig class

Updates an IPAM database configuration.

Syntax

uint32 SetDatabaseConfig(
  [in]  string             DatabaseServer,
  [in]  string             DatabaseName,
  [in]  uint16             DatabasePort,
  [in]  uint16             DatabaseAuthType,
  [in]  string             DatabaseCredential,
  [out] MSFT_IPAM_DBConfig Output
);

Parameters

DatabaseServer [in]

The IP address or FQDN of the database server.

DatabaseName [in]

The name of the database to update.

DatabasePort [in]

The port used to run the SQL service.

DatabaseAuthType [in]

The type of authentication to use to connect to the IPAM database.

The possible values are:

0

Authentication Not Configured.

1

Windows Authentication.

Note

If you use Windows authentication, IPAM will use the server machine account to connect to the database.

2

SQL Authentication.

Note

If you use Windows SQL authentication, specify a username and password to connect to the database.

DatabaseCredential [in]

The credentials to the database.

Output [out]

When this method returns, this parameter contains the updated database configuration object.

Return value

Returns 0 on success, otherwise returns a WMI error code.

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

MSFT_IPAM_DBConfig