オンプレミス データ ゲートウェイ クラスターの PowerShell サポート

  • [アーティクル]

PowerShell スクリプトは、PowerShell ギャラリーで使用できます。 この記事で説明するスクリプトは、PowerShell バージョン 5 用です。 PowerShell バージョン 7 を使用する場合は、「オンプレミス データ ゲートウェイ管理の PowerShell コマンドレット」を参照してください。 PowerShell スクリプトを使用すると、以下の操作を実行できます。

  • ユーザーが使用できるゲートウェイ クラスターのリストを取得する。
  • クラスターで登録されているゲートウェイ インスタンスのリストと、状態 (オンラインまたはオフライン) を取得する。
  • クラスター内のゲートウェイ インスタンスの有効または無効の状態と、他のゲートウェイ プロパティを変更する。
  • ゲートウェイの削除。

PowerShell コマンドを実行する

これらのコマンドレットをインストールするには、管理者特権の PowerShell セッションで次のコマンドを実行します。

Install-Module -Name OnPremisesDataGatewayHAMgmt

コマンドレットのリスト全体は、次のコマンドを使用して見つけることができます。

Get-Command -Module OnPremisesDataGateway*

例と説明はコマンドレットに含まれており、次のコマンドを使用するとアクセスできます。

get-help <cmdlet-name>

これで、次の表のコマンドを使用してゲートウェイ クラスターを管理できます。

コマンド 説明 パラメーター
Login-OnPremisesDataGateway このコマンドを使用してサインインし、オンプレミス データ ゲートウェイ クラスターを管理します。 他の高可用性コマンドが正しく機能する "前" に、このコマンドを実行してサインインする必要があります。 注: 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 である Get-OnPremisesDataClusterGateways コマンドを使用して取得できる実際のゲートウェイ オブジェクト ID 値に置き換えられます)。
Get-OnPremisesDataGatewayStatus このコマンドを使用して、クラスター内の指定されたゲートウェイ インスタンスの状態を取得できます。 -ClusterObjectID xyz (この xyz は実際のクラスター オブジェクト ID の値に置き換えます。これは、Get-OnPremisesDataGatewayClusters コマンドを使用して取得できます) -GatewayObjectID abc (この abc は、指定されたクラスター オブジェクト ID である Get-OnPremisesDataClusterGateways コマンドを使用して取得できる実際のゲートウェイ オブジェクト ID 値に置き換えられます)。
Remove-OnPremisesDataGateway このコマンドを使用して、クラスターからゲートウェイ インスタンスを削除します。 注: クラスター内のプライマリ ゲートウェイは、クラスター内の他のすべてのゲートウェイが削除されるまで削除できません。 -ClusterObjectID xyz (この xyz は実際のクラスター オブジェクト ID の値に置き換えます。これは、Get-OnPremisesDataGatewayClusters コマンドを使用して取得できます) -GatewayObjectID abc (この abc は、指定されたクラスター オブジェクト ID である Get-OnPremisesDataClusterGateways コマンドを使用して取得できる実際のゲートウェイ オブジェクト ID 値に置き換えられます)。

次のステップ