google.cloud.gcp_compute_subnetwork_info – Сбор информации о подсети GCP

Примечание

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

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

Чтобы использовать его в книге задач, укажите: google.cloud.gcp_compute_subnetwork_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 строка / обязательно		Регион GCP для этой подсети.
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 subnetwork
  gcp_compute_subnetwork_info:
    region: us-west1
    filters:
    - name = test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

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

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

Ключ			Возвращаемое значение	Описание
resources сложное			всегда	Список ресурсов
	creationTimestamp строка		успех	Дата и время создания в формате RFC3339.
	description строка		успех	Необязательное описание этого ресурса. Укажите это свойство при создании ресурса. Это поле можно установить только при создании ресурса.
	gatewayAddress строка		успех	Адрес шлюза для маршрутов по умолчанию, чтобы добраться до адресов назначения за пределами этой подсети.
	id целое число		успех	Уникальный идентификатор ресурса.
	ipCidrRange строка		успех	Диапазон внутренних адресов, принадлежащих этой подсети. Укажите это свойство при создании подсети. Например, 10.0.0.0/8 или 192.168.0.0/16. Диапазоны должны быть уникальными и не перекрываться в пределах сети. Поддерживается только IPv4.
	name строка		успех	Имя ресурса, предоставленное клиентом при первоначальном создании ресурса. Имя должно иметь длину от 1 до 63 символов и соответствовать RFC1035. Точнее, имя должно иметь длину от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы — дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом.
	network словарь		успех	Сеть, к которой принадлежит эта подсеть. Только сети в режиме распределения могут иметь подсети.
	privateIpGoogleAccess логическое значение		успех	При включении ВМ в этой подсети без внешних IP-адресов могут получать доступ к Google API и службам, используя Private Google Access.
	region строка		успех	Регион GCP для этой подсети.
	secondaryIpRanges сложное		успех	Массив конфигураций для вторичных диапазонов IP-адресов для виртуальных машин, содержащихся в этой подсети. Основной IP такой ВМ должен принадлежать первичному диапазону ipCidrRange подсети. Alias IP могут принадлежать как первичному, так и вторичному диапазонам.
		ipCidrRange строка	успех	Диапазон IP-адресов, принадлежащих вторичному диапазону этой подсети. Укажите это свойство при создании подсети. Диапазоны должны быть уникальными и не перекрываться ни с первичным, ни со вторичными диапазонами IP в пределах сети. Поддерживается только IPv4.
		rangeName строка	успех	Имя, связанное со вторичным диапазоном этой подсети, используемое при добавлении диапазона alias IP в виртуальную машину. Имя должно иметь длину от 1 до 63 символов и соответствовать RFC1035. Имя должно быть уникальным в пределах подсети.

Авторы

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