sensu.sensu_go.role_info – Список ролей Sensu
Примечание
Этот плагин входит в состав коллекции sensu.sensu_go (версия 1.8.0).
Для его установки используйте: ansible-galaxy collection install sensu.sensu_go.
Чтобы использовать его в книге задач, укажите: sensu.sensu_go.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 строка | Получение информации об этом конкретном объекте вместо перечисления всех объектов. | ||
| namespace строка | Значение по умолчанию: "default" | Пространство имен RBAC для работы. Если этот параметр не задан, используется значение переменной окружения SENSU_NAMESPACE. | |
См. также
См. также
- sensu.sensu_go.role
-
Официальная документация по модулю sensu.sensu_go.role.
Примеры
- 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. Пример: [{'metadata': {'name': 'namespaced-resources-all-verbs', 'namespace': 'default'}, 'rules': [{'resource_names': [], 'resources': ['assets', 'checks'], 'verbs': ['create', 'update', 'delete']}]}] |
Авторы
- 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/role_info_module.html