Spec-Zone.ru › Ansible

Модуль google.cloud.gcp_dns_managed_zone_info — сбор сведений о ManagedZone в GCP

Примечание

Этот модуль входит в коллекцию google.cloud (версия 1.13.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: google.cloud.gcp_dns_managed_zone_info.

  • Краткое описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

  • Сбор сведений о ManagedZone в GCP

Требования

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

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

Параметры

Параметр

Комментарии

access_token

string

Токен доступа OAuth2, если тип учетных данных — accesstoken.

auth_kind

string / обязательно

Тип используемых учетных данных.

Варианты:

  • "application"
  • "machineaccount"
  • "serviceaccount"
  • "accesstoken"

dns_name

list / элементы=string

Ограничивает список зонами с указанным доменным именем.

env_type

string

Указывает среду Ansible, в которой выполняется этот модуль.

Не задавайте этот параметр, если не знаете, что делаете.

Он изменяет только строку User Agent для запросов к API.

project

string

Проект Google Cloud Platform, который следует использовать.

scopes

list / элементы=string

Массив используемых областей действия

service_account_contents

jsonarg

Содержимое JSON-файла учетной записи службы: словарь или представляющая его строка JSON.

service_account_email

string

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

service_account_file

path

Путь к JSON-файлу учетной записи службы, если в качестве типа выбрано serviceaccount.

Примечания

Примечание

  • Для аутентификации можно задать service_account_file с помощью переменной среды GCP_SERVICE_ACCOUNT_FILE.
  • Для аутентификации можно задать service_account_contents с помощью переменной среды GCP_SERVICE_ACCOUNT_CONTENTS.
  • Для аутентификации можно задать service_account_email с помощью переменной среды GCP_SERVICE_ACCOUNT_EMAIL.
  • Для аутентификации можно задать access_token с помощью переменной среды GCP_ACCESS_TOKEN.
  • Для аутентификации можно задать 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 этой ManagedZone. Если указана спецификация для keySigning или zoneSigning, необходимо указать ее и для другого типа.

Параметр default_key_specs можно обновить, только если состояние равно `off`.

Возвращается: при успехе

algorithm

string

Строковое мнемоническое обозначение алгоритма DNSSEC этого ключа.

Возвращается: при успехе

keyLength

integer

Длина ключей в битах.

Возвращается: при успехе

keyType

string

Указывает, является ли этот ключ ключом подписи ключей (KSK) или ключом подписи зоны (ZSK). Для ключей подписи ключей установлен флаг Secure Entry Point; в активном состоянии они используются только для подписи наборов записей ресурсов типа DNSKEY. Для ключей подписи зоны флаг Secure Entry Point не установлен; они используются для подписи наборов записей ресурсов всех остальных типов.

Возвращается: при успехе

kind

string

Определяет тип этого ресурса.

Возвращается: при успехе

kind

string

Определяет тип этого ресурса.

Возвращается: при успехе

nonExistence

string

Указывает механизм предоставления аутентифицированных ответов об отсутствии данных.

Параметр non_existence можно обновить, только если состояние равно `off`.

Возвращается: при успехе

state

string

Указывает, включен ли DNSSEC и в каком режиме он работает.

Возвращается: при успехе

forwardingConfig

complex

Наличие этого поля означает, что для зоны включена переадресация исходящих запросов. Значение поля содержит список адресатов для переадресации.

Возвращается: при успехе

targetNameServers

complex

Список целевых серверов имен, на которые следует переадресовывать запросы. Если указано несколько целевых серверов, Cloud DNS выберет наиболее подходящий доступный сервер имен.

Возвращается: при успехе

forwardingPath

string

Путь переадресации для этого TargetNameServer. Если значение не задано или равно `default`, Cloud DNS выберет путь переадресации на основе диапазонов адресов: адреса RFC1918 направляются в VPC, а адреса, не относящиеся к RFC1918, — в Интернет. Если задано значение `private`, Cloud DNS всегда будет отправлять запросы к этому целевому серверу через VPC.

Возвращается: при успехе

ipv4Address

string

IPv4-адрес целевого сервера имен.

Возвращается: при успехе

id

integer

Уникальный идентификатор ресурса, назначаемый сервером.

Возвращается: при успехе

labels

dictionary

Набор пар «ключ/значение» меток для этой ManagedZone.

Возвращается: при успехе

name

string

Имя ресурса, назначенное пользователем.

Должно быть уникальным в пределах проекта.

Возвращается: при успехе

nameServers

list / элементы=string

Делегируйте managed_zone этим виртуальным серверам имен; список назначается сервером.

Возвращается: при успехе

nameServerSet

string

Необязательный параметр, задающий набор серверов имен (NameServerSet) для этой ManagedZone. 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/google/cloud/gcp_dns_managed_zone_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API