Spec-Zone.ru › Ansible

Модуль google.cloud.gcp_dns_managed_zone — Создаёт GCP ManagedZone

Примечание

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

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

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

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

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

Обзор

  • Зона — это поддерево пространства имён DNS, находящееся под одной административной ответственностью. ManagedZone — это ресурс, представляющий зону DNS, размещённую в службе Cloud DNS.

Требования

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

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

Параметры

Параметр

Комментарии

access_token

строка

Токен доступа OAuth2, если тип аутентификации — accesstoken.

auth_kind

строка / обязательно

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

Варианты:

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

description

строка / обязательно

Изменяемая строка длиной не более 1024 символов, связанная с этим ресурсом для удобства пользователя. Не влияет на работу управляемой зоны.

dns_name

строка / обязательно

Имя DNS этой управляемой зоны, например «example.com».

dnssec_config

словарь

Настройка DNSSEC.

default_key_specs

список / элементы=словарь

Указывает параметры, которые будут использоваться для генерации начальных ключей DnsKey для этой управляемой зоны. Если вы предоставляете спецификацию для keySigning или zoneSigning, вы также должны предоставить ее для другой.

default_key_specs можно обновлять только при состоянии `off`.

algorithm

строка

Мемоническая строка, определяющая алгоритм DNSSEC для этого ключа.

Некоторые допустимые значения: «ecdsap256sha256», «ecdsap384sha384», «rsasha1», «rsasha256», «rsasha512»

key_length

целое число

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

key_type

строка

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

Некоторые допустимые значения: «keySigning», «zoneSigning»

kind

строка

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

По умолчанию: "dns#dnsKeySpec"

kind

строка

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

По умолчанию: "dns#managedZoneDnsSecConfig"

non_existence

строка

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

non_existence можно обновлять только при состоянии `off`.

Некоторые допустимые значения: «nsec», «nsec3»

state

строка

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

Некоторые допустимые значения: «off», «on», «transfer»

env_type

строка

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

Это не должно устанавливаться, если вы не знаете, что делаете.

Это изменяет только строку User Agent для любых запросов к API.

forwarding_config

словарь

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

target_name_servers

список / элементы=словарь / обязательно

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

forwarding_path

строка

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

Некоторые допустимые значения: «default», «private»

ipv4_address

строка / обязательно

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

labels

словарь

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

name

строка / обязательно

Назначенное пользователем имя для этого ресурса.

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

name_server_set

строка

Необязательно указывает NameServerSet для этой ManagedZone. NameServerSet — это набор DNS-серверов, на которых размещены все ManagedZones. Большинство пользователей оставят это поле незаполненным.

END_OF_DOCUMENT_MARKER

peering_config

словарь

Наличие этого поля указывает, что для этой зоны включено DNS-перингование. Значение этого поля содержит сеть для перинга.

target_network

словарь / обязательно

Сеть для перинга.

network_url

строка / обязательно

Полный URL сети VPC для переадресации запросов.

Должен быть отформатирован как `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` .

private_visibility_config

словарь

Для зон с приватной видимостью — набор ресурсов Virtual Private Cloud, из которых зона видима.

networks

список / элементы=словарь / обязательно

Список сетей VPC, которые могут видеть эту зону.

network_url

строка / обязательно

Полный URL сети VPC, к которой нужно привязать зону.

Должен быть отформатирован как `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` .

project

строка

Проект Google Cloud Platform для использования.

scopes

список / элементы=строка

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

service_account_contents

jsonarg

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

service_account_email

строка

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

service_account_file

путь

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

state

строка

Нужно ли заданному объекту существовать в GCP

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

visibility

строка

Видимость зоны: публичные зоны доступны в интернете, а приватные — только для ресурсов Virtual Private Cloud.

Некоторые допустимые варианты: «private», «public»

По умолчанию: "public"

Примечания

Примечание

  • Ссылка на API: https://cloud.google.com/dns/api/v1/managedZones
  • Управление зонами: https://cloud.google.com/dns/zones/
  • для аутентификации можно установить 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.
  • Значения переменных среды будут использоваться только в том случае, если значения в playbook не заданы.
  • Параметры service_account_email и service_account_file взаимоисключающие.

Примеры

- name: create a managed zone
  google.cloud.gcp_dns_managed_zone:
    name: test_object
    dns_name: test.somewild2.example.com.
    description: test zone
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

Значения возврата

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

Ключ

Описание

creationTime

строка

Время создания этого ресурса на сервере.

Формат — RFC3339.

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

description

строка

Изменяемая строка длиной не более 1024 символов, связанная с этим ресурсом для удобства пользователя. Не оказывает влияния на работу управляемой зоны.

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

dnsName

строка

Имя DNS этой управляемой зоны, например, «example.com».

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

dnssecConfig

сложное

Настройка DNSSEC.

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

defaultKeySpecs

сложное

Указывает параметры, которые будут использоваться для генерации начальных ключей DnsKey для этой ManagedZone. Если вы предоставляете спецификацию для keySigning или zoneSigning, вы также должны предоставить одну для другой.

default_key_specs может быть обновлён только когда состояние равно `off`.

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

algorithm

строка

Мемоническая строка, определяющая алгоритм DNSSEC этого ключа.

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

keyLength

целое число

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

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

keyType

строка

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

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

kind

строка

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

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

kind

строка

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

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

nonExistence

строка

Определяет механизм, используемый для предоставления аутентифицированных ответов об отсутствии записей.

non_existence может быть обновлён только когда состояние равно `off`.

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

state

строка

Определяет, включён ли DNSSEC и в каком режиме он находится.

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

forwardingConfig

сложное

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

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

targetNameServers

сложное

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

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

forwardingPath

строка

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

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

ipv4Address

строка

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

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

id

целое число

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

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

labels

словарь

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

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

name

строка

Назначенное пользователем имя для этого ресурса.

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

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

nameServers

список / элементы=строка

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

Возвращено: успех

nameServerSet

строка

Необязательно указывает NameServerSet для этого ManagedZone. NameServerSet — это набор серверов DNS, которые все содержат одни и те же ManagedZone. Большинство пользователей оставят это поле пустым.

Возвращено: успех

peeringConfig

сложное

Наличие этого поля указывает, что DNS Peering включен для этой зоны. Значение этого поля содержит сеть для подключения.

Возвращено: успех

targetNetwork

сложное

Сеть, с которой необходимо подключиться.

Возвращено: успех

networkUrl

строка

Полный URL сети VPC для перенаправления запросов.

Он должен быть отформатирован как `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`.

Возвращено: успех

privateVisibilityConfig

сложное

Для зон с приватной видимостью набор ресурсов Virtual Private Cloud, из которых видна зона.

Возвращено: успех

networks

сложное

Список сетей VPC, которые могут видеть эту зону.

Возвращено: успех

networkUrl

строка

Полный URL сети VPC, которая должна быть привязана.

Он должен быть отформатирован как `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`.

Возвращено: успех

visibility

строка

Видимость зоны: публичные зоны доступны в интернете, а приватные зоны видны только ресурсам Virtual Private Cloud.

Возвращено: успех

Авторы

  • Google Inc. (@googlecloudplatform)

Ссылки на коллекции

  • Система отслеживания задач
  • Главная страница
  • Репозиторий (исходные коды)

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/google/cloud/gcp_dns_managed_zone_module.html

Spec-Zone.ru

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