Модуль google.cloud.gcp_dns_managed_zone — создание 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.
Обзор
- Зона — это поддерево пространства имен DNS, находящееся под управлением одного администратора. ManagedZone — это ресурс, представляющий зону DNS, размещенную в сервисе Cloud DNS.
Требования
Перечисленные ниже требования должны быть выполнены на хосте, на котором запускается этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен доступа OAuth2, если тип учетных данных — accesstoken. |
auth_kind string / обязательный | Тип используемых учетных данных. Варианты:
|
description string / обязательный | Изменяемая строка длиной не более 1024 символов, связанная с этим ресурсом для удобства пользователя. Не влияет на работу управляемой зоны. |
dns_name string / обязательный | Имя DNS этой управляемой зоны, например «example.com.». |
dnssec_config dictionary | Конфигурация DNSSEC. |
|
default_key_specs list / elements=dictionary |
Задает параметры, используемые для создания начальных DnsKeys для этой ManagedZone. Если вы указываете спецификацию для keySigning или zoneSigning, необходимо также указать спецификацию для другого типа. Параметр default_key_specs можно обновить, только если состояние — `off`. |
|
algorithm string |
Мнемоническое строковое обозначение алгоритма DNSSEC для этого ключа. Допустимые варианты: «ecdsap256sha256», «ecdsap384sha384», «rsasha1», «rsasha256», «rsasha512» |
|
key_length integer |
Длина ключей в битах. |
|
key_type string |
Указывает, является ли ключ ключом подписи ключей (KSK) или ключом подписи зоны (ZSK). Для ключей подписи ключей установлен флаг Secure Entry Point; в активном состоянии они используются только для подписи наборов записей ресурсов типа DNSKEY. Для ключей подписи зоны флаг Secure Entry Point не установлен; они используются для подписи всех остальных типов наборов записей ресурсов. Допустимые варианты: «keySigning», «zoneSigning» |
|
kind string |
Определяет тип этого ресурса. По умолчанию: |
|
kind string |
Определяет тип этого ресурса. По умолчанию: |
|
non_existence string |
Задает механизм, используемый для предоставления аутентифицированных ответов об отсутствии записей. Параметр non_existence можно обновить, только если состояние — `off`. Допустимые варианты: «nsec», «nsec3» |
|
state string |
Указывает, включен ли DNSSEC и в каком режиме он работает. Допустимые варианты: «off», «on», «transfer» |
env_type string | Указывает среду Ansible, в которой выполняется этот модуль. Не задавайте этот параметр, если не знаете, что делаете. Он изменяет только строку User Agent для любых запросов к API. |
forwarding_config dictionary | Наличие этого поля указывает, что для зоны включена исходящая переадресация. Значение этого поля содержит список адресов назначения для переадресации. |
|
target_name_servers list / elements=dictionary / обязательный |
Список целевых серверов имен для переадресации запросов. Если указано несколько целевых серверов, Cloud DNS выберет наиболее подходящий доступный сервер имен. |
|
forwarding_path string |
Путь переадресации для этого TargetNameServer. Если значение не задано или равно `default`, Cloud DNS выберет способ переадресации на основе диапазонов адресов: адреса RFC1918 направляются в VPC, а адреса, не относящиеся к RFC1918, — в Интернет. Если задано значение `private`, Cloud DNS всегда будет отправлять запросы к этому целевому серверу через VPC. Допустимые варианты: «default», «private» |
|
ipv4_address string / обязательный |
IPv4-адрес целевого сервера имен. |
labels dictionary | Набор пар метка/значение, назначаемых этой ManagedZone. |
name string / обязательный | Имя ресурса, назначенное пользователем. Должно быть уникальным в пределах проекта. |
name_server_set string | Необязательный параметр, задающий NameServerSet для этой ManagedZone. NameServerSet — это набор серверов имен DNS, на которых размещены одни и те же ManagedZones. Большинство пользователей оставляют это поле незаполненным. |
peering_config dictionary | Наличие этого поля указывает, что для зоны включен DNS Peering. Значение этого поля содержит сеть, с которой устанавливается пиринговое соединение. |
|
target_network dictionary / обязательный |
Сеть для установки пирингового соединения. |
|
network_url string / обязательный |
Полный URL сети VPC, на которую переадресуются запросы. Формат должен быть следующим: `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` . |
private_visibility_config dictionary | Для зон с частной видимостью — набор ресурсов Virtual Private Cloud, из которых видна эта зона. |
|
networks list / elements=dictionary / обязательный |
Список сетей VPC, которым доступна эта зона. |
|
network_url string / обязательный |
Полный URL сети VPC, к которой привязывается зона. Формат должен быть следующим: `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` . |
project string | Проект Google Cloud Platform, который следует использовать. |
scopes list / elements=string | Массив используемых областей доступа |
service_account_contents jsonarg | Содержимое JSON-файла учетной записи службы — в виде словаря или строки JSON, представляющей его. |
service_account_email string | Необязательный адрес электронной почты учетной записи службы. Используется, если выбран вариант machineaccount и пользователь не хочет использовать адрес электронной почты по умолчанию. |
service_account_file path | Путь к JSON-файлу учетной записи службы, если в качестве типа выбрано serviceaccount. |
state string | Должен ли указанный объект существовать в GCP Варианты:
|
visibility string | Видимость зоны: общедоступные зоны доступны из Интернета, а частные зоны видны только ресурсам Virtual Private Cloud. Допустимые варианты: «private», «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. - Значения переменных среды используются только в том случае, если значения в плейбуке не заданы.
- Параметры 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 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 / elements=string | Делегируйте managed_zone этим виртуальным серверам имен; они назначаются сервером. Возвращается: при успехе |
nameServerSet string | Необязательный параметр, задающий NameServerSet для этой ManagedZone. NameServerSet — это набор DNS-серверов имен, на которых размещены одни и те же ManagedZones. Большинство пользователей оставляют это поле незаполненным. Возвращается: при успехе |
peeringConfig complex | Наличие этого поля указывает, что для этой зоны включен DNS Peering. Значение поля содержит сеть, с которой устанавливается пиринговое соединение. Возвращается: при успехе |
|
targetNetwork complex |
Сеть, с которой устанавливается пиринговое соединение. Возвращается: при успехе |
|
networkUrl string |
Полный URL сети VPC, на которую будут переадресовываться запросы. Формат URL: `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` . Возвращается: при успехе |
privateVisibilityConfig complex | Для зон с частной видимостью — набор ресурсов Virtual Private Cloud, из которых видна эта зона. Возвращается: при успехе |
|
networks complex |
Список сетей VPC, из которых видна эта зона. Возвращается: при успехе |
|
networkUrl string |
Полный URL сети VPC, к которой выполняется привязка. Формат URL: `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` . Возвращается: при успехе |
visibility string | Видимость зоны: общедоступные зоны доступны из Интернета, а частные зоны видны только ресурсам Virtual Private Cloud. Возвращается: при успехе |
Ссылки на коллекцию
© 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_module.html