/ /

Variables de entorno de la CLI de Atlas

Para facilitar la creación de scripts, puede especificar opciones de configuración mediante variables de entorno.

Precedence

Cuando ejecuta cualquier comando, cada configuración que especifique con una variable de entorno tendrá prioridad sobre la perfil almacenado en el archivo de configuración.
Cuando ejecuta un comando utilizando el --projectId opción, la opción de la línea de comando tiene prioridad sobre la variable de entorno y el perfil almacenado en el archivo de configuración.

Variables de entorno admitidas

Importante

Atlas CLI admite tanto las variables de entorno de MongoDB CLI como las de Atlas CLI. Puede usar variables de entorno de MongoDB CLI o de Atlas CLI, pero no ambas juntas.

La CLI de Atlas admite las siguientes variables de entorno:

Variable

Descripción

DO_NOT_TRACK

Marca que indica si la telemetría está deshabilitada para la CLI de Atlas. Establézcala en 1 para deshabilitarla.

También puedes habilitar o deshabilitar la telemetría con MONGODB_ATLAS_TELEMETRY_ENABLED, pero no es necesario especificar ambas.

MONGODB_ATLAS_CLIENT_ID

Establece el ID de cliente de la cuenta de servicio para los comandos que interactúan con Atlas.

MONGODB_ATLAS_CLIENT_SECRET

Establece el secreto del cliente de la cuenta de servicio para los comandos que interactúan con Atlas.

MONGODB_ATLAS_SILENCE_STORAGE_WARNING

Cuando se configura en true, la CLI de Atlas no le advierte si el almacenamiento seguro no está disponible.

MONGODB_ATLAS_PUBLIC_API_KEY

Establece el público Clave API para comandos que interactúan con Atlas.

MONGODB_ATLAS_PRIVATE_API_KEY

Establece la clave API privada para los comandos que interactúan con Atlas.

MONGODB_ATLAS_ORG_ID

Establece el ID de la organización para los comandos que requieren la opción --orgId.

MONGODB_ATLAS_PROJECT_ID

Establece el ID del proyecto para los comandos que requieren la opción --projectId.

MONGODB_ATLAS_OUTPUT

Establece los campos de salida y el formato. Los valores válidos son:

Valor	Formato de salida
Empty default	Salida legible por humanos que incluye todos los campos que devuelve la CLI de Atlas.
`json`	Salida JSON que incluye todos los campos que devuelve la CLI de Atlas.
`json-path`	Salida JSON que incluye los campos que usted especifique.
`go-template`	Salida con formato personalizado que incluye los campos que especifique en una plantilla Go.

MONGODB_ATLAS_MONGOSH_PATH

La ruta completa en su sistema local al Shell MongoDB, mongosh.

MONGODB_ATLAS_SKIP_UPDATE_CHECK

Cuando se establece en yes, la CLI de Atlas no le solicita que actualice a nuevas versiones.

MONGODB_ATLAS_ACCESS_TOKEN

Cadena que otorga acceso a su cuenta de Atlas. El token de acceso es válido durante 12 horas.

MONGODB_ATLAS_REFRESH_TOKEN

Cadena que permite a Atlas solicitar automáticamente un nuevo token de acceso cuando expira el token de acceso actual.

MONGODB_ATLAS_TELEMETRY_ENABLED

Marca que indica si la telemetría está habilitada para la CLI de Atlas. Establézcala en false para deshabilitarla.

También puedes habilitar o deshabilitar la telemetría con DO_NOT_TRACK, pero no es necesario especificar ambas.

MONGODB_ATLAS_LOCAL_DEPLOYMENT_IMAGE

Cadena que especifica el registro de contenedor con el espacio de nombres y el nombre del repositorio que contiene la imagen que se utilizará para las implementaciones locales.

HTTP_PROXY

La URL absoluta o el nombre de host y el puerto en el hostname[:port] formato.

Los siguientes ejemplos muestran cómo configurar la variable de entorno en diferentes situaciones:

Si su configuración de proxy no requiere autenticación:
```
HTTP_PROXY=<my.proxy.address>
```
Si su configuración de proxy requiere autenticación:
```
HTTP_PROXY=<username>:<password>@<my.proxy.address>
```
Si el esquema es socks5:
```
HTTP_PROXY=socks5://<my.proxy.address>
```

HTTPS_PROXY

La URL absoluta. Si HTTP_PROXY también se establece, esta tiene prioridad sobre HTTP_PROXY en todas las solicitudes.

El siguiente ejemplo muestra cómo configurar la variable de entorno:

HTTPS_PROXY=https://<my.proxy.address>

NO_PROXY

Indica que no hay ningún proxy para la URL porque el proxy no está configurado para la URL.

Volver

Automatizar

Personalizar salida