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

Новая в sensu.sensu_go 1.0.0

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

Описание

Получение информации о ролях Sensu.
Дополнительную информацию см. в документации Sensu по адресу https://docs.sensu.io/sensu-go/latest/reference/rbac/#roles-and-cluster-roles.

Требования

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

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. Если не задан, будет проверен value переменной среды SENSU_PASSWORD. Этот параметр игнорируется, если установлен параметр auth.api_key. По умолчанию: `"P@ssw0rd!"`
url строка	Расположение API бэкенда Sensu. Если не задан, будет проверен value переменной среды SENSU_URL. По умолчанию: `"http://localhost:8080"`
user строка	Имя пользователя для подключения к API Sensu. Если не задан, будет проверен value переменной среды 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.cluster_role: Управление ролями кластера Sensu.

Примеры

- name: List all Sensu cluster roles
  sensu.sensu_go.cluster_role_info:
  register: result

- name: Retrieve Sensu cluster role by name
  sensu.sensu_go.cluster_role_info:
    name: my-custer-role
  register: result

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

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

Ключ	Описание
roles список / элементы=словарь	Список ролей кластера Sensu. Возвращаемое значение: успех Пример: `[{"metadata": {"name": "cluster-role"}, "rules": [{"resource_names": ["sample-name"], "resources": ["assets", "checks"], "verbs": ["get", "list"]}]}]`

Авторы

Paul Arthur (@flowerysong)
Manca Bizjak (@mancabizjak)
Aljaz Kosir (@aljazkosir)
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/cluster_role_info_module.html