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

Новая версия с 2.7.

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

Обзор

Сбор информации о GCP GlobalAddress
Этот модуль назывался gcp_compute_global_address_facts до Ansible 2.9. Использование не изменилось.

Псевдонимы: gcp_compute_global_address_facts

Требования

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

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 для использования.
scopes список		Массив используемых областей.
service_account_contents jsonarg		Содержание файла JSON учетной записи службы, либо в словаре, либо как строка JSON, представляющая его.
service_account_email строка		Дополнительный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию.
service_account_file путь		Путь к файлу JSON учетной записи службы, если тип serviceaccount выбран.

Примечания

Примечание

для аутентификации можно установить service_account_file с помощью переменной среды c(gcp_service_account_file).
для аутентификации можно установить service_account_contents с помощью переменной среды c(GCP_SERVICE_ACCOUNT_CONTENTS).
для аутентификации можно установить service_account_email с помощью переменной среды GCP_SERVICE_ACCOUNT_EMAIL.
для аутентификации можно установить auth_kind с помощью переменной среды GCP_AUTH_KIND.
для аутентификации можно установить scopes с помощью переменной среды GCP_SCOPES.
значения переменных среды будут использоваться только в том случае, если значения в playbook не установлены.
параметры 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. * EXTERNAL указывает общедоступный/внешний одиночный IP-адрес. * INTERNAL указывает внутренние IP-диапазоны, принадлежащие к какой-либо сети.
	creationTimestamp строка	успех	Дата и время создания в формате RFC3339.
	description строка	успех	Необязательное описание этого ресурса.
	id целое число	успех	Уникальный идентификатор ресурса, определенный сервером.
	ipVersion строка	успех	Версия IP, которая будет использоваться этим адресом. Допустимые значения — `IPV4` или `IPV6`. Значение по умолчанию — `IPV4`.
	name строка	успех	Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно быть длиной от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы — дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом.
	network словарь	успех	URL сети, в которой необходимо зарезервировать IP-диапазон. IP-диапазон должен быть в пространстве RFC1918. Сеть не может быть удалена, если для неё существуют сохраненные IP-диапазоны. Это значение должно быть установлено только при использовании внутреннего адреса.
	prefixLength целое число	успех	Длина префикса IP-диапазона. Если отсутствует, это означает, что адрес — это один IP-адрес. Это поле не применимо к адресам с addressType=EXTERNAL.
	purpose строка	успех	Назначение ресурса. Для глобальных внутренних адресов он может быть * VPC_PEERING — для сетей-партнеров. Это значение должно быть установлено только при использовании внутреннего адреса.
	region строка	успех	Ссылка на регион, где находится региональный адрес.

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

Google Inc. (@googlecloudplatform)

Подсказка

Если вы заметите проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/gcp_compute_global_address_info_module.html