Модуль community.mongodb.mongodb_info – Сбор информации об экземпляре MongoDB.
Примечание
Этот модуль является частью коллекции community.mongodb (версия 1.7.7).
Возможно, эта коллекция уже установлена, если вы используете пакет 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 boolean | Путь аутентификации, предназначенный для экземпляров MongoDB Atlas Варианты:
|
auth_mechanism string | Тип аутентификации. Варианты:
|
connection_options list / elements=any | Дополнительные параметры подключения. Укажите в виде списка словарей или строк, содержащих пары ключ-значение, разделенные символом ‘=’. |
filter list / elements=string | Ограничьте собираемую информацию с помощью строки, разделенной запятыми, или списка YAML. Допустимые значения: По умолчанию собираются все подмножества. Вы можете использовать ‘!’ перед значением (например, Если вы передаете включающие и исключающие значения в фильтр, например, filter=!general,users, то исключающие значения, |
login_database string | База данных, где хранятся учетные данные для входа. По умолчанию: |
login_host string | Хост, на котором запущен экземпляр MongoDB для входа. По умолчанию: |
login_password string | Пароль, используемый для аутентификации. Требуется, когда указан login_user. |
login_port integer | Порт сервера MongoDB для входа. По умолчанию: |
login_user string | Пользователь MongoDB для входа. Требуется, когда указан login_password. |
ssl aliases: tls boolean | Использовать ли SSL-соединение при подключении к базе данных. Варианты:
|
ssl_ca_certs aliases: tlsCAFile string | Параметр ssl_ca_certs принимает путь к файлу CA. |
ssl_cert_reqs aliases: tlsAllowInvalidCertificates string | Указывает, требуется ли сертификат от другой стороны соединения и будет ли он проверен, если предоставлен. Варианты:
|
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 Варианты:
|
Примечания
Примечание
- Требуется пакет pymongo Python на удаленном хосте, версия 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 словарь | Информация о базе данных. Возвращается: всегда Пример: |
general словарь | Общая информация об экземпляре. Возвращается: всегда Пример: |
parameters словарь | Информация о параметрах сервера. Возвращается: всегда Пример: |
roles словарь | Информация о ролях. Возвращается: всегда Пример: |
total_size целое число | Общий размер всех баз данных в байтах. Возвращается: всегда Пример: |
users словарь | Информация о пользователях. Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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_info_module.html