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

Примечание

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

Для его установки используйте: 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. Каждый дополнительный фильтр в списке будет добавлен как условие И (filter1 и filter2).
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-адресов псевдонимов, внутренними балансировщиками и аналогичными ресурсами. Это значение должно быть установлено только при использовании внутреннего адреса.
	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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/google/cloud/gcp_compute_address_info_module.html