Модуль sensu.sensu_go.mutator_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.mutator_info.
Новое в sensu.sensu_go 1.0.0
Описание
- Получение информации о мутаторах Sensu.
- Для получения дополнительной информации обратитесь к документации Sensu по адресу https://docs.sensu.io/sensu-go/latest/reference/mutators/.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- 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 задан. Значение по умолчанию: |
|
url строка |
Расположение API бэкенда Sensu. Если он не задан, проверяется значение переменной окружения SENSU_URL. Значение по умолчанию: |
|
user строка |
Имя пользователя для подключения к API Sensu. Если он не задан, проверяется значение переменной окружения SENSU_USER. Этот параметр игнорируется, если параметр auth.api_key задан. Значение по умолчанию: |
|
verify логическое добавлен в sensu.sensu_go 1.5.0 |
Флаг, контролирующий проверку сертификата. Если вы используете самозаверяемые сертификаты, можно установить этот параметр в ИСПОЛЬЗУЙТЕ ЭТОТ ПАРАМЕТР ТОЛЬКО В СЦЕНАРИЯХ РАЗРАБОТКИ! Если вы используете самозаверяемые сертификаты в рабочей среде, см. параметр auth.ca_path. Также возможно установить этот параметр через переменную окружения SENSU_VERIFY. Варианты:
|
name строка | Получение информации об этом конкретном объекте вместо перечисления всех объектов. |
namespace строка | Пространство имен RBAC для работы. Если не задано, используется значение переменной окружения SENSU_NAMESPACE. Значение по умолчанию: |
См. также
См. также
- sensu.sensu_go.mutator
-
Управление мутаторами Sensu.
Примеры
- 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. Возвращается: успех Пример: |
Ссылки на коллекцию
© 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/mutator_info_module.html