Spec-Zone.ru › Ansible 2.6

cloudflare_dns - управление записями DNS Cloudflare

Новое в версии 2.1.

  • Обзор
    • Требования
  • Параметры
  • Примеры
  • Возвращаемые значения
  • Статус
  • Техническое обслуживание
    • Автор

Обзор

  • Управляет записями DNS через API Cloudflare, см. документацию: https://api.cloudflare.com/

Требования

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

  • python >= 2.6

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
account_api_token
обязательно
Токен API учетной записи. Вы можете получить свой ключ API в нижней части страницы Cloudflare «Мой аккаунт» по адресу: https://www.cloudflare.com/a/account
account_email
обязательно
Электронная почта учетной записи.
port
Порт сервиса. Требуется для type=SRV
priority По умолчанию:
"1"
Приоритет записи. Требуется для type=MX и type=SRV
proto
Протокол сервиса. Требуется для type=SRV.
Общие значения — tcp и udp.
Перед Ansible 2.6 были доступны только tcp и udp.
proxied
bool

(добавлено в 2.3)
    Варианты:
  • нет ←
  • да
Проксировать через сеть Cloudflare или использовать только DNS
record По умолчанию:
"@"
Запись для добавления. Требуется, если state=present. Значение по умолчанию — @ (например, имя зоны).

псевдонимы: имя
service
Сервис записи. Требуется для type=SRV
solo
Указывает, должна ли запись быть единственной для данного типа записи и имени. Используйте только с state=present
Это удалит все другие записи с тем же именем и типом записи.
state
    Варианты:
  • present ←
  • absent
Указывает, должна ли существовать запись(и) или нет
timeout По умолчанию:
30
Таймаут для вызовов API Cloudflare
ttl По умолчанию:
"1 (автоматически)"
Время жизни (TTL) новой записи. Должно быть значением от 120 до 2 147 483 647 секунд или 1 для автоматического значения.
type
    Варианты:
  • A
  • AAAA
  • CNAME
  • TXT
  • SRV
  • MX
  • NS
  • SPF
Тип записи DNS для создания. Требуется, если state=present
value
Значение записи. Требуется для state=present

псевдонимы: содержимое
weight По умолчанию:
"1"
Вес сервиса. Требуется для type=SRV
zone
обязательно
Имя зоны для работы (например, "example.com"). Зона должна уже существовать.

псевдонимы: домен

Примеры

# 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

Возвращаемые значения

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

Ключ Возвращаемое значение Описание
record
сложный
успех, за исключением удаления записи
словарь, содержащий данные записи

content
строка
успех
содержимое записи (подробности зависят от типа записи)

Пример:
192.0.2.91
created_on
строка
успех
дата создания записи

Пример:
2016-03-25 19:09:42.516553
data
словарь
успех, если тип — SRV
дополнительные данные записи

Пример:
{'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
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. Для получения дополнительной информации см. Поддержка и обслуживание модулей.

Чтобы увидеть список других модулей, также поддерживаемых сообществом Ansible, см. здесь.

Автор

  • 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.6/modules/cloudflare_dns_module.html

Spec-Zone.ru

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