google.cloud.gcp_dns_managed_zone_info – Сбор информации о GCP ManagedZone

Примечание

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

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

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

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

Обзор

Сбор информации о GCP ManagedZone

Требования

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

python >= 2.6
requests >= 2.18.4
google-auth >= 1.3.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
auth_kind строка / обязательно	Варианты: application machineaccount serviceaccount	Тип используемых учетных данных.
dns_name список / элементы=строка		Ограничивает список, возвращая только зоны с указанным именем домена.
env_type строка		Указывает, в какой среде Ansible выполняется этот модуль. Этого значения не следует устанавливать, если вы не знаете, что делаете. Это изменяет только строку User Agent для всех запросов API.
project строка		Проект Google Cloud Platform, который нужно использовать.
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 managed zone
  gcp_dns_managed_zone_info:
    dns_name: test.somewild2.example.com.
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

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

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

Краткое описание полей				Возвращаемое значение	Описание
resources complex				всегда	Список ресурсов
	creationTime string			успех	Время создания этого ресурса на сервере. Формат — RFC3339.
	description string			успех	Изменяемая строка длиной не более 1024 символов, связанная с этим ресурсом для удобства пользователя. Не оказывает влияния на функцию управляемой зоны.
	dnsName string			успех	Имя DNS этой управляемой зоны, например, "example.com.".
	dnssecConfig complex			успех	Настройка DNSSEC.
		defaultKeySpecs complex		успех	Указывает параметры, которые будут использоваться для генерации начальных ключей DnsKeys для этой управляемой зоны. Если вы предоставили спецификацию для keySigning или zoneSigning, вы также должны предоставить её для другого. default_key_specs могут обновляться только при состоянии «выключено».
			algorithm string	успех	Мемоническое обозначение строки, указывающее алгоритм DNSSEC этого ключа.
			keyLength integer	успех	Длина ключей в битах.
			keyType string	успех	Указывает, является ли это ключом подписи ключа (KSK) или ключом подписи зоны (ZSK). Ключи подписи ключей имеют флаг Secure Entry Point и, когда активны, будут использоваться только для подписи наборов записей ресурсов типа DNSKEY. Ключи подписи зоны не имеют флага Secure Entry Point и будут использоваться для подписи всех других типов наборов записей ресурсов.
			kind string	успех	Идентифицирует тип этого ресурса.
		kind string		успех	Идентифицирует тип этого ресурса.
		nonExistence string		успех	Указывает механизм, используемый для предоставления аутентифицированных ответов об отсутствии. non_existence может обновляться только при состоянии «выключено».
		state string		успех	Указывает, включен ли DNSSEC и в каком режиме.
	forwardingConfig complex			успех	Наличие этого поля указывает на то, что для этой зоны включено внешнее переадресация. Значение этого поля содержит набор пунктов назначения для переадресации.
		targetNameServers complex		успех	Список целевых имен серверов для переадресации. Cloud DNS выберет наилучший доступный сервер, если задано более одного пункта назначения.
			forwardingPath string	успех	Путь переадресации для этого целевого имени сервера. Если не задано или `default`, Cloud DNS примет решение о переадресации на основе диапазонов адресов, то есть адреса RFC1918 направляются в VPC, адреса, не соответствующие RFC1918, — в Интернет. При установке в `private` Cloud DNS всегда будет отправлять запросы через VPC для данного пункта назначения.
			ipv4Address string	успех	IPv4-адрес целевого имени сервера.
	id integer			успех	Уникальный идентификатор ресурса, определённый сервером.
	labels dictionary			успех	Набор пар ключ/значение меток для назначения этой управляемой зоны.
	name string			успех	Назначенное пользователем имя для этого ресурса. Должно быть уникальным в рамках проекта.
	nameServers list / elements=string			успех	Делегируйте свою управляемую зону этим виртуальным именам серверов; определяются сервером.
	nameServerSet string			успех	Необязательно указывает NameServerSet для этой управляемой зоны. NameServerSet — это набор DNS-имен серверов, которые все содержат те же ManagedZones. Большинство пользователей оставят это поле незаполненным.
	peeringConfig complex			успех	Наличие этого поля указывает на то, что DNS-переадресация включена для этой зоны. Значение этого поля содержит сеть для переадресации.
		targetNetwork complex		успех	Сеть, с которой следует установить переадресацию.
			networkUrl string	успех	Полный URL сети VPC, в которую будут перенаправляться запросы. Он должен быть отформатирован как `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`.
	privateVisibilityConfig complex			успех	Для зон с приватной видимости — набор ресурсов Virtual Private Cloud, из которых зона видна.
		networks complex		успех	Список сетей VPC, которые могут видеть эту зону.
			networkUrl string	успех	Полный URL сети VPC, к которой привязана зона. Он должен быть отформатирован как `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`.
	visibility string			успех	Видимость зоны: публичные зоны доступны в Интернете, а приватные зоны видны только ресурсам Virtual Private Cloud.

Авторы

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