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

Примечание

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

Для его установки используйте: 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.
	privateIpv6GoogleAccess строка		успех	Тип доступа к Google через частный IPv6 для виртуальных машин в этой подсети.
	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–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_subnetwork_info_module.html