Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Set-IpamDatabase

Set-IpamDatabase

ipamdatabase.cdxml

Synopsis

Modifies settings that IPAM uses to connect to the IPAM database.

Syntax

Set-IpamDatabase [-DatabaseServer] [-DatabaseName] [-DatabasePort] [-AsJob] [-CimSession] [-DatabaseCredential] [-Force] [-PassThru] [-ThrottleLimit] [-DatabaseAuthType] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed 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 Server.

Parameters

-AsJob <SwitchParameter>

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.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-CimSession <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.

Aliases

Session

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-DatabaseAuthType <AuthType>

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.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-DatabaseCredential <PSCredential>

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 for the DatabaseAuthType parameter.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-DatabaseName <String>

Specifies the name of a SQL Server database. The IPAM server connects to this database.

Aliases

None

Required?

true

Position

3

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-DatabasePort <UInt16>

Specifies the port that the IPAM server uses to connect to the database server.

Aliases

None

Required?

true

Position

4

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-DatabaseServer <String>

Specifies the fully qualified domain name (FQDN) or IP address of the database server. The IPAM server connects to this server.

Aliases

None

Required?

true

Position

2

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Force <SwitchParameter>

Forces the command to run without asking for user confirmation.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-PassThru <SwitchParameter>

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-ThrottleLimit <Int32>

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.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Confirm <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type


Return Type

IpamDatabase

Notes

None

Examples

Example 1: Connect to an external database

This example configures the IPAM server to connect to an external database. The cmdlet does not move any data from the existing 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.

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     : 

Online Version
Get-IpamDatabase
Move-IpamDatabase