gcp_iam_role – Создаёт роль GCP

Новая версия 2.8.

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

Обзор

Роль в API управления доступом и идентификацией.

Требования

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

python >= 2.6
requests >= 2.18.4
google-auth >= 1.3.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
auth_kind строка / обязательно	Варианты: application machineaccount serviceaccount	Тип используемых учетных данных.
description строка		Описание роли для удобства чтения.
env_type строка		Указывает, в какой среде Ansible выполняется этот модуль. Это не должно устанавливаться, если вы не знаете, что делаете. Это изменяет только строку имени пользователя для всех запросов 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 строка	Варианты: present ← absent	Нужно ли, чтобы указанный объект существовал в GCP
title строка		Читаемое описание названия роли. Обычно ограничено 100 байтами UTF-8.

Примечания

Примечание

для аутентификации можно установить service_account_file с помощью переменной среды c(gcp_service_account_file).
для аутентификации можно установить service_account_contents с помощью переменной среды c(GCP_SERVICE_ACCOUNT_CONTENTS).
для аутентификации можно установить service_account_email с помощью переменной среды GCP_SERVICE_ACCOUNT_EMAIL.
для аутентификации можно установить auth_kind с помощью переменной среды GCP_AUTH_KIND.
для аутентификации можно установить scopes с помощью переменной среды GCP_SCOPES.
Значения переменных среды будут использоваться только в том случае, если значения в playbook не заданы.
Параметры service_account_email и service_account_file взаимоисключающие.

Примеры

- name: create a role
  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.

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

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.9/modules/gcp_iam_role_module.html