- Esta versión de la documentación está archivada y ya no se admite. Ver la Documentación actual para aprender cómo actualizar su versión de Atlas CLI.
Registra, autentica, crea y accede a un clúster Atlas.
Vista previa pública: El subcomando atlas api, generado automáticamente desde la API de administración de MongoDB Atlas, ofrece cobertura completa de la API de administración y se encuentra actualmente en vista previa pública (envíe sus comentarios en https://feedback.mongodb.com/forums/930808-atlas-cli). Las capacidades de la API de administración tienen su propio ciclo de vida de lanzamiento, que puede consultar a través del enlace de documentación del punto final de la API.
Este comando lo guía a través del registro, inicio de sesión, creación de perfil predeterminado, creación de su primer clúster de nivel gratuito y conexión a él mediante MongoDB Shell.
Sintaxis
atlas setup [options]
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
--accessListIp | cadenas | false | Dirección IP para otorgar acceso a la implementación. Mutuamente excluyente con --currentIp. |
--clusterName | string | false | Nombre del clúster. Para obtener más información, consulte https://dochub.mongodb.org/core/create-cluster-api. |
--connectWith | string | false | Método de conexión al clúster. Los valores válidos son compass, mongosh, vscode y skip. Mutuamente excluyente con --skipMongosh. |
--currentIp | false | Bandera que agrega la dirección IP del host que actualmente está ejecutando el comando a la lista de acceso. Mutuamente excluyente con --accessListIp. | |
--enableTerminationProtection | false | Habilita la protección contra la terminación del clúster. No se puede eliminar un clúster con esta protección habilitada. | |
--force | false | Bandera que indica si se debe omitir la solicitud de entrada y crear un clúster con la configuración predeterminada para cualquier opción no especificada. | |
--gov | false | Regístrese en Atlas para el Gobierno. | |
-h, --ayuda | false | ayuda para configurar | |
--mdbVersion | string | false | Versión principal de MongoDB de la implementación. |
--noBrowser | false | No intente abrir una sesión del navegador. | |
--password | string | false | Contraseña para el usuario. |
--projectId | string | false | Cadena hexadecimal que identifica el proyecto que se utilizará. Esta opción anula la configuración del archivo de configuración o la variable de entorno. |
--provider | string | false | Nombre de su proveedor de servicios en la nube. Los valores válidos son AWS, AZURE o GCP. |
-r, --region | string | false | Ubicación física de su clúster de MongoDB. Para obtener una lista completa de las regiones de AWS compatibles, consulte: https://dochub.mongodb.org/core/aws-atlas. Paraobtener una lista completa delas regiones de Azure compatibles, consulte: https://dochub.mongodb.org/core/azure-atlas. Para obtener una lista completa de las regiones de GCP compatibles, consulte: https://dochub.mongodb.org/core/gcp-atlas. |
--skipSampleData | false | Bandera que indica si se debe omitir la carga de datos de muestra en su clúster MongoDB. | |
--tag | clave=valor | false | Lista que contiene pares clave-valor de entre 1 y 255 caracteres de longitud para etiquetar y categorizar el clúster. |
--tier | string | false | Nivel de cada servidor de datos del clúster. Para obtener más información sobre los niveles del clúster, consulte https://dochub.mongodb.org/core/cluster-tier-atlas. El valor predeterminado es "M0". |
--username | string | false | Nombre de usuario para autenticarse en MongoDB. |
Opciones heredadas
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
-P, --profile | string | false | Nombre del perfil que se usará en el archivo de configuración. Para obtener más información sobre los perfiles de la CLI de Atlas, consulte https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Ejemplos
# Override default cluster settings like name, provider, or database username by using the command options atlas setup --clusterName Test --provider GCP --username dbuserTest