Модуль community.mongodb.mongodb_info — сбор информации об экземпляре MongoDB.

Примечание

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

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

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

Чтобы использовать его в плейбуке, укажите: community.mongodb.mongodb_info.

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

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

Краткое описание

Сбор информации об экземпляре MongoDB.

Требования

Следующие требования должны быть выполнены на хосте, где выполняется этот модуль.

pymongo

Параметры

Параметр	Комментарии
atlas_auth логический	Способ аутентификации, предназначенный для экземпляров MongoDB Atlas Варианты: `false` ← (по умолчанию) `true`
auth_mechanism строка	Тип аутентификации. Варианты: `"SCRAM-SHA-256"` `"SCRAM-SHA-1"` `"MONGODB-X509"` `"GSSAPI"` `"PLAIN"`
connection_options список / элементы=любые	Дополнительные параметры подключения. Передайте список словарей или строк с парами «ключ=значение».
filter список / элементы=строка	Ограничение собираемой информации с помощью строки со значениями, разделёнными запятыми, или списка YAML. Допустимые значения: `general`, `databases`, `total_size`, `parameters`, `users`, `roles`. По умолчанию собираются все подмножества. Чтобы исключить значение из информации, поставьте перед ним «!» (например, `!users`). Если в фильтре указаны включающие и исключающие значения, например filter=!general,users, исключающие значения (в данном случае `!general`) будут проигнорированы.
login_database строка	База данных, в которой хранятся учётные данные для входа. По умолчанию: `"admin"`
login_host строка	Хост с экземпляром MongoDB, к которому выполняется подключение. По умолчанию: `"localhost"`
login_password строка	Пароль для аутентификации. Обязателен, если указан login_user.
login_port целое число	Порт сервера MongoDB, к которому выполняется подключение. По умолчанию: `27017`
login_user строка	Пользователь MongoDB для подключения. Обязателен, если указан login_password.
ssl псевдонимы: tls логический	Использовать ли SSL-соединение при подключении к базе данных. Варианты: `false` ← (по умолчанию) `true`
ssl_ca_certs псевдонимы: tlsCAFile строка	Параметру ssl_ca_certs указывается путь к файлу CA.
ssl_cert_reqs псевдонимы: tlsAllowInvalidCertificates строка	Указывает, требуется ли сертификат от другой стороны соединения и будет ли он проверен, если предоставлен. Варианты: `"CERT_NONE"` `"CERT_OPTIONAL"` `"CERT_REQUIRED"` ← (по умолчанию)
ssl_certfile псевдонимы: tlsCertificateKeyFile строка	Предоставляет клиентский сертификат с помощью параметра ssl_certfile.
ssl_crlfile строка	Параметру ssl_crlfile указывается путь к файлу CRL.
ssl_keyfile строка	Закрытый ключ клиентского сертификата.
ssl_pem_passphrase псевдонимы: tlsCertificateKeyFilePassword строка	Парольная фраза для расшифровки зашифрованных закрытых ключей.
strict_compatibility логический	Строго проверять требования к версиям pymongo и MongoDB Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

На удалённом хосте требуется пакет Python pymongo версии 4 или выше.

Примеры

- name: Gather all supported information
  community.mongodb.mongodb_info:
    login_user: admin
    login_password: secret
  register: result

- name: Show gathered info
  debug:
    msg: '{{ result }}'

- name: Gather only information about databases and their total size
  community.mongodb.mongodb_info:
    login_user: admin
    login_password: secret
    filter: databases, total_size

- name: Gather all information except parameters
  community.mongodb.mongodb_info:
    login_user: admin
    login_password: secret
    filter: '!parameters'

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

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

Ключ	Описание
databases словарь	Информация о базах данных. Возвращается: всегда Пример: `{"admin": {"empty": false, "sizeOnDisk": 245760}, "config": {"empty": false, "sizeOnDisk": 110592}}`
general словарь	Общая информация об экземпляре. Возвращается: всегда Пример: `{"allocator": "tcmalloc", "bits": 64, "maxBsonObjectSize": 16777216, "storageEngines": ["biggie"], "version": "4.2.3"}`
parameters словарь	Информация о параметрах сервера. Возвращается: всегда Пример: `{"maxOplogTruncationPointsAfterStartup": 100, "maxOplogTruncationPointsDuringStartup": 100, "maxSessions": 1000000}`
roles словарь	Информация о ролях. Возвращается: всегда Пример: `{"db": {"restore": {"inheritedRoles": [], "isBuiltin": true, "roles": []}}}`
total_size целое число	Общий размер всех баз данных в байтах. Возвращается: всегда Пример: `397312`
users словарь	Информация о пользователях. Возвращается: всегда Пример: `{"db": {"new_user": {"_id": "config.new_user", "mechanisms": ["SCRAM-SHA-1", "SCRAM-SHA-256"], "roles": []}}}`

Авторы

Andrew Klychkov (@Andersson007)

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

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