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

Примечание

Этот модуль входит в коллекцию community.mongodb (версия 1.7.7).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.mongodb. Для использования этого модуля необходимы дополнительные требования, см. Требования для подробностей.

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

Добавлен в community.mongodb 1.1.0

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

Описание

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

Требования

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

mongosh

Параметры

Параметр	Комментарии
additional_args any	Дополнительные аргументы для передачи команде mongo. Указываются в виде пар ключ-значение. Если параметр является флагом без значения, укажите пустую строку в качестве значения.
atlas_auth boolean	Путь аутентификации, предназначенный для экземпляров MongoDB Atlas Варианты: `false` ← (default) `true`
auth_mechanism string	Тип аутентификации. Варианты: `"SCRAM-SHA-256"` `"SCRAM-SHA-1"` `"MONGODB-X509"` `"GSSAPI"` `"PLAIN"`
connection_options list / elements=any	Дополнительные параметры подключения. Указываются в виде списка словарей или строк, содержащих пары ключ-значение, разделенные символом ‘=’.
db string	База данных, для которой будут выполняться команды По умолчанию: `"test"`
debug boolean	Показать дополнительную отладочную информацию. Варианты: `false` ← (default) `true`
eval string	Команда MongoDB для выполнения.
file string	Путь к файлу, содержащему команды MongoDB.
idempotent boolean	Обеспечивает форму псевдо-идемпотентности для модуля. Выполняется вычисление хэша содержимого ключа eval или имени файла, указанного в ключе file. При первом выполнении команды создается поле <hash>.success. Модуль не будет повторно запускать команду, если этот файл существует и idempotent имеет значение true. Варианты: `false` ← (default) `true`
login_database string	База данных, где хранятся учетные данные для входа. По умолчанию: `"admin"`
login_host string	Хост, на котором запущен экземпляр MongoDB для входа. По умолчанию: `"localhost"`
login_password string	Пароль, используемый для аутентификации. Обязателен, если указан login_user.
login_port integer	Порт сервера MongoDB для входа. По умолчанию: `27017`
login_user string	Пользователь MongoDB для входа. Обязателен, если указан login_password.
mongo_cmd string	Команда оболочки MongoDB. auto - Автоматическое определение используемой команды оболочки MongoDB. Используйте «mongosh», если доступно, иначе используйте команду «mongo». mongo - Это должно работать в большинстве случаев, но могут возникнуть проблемы с анализом json. Используйте transform_type ‘raw’, если у вас возникнут проблемы. По умолчанию: `"mongosh"`
nodb boolean	Укажите нестандартную кодировку для вывода. Варианты: `false` ← (default) `true`
norc boolean	Предотвращает загрузку и оценку оболочкой ~/.mongorc.js при запуске. Варианты: `false` ← (default) `true`
omit list / elements=string	Параметр для пропуска в командной строке. Это должно соответствовать имени параметра, которое принимает оболочка MongoDB, а не имени модуля. По умолчанию: `[]`
quiet boolean	Отключает вывод из оболочки во время процесса подключения. Варианты: `false` `true` ← (default)

split_char string	Используется действием split на стадии преобразования. По умолчанию: `" "`
ssl aliases: tls boolean	Использовать ли SSL-соединение при подключении к базе данных. Доступные значения: `false` ← (по умолчанию) `true`
ssl_ca_certs aliases: tlsCAFile string	Параметр ssl_ca_certs принимает путь к файлу CA.
ssl_cert_reqs aliases: tlsAllowInvalidCertificates string	Определяет, требуется ли сертификат от другой стороны подключения и будет ли он проверен, если предоставлен. Доступные значения: `"CERT_NONE"` `"CERT_OPTIONAL"` `"CERT_REQUIRED"` ← (по умолчанию)
ssl_certfile aliases: tlsCertificateKeyFile string	Предоставить сертификат клиента с помощью параметра ssl_certfile.
ssl_crlfile string	Параметр ssl_crlfile принимает путь к файлу CRL.
ssl_keyfile string	Приватный ключ для сертификата клиента.
ssl_pem_passphrase aliases: tlsCertificateKeyFilePassword string	Пароль для расшифровки зашифрованных приватных ключей.
strict_compatibility boolean	Принудительное выполнение строгих требований для версий pymongo и MongoDB программного обеспечения Доступные значения: `false` `true` ← (по умолчанию)
stringify boolean	Оборачивает команду в eval в JSON.stringify(<js cmd>) (mongo) или EJSON.stringify(<js cmd>) (mongosh). Полезно для экранирования документов, возвращаемых в формате Extended JSON. Автоматически устанавливается в false при использовании mongo. Автоматически устанавливается в true при использовании mongosh. Явно устанавливается для переопределения автоматического выбора. Доступные значения: `false` `true`
transform string	Преобразовать вывод, возвращаемый пользователю. auto - Попытка автоматически определить лучшее преобразование. split - Разбить вывод на символы. json - разобрать как json. raw - Вернуть исходный вывод. Доступные значения: `"auto"` ← (по умолчанию) `"split"` `"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	Необработанная stderr из mongo. Возвращается: когда debug установлен в true
failed boolean	Произошла ошибка. Возвращается: при ошибке
file string	Файл JS, который был успешно выполнен. Возвращается: Когда используется js-файл.
msg string	Сообщение, указывающее, что произошло. Возвращается: всегда
out string	Необработанный stdout из mongo. Возвращается: когда debug установлен в true
rc integer	Код возврата из mongo. Возвращается: когда debug установлен в true
transformed_output list / elements=string	Вывод из команды mongo. Мы пытаемся разобрать его в список или json, где это возможно. Возвращается: при успехе

Авторы

Rhys Campbell (@rhysmeister)

Ссылки на коллекции

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