Inicia um teste de failover para o cluster especificado no projeto especificado.
Visualização pública: o subcomando da API atlas, gerado automaticamente a partir da API de administração do MongoDB Atlas, oferece cobertura completa da API de administração e está atualmente em visualização pública (forneça feedback em https://feedback.mongodb.com/fóruns/930808-atlas-cli). Os recursos da API de administração têm seu próprio ciclo de vida de versão, que você pode verificar por meio do link de documentação do endpoint da API fornecido.
Os clusters contêm um grupo de hosts que mantêm o mesmo conjunto de dados. Um teste de failover verifica como o MongoDB Cloud administra a falha do nó primário do cluster. Durante o teste, o MongoDB Cloud desliga o nó primário e elege um novo primário.
Sintaxe
atlas clusters failover <clusterName> [options]
argumentos
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
clusterName | string | true | Etiqueta legível para humanos que identifica o cluster para iniciar um teste de failover. |
Opções
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
--force | false | Sinalizador que indica se o prompt de confirmação deve ser ignorado antes de prosseguir com a ação solicitada. | |
-h, --help | false | ajuda para failover | |
--projectId | string | false | String hexadecimal que identifica o projeto a ser usado. Esta opção substitui as configurações no arquivo de configuração ou variável de ambiente. |
Opções herdadas
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
-P, --profile | string | false | Nome do perfil a ser usado no arquivo de configuração. Para saber mais sobre perfis para o Atlas CLI, consulte https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Saída
Se o comando for bem-sucedido, a CLI retornará uma saída semelhante à amostra a seguir. Os valores entre colchetes representam seus valores.
Failover test for '<Name>' started
Exemplos
# Test failover for a cluster named myCluster: atlas clusters failover myCluster