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

Примечание

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

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

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

Добавлено в версии 1.0.0: из community.mongodb

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

Описание

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

Требования

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

pymongo

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
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 строка	По умолчанию: "localhost"	Хост, на котором работает экземпляр MongoDB, для входа.
login_password строка		Пароль, используемый для аутентификации. Требуется, когда указан login_user.
login_port целое число	По умолчанию: 27017	Порт сервера MongoDB для входа.
login_user строка		Пользователь MongoDB для входа. Требуется, когда указан login_password.
ssl булево	Варианты: нет ← да	Использовать ли SSL-соединение при подключении к базе данных.
ssl_ca_certs строка		Путь к файлу сертификата CA.
ssl_cert_reqs строка	Варианты: CERT_NONE CERT_OPTIONAL CERT_REQUIRED ←	Определяет, требуется ли сертификат от другой стороны соединения и будет ли он проверен при предоставлении.
ssl_certfile строка		Предоставить сертификат клиента с помощью ssl_certfile.
ssl_crlfile строка		Путь к файлу CRL.
ssl_keyfile строка		Приватный ключ для сертификата клиента.
ssl_pem_passphrase строка		Пароль для расшифровки зашифрованных приватных ключей.

Примечания

Примечание

Требуется пакет pymongo для Python на удаленном хосте, версия 2.4.2+.

Примеры

- 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': {'пустая': False, 'размерНаДиске': 245760}, 'config': {'пустая': False, 'размерНаДиске': 110592}}
general словарь	всегда	Общая информация об экземпляре. Пример: {'аллокатор': 'tcmalloc', 'разрядность': 64, 'максРазмерОбъектаBson': 16777216, 'двигателиХранения': ['biggie'], 'версия': '4.2.3'}
parameters словарь	всегда	Информация о параметрах сервера. Пример: {'maxOplogTruncationPointsAfterStartup': 100, 'maxOplogTruncationPointsDuringStartup': 100, 'maxSessions': 1000000}
roles словарь	всегда	Информация о ролях. Пример: {'восстановление': {'db': 'admin', 'унаследованныеРоли': [], 'являетсяВстроенной': True, 'роли': []}}
total_size целое число	всегда	Общий размер всех баз данных в байтах. Пример: 397312
users словарь	всегда	Информация о пользователях. Пример: {'новый_пользователь': {'_id': 'config.новый_пользователь', 'db': 'config', 'механизмы': ['SCRAM-SHA-1', 'SCRAM-SHA-256'], 'роли': []}}

Авторы

Андрей Клычков (@Andersson007)

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