Suporte do PowerShell para clusters de gateway de dados local
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, confira Cmdlets do PowerShell para gerenciamento do gateway de dados local. Você pode usar os scripts do PowerShell para executar as seguintes operações:
- Recuperar a lista de clusters de gateway disponíveis para um usuário.
- Recuperar a lista de instâncias de gateway registradas em um cluster, bem como o status online ou offline.
- Modificar o status habilitar/desabilitar de uma instância de gateway em um cluster, bem como outras propriedades do gateway.
- Excluir um gateway.
Executar os comandos do PowerShell
Para instalar esses cmdlets, execute o seguinte comando em uma sessão do PowerShell com privilégios elevados:
Install-Module -Name OnPremisesDataGatewayHAMgmt
A lista inteira de cmdlets pode ser encontrada usando o seguinte comando:
Get-Command -Module OnPremisesDataGateway*
Exemplos e descrições estã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 os clusters do gateway.
| Comando | Descrição | Parâmetros |
|---|---|---|
| Login-OnPremisesDataGateway | Use esse comando para entrar e gerenciar os clusters de gateway de dados local. Você precisa executar este comando e entrar primeiro, para que outros comandos de alta disponibilidade funcionem corretamente. Observação: o token de autenticação do Microsoft Entra ID adquirido como parte de uma chamada login é válido por apenas 1 hora, após a qual ele expira. Você pode executar novamente o comando login para adquirir um novo token. |
Nome de usuário e senha do Microsoft Entra ID (fornecidos como parte da execução do comando, não invocação inicial). |
| Get-OnPremisesDataGatewayClusters | Recupera a lista de clusters do gateway para o usuário conectado. | Ou é possível passar parâmetros de formatação a esse comando para aprimorar a 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 de um determinado gateway dentro de 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 (em que abc é substituído por um valor de ID de objeto de gateway real, que pode ser recuperado usando o comando Get-OnPremisesDataClusterGateways, dada uma ID de objeto de cluster). |
| Get-OnPremisesDataGatewayStatus | Use esse comando para recuperar o status de uma instância de gateway específica 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 (em que abc é substituído por um valor de ID de objeto de gateway real, que pode ser recuperado usando o comando Get-OnPremisesDataClusterGateways, dada uma ID de objeto de cluster). |
| Remove-OnPremisesDataGateway | Use esse 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 (em que abc é substituído por um valor de ID de objeto de gateway real, que pode ser recuperado usando o comando Get-OnPremisesDataClusterGateways, dada uma ID de objeto de cluster). |