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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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 string	Токен доступа OAuth2, если тип учетных данных — accesstoken.
auth_kind string / обязательный	Тип используемых учетных данных. Варианты: `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
config string / обязательный	Имя конфигурации среды выполнения, к которой относится эта переменная.
env_type string	Указывает, в какой среде Ansible запускается этот модуль. Не указывайте этот параметр, если не знаете, что делаете. Он изменяет только строку User Agent для запросов к API.
project string	Проект Google Cloud Platform, который будет использоваться.
scopes list / элементы типа string	Массив областей доступа для использования
service_account_contents jsonarg	Содержимое JSON-файла учетной записи службы: словарь или представляющая его строка JSON.
service_account_email string	Необязательный адрес электронной почты учетной записи службы, если выбрано machineaccount и пользователь не хочет использовать адрес электронной почты по умолчанию.
service_account_file path	Путь к 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 complex	Список ресурсов Возвращается: всегда
config string	Имя конфигурации среды выполнения, к которой относится эта переменная. Возвращается: при успешном выполнении
name string	Имя ресурса переменной. Возвращается: при успешном выполнении
text string	Строковое значение переменной. Можно задать либо его, либо `value`. Возвращается: при успешном выполнении
value string	Двоичное значение переменной. Можно задать либо его, либо `text`. Возвращается: при успешном выполнении

Авторы

Google Inc. (@googlecloudplatform)

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

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/google/cloud/gcp_runtimeconfig_variable_info_module.html