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

Примечание

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

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

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

Новое в версии 1.0.0: of 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, например, 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_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': {'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': []}}}

Авторы

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

© 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_info_module.html