Модуль google.cloud.gcp_iam_role_info – Сбор информации о роли GCP

Примечание

Этот модуль является частью коллекции google.cloud (версия 1.4.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля необходимы дополнительные требования, см. Требования для подробностей.

Для использования в плейбуке укажите: google.cloud.gcp_iam_role_info.

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

Описание

Сбор информации о роли GCP

Требования

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

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

Параметры

Параметр	Комментарии
access_token строка	Токен доступа OAuth2, если тип аутентификации — accesstoken.
auth_kind строка / обязательно	Тип используемых учетных данных. Варианты: `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
env_type строка	Указывает, в какой среде Ansible выполняется этот модуль. Это поле следует устанавливать только в том случае, если вы знаете, что делаете. Это поле изменяет только строку User Agent для всех запросов к API.
project строка	Проект Google Cloud Platform, который следует использовать.
scopes список / элементы=строка	Массив используемых областей
service_account_contents jsonarg	Содержимое файла JSON учетной записи службы, либо в виде словаря, либо в виде JSON-строки, которая его представляет.
service_account_email строка	Дополнительный адрес электронной почты учетной записи службы, если выбран machineaccount и пользователь не хочет использовать адрес по умолчанию.
service_account_file путь	Путь к файлу JSON учетной записи службы, если тип учетных данных — serviceaccount.

Примечания

Примечание

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

Примеры

- name: get info on a role
  gcp_iam_role_info:
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

Значения возврата

Общие значения возврата документированы здесь, следующие — поля, уникальные для этого модуля:

Ключ	Описание
resources сложный	Список ресурсов Возвращается: всегда
deleted логический	Текущее состояние удаления роли. Возвращается: успех
description строка	Описание роли в удобочитаемой форме. Возвращается: успех
includedPermissions список / элементы=строка	Названия разрешений, предоставляемых этой ролью при связывании в политике IAM. Возвращается: успех
name строка	Имя роли. Возвращается: успех
stage строка	Текущая фаза запуска роли. Возвращается: успех
title строка	Удобочитаемое название роли. Обычно ограничено 100 байтами UTF-8. Возвращается: успех

Авторы

Google Inc. (@googlecloudplatform)

Ссылки на коллекции

© 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/google/cloud/gcp_iam_role_info_module.html