cloudflare_dns – управление записями DNS Cloudflare
Новое в версии 2.1.
Описание
- Управляет записями DNS через API Cloudflare, см. документацию: https://api.cloudflare.com/
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| account_api_token - / обязательно | Токен API учетной записи. Вы можете получить свой ключ API в нижней части страницы Cloudflare «Моя учетная запись», по адресу: https://dash.cloudflare.com/
| |
| account_email - / обязательно | Электронная почта учетной записи. | |
| algorithm целое число добавлено в 2.7 | Номер алгоритма. Требуется для type=DS и type=SSHFP при state=present. | |
| cert_usage целое число добавлено в 2.7 |
| Номер использования сертификата. Требуется для type=TLSA при state=present. |
| hash_type целое число добавлено в 2.7 |
| Номер типа хэша. Требуется для type=DS, type=SSHFP и type=TLSA при state=present. |
| key_tag целое число добавлено в 2.7 | Тег ключа DNSSEC. Необходим для type=DS при state=present. | |
| port - | Порт сервиса. Требуется для type=SRV и type=TLSA. | |
| priority - | Значение по умолчанию: "1" | Приоритет записи. Требуется для type=MX и type=SRV
|
| proto - | Протокол сервиса. Требуется для type=SRV и type=TLSA.Типичные значения - tcp и udp. До Ansible 2.6 были доступны только tcp и udp. | |
| proxied логическое значение добавлено в 2.3 |
| Проксировать через сеть Cloudflare или использовать только DNS |
| record - | Значение по умолчанию: "@" | Запись для добавления. Обязательно, если state=present. Значение по умолчанию @ (например, имя зоны).псевдонимы: name |
| selector целое число добавлено в 2.7 |
| Номер селектора. Требуется для type=TLSA при state=present. |
| service - | Сервис записи. Требуется для type=SRV
| |
| solo - | Указывает, должна ли запись быть единственной для данного типа записи и имени записи. Используйте только с state=present
Это удалит все другие записи с тем же именем и типом записи. | |
| state - |
| Указывает, должна ли запись (или записи) существовать |
| timeout - | Значение по умолчанию: 30 | Таймаут для вызовов API Cloudflare |
| ttl - | Значение по умолчанию: "1 (автоматически)" | Значение TTL для новой записи. Должно быть значением от 120 до 2 147 483 647 секунд или 1 для автоматического значения. |
| type - |
| Тип записи DNS для создания. Обязательно, если state=present
type=DS, type=SSHFP и type=TLSA добавлены в Ansible 2.7. |
| value - | Значение записи. Требуется для state=present
псевдонимы: content | |
| weight - | Значение по умолчанию: "1" | Вес сервиса. Требуется для type=SRV
|
| zone - / обязательно | Имя зоны для работы (например, "example.com"). Зона должна уже существовать. псевдонимы: domain |
Примеры
# create a test.my.com A record to point to 127.0.0.1
- cloudflare_dns:
zone: my.com
record: test
type: A
value: 127.0.0.1
account_email: test@example.com
account_api_token: dummyapitoken
register: record
# create a my.com CNAME record to example.com
- cloudflare_dns:
zone: my.com
type: CNAME
value: example.com
state: present
account_email: test@example.com
account_api_token: dummyapitoken
# change it's ttl
- cloudflare_dns:
zone: my.com
type: CNAME
value: example.com
ttl: 600
state: present
account_email: test@example.com
account_api_token: dummyapitoken
# and delete the record
- cloudflare_dns:
zone: my.com
type: CNAME
value: example.com
state: absent
account_email: test@example.com
account_api_token: dummyapitoken
# create a my.com CNAME record to example.com and proxy through cloudflare's network
- cloudflare_dns:
zone: my.com
type: CNAME
value: example.com
state: present
proxied: yes
account_email: test@example.com
account_api_token: dummyapitoken
# create TXT record "test.my.com" with value "unique value"
# delete all other TXT records named "test.my.com"
- cloudflare_dns:
domain: my.com
record: test
type: TXT
value: unique value
state: present
solo: true
account_email: test@example.com
account_api_token: dummyapitoken
# create a SRV record _foo._tcp.my.com
- cloudflare_dns:
domain: my.com
service: foo
proto: tcp
port: 3500
priority: 10
weight: 20
type: SRV
value: fooserver.my.com
# create a SSHFP record login.example.com
- cloudflare_dns:
zone: example.com
record: login
type: SSHFP
algorithm: 4
hash_type: 2
value: 9dc1d6742696d2f51ca1f1a78b3d16a840f7d111eb9454239e70db31363f33e1
# create a TLSA record _25._tcp.mail.example.com
- cloudflare_dns:
zone: example.com
record: mail
port: 25
proto: tcp
type: TLSA
cert_usage: 3
selector: 1
hash_type: 1
value: 6b76d034492b493e15a7376fccd08e63befdad0edab8e442562f532338364bf3
# Create a DS record for subdomain.example.com
- cloudflare_dns:
zone: example.com
record: subdomain
type: DS
key_tag: 5464
algorithm: 8
hash_type: 2
value: B4EB5AC4467D2DFB3BAF9FB9961DC1B6FED54A58CDFAA3E465081EC86F89BFAB
Возвращаемые значения
Общие возвращаемые значения описаны в этом разделе, а ниже приведены поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| record сложный | успех, за исключением удаления записи | словарь, содержащий данные записи | |
| content строка | успех | содержание записи (подробности зависят от типа записи) Пример: 192.0.2.91 | |
| created_on строка | успех | дата создания записи Пример: 2016-03-25 19:09:42.516553+00:00 | |
| data словарь | успех, если тип SRV, DS, SSHFP или TLSA | дополнительные данные записи Пример: {'name': 'jabber', 'port': 8080, 'priority': 10, 'proto': '_tcp', 'service': '_xmpp', 'target': 'jabberhost.sample.com', 'weight': 5} | |
| id строка | успех | идентификатор записи Пример: f9efb0549e96abcb750de63b38c9576e | |
| locked булево значение | успех | Документация отсутствует | |
| meta словарь | успех | Документация отсутствует Пример: {'auto_added': False} | |
| modified_on строка | успех | дата изменения записи Пример: 2016-03-25 19:09:42.516553+00:00 | |
| name строка | успех | имя записи в формате FQDN (включая _service и _proto для SRV) Пример: www.sample.com | |
| priority целое число | успех, если тип MX | приоритет записи MX Пример: 10 | |
| proxiable булево значение | успех | можно ли проксировать эту запись через Cloudflare | |
| proxied булево значение | успех | запись проксируется через Cloudflare | |
| ttl целое число | успех | время жизни записи Пример: 300 | |
| type строка | успех | тип записи Пример: A | |
| zone_id строка | успех | идентификатор зоны, содержащей запись Пример: abcede0bf9f0066f94029d2e6b73856a | |
| zone_name строка | успех | имя зоны, содержащей запись Пример: sample.com | |
Статус
- Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Michael Gruener (@mgruener)
Подсказка
Если вы заметили какие-либо проблемы в данной документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/cloudflare_dns_module.html