Nota

Este complemento es parte del colección community.mongodb (versión 1.2.0).

Para instalarlo use: ansible-galaxy collection install community.mongodb.

Para usarlo en un libro de jugadas, especifique: community.mongodb.mongodb_shell.

  • Sinopsis
  • Requisitos
  • Parámetros
  • Ejemplos de
  • Valores devueltos

Sinopsis

  • Ejecute comandos a través del shell MongoDB.
  • Comandos proporcionados con el parámetro eval o incluidos en un archivo Javascript.
  • Intenta analizar los datos devueltos en un formato que pueda usar Ansible.

Requisitos

Los siguientes requisitos son necesarios en el host que ejecuta este módulo.

  • mongo

Parámetros

Parámetro Opciones / Valores predeterminados Comentarios
additional_argscrudo Argumentos adicionales para suministrar al comando mongo. keypares de valores. Si el parámetro es una bandera sin valor, proporcione un string como el valor.
dbstring Defecto:
“prueba”		 La base de datos para ejecutar comandos contra
depurarbooleano
    Opciones:

  • no ←
  • sí
 muestra información adicional de depuración.
evalstring Un comando de MongoDB para ejecutar.
expedientestring Ruta a un archivo que contiene comandos de MongoDB.
idempotentebooleano
    Opciones:

  • no ←
  • sí
 Proporciona una forma de pseudo-idempotencia al módulo. Realizamos un cálculo hash sobre el contenido de la evaluación. key o el nombre de archivo proporcionado en el archivo key.Cuando el comando se ejecuta por primera vez un archivo llamado Se creará .success El módulo no volverá a ejecutar el comando si este archivo existe e idempotent está configurado en true.
login_databasestring Defecto:
“administración”		 La base de datos donde se almacenan las credenciales de inicio de sesión.
login_hoststring Defecto:
“localhost”		 El host que ejecuta la instancia de MongoDB para iniciar sesión.
contraseña de inicio de sesiónstring La contraseña utilizada para autenticarse. Requerida cuando login_user está especificado.
login_portentero Defecto:
27017		 El puerto del servidor MongoDB para iniciar sesión.
login_userstring El usuario de MongoDB con el que iniciar sesión. contraseña de inicio de sesión está especificado.
mongo_cmdstring Defecto:
“mongo”		 El comando de shell de MongoDB.
nodbbooleano
    Opciones:

  • no ←
  • sí
 Especifique una codificación no predeterminada para la salida.
norcbooleano
    Opciones:

  • no ←
  • sí
 Evita que el shell obtenga y evalúe ~ / .mongorc.js al iniciar.
tranquilobooleano
    Opciones:

  • no
  • sí ←
 Silencia la salida del shell durante el proceso de conexión.
split_charstring Defecto:
“”		 Utilizado por la acción de división en la etapa de transformación.
encadenarbooleano
    Opciones:

  • no ←
  • sí
 Envuelve el comando en eval en JSON.stringify (Útil para escapar de documentos que se devuelven en formato JSON extendido.
transformarstring
    Opciones:

  • auto ←
  • separar
  • json
  • crudo
 Transforma la salida devuelta al usuario.auto: intenta decidir automáticamente la mejor tranformation.split: divide la salida en un character.json: analiza como json.raw: devuelve la salida sin procesar.

Ejemplos de

-name: Run the listDatabases command
  community.mongodb.mongodb_shell:login_user: user
    login_password: secret
    eval:"db.adminCommand('listDatabases')"-name: List collections and stringify the output
  community.mongodb.mongodb_shell:login_user: user
    login_password: secret
    eval:"db.adminCommand('listCollections')"stringify: yes

-name: Run the showBuiltinRoles command
  community.mongodb.mongodb_shell:login_user: user
    login_password: secret
    eval:"db.getRoles(showBuiltinRoles: true)"-name: Run a js file containing MongoDB commands with pseudo-idempotency
  community.mongodb.mongodb_shell:login_user: user
    login_password: secret
    file:"/path/to/mongo/file.js"idempotent: yes

-name: Provide a couple of additional cmd args
  community.mongodb.mongodb_shell:login_user: user
    login_password: secret
    eval:"db.adminCommand('listDatabases')"additional_args:verbose:TruenetworkMessageCompressors:"snappy"

Valores devueltos

Los valores de retorno comunes están documentados aquí, los siguientes son los campos exclusivos de este módulo:

Llave Devuelto Descripción
cambióbooleano siempre Cambiar Estado.
errarstring cuando la depuración se establece en true Stderr crudo de mongo.
fallidobooleano en el fracaso Algo salió mal.
expedientestring Cuando se usa un archivo js. Archivo JS que se ejecutó correctamente.
msgstring siempre Un mensaje que indica lo que ha sucedido.
fuerastring cuando la depuración se establece en true Stdout crudo de mongo.
rcentero cuando la depuración se establece en true Código de retorno de mongo.
salida_transformadalista / elementos =string en el éxito Salida del comando mongo. Intentamos analizar esto en una lista o json siempre que sea posible.

Autores

  • Rhys Campbell (@rhysmeister)