Puede definir las configuraciones que la CLI de MongoDB utiliza para interactuar con servicios de MongoDB como Atlas, Cloud Manager y Ops Manager mediante el uso de Comando mongocli auth login o mongocli config. La primera vez que se ejecuta uno de estos comandos, la CLI de MongoDB crea un archivo de configuración llamado config.toml
para almacenar su configuración.
Requisitos previos
Para configurar la CLI de MongoDB:
Añade tu Bloque deIP o CIDR a la lista de acceso API para su servicio MongoDB.
Genere una clave API programática si aún no tiene una.
Nota
Las claves API programáticas se basan en roles. Cada rol tiene distintos privilegios y capacidades, y algunos comandos de la CLI de MongoDB están disponibles para algunos roles, pero no para otros. Asegúrese de que los roles asignados a su clave API programática sean adecuados para los comandos que desea utilizar.
Para obtener más información sobre cómo generar una llave API programática para tu servicio de MongoDB, consulta la siguiente documentación:
Configure la
HTTP_PROXYvariableHTTPS_PROXYde entorno o si su instalación de MongoDB CLI está protegida por un firewall y desea usar una URL de proxy. MongoDB CLI admitehttphttpssocks5los esquemas, y. Además, especifiquecloud.mongodb.com/como la URL de destino principal en la lista de acceso del servicio proxy. También debe especificar el nombre de usuario y la contraseña si la configuración del proxy permite la autenticación.Para obtener más información,consulte Servidor proxy.
Procedimiento
Autenticarse en Atlas.
Ejecute el comando mongocli auth login:
mongocli auth login El comando abre una ventana del navegador y devuelve un código de activación de un solo uso. Este código expira después de 10 minutos.
Si aún no ha iniciado sesión, inicie sesión en su cuenta de Atlas en el navegador.
Pegue su código de activación en el navegador y haga clic Confirm Authorization.
Crea un perfil.
En tu terminal, presiona Enter para crear un perfil llamado default en el archivo de configuración CLI de MongoDB.
Elija su organización predeterminada.
Seleccione su organización
Presione las teclas
Down ArrowyUp Arrowpara resaltar la organización deseada, oEscriba el nombre de la organización para filtrar las organizaciones disponibles.
? Choose a default organization: [Use arrows to move, type to filter] Org1 (5e39bf1212121e685774c81c) Presione
Enter.
Elige tu proyecto predeterminado.
Seleccione su proyecto:
Presione las teclas
Down ArrowyUp Arrowpara resaltar el proyecto deseado, oEscriba el nombre del proyecto para filtrar los proyectos disponibles.
? Choose a default project: [Use arrows to move, type to filter] Project1 (5e5ebffd0c04a97009061234) Project2 (5cfacee6014b761b07f15678) Project3 (5e39bf4979358e6857741212) Project4 (5c815cc7014b768fb67e3434) Presione
Enter.
Elija su formato de salida predeterminado.
Presione las teclas
Down ArrowyUp Arrowpara resaltar el formato de salida predeterminado deseado:? Default Output Format: [Use arrows to move, type to filter] plaintext json OpciónDescripciónplaintextSalida legible por humanos que incluye todos los campos que devuelve MongoDB CLI.
jsonSalida JSON que incluye todos los campos que devuelve la CLI de MongoDB.
Presione
Enter.
Especifique la ruta al Shell MongoDB,, en sumongosh sistema.
La CLI de MongoDB utiliza la mongosh ruta especificada para acceder a sus implementaciones. El valor predeterminado /usr/local/bin/mongosh es. Pulse Enter para aceptar el valor predeterminado o:
Especifique la ruta a en su
mongoshsistema.? Default MongoDB Shell Path: [? for help] (/usr/local/bin/mongosh) Presione
Enter.
Opcional: agregue claves API a su perfil.
Tras una autenticación exitosa, la sesión iniciada en la CLI de MongoDB permanecerá 12 abierta durante horas. Para una cuenta que necesite acceso programático durante más de 12 horas, configure las claves API para el perfil con el comando mongocli config set:
mongocli config set public_api_key abcdef mongocli config set private_api_key a123bc45-ab1c-234d-5678-f91234a5bc6d
Nota
Las claves API programáticas se basan en roles. Cada rol tiene distintos privilegios y capacidades, y algunos comandos de la CLI de MongoDB están disponibles para algunos roles, pero no para otros. Asegúrese de asignar a su clave API programática roles adecuados para los comandos que desea utilizar.
Para obtener más información sobre cómo generar una clave API para Atlas, consulte Clave API programática.
Verifica tu perfil.
Vea el archivo de configuración o ejecute el comando mongocli config describe para verificar su perfil.
Ejemplo
El siguiente comando devuelve la configuración en el perfil predeterminado:
mongocli config describe default
El comando anterior devuelve la siguiente configuración. Por motivos de seguridad, el comando oculta las claves API en la salida.
SETTING VALUE mongosh_path /usr/local/bin/mongosh org_id 5f1f39ffc902201990f12345 private_api_key redacted project_id 7ehf04abc10defb66c7d1234c public_api_key redacted service cloud
Ejemplo
El siguiente comando devuelve la configuración en el perfil llamado myMongoDB:
mongocli config describe myMongoDB
El comando devuelve la siguiente configuración. Por seguridad, el comando oculta las claves API en la salida.
SETTING VALUE org_id 5f1f39ffc902201990f12345 private_api_key redacted project_id 7ehf04abc10defb66c7d1234c public_api_key redacted service cloud
Autenticarse en MongoDB Cloud Manager.
Ejecute el comando mongocli auth login:
mongocli auth login --cm El comando abre una ventana del navegador y devuelve un código de activación de un solo uso. Este código expira después de 10 minutos.
Si aún no ha iniciado sesión, inicie sesión en su cuenta de MongoDB Cloud Manager en el navegador.
Pegue su código de activación en el navegador y haga clic en Confirm Authorization.
Crea un perfil.
En su terminal, presione Enter para crear un perfil llamado default en el archivo de configuración CLI de MongoDB.
Elija su organización predeterminada.
Seleccione su organización
Presione las teclas
Down ArrowyUp Arrowpara resaltar la organización deseada, oEscriba el nombre de la organización para filtrar las organizaciones disponibles.
? Choose a default organization: [Use arrows to move, type to filter] Org1 (5e39bf1212121e685774c81c) Presione
Enter.
Elige tu proyecto predeterminado.
Seleccione su proyecto:
Presione las teclas
Down ArrowyUp Arrowpara resaltar el proyecto deseado, oEscriba el nombre del proyecto para filtrar los proyectos disponibles.
? Choose a default project: [Use arrows to move, type to filter] Project1 (5e5ebffd0c04a97009061234) Project2 (5cfacee6014b761b07f15678) Project3 (5e39bf4979358e6857741212) Project4 (5c815cc7014b768fb67e3434) Presione
Enter.
Elija su formato de salida predeterminado.
Presione las teclas
Down ArrowyUp Arrowpara resaltar el formato de salida predeterminado deseado:? Default Output Format: [Use arrows to move, type to filter] plaintext json OpciónDescripciónplaintextSalida legible por humanos que incluye todos los campos que devuelve MongoDB CLI.
jsonSalida JSON que incluye todos los campos que devuelve la CLI de MongoDB.
Presione
Enter.
Especifique la ruta al Shell MongoDB,, en sumongosh sistema.
La CLI de MongoDB utiliza la mongosh ruta especificada para acceder a sus implementaciones. El valor predeterminado /usr/local/bin/mongosh es. Pulse Enter para aceptar el valor predeterminado o:
Especifique la ruta a en su
mongoshsistema.? Default MongoDB Shell Path: [? for help] (/usr/local/bin/mongosh) Presione
Enter.
Opcional: agregue claves API a su perfil.
Tras una autenticación exitosa, la sesión iniciada en la CLI de MongoDB permanecerá 12 abierta durante horas. Para una cuenta que necesite acceso programático durante más de 12 horas, configure las claves API para el perfil con el comando mongocli config set:
mongocli config set public_api_key abcdef mongocli config set private_api_key a123bc45-ab1c-234d-5678-f91234a5bc6d
Nota
Las claves API programáticas se basan en roles. Cada rol tiene distintos privilegios y capacidades, y algunos comandos de la CLI de MongoDB están disponibles para algunos roles, pero no para otros. Asegúrese de asignar a su clave API programática roles adecuados para los comandos que desea utilizar.
Para obtener más información sobre cómo generar una clave de API para MongoDB Cloud Manager, consulta Claves de API.
Verifica tu perfil.
Vea el archivo de configuración o ejecute el comando mongocli config describe para verificar su perfil.
Ejemplo
El siguiente comando devuelve la configuración en el perfil predeterminado:
mongocli config describe default
El comando anterior devuelve la siguiente configuración. Por motivos de seguridad, el comando oculta las claves API en la salida.
SETTING VALUE mongosh_path /usr/local/bin/mongosh org_id 5f1f39ffc902201990f12345 private_api_key redacted project_id 7ehf04abc10defb66c7d1234c public_api_key redacted service cloud-manager
Ejemplo
El siguiente comando devuelve la configuración en el perfil llamado myMongoDB:
mongocli config describe myMongoDB
El comando devuelve la siguiente configuración. Por seguridad, el comando oculta las claves API en la salida.
SETTING VALUE org_id 5f1f39ffc902201990f12345 private_api_key redacted project_id 7ehf04abc10defb66c7d1234c public_api_key redacted service cloud-manager
Completar los prerrequisitos.
Antes de configurar la CLI de MongoDB:
Agregue su bloque IP o CIDR a la lista de acceso API para Ops Manager.
Genere una clave API programática si aún no tiene una.
Nota
Las claves API programáticas se basan en roles. Cada rol tiene distintos privilegios y capacidades, y algunos comandos de la CLI de MongoDB están disponibles para algunos roles, pero no para otros. Asegúrese de asignar a su clave API programática roles adecuados para los comandos que desea utilizar.
Para obtener más información sobre cómo generar una clave API programática para Ops Manager, consulte Acceso a la API de Ops Manager.
Crea un perfil.
Este comando crea un perfil llamado default en el archivo de configuración CLI de MongoDB.
Ejecute el comando de configuración de mongocli:
mongocli config --service ops-manager
Este comando crea un perfil con un nombre personalizado en el archivo de configuración de la CLI de MongoDB. Para usar este perfil en un comando, debe especificarlo con el --profile indicador.
Ejecute el comando de configuración de mongocli:
mongocli config --service ops-manager --profile <profile-name>
Introduzca la URL que utiliza para acceder a Ops Manager.
? URL to Access Ops Manager: http://mms.example.com:8080/
Opcional: Ingrese sus claves API.
Cuando se le solicite, ingrese Public API Key y Private API Key para su implementación de Ops Manager.
? Public API Key: [? for help] abcdef ? Private API Key: [? for help] ************************************
Elija su organización predeterminada.
Si ingresó claves API, el comando muestra el nombre y el ID de las organizaciones a las que su clave API puede acceder.
Seleccione su organización
Presione las teclas
Down ArrowyUp Arrowpara resaltar la organización deseada, oEscriba el nombre de la organización para filtrar las organizaciones disponibles.
? Choose a default organization: [Use arrows to move, type to filter] Org1 (5e39bf1212121e685774c81c) Presione
Enter.
Si no ingresó claves API, el comando le solicitará que ingrese Default Organization ID su.
Elige tu proyecto predeterminado.
Si ingresó claves API, el comando muestra el nombre y el ID de los proyectos a los que su clave API puede acceder.
Seleccione su proyecto:
Presione las teclas
Down ArrowyUp Arrowpara resaltar el proyecto deseado, oEscriba el nombre del proyecto para filtrar los proyectos disponibles.
? Default Project ID: [Use arrows to move, type to filter] Project1 (5e5ebffd0c04a97009061234) Project2 (5cfacee6014b761b07f15678) Project3 (5e39bf4979358e6857741212) Project4 (5c815cc7014b768fb67e3434) Presione
Enter.
Si no ingresó claves API, el comando le solicitará que ingrese Default Project ID su.
Elija su formato de salida predeterminado.
Presione las teclas
Down ArrowyUp Arrowpara resaltar el formato de salida predeterminado deseado:? Default Output Format: [Use arrows to move, type to filter] plaintext json OpciónDescripciónplaintextSalida legible por humanos que incluye todos los campos que devuelve MongoDB CLI.
jsonSalida JSON que incluye todos los campos que devuelve la CLI de MongoDB.
Presione
Enter.
Especifique la ruta al Shell MongoDB,, en sumongosh sistema.
La CLI de MongoDB utiliza la mongosh ruta especificada para acceder a sus implementaciones. El valor predeterminado /usr/local/bin/mongosh es. Pulse Enter para aceptar el valor predeterminado o:
Especifique la ruta a en su
mongoshsistema.? Default MongoDB Shell Path: [? for help] (/usr/local/bin/mongosh) Presione
Enter.
Verifica tu perfil.
Vea el archivo de configuración o ejecute el comando mongocli config describe para verificar su perfil.
Ejemplo
El siguiente comando devuelve la configuración en el perfil predeterminado:
mongocli config describe default
El comando anterior devuelve la siguiente configuración. Por motivos de seguridad, el comando oculta las claves API en la salida.
SETTING VALUE mongosh_path /usr/local/bin/mongosh ops_manager_url = https://mms.example.com:8080/ org_id 5f1f39ffc902201990f12345 private_api_key redacted project_id 7ehf04abc10defb66c7d1234c public_api_key redacted service ops-manager
Ejemplo
El siguiente comando devuelve la configuración en el perfil llamado myMongoDB:
mongocli config describe myMongoDB
El comando devuelve la siguiente configuración. Por seguridad, el comando oculta las claves API en la salida.
SETTING VALUE ops_manager_url = https://mms.example.com:8080/ org_id 5f1f39ffc902201990f12345 private_api_key redacted project_id 7ehf04abc10defb66c7d1234c public_api_key redacted service ops-manager
Próximos pasos
Edite su archivo de configuración para agregar o modificar perfiles.
Establezca variables de entorno para permitir una creación de scripts más sencilla.
Active el autocompletado para ver los comandos disponibles y su sintaxis directamente en su shell.