PowerShell スクリプトは、 PowerShell ギャラリーで使用できます。 この記事で説明するスクリプトは、PowerShell バージョン 5 用です。 PowerShell バージョン 7 を使用する場合は、 オンプレミスのデータ ゲートウェイ管理に関する PowerShell コマンドレットを参照してください。 PowerShell スクリプトを使用して、次の操作を実行できます。
- ユーザーが使用できるゲートウェイ クラスターの一覧を取得します。
- クラスターに登録されているゲートウェイ インスタンスの一覧と、そのオンラインまたはオフラインの状態を取得します。
- クラスター内のゲートウェイ インスタンスとその他のゲートウェイ プロパティの有効化または無効化の状態を変更します。
- ゲートウェイの削除。
PowerShell コマンドを実行する
これらのコマンドレットをインストールするには、管理者特権の PowerShell セッションで次のコマンドを実行します。
Install-Module -Name OnPremisesDataGatewayHAMgmt
コマンドレットの一覧全体は、次のコマンドを使用して確認できます。
Get-Command -Module OnPremisesDataGateway*
コマンドレットには例と説明が含まれており、次のコマンドを使用してアクセスできます。
get-help <cmdlet-name>
次の表のコマンドを使用して、ゲートウェイ クラスターを管理できるようになりました。
| 命令 | 説明 | パラメーター |
|---|---|---|
| ログイン-オンプレミスデータゲートウェイ | このコマンドを使用してサインインし、オンプレミスのデータ ゲートウェイ クラスターを管理します。 他の高可用性コマンドが正常 に 動作するには、このコマンドを実行してサインインする必要があります。 注: login 呼び出しの一部として取得された Microsoft Entra ID 認証トークンは、有効期限が切れた後、1 時間だけ有効です。
login コマンドを再実行して、新しいトークンを取得できます。 |
Microsoft Entra ID のユーザー名とパスワード (最初の呼び出しではなく、コマンド実行の一部として提供されます)。 |
| Get-OnPremisesDataGatewayClusters（オンプレミスデータゲートウェイクラスターを取得） | サインインしているユーザーのゲートウェイ クラスターの一覧を取得します。 | 必要に応じて、Format-Table -AutoSize -Wrap など、読みやすくするために、このコマンドに書式設定パラメーターを渡すことができます。 |
| Get-OnPremisesDataClusterGateways | 指定したクラスター内のゲートウェイの一覧と、オンラインまたはオフラインの状態やマシン名などの各ゲートウェイの追加情報を取得します。 | -ClusterObjectID xyz ( xyz は実際のクラスター オブジェクト ID 値に置き換えられ、 Get-OnPremisesDataGatewayClusters コマンドを使用して取得できます)。 |
| Set-OnPremisesDataGateway | このコマンドを使用して、クラスター内の特定のゲートウェイのプロパティ値を設定します。これには、特定のゲートウェイ インスタンスを有効または無効にする機能が含まれます。 |
-ClusterObjectID xyz ( xyz は実際のクラスター オブジェクト ID 値に置き換えられ、 Get-OnPremisesDataGatewayClusters コマンドを使用して取得できます)。 -GatewayObjectID abc ( abc は実際のゲートウェイ オブジェクト ID 値に置き換えられます。これは、クラスター オブジェクト ID を指定して Get-OnPremisesDataClusterGateways コマンドを使用して取得できます)。 |
| Get-OnPremisesDataGatewayStatus オンプレミスデータゲートウェイのステータス取得 | このコマンドを使用して、クラスター内の特定のゲートウェイ インスタンスの状態を取得します。 |
-ClusterObjectID xyz ( xyz は実際のクラスター オブジェクト ID 値に置き換えられ、 Get-OnPremisesDataGatewayClusters コマンドを使用して取得できます)。 -GatewayObjectID abc ( abc は実際のゲートウェイ オブジェクト ID 値に置き換えられます。これは、クラスター オブジェクト ID を指定して Get-OnPremisesDataClusterGateways コマンドを使用して取得できます)。 |
| Remove-OnPremisesDataGateway（オンプレミスデータゲートウェイの削除） | このコマンドを使用して、クラスターからゲートウェイ インスタンスを削除します。 注: クラスター内の他のすべてのゲートウェイが削除されるまで、クラスター内のプライマリ ゲートウェイを削除することはできません。 |
-ClusterObjectID xyz ( xyz は実際のクラスター オブジェクト ID 値に置き換えられ、 Get-OnPremisesDataGatewayClusters コマンドを使用して取得できます)。 -GatewayObjectID abc ( abc は実際のゲートウェイ オブジェクト ID 値に置き換えられます。これは、クラスター オブジェクト ID を指定して Get-OnPremisesDataClusterGateways コマンドを使用して取得できます)。 |