Модуль sensu.sensu_go.pipeline_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.pipeline_info.

Новый в sensu.sensu_go 1.14.0

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

Описание

Получить информацию о конвейерах Sensu Go.
Для получения дополнительной информации, обратитесь к документации Sensu по адресу https://docs.sensu.io/sensu-go/latest/observability-pipeline/observe-process/pipelines/.

Требования

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

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 строка	Имя конкретного конвейера.
namespace строка	Пространство имён RBAC, в котором следует выполнять операцию. Если не указано, будет использоваться значение переменной окружения SENSU_NAMESPACE. По умолчанию: `"default"`

См. также

sensu.sensu_go.socket_handler: Управление обработчиками Sensu TCP/UDP.
sensu.sensu_go.handler_info: Список обработчиков Sensu.
sensu.sensu_go.pipe_handler: Управление обработчиками Sensu pipe.
sensu.sensu_go.filter: Управление фильтрами Sensu.
sensu.sensu_go.filter_info: Список информации Sensu.
sensu.sensu_go.mutator: Управление мутаторами Sensu.
sensu.sensu_go.mutator_info: Список мутаторов Sensu.

Примеры

- name: List all Sensu pipelines
  sensu.sensu_go.pipeline_info:
  register: result

- name: List the selected Sensu pipeline
  sensu.sensu_go.pipeline_info:
    name: my_pipeline
  register: result

Значения возврата

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

Ключ	Описание
objects список / элементы=словарь	Список конвейеров Sensu. Возвращено: успех Пример: [{"metadata": {"created_by": "admin", "name": "this_pipeline", "namespace": "default"}, "workflows": null}, {"metadata": {"created_by": "admin", "name": "this_pipeline_1", "namespace": "default"}, "workflows": [{"handler": {"api_version": "core/v2", "name": "best_handler_1", "type": "Handler"}, "name": "best_workflow_1"}]}, {"metadata": {"created_by": "admin", "name": "this_pipeline_2", "namespace": "default"}, "workflows": [{"handler": {"api_version": "core/v2", "name": "best_handler_2", "type": "Handler"}, "name": "best_workflow_1"}]}]

Ключ

Описание

objects

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

Список конвейеров Sensu.

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

Пример: [{"metadata": {"created_by": "admin", "name": "this_pipeline", "namespace": "default"}, "workflows": null}, {"metadata": {"created_by": "admin", "name": "this_pipeline_1", "namespace": "default"}, "workflows": [{"handler": {"api_version": "core/v2", "name": "best_handler_1", "type": "Handler"}, "name": "best_workflow_1"}]}, {"metadata": {"created_by": "admin", "name": "this_pipeline_2", "namespace": "default"}, "workflows": [{"handler": {"api_version": "core/v2", "name": "best_handler_2", "type": "Handler"}, "name": "best_workflow_1"}]}]

Авторы

Domen Dobnikar (@domen_dobnikar)

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

© 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/pipeline_info_module.html