Set-IpamDatabase

Set-IpamDatabase

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

構文

Parameter Set: SetDatabaseConfig0
Set-IpamDatabase [-DatabaseServer] <String> [-DatabaseName] <String> [-DatabasePort] <UInt16> -DatabaseAuthType <AuthType> [-AsJob] [-CimSession <CimSession[]> ] [-DatabaseCredential <PSCredential> ] [-Force] [-PassThru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

詳細説明

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.

パラメーター

-AsJob

-CimSession<CimSession[]>

リモート セッションまたはリモート コンピューターでコマンドレットを実行します。New-CimSession コマンドレットや Get-CimSession コマンドレットの出力など、コンピューター名またはセッション オブジェクトを入力します。既定値は、ローカル コンピューターで実行中の現在のセッションです。

-DatabaseAuthType<AuthType>

Specifies which type of authentication to use to connect to the computer that runs SQL Server. このパラメーターに対して使用できる値:

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

-DatabaseName<String>

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

-DatabasePort<UInt16>

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

-DatabaseServer<String>

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

-Force

ユーザーの確認を求めずにコマンドを強制的に実行します。

-PassThru

作業中の項目を表すオブジェクトを返します。既定では、このコマンドレットによる出力はありません。

-ThrottleLimit<Int32>

このコマンドレットを実行するために確立できる最大同時操作数を指定します。このパラメーターを省略するか、値として 0 を入力した場合、Windows PowerShell® では、コンピューターで実行している CIM コマンドレットの数に基づいて、コマンドレットに対する最適なスロットル制限を計算します。スロットル制限は現在のコマンドレットのみに適用され、セッションまたはコンピューターには適用されません。

-Confirm

コマンドレットを実行する前に、ユーザーに確認を求めます。

-WhatIf

コマンドレットを実行するとどのような結果になるかを表示します。コマンドレットは実行されません。

<CommonParameters>

このコマンドレットは次の共通パラメーターをサポートします。-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、-OutVariable.詳細については、以下を参照してください。 about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216)。

入力

入力型は、コマンドレットにパイプできるオブジェクトの型です。

出力

出力型は、コマンドレットによって生成されるオブジェクトの型です。

• IpamDatabase

  Represents the datastore for an IPAM server.

例

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

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

The last command repeats the first command, displaying the revised configuration information.

PS C:\> Get-IpamDatabase

関連トピック

Get-IpamDatabase

Move-IpamDatabase