本地数据网关群集的 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>
现在,你可以使用下表中的命令来管理网关群集。
命令 | 描述 | Parameters |
---|---|---|
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 给定)。 |