Модуль sensu.sensu_go.datastore_info – Список внешних поставщиков данных Sensu

Примечание

Этот модуль является частью коллекции sensu.sensu_go (версия 1.14.0).

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

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

Для использования в книге задач укажите: sensu.sensu_go.datastore_info.

Новая функция в sensu.sensu_go 1.1.0

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

Описание

Получение информации о внешних хранилищах данных Sensu.
Дополнительную информацию см. в документации Sensu по адресу https://docs.sensu.io/sensu-go/latest/reference/datastore/.

Требования

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

python >= 2.7

Параметры

Параметр	Комментарии
auth словарь	Параметры аутентификации. Можно определить каждый из них также с помощью переменной окружения.
api_key строка добавлен в sensu.sensu_go 1.3.0	Ключ API, который следует использовать при аутентификации. Если он не задан, будет проверена переменная среды SENSU_API_KEY. Заменяет параметры auth.user и auth.password. Дополнительную информацию о ключе API см. в официальной документации Sensu по адресу https://docs.sensu.io/sensu-go/latest/guides/use-apikey-feature/.
ca_path путь добавлен в sensu.sensu_go 1.5.0	Путь к каталогу сертификатов CA, который следует использовать для проверки сертификата бэкенда. Если этот параметр не задан, модуль использует каталог сертификатов CA, используемый Python. Также можно задать этот параметр через переменную среды SENSU_CA_PATH.
password строка	Пароль пользователя Sensu. Если не задан, будет проверена переменная среды SENSU_PASSWORD. Этот параметр игнорируется, если задан параметр auth.api_key. По умолчанию: `"P@ssw0rd!"`
url строка	Местоположение API бэкенда Sensu. Если не задан, будет проверена переменная среды SENSU_URL. По умолчанию: `"http://localhost:8080"`
user строка	Имя пользователя для подключения к API Sensu. Если не задан, будет проверена переменная среды SENSU_USER. Этот параметр игнорируется, если задан параметр auth.api_key. По умолчанию: `"admin"`
verify логическое добавлен в sensu.sensu_go 1.5.0	Флаг, управляющий проверкой сертификатов. Если вы используете самозаверяющие сертификаты, можно установить этот параметр в `false`. Используйте этот параметр ТОЛЬКО в сценариях разработки! При использовании самозаверяющих сертификатов в производственной среде см. параметр auth.ca_path. Также можно установить этот параметр с помощью переменной среды SENSU_VERIFY. Варианты: `false` `true` ← (по умолчанию)
name строка	Получение информации об этом конкретном объекте вместо перечисления всех объектов.

См. также

sensu.sensu_go.datastore: Управление внешними поставщиками данных Sensu.

Примеры

- name: List all external Sensu datastores
  sensu.sensu_go.datastore_info:
  register: result

- name: Retrieve the selected external Sensu datastore
  sensu.sensu_go.datastore_info:
    name: my-datastore
  register: result

- name: Do something with result
  ansible.builtin.debug:
    msg: "{{ result.objects.0.dsn }}"

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

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

Ключ	Описание
objects список / элементы=словарь	Список внешних поставщиков данных Sensu. Возвращаемое значение: успех Пример: `[{"batch_buffer": 0, "batch_size": 1, "batch_workers": 0, "dsn": "postgresql://user:secret@host:port/dbname", "enable_round_robin": true, "max_conn_lifetime": "5m", "max_idle_conns": 2, "metadata": {"name": "my-postgres"}, "pool_size": 20, "strict": true}]`

Ключ

Описание

objects

список / элементы=словарь

Список внешних поставщиков данных Sensu.

Возвращаемое значение: успех

Пример: [{"batch_buffer": 0, "batch_size": 1, "batch_workers": 0, "dsn": "postgresql://user:secret@host:port/dbname", "enable_round_robin": true, "max_conn_lifetime": "5m", "max_idle_conns": 2, "metadata": {"name": "my-postgres"}, "pool_size": 20, "strict": true}]

Авторы

Manca Bizjak (@mancabizjak)
Tadej Borovsak (@tadeboro)

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

© 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/sensu/sensu_go/datastore_info_module.html