Modifies settings that IPAM uses to connect to the IPAM database.
Networking / Security · Risk: High · Documentation Verified
Last verified: 2026-10-26
Microsoft IpamServer reference: Modifies settings that IPAM uses to connect to the IPAM database. The syntax and selected example below are adapted from the pinned Windows Server 2025 reference. Module availability, target configuration and delegated permissions determine whether it can run in your environment. Documentation and parameter text: Microsoft, CC BY 4.0; formatting adapted by Cmdlet World. No execution testing is claimed.
Use an account with the target resource permissions documented for Set-IpamDatabase. Modifying administrative cmdlets may require elevation or delegated administration. This catalog does not assert that ordinary users can execute the command.
Supported environments
Windows / IpamServer · Windows Server 2025 documentation; feature/module prerequisites apply
Parameters
-AsJob
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell background jobs, see about_Jobs.
-CimSession
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.
-Confirm
Prompts you for confirmation before running the cmdlet.
-DatabaseAuthType (required)
Specifies which type of authentication to use to connect to the computer that runs SQL Server. The acceptable values for this parameter are: - SQL. Use the database account. Specify this credential by using the *DatabaseCredential* parameter. - Windows. Use the account for the computer that runs the IPAM server.
-DatabaseCredential
Specifies credentials, as a PSCredential object, for the computer that runs SQL Server. To obtain a PSCredential object, use the Get-Credential cmdlet. For more information, type Get-Help Get-Credential. Specify this parameter if you specified a value of SQL Server for the *DatabaseAuthType* parameter.
-DatabaseName (required)
Specifies the name of a SQL Serverdatabase. The IPAM server connects to this database.
-DatabasePort (required)
Specifies the port that the IPAM server uses to connect to the database server.
-DatabaseServer (required)
Specifies the fully qualified domain name (FQDN) or IP address of the database server. The IPAM server connects to this server.
-Force
Forces the command to run without asking for user confirmation.
-PassThru
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
-ThrottleLimit
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Prerequisites
Windows with the IpamServer module and the Windows feature or management tools that provide it. Confirm target connectivity and version compatibility using the linked Microsoft reference.
Security considerations
This cmdlet changes system state. Review every target and parameter in the official reference, test outside production, and prepare an appropriate backup or rollback. Do not execute the example automatically.
Examples
Example 1: Connect to an external database
Set-IpamDatabase -DatabaseServer "ContosoDB04" -DatabaseName "IpamData01" -DatabasePort 1433 -DatabaseAuthType Windows
This example configures the IPAM server to connect to an external database. The cmdlet does not move any data from the existing Windows Internal Database (WID) database or create the new database. Configure all access settings manually on the database server. The example uses Windows as the database authentication type. Source: Microsoft, CC BY 4.0; transcript prompt/output removed. This example was not executed.