sensu.sensu_go.cluster_role_info – Список ролей кластера Sensu

Примечание

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

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

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

Новое в версии 1.0.0: из sensu.sensu_go

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

Обзор

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

Требования

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

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		Путь к файлу с корневыми сертификатами, который следует использовать для проверки сертификата бэкенда. Если этот параметр не задан, модуль использует корневые сертификаты, используемые 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 строка			Получить информацию об этом конкретном объекте вместо перечисления всех объектов.

См. также

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

Примеры

- 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/sensu/sensu_go/cluster_role_info_module.html