Set-IpamDatabase
Modifies settings that IPAM uses to connect to the IPAM database.
Syntax
Default (Default)
Set-IpamDatabase
[-DatabaseServer] <String>
[-DatabaseName] <String>
[-DatabasePort] <UInt16>
-DatabaseAuthType <AuthType>
[-DatabaseCredential <PSCredential>]
[-PassThru]
[-Force]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Set-IpamDatabase cmdlet modifies settings that IP Address Management (IPAM) uses to connect to the IPAM database hosted on a computer that runs Microsoft SQL Server.
Verify that you can reach the database server from the IPAM server. Specify whether to connect to the destination server by using the account for the computer that hosts the IPAM server or by using a SQL Server database account. If you specify the IPAM server account, verify that account has necessary permissions.
Use the Get-IpamDatabase cmdlet to view database configuration settings.
You can specify any port to connect to the database server. We recommend you use the default port, 1433, to connect to Microsoft SQL Serverr.
Examples
Example 1: Connect to an external database
The first command command uses the **Get-IpamDatabase** cmdlet to display the configuration settings of the database.
PS C:\> Get-IpamDatabase
DatabaseType : WID
WidSchemaPath : C:\Windows\System32\IPAM\Database
DatabaseServer :
DatabaseName : IPAM
DatabasePort :
DatabaseAuthType : Windows
DatabaseUser :
The second command sets the database configuration. The command includes the database name and database server name. The cmdlet prompts you before it continues.
PS C:\> Set-IpamDatabase -DatabaseServer "ContosoDB04" -DatabaseName "IpamData01" -DatabasePort 1433 -DatabaseAuthType Windows
Confirm
Updating IPAM database settings to use an MsSql database. If the configuration is successful, IPAM cannot be
reconfigured to use Windows Internal Database. The cmdlet will verify that the database specified is reachable and
compatible with Ipam version. Do you want to continue?
[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y
The last command repeats the first command, displaying the revised configuration information.
PS C:\> Get-IpamDatabase
DatabaseType : MSSQL
WidSchemaPath :
DatabaseServer : ContosoDB04
DatabaseName : IpamData01
DatabasePort : 1433
DatabaseAuthType : Windows
DatabaseUser :
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.
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.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-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.
Parameter properties
| Type: | CimSession[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Session |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-DatabaseAuthType
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.
Parameter properties
| Type: | AuthType |
| Default value: | None |
| Accepted values: | Windows, SQL |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-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.
Parameter properties
| Type: | PSCredential |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-DatabaseName
Specifies the name of a SQL Serverdatabase. The IPAM server connects to this database.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 2 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-DatabasePort
Specifies the port that the IPAM server uses to connect to the database server.
Parameter properties
| Type: | UInt16 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 3 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-DatabaseServer
Specifies the fully qualified domain name (FQDN) or IP address of the database server. The IPAM server connects to this server.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Force
Forces the command to run without asking for user confirmation.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-PassThru
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-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.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Outputs
IpamDatabase
This cmdlet returns an object that represents the datastore for an IPAM server.