google.cloud.gcp_iam_role – Создаёт роль GCP
Примечание
Этот плагин входит в состав коллекции google.cloud (версия 1.0.1).
Для его установки используйте: ansible-galaxy collection install google.cloud.
Для использования в плейбуке укажите: google.cloud.gcp_iam_role.
Обзор
- Роль в API управления доступом и идентификацией.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth_kind строка / обязательно |
| Тип используемых учетных данных. |
| description строка | Описание роли, понятное для человека. | |
| env_type строка | Указывает среду Ansible, в которой выполняется этот модуль. Необходимо задавать только в случае необходимости. Изменяет только строку User Agent для запросов к API. | |
| included_permissions список / элементы=строка | Имена разрешений, предоставляемых этой ролью при связывании в политике IAM. | |
| name строка / обязательно | Имя роли. | |
| project строка | Проект Google Cloud Platform для использования. | |
| scopes список / элементы=строка | Массив используемых областей видимости. | |
| service_account_contents jsonarg | Содержимое JSON-файла учетной записи службы, представленное в словаре или как строка JSON. | |
| service_account_email строка | Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию. | |
| service_account_file путь | Путь к JSON-файлу учетной записи службы, если в качестве типа выбрано serviceaccount. | |
| stage строка | Текущая фаза запуска роли. Некоторые допустимые значения: "ALPHA", "BETA", "GA", "DEPRECATED", "DISABLED", "EAP". | |
| state строка |
| Необходимо ли существование данного объекта в GCP. |
| title строка | Название роли, понятное для человека. Обычно ограничено 100 байтами UTF-8. |
Примеры
- name: create a role
google.cloud.gcp_iam_role:
name: myCustomRole2
title: My Custom Role
description: My custom role description
included_permissions:
- iam.roles.list
- iam.roles.create
- iam.roles.delete
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: present
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| deleted логическое значение | успешно | Текущее состояние удаления роли. |
| description строка | успешно | Описание роли, понятное для человека. |
| includedPermissions список / элементы=строка | успешно | Имена разрешений, предоставляемых этой ролью при связывании в политике IAM. |
| name строка | успешно | Имя роли. |
| stage строка | успешно | Текущая фаза запуска роли. |
| title строка | успешно | Название роли, понятное для человека. Обычно ограничено 100 байтами UTF-8. |
Авторы
- Google Inc. (@googlecloudplatform)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/google/cloud/gcp_iam_role_module.html