community.mongodb.mongodb_shell – Выполнение команд через MongoDB shell.

Примечание

Этот плагин входит в коллекцию community.mongodb (версия 1.2.0).

Для его установки используйте: ansible-galaxy collection install community.mongodb.

Для использования в playbook укажите: community.mongodb.mongodb_shell.

Обзор
Требования
Параметры
Примеры
Возвращаемые значения

Обзор

Выполнение команд через MongoDB shell.
Команды предоставляются с параметром eval или включены в файл Javascript.
Попытка парсинга возвращаемых данных в формат, который Ansible может использовать.

Требования

Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.

mongo

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
additional_args raw		Дополнительные аргументы для передачи команде mongo. Указывайте в виде пар ключ-значение. Если параметр — флаг без значения, укажите пустую строку в качестве значения.
db string	Значение по умолчанию: "test"	База данных для выполнения команд
debug boolean	Варианты: нет ← да	отображение дополнительной отладочной информации.
eval string		Команда MongoDB для выполнения.
file string		Путь к файлу, содержащему команды MongoDB.
idempotent boolean	Варианты: нет ← да	Обеспечивает псевдоидемпотентность модуля. Вычисляется хэш содержимого ключа eval или имени файла, указанного в ключе file. При первом выполнении создается файл с именем <hash>.success. Модуль не будет повторно выполнять команду, если этот файл существует, а идемпотентность установлена в true.
login_database string	Значение по умолчанию: "admin"	База данных, где хранятся учетные данные для входа.
login_host string	Значение по умолчанию: "localhost"	Хост, на котором запущен экземпляр MongoDB для входа.
login_password string		Пароль, используемый для аутентификации. Требуется, когда указан login_user.
login_port integer	Значение по умолчанию: 27017	Порт сервера MongoDB для входа.
login_user string		Пользователь MongoDB для входа. Требуется, когда указан login_password.
mongo_cmd string	Значение по умолчанию: "mongo"	Команда командной строки MongoDB.
nodb boolean	Варианты: нет ← да	Указывает нестандартную кодировку для вывода.
norc boolean	Варианты: нет ← да	Запрещает shell'у подключаться и выполнять ~/.mongorc.js при запуске.
quiet boolean	Варианты: нет да ←	Успокаивает вывод shell во время процесса подключения.
split_char string	Значение по умолчанию: " "	Используется действием split на этапе преобразования.
stringify boolean	Варианты: нет ← да	Оборачивает команду eval в JSON.stringify(<js cmd>). Полезно для экранирования документов, возвращаемых в формате Extended JSON.
transform string	Варианты: auto ← split json raw	Преобразовать возвращаемый пользователю вывод. auto — Попытка автоматически выбрать лучшее преобразование. split — Разделить вывод по символу. json — Парсить как JSON. raw — Возвратить исходный вывод.

Примеры

- 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: True
      networkMessageCompressors: "snappy"

Возвращаемые значения

Общие возвращаемые значения документированы здесь, следующие поля уникальны для данного модуля:

Ключ	Возвращаемое значение	Описание
changed boolean	всегда	Статус изменения.
err string	при debug = true	Необработанный вывод stderr от mongo.
failed boolean	при ошибке	Произошла ошибка.
file string	При использовании js файла.	Успешно исполненный JS файл.
msg string	всегда	Сообщение, указывающее на то, что произошло.
out string	при debug = true	Необработанный вывод stdout от mongo.
rc integer	при debug = true	Код возврата от mongo.
transformed_output list / elements=string	при успехе	Вывод от команды mongo. Мы пытаемся распарсить его в список или JSON, где это возможно.

Авторы

Rhys Campbell (@rhysmeister)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/mongodb/mongodb_shell_module.html