Модуль azure.azcollection.azure_rm_dnsrecordset — создание, удаление и обновление наборов DNS-записей и записей
Примечание
Этот модуль входит в коллекцию azure.azcollection (версия 3.18.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля требуются дополнительные компоненты. Подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: azure.azcollection.azure_rm_dnsrecordset.
Добавлено в azure.azcollection 0.1.0
Краткое описание
- Создает, удаляет и обновляет наборы DNS-записей и записи в существующей зоне Azure DNS.
Требования
На узле, выполняющем этот модуль, необходимы перечисленные ниже компоненты.
- python >= 2.7
- На узле, выполняющем этот модуль, должна быть установлена коллекция azure.azcollection из galaxy
- Все пакеты Python, перечисленные в requirements.txt коллекции, должны быть установлены с помощью pip на узле, выполняющем модули из azure.azcollection
- Полные инструкции по установке доступны по адресу https://galaxy.ansible.com/azure/azcollection
Параметры
Параметр | Описание |
|---|---|
ad_user string | Имя пользователя Active Directory. Используйте этот параметр для аутентификации от имени пользователя Active Directory, а не субъекта-службы. |
adfs_authority_url string добавлено в azure.azcollection 0.0.1 | URL-адрес центра Azure AD. Используйте этот параметр для аутентификации по имени пользователя и паролю с собственным центром ADFS. |
api_profile string добавлено в azure.azcollection 0.0.1 | Выбирает профиль API для взаимодействия со службами Azure. Значение по умолчанию По умолчанию: |
append_metadata boolean | Определяет, следует ли добавлять метаданные. Варианты:
|
append_tags boolean | Определяет, является ли поле тегов каноническим или теги только добавляются к существующим. Если поле каноническое, все теги, отсутствующие в параметре tags, будут удалены из метаданных объекта. Варианты:
|
auth_source string добавлено в azure.azcollection 0.0.1 | Определяет источник учетных данных для аутентификации. Также можно задать с помощью переменной окружения Если задано значение Если задано значение Если задано значение Если задано значение Если задано значение Параметр Варианты:
|
cert_validation_mode string добавлено в azure.azcollection 0.0.1 | Определяет способ проверки сертификатов конечных точек Azure. По умолчанию все модули проверяют сертификат сервера, однако при использовании HTTPS-прокси или Azure Stack может потребоваться отключить эту проверку, передав Варианты:
|
client_id string | Идентификатор клиента Azure. Используйте для аутентификации с помощью субъекта-службы или управляемого удостоверения (msi). Также можно задать с помощью переменной окружения |
cloud_environment string добавлено в azure.azcollection 0.0.1 | Для облачных сред, отличных от общедоступного облака США, укажите имя среды (согласно Azure Python SDK, например По умолчанию: |
disable_instance_discovery boolean добавлено в azure.azcollection 2.3.0 | Определяет, выполняется ли обнаружение экземпляра при попытке аутентификации. Значение true полностью отключает обнаружение экземпляра и проверку центра. Эта возможность предназначена для сценариев, в которых конечная точка метаданных недоступна, например в частных облаках или Azure Stack. Процесс обнаружения экземпляра включает получение метаданных центра с адреса https://login.microsoft.com/ для проверки центра. Установка значения **True** отключает проверку центра. Поэтому крайне важно убедиться, что настроенный узел центра является допустимым и заслуживающим доверия. Задается через профиль файла учетных данных или переменную окружения Варианты:
|
log_mode string | Аргумент родительского модуля. |
log_path string | Аргумент родительского модуля. |
metadata dictionary | Теги метаданных для наборов записей. |
oidc_token string добавлено в azure.azcollection 3.17.0 | Токен OpenID Connect (OIDC) (JWT), используемый для аутентификации рабочей нагрузки по удостоверению. Этот токен обменивается с Azure AD с помощью федеративного удостоверения OIDC. Полезен в системах CI (например, GitHub Actions, Azure DevOps), где платформа предоставляет токен OIDC напрямую. Также можно задать с помощью переменной окружения |
oidc_token_file_path path добавлено в azure.azcollection 3.17.0 | Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации рабочей нагрузки по удостоверению. Файл должен содержать только необработанный токен. Этот способ часто используется на платформах, которые сохраняют токены OIDC в файлы. Также можно задать с помощью переменной окружения |
password string | Пароль пользователя Active Directory. Используйте этот параметр для аутентификации от имени пользователя Active Directory, а не субъекта-службы. |
profile string | Профиль безопасности из файла ~/.azure/credentials. |
record_mode string | Следует ли удалять существующие значения записей, не переданные модулю. Варианты:
|
record_type string / обязательный | Тип набора записей, который требуется создать или удалить. Варианты:
|
records list / elements=dictionary | Список записей для создания в зависимости от типа записи (набора). Нельзя одновременно настроить target_resource и records. Параметр records необходимо настроить для всех типов записей, кроме record_type=A, record_type=AAAA и record_type=CNAME. |
|
string |
Используется для создания набора записей/записей Контактный адрес электронной почты для этой записи SOA. |
|
entry string |
Основное значение данных для всех типов записей. |
|
expire_time string |
Используется для создания набора записей/записей Время истечения срока действия этой записи SOA. |
|
minimum_ttl string |
Используется для создания набора записей/записей Минимальное значение для этой записи SOA. По соглашению оно используется для определения длительности отрицательного кэширования. |
|
port string |
Используется для создания набора записей/записей |
|
preference string |
Используется для создания набора записей/записей |
|
priority string |
Используется для создания набора записей/записей |
|
refresh_time string |
Используется для создания набора записей/записей Интервал обновления для этой записи SOA. |
|
retry_time string |
Используется для создания набора записей/записей Интервал повтора для этой записи SOA. |
|
serial_number string |
Используется для создания набора записей/записей Серийный номер этой записи SOA. |
|
weight string |
Используется для создания набора записей/записей |
relative_name string / обязательный | Относительное имя набора записей. |
resource_group string / обязательный | Имя группы ресурсов. |
secret string | Секрет клиента Azure. Используйте для аутентификации с помощью субъекта-службы. |
state string | Задает требуемое состояние набора записей. Используйте Варианты:
|
subscription_id string | Идентификатор вашей подписки Azure. |
tags dictionary | Словарь пар строка:строка, назначаемых объекту в качестве метаданных. Метаданные объекта будут обновлены с учетом всех указанных значений. Чтобы удалить теги, задайте для параметра append_tags значение false. В настоящее время в тегах для зон Azure DNS и служб Traffic Manager также нельзя использовать пробелы. Azure Front Door не поддерживает использование Azure Automation и Azure CDN поддерживают не более 15 тегов для ресурсов. |
target_resource dictionary | Ссылка на ресурс Azure, из которого берется значение DNS-ресурса. Этот параметр можно применять только к record_type=A, record_type=AAAA и record_type=CNAME. Нельзя одновременно настроить target_resource и records. |
|
id string |
Ссылка на идентификатор другого ресурса. Пример: |
tenant string | Идентификатор клиента Azure. Используйте для аутентификации с помощью субъекта-службы. |
thumbprint string добавлено в azure.azcollection 1.14.0 | Отпечаток закрытого ключа, указанного в x509_certificate_path. Используйте для аутентификации с помощью субъекта-службы. Обязателен, если задан x509_certificate_path. |
time_to_live integer | Время жизни набора записей в секундах. По умолчанию: |
x509_certificate_path path добавлено в azure.azcollection 1.14.0 | Путь к сертификату X509 в формате PEM, используемому для создания субъекта-службы. Сертификат должен быть добавлен к закрытому ключу. Используйте для аутентификации с помощью субъекта-службы. |
zone_name string / обязательный | Имя существующей зоны DNS, в которой нужно управлять набором записей. |
Примечания
Примечание
- Для аутентификации в Azure можно передать параметры, задать переменные окружения, использовать профиль из ~/.azure/credentials или войти в систему перед запуском задач или плейбука с помощью
az login. - Аутентификация также возможна с помощью субъекта-службы или пользователя Active Directory.
- Для аутентификации через OIDC передайте client_id, tenant и oidc_token или oidc_token_file_path либо задайте переменные окружения AZURE_CLIENT_ID, AZURE_TENANT и AZURE_FEDERATED_TOKEN или AZURE_FEDERATED_TOKEN_FILE.
- Для аутентификации с помощью субъекта-службы передайте subscription_id, client_id, secret и tenant либо задайте переменные окружения AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET и AZURE_TENANT.
- Для аутентификации от имени пользователя Active Directory передайте ad_user и password либо задайте в окружении AZURE_AD_USER и AZURE_PASSWORD.
- В качестве альтернативы учетные данные можно хранить в ~/.azure/credentials. Это файл ini, содержащий раздел [default] и следующие ключи: subscription_id, client_id, secret и tenant либо subscription_id, ad_user и password. Также можно добавить дополнительные профили. Укажите профиль, передав profile или задав в окружении AZURE_PROFILE.
См. также
См. также
- Вход с помощью Azure CLI
-
Как пройти аутентификацию с помощью команды
az login.
Примеры
- name: ensure an "A" record set with multiple records
azure_rm_dnsrecordset:
resource_group: myResourceGroup
relative_name: www
zone_name: testing.com
record_type: A
records:
- entry: 192.168.100.101
- entry: 192.168.100.102
- entry: 192.168.100.103
- name: delete a record set
azure_rm_dnsrecordset:
resource_group: myResourceGroup
record_type: A
relative_name: www
zone_name: testing.com
state: absent
- name: create A record set with metadata information
azure_rm_dnsrecordset:
resource_group: myResourceGroup
relative_name: www
zone_name: zone1.com
record_type: A
records:
- entry: 192.168.100.104
metadata:
key1: "value1"
- name: Create A dns record set with target_resource
azure_rm_dnsrecordset:
resource_group: myResourceGroup
relative_name: www
zone_name: zone1.com
record_type: A
target_resource:
id: "/subscriptions/xxx-xxx/resourceGroups/v-xisuRG02/providers/Microsoft.Network/publicIPAddresses/pip01"
- name: create multiple "A" record sets with multiple records
azure_rm_dnsrecordset:
resource_group: myResourceGroup
zone_name: testing.com
relative_name: "{{ item.name }}"
record_type: "{{ item.type }}"
records: "{{ item.records }}"
with_items:
- {name: 'servera', type: 'A', records: [{entry: '10.10.10.20'}, {entry: '10.10.10.21'}]}
- {name: 'serverb', type: 'A', records: [{entry: '10.10.10.30'}, {entry: '10.10.10.41'}]}
- {name: 'serverc', type: 'A', records: [{entry: '10.10.10.40'}, {entry: '10.10.10.41'}]}
- name: create SRV records in a new record set
azure_rm_dnsrecordset:
resource_group: myResourceGroup
relative_name: _sip._tcp.testing.com
zone_name: testing.com
time_to_live: 7200
record_type: SRV
records:
- entry: sip.testing.com
preference: 10
priority: 20
weight: 10
port: 5060
- name: create PTR record in a new record set
azure_rm_dnsrecordset:
resource_group: myResourceGroup
relative_name: 192.168.100.101.in-addr.arpa
zone_name: testing.com
record_type: PTR
records:
- entry: servera.testing.com
- name: create TXT record in a new record set
azure_rm_dnsrecordset:
resource_group: myResourceGroup
relative_name: mail.testing.com
zone_name: testing.com
record_type: TXT
records:
- entry: 'v=spf1 a -all'
- name: Update SOA record
azure_rm_dnsrecordset:
resource_group: myResourceGroup
relative_name: "@"
zone_name: testing.com
record_type: SOA
records:
- host: ns1-99.example.com.
email: azuredns-hostmaster99.example.com
serial_number: 99
refresh_time: 3699
retry_time: 399
expire_time: 2419299
minimum_ttl: 399
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
state complex | Текущее состояние набора записей DNS. Возвращается: всегда |
|
arecords list / elements=string |
Список записей в наборе записей. Возвращается: всегда Пример: |
|
etag string |
ETag набора записей. Возвращается: всегда Пример: |
|
fqdn string |
Полное доменное имя набора записей. Возвращается: всегда Пример: |
|
id string |
Идентификатор набора записей DNS. Возвращается: всегда Пример: |
|
name string |
Относительное имя набора записей. Возвращается: всегда Пример: |
|
provisioning_state string |
Состояние набора записей DNS. Возвращается: всегда Пример: |
|
target_resource dictionary |
Целевой ресурс набора записей. Возвращается: всегда Пример: |
|
ttl integer |
TTL (время жизни) записей в наборе записей. Возвращается: всегда Пример: |
|
type string |
Тип записи DNS в этом наборе записей. Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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/azure/azcollection/azure_rm_dnsrecordset_module.html