google.cloud.gcp_compute_global_address_info – Сбор информации о GCP GlobalAddress

Примечание

Этот плагин входит в состав коллекции google.cloud (версия 1.0.2).

Для его установки используйте: ansible-galaxy collection install google.cloud

Для использования в книге задач укажите: google.cloud.gcp_compute_global_address_info

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

Описание

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

Требования

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

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
auth_kind строка / обязательно	Варианты: application machineaccount serviceaccount	Тип используемых учетных данных.
env_type строка		Указывает, в какой среде Ansible выполняется этот модуль. Не устанавливать, если вы не знаете, что делаете. Это влияет только на строку User Agent при отправке запросов к API.
filters список / элементы=строка		Список пар значений фильтров. Доступные фильтры перечислены здесь https://cloud.google.com/sdk/gcloud/reference/topic/filters. Каждый дополнительный фильтр в списке будет добавлен как условие И (filter1 и filter2).
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
для аутентификации можно установить auth_kind с помощью переменной среды GCP_AUTH_KIND
для аутентификации можно установить scopes с помощью переменной среды GCP_SCOPES
Значения переменных среды будут использоваться только в том случае, если значения в книге задач не установлены.
Параметры service_account_email и service_account_file взаимоисключающие.

Примеры

- name: get info on a global address
  gcp_compute_global_address_info:
    filters:
    - name = test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

Возвращаемые значения

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

Ключ		Возвращаемое значение	Описание
resources сложный		всегда	Список ресурсов
	address строка	успех	Статический внешний IP-адрес, представленный этим ресурсом.
	addressType строка	успех	Тип адреса для резервирования. * EXTERNAL означает публичный/внешний единственный IP-адрес. * INTERNAL означает внутренние диапазоны IP, принадлежащие какой-либо сети.
	creationTimestamp строка	успех	Дата и время создания в формате RFC3339.
	description строка	успех	Необязательное описание этого ресурса.
	id целое число	успех	Уникальный идентификатор ресурса. Этот идентификатор определяется сервером.
	ipVersion строка	успех	Версия IP, которая будет использоваться этим адресом. Значение по умолчанию - `IPV4`.
	name строка	успех	Имя ресурса. Предоставляется клиентом при создании ресурса. Длина имени должна быть от 1 до 63 символов и соответствовать RFC1035. То есть имя должно содержать 1–63 символа и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы — дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом.
	network словарь	успех	URL сети, в которой необходимо зарезервировать диапазон IP-адресов. Диапазон IP-адресов должен находиться в пространстве RFC1918. Сеть нельзя удалить, если на неё ссылаются какие-либо зарезервированные диапазоны IP-адресов. Это поле должно быть установлено только при использовании внутреннего адреса.
	prefixLength целое число	успех	Длина префикса диапазона IP-адресов. Если отсутствует, это означает, что поле address представляет собой одиночный IP-адрес. Это поле неприменимо к адресам с addressType=EXTERNAL.
	purpose строка	успех	Назначение ресурса. Для глобальных внутренних адресов это может быть * VPC_PEERING — для сетей-партнёров. Это поле должно быть установлено только при использовании внутреннего адреса.
	region строка	успех	Ссылка на регион, в котором находится региональный адрес.

Авторы

Google Inc. (@googlecloudplatform)

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