sensu.sensu_go.hook_info – Список хуков Sensu

Примечание

Этот плагин входит в состав коллекции sensu.sensu_go (версия 1.8.0).

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

Для использования в плейбуке укажите: sensu.sensu_go.hook_info

Новое в версии 1.0.0: модуля sensu.sensu_go

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

Описание

Получение информации о хуках Sensu.
Для получения дополнительной информации обратитесь к документации Sensu по адресу https://docs.sensu.io/sensu-go/latest/reference/hooks/.

Требования

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

python >= 2.7

Параметры

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

См. также

sensu.sensu_go.hook: Официальная документация по модулю sensu.sensu_go.hook.

Примеры

- name: List all Sensu hooks
  sensu.sensu_go.hook_info:
  register: result

- name: Fetch a specific Sensu hook
  sensu.sensu_go.hook_info:
    name: awesome-hook
  register: result

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

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

Ключ	Возвращаемое значение	Описание
objects список / элементы=словарь	успех	Список хуков Sensu. Пример: [{'command': 'sudo systemctl start nginx', 'metadata': {'annotations': None, 'labels': None, 'name': 'restart_nginx', 'namespace': 'default'}, 'stdin': False, 'timeout': 60}]

Авторы

Paul Arthur (@flowerysong)
Aljaz Kosir (@aljazkosir)
Miha Plesko (@miha-plesko)
Tadej Borovsak (@tadeboro)

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