Модуль google.cloud.gcp_runtimeconfig_variable_info — Сбор информации о переменной GCP

Примечание

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

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

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

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

Обзор
Требования
Параметры
Примечания
Примеры
Значения возврата

Обзор

Сбор информации о переменной GCP

Требования

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

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

Параметры

Параметр	Комментарии
access_token строка	Токен доступа OAuth2, если тип аутентификации accesstoken.
auth_kind строка / обязательно	Тип используемых учетных данных. Варианты: `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
config строка / обязательно	Имя конфигурации runtime config, к которой принадлежит переменная.
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 variable
  gcp_runtimeconfig_variable_info:
    config: my-config
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

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

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

Ключ	Описание
resources сложная структура	Список ресурсов Возвращается: всегда
config строка	Имя конфигурации runtime config, к которой принадлежит переменная. Возвращается: при успехе
name строка	Имя ресурса переменной. Возвращается: при успехе
text строка	Строковое значение переменной. Либо это, либо `value` может быть установлено. Возвращается: при успехе
value строка	Бинарное значение переменной. Либо это, либо `text` может быть установлено. Возвращается: при успехе

Авторы

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_runtimeconfig_variable_info_module.html