google.cloud.gcp_compute_address_info – Сбор информации о GCP-адресе

Примечание

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

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

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

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

Обзор

Сбор информации о GCP-адресе

Требования

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

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. Каждый дополнительный фильтр в списке будет добавлен как условие AND (фильтр1 и фильтр2).
project строка		Проект Google Cloud Platform для использования.
region строка / обязательно		URL региона, в котором находится региональный адрес. Это поле не применимо к глобальным адресам.
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 an address
  gcp_compute_address_info:
    region: us-west1
    filters:
    - name = test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

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

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

Ключ		Возвращаемое значение	Описание
resources сложное		всегда	Список ресурсов
	address строка	успех	Статический внешний IP-адрес, представленный этим ресурсом. Поддерживается только IPv4. Адрес может быть указан только для типов адресов INTERNAL. IP-адрес должен находиться в указанной подсети, если таковая имеется.
	addressType строка	успех	Тип адреса для бронирования.
	creationTimestamp строка	успех	Дата и время создания в формате RFC3339.
	description строка	успех	Необязательное описание этого ресурса.
	id целое число	успех	Уникальный идентификатор ресурса.
	name строка	успех	Имя ресурса. Длина имени должна составлять 1-63 символа и соответствовать RFC1035. То есть длина имени должна составлять 1-63 символа и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом.
	networkTier строка	успех	Уровень сетевой инфраструктуры, используемый для настройки этого адреса. Если это поле не указано, предполагается, что оно равно PREMIUM.
	purpose строка	успех	Назначение этого ресурса, которое может быть одним из следующих значений: * GCE_ENDPOINT для адресов, используемых виртуальными машинами, псевдонимами диапазонов IP-адресов, внутренними балансировщиками и аналогичными ресурсами. * SHARED_LOADBALANCER_VIP для адреса, который может использоваться несколькими внутренними балансировщиками. * VPC_PEERING для адресов, зарезервированных для сетей VPC-перинга. Это значение должно быть установлено только при использовании внутреннего адреса.
	region строка	успех	URL региона, в котором находится региональный адрес. Это поле не применимо к глобальным адресам.
	status строка	успех	Статус адреса, который может быть одним из следующих значений: RESERVING, RESERVED или IN_USE. Адрес, который находится в состоянии RESERVING, в настоящее время находится в процессе бронирования. Адрес RESERVED в настоящее время зарезервирован и доступен для использования. Адрес IN_USE в настоящее время используется другим ресурсом и недоступен.
	subnetwork словарь	успех	URL подсети, в которой необходимо зарезервировать адрес. Если указан IP-адрес, он должен находиться в диапазоне IP-адресов подсети. Это поле может быть использовано только с типом INTERNAL с целями GCE_ENDPOINT/DNS_RESOLVER.
	users список / элементы=строка	успех	URL ресурсов, использующих этот адрес.

Авторы

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