Модуль sensu.sensu_go.role_info – Список ролей Sensu
Примечание
Этот модуль входит в коллекцию sensu.sensu_go (версия 1.14.0).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install sensu.sensu_go. Для использования этого модуля необходимы дополнительные требования. Подробнее см. Требования.
Чтобы использовать его в playbook, укажите: sensu.sensu_go.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. Если он не задан, будет проверена переменная среды 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.role
-
Управление ролями Sensu.
Примеры
- name: List all Sensu roles
sensu.sensu_go.role_info:
register: result
- name: Retrieve a specific Sensu role
sensu.sensu_go.role_info:
name: my-role
register: result
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
roles список / элементы=словарь | Список ролей 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/role_info_module.html