sensu.sensu_go.mutator_info – Список мутаторов Sensu
Примечание
Этот плагин является частью коллекции sensu.sensu_go (версия 1.8.0).
Для его установки используйте: ansible-galaxy collection install sensu.sensu_go.
Для использования в книге задач укажите: sensu.sensu_go.mutator_info.
Новый в версии 1.0.0: из sensu.sensu_go
Краткое описание
- Получение информации о мутаторах Sensu.
- Для получения дополнительной информации обратитесь к документации Sensu по адресу https://docs.sensu.io/sensu-go/latest/reference/mutators/.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- 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.mutator
-
Официальная документация по модулю sensu.sensu_go.mutator.
Примеры
- name: List all Sensu mutators
sensu.sensu_go.mutator_info:
register: result
- name: Retrieve a single Sensu mutator
sensu.sensu_go.mutator_info:
name: my-mutator
register: result
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| objects список / элементы=словарь | успех | Список мутаторов Sensu. Пример: [{'command': 'example_mutator.go', 'env_vars': [], 'metadata': {'annotations': None, 'labels': None, 'name': 'example-mutator', 'namespace': 'default'}, 'runtime_assets': [], 'timeout': 0}] |
Авторы
- 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/mutator_info_module.html
