gcp_dns_managed_zone_info – Сбор информации о управляемой зоне GCP
Новая в версии 2.8.
Обзор
- Сбор информации о управляемой зоне GCP
- Этот модуль назывался
gcp_dns_managed_zone_factsдо Ansible 2.9. Способ использования не изменился.
Псевдонимы: gcp_dns_managed_zone_facts
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth_kind строка / обязательно |
| Тип используемых учетных данных. |
| 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 с помощью переменной среды c(gcp_service_account_file).
- для аутентификации можно задать service_account_contents с помощью переменной среды c(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, вы также должны указать её для другого. | |||
| algorithm string | успех | Символьное обозначение алгоритма DNSSEC этого ключа. | |||
| keyLength integer | успех | Длина ключей в битах. | |||
| keyType string | успех | Указывает, является ли это ключом подписи ключей (KSK) или ключом подписи зоны (ZSK). Ключи подписи ключей имеют установленный флаг Secure Entry Point и, когда активны, будут использоваться только для подписи записей ресурсов типа DNSKEY. Ключи подписи зоны не имеют установленного флага Secure Entry Point и будут использоваться для подписи всех других типов записей ресурсов. | |||
| kind string | успех | Определяет, какой тип ресурса это. | |||
| kind string | успех | Определяет, какой тип ресурса это. | |||
| nonExistence string | успех | Указывает механизм, используемый для предоставления аутентифицированных ответов об отсутствии ресурсов. | |||
| state string | успех | Указывает, включен ли DNSSEC и в каком режиме он находится. | |||
| id integer | успех | Уникальный идентификатор ресурса, заданный сервером. | |||
| labels dictionary | успех | Набор пар ключ/значение метки для назначения этой управляемой зоны. | |||
| name string | успех | Назначенное пользователем имя для этого ресурса. Должно быть уникальным в рамках проекта. | |||
| nameServers list | успех | Делегируйте вашу управляемую зону этим виртуальным DNS-серверам; определяются сервером. | |||
| nameServerSet string | успех | Необязательно, указывает набор DNS-серверов для этой управляемой зоны. Набор DNS-серверов — это набор DNS-серверов, которые все размещают одни и те же управляемые зоны. Большинство пользователей оставят это поле незаполненным. | |||
| privateVisibilityConfig complex | успех | Для зон с частной видимостью — набор ресурсов виртуальной частной сети, из которых зона видна. | |||
| networks complex | успех | Список сетей VPC, которые могут видеть эту зону. | |||
| networkUrl string | успех | Полный URL сети VPC, к которой привязать. Должен быть отформатирован как `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. | |||
| visibility string | успех | Видимость зоны: публичные зоны доступны в Интернете, а частные зоны видны только ресурсам виртуальной частной сети. Должно быть одно из: `public`, `private`. | |||
Статус
- Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Google Inc. (@googlecloudplatform)
Подсказка
Если вы заметите какие-либо проблемы в данной документации, вы можете отредактировать этот документ для его улучшения.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/gcp_dns_managed_zone_info_module.html