PowerShell 对本地数据网关群集的支持

PowerShell 脚本在PowerShell 画廊中提供。 本文中所述的脚本适用于 PowerShell 版本 5。 使用 PowerShell 版本 7 时,请参阅 PowerShell Cmdlet 进行本地数据网关管理。 可以使用 PowerShell 脚本执行以下作:

  • 检索用户可用的网关群集列表。
  • 检索在群集中注册的网关实例的列表及其联机或脱机状态。
  • 修改群集和其他网关属性中网关实例的启用或禁用状态。
  • 删除网关。

运行 PowerShell 命令

若要安装这些 cmdlet,请在提升的 PowerShell 会话中运行以下命令:

Install-Module -Name OnPremisesDataGatewayHAMgmt

可以使用以下命令找到 cmdlet 的完整列表:

Get-Command -Module OnPremisesDataGateway*

cmdlet 中包含示例和说明,可以使用以下命令访问它们:

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)检索该值。
移除-本地数据网关 使用此命令从群集中删除网关实例。 注意:在删除群集中的所有其他网关之前,无法删除群集中的主网关。 -ClusterObjectID xyz (其中 xyz 替换为实际的群集对象 ID 值,可以使用 Get-OnPremisesDataGatewayClusters 命令检索该值)。

-GatewayObjectID abc (其中 abc 替换为实际的网关对象 ID 值,可以使用 Get-OnPremisesDataClusterGateways 命令(给定群集对象 ID)检索该值。