Compartilhar via


Suporte do PowerShell para clusters de gateway de dados locais

Os scripts do PowerShell estão disponíveis na galeria do PowerShell. Os scripts descritos neste artigo são para o PowerShell versão 5. Ao usar o PowerShell versão 7, consulte cmdlets do PowerShell para gerenciamento de gateway de dados local. Você pode usar os scripts do PowerShell para executar as seguintes operações:

  • Recupere a lista de clusters de gateway disponíveis para um usuário.
  • Recupere a lista de instâncias de gateway registradas em um cluster e seu status online ou offline.
  • Modifique o status de ativação ou desativação de uma instância de gateway em um cluster e outras propriedades do gateway.
  • Excluir um gateway.

Executar os comandos do PowerShell

Para instalar esses cmdlets, execute o seguinte comando em uma sessão elevada do PowerShell:

Install-Module -Name OnPremisesDataGatewayHAMgmt

Toda a lista de cmdlets pode ser encontrada usando o seguinte comando:

Get-Command -Module OnPremisesDataGateway*

Exemplos e descrições são incluídos nos cmdlets e você pode acessá-los usando o seguinte comando:

get-help <cmdlet-name>

Agora você pode usar os comandos na tabela a seguir para gerenciar seus clusters de gateway.

Comando Descrição Parâmetros
Login-OnPremisesDataGateway Use este comando para fazer login e gerenciar seus clusters de gateway de dados no local. Você deve executar esse comando e entrar antes que outros comandos de alta disponibilidade possam funcionar corretamente. Observação: o token de autenticação da ID do Microsoft Entra adquirido como parte de uma login chamada é válido por apenas 1 hora, após a qual expira. Você pode executar novamente o login comando para adquirir um novo token. Nome de usuário e senha da ID do Microsoft Entra (fornecidos como parte da execução do comando, não invocação inicial).
Get-OnPremisesDataGatewayClusters Recupera a lista de clusters de gateway para o usuário conectado. Opcionalmente, você pode passar parâmetros de formatação para esse comando para obter melhor legibilidade, como Format-Table -AutoSize -Wrap.
Get-OnPremisesDataClusterGateways Recupera a lista de gateways dentro do cluster especificado e informações adicionais para cada gateway, como status online ou offline e nome do computador. -ClusterObjectID xyz (em que xyz é substituído por um valor de ID de objeto de cluster real, que pode ser recuperado usando o comando Get-OnPremisesDataGatewayClusters ).
Set-OnPremisesDataGateway Use esse comando para definir valores de propriedade para um determinado gateway em um cluster, o que inclui a capacidade de habilitar ou desabilitar uma instância de gateway específica. -ClusterObjectID xyz (em que xyz é substituído por um valor de ID de objeto de cluster real, que pode ser recuperado usando o comando Get-OnPremisesDataGatewayClusters ).

-GatewayObjectID abc (onde abc é substituído por um valor real de ID de objeto de gateway, que pode ser recuperado usando o comando Get-OnPremisesDataClusterGateways , dada uma ID de objeto de cluster).
Get-OnPremisesDataGatewayStatus Use este comando para recuperar o status de uma determinada instância de gateway em um cluster. -ClusterObjectID xyz (em que xyz é substituído por um valor de ID de objeto de cluster real, que pode ser recuperado usando o comando Get-OnPremisesDataGatewayClusters ).

-GatewayObjectID abc (onde abc é substituído por um valor real de ID de objeto de gateway, que pode ser recuperado usando o comando Get-OnPremisesDataClusterGateways , dada uma ID de objeto de cluster).
Remove-OnPremisesDataGateway Use este comando para remover uma instância de gateway de um cluster. Observação: o gateway primário no cluster não pode ser removido até que todos os outros gateways no cluster sejam removidos. -ClusterObjectID xyz (em que xyz é substituído por um valor de ID de objeto de cluster real, que pode ser recuperado usando o comando Get-OnPremisesDataGatewayClusters ).

-GatewayObjectID abc (onde abc é substituído por um valor real de ID de objeto de gateway, que pode ser recuperado usando o comando Get-OnPremisesDataClusterGateways , dada uma ID de objeto de cluster).