Spec-Zone.ru › Ansible 2.4

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
нет
  • tcp
  • udp
Протокол службы. Требуется для type=SRV
proxied
(добавлен в 2.3)
нет
Проксирование через сеть Cloudflare или просто использование DNS
record
нет @
Запись для добавления. Требуется, если state=present. По умолчанию @ (например, имя зоны).
псевдонимы: имя
service
нет
Служба записи. Требуется для type=SRV
solo
нет
Необходимо ли сделать запись единственной для данного типа записи и имени записи. Используйте только с state=present
Это удалит все остальные записи с тем же именем и типом.
state
нет present
  • 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
словарь, содержащий данные записи
успех, за исключением удаления записи сложный
содержит:
имя описание возвращается тип пример
proxiable
можно ли проксировать эту запись через Cloudflare
успех булево False
locked
Нет доступной документации
успех булево False
name
имя записи в формате FQDN (включая _service и _proto для SRV)
успех строка www.sample.com
data
дополнительные данные записи
успех, если тип SRV словарь {'priority': 10, 'target': 'jabberhost.sample.com', 'service': '_xmpp', 'proto': '_tcp', 'port': 8080, 'weight': 5, 'name': 'jabber'}
proxied
проксируется ли запись через Cloudflare
успех булево False
priority
приоритет записи MX
успех, если тип MX целое 10
created_on
дата создания записи
успех строка 2016-03-25 19:09:42.516553
meta
Нет доступной документации
успех словарь {'auto_added': False}
ttl
время жизни записи
успех целое 300
modified_on
дата изменения записи
успех строка 2016-03-25 19:09:42.516553
zone_name
имя зоны, содержащей запись
успех строка sample.com
content
содержимое записи (детали зависят от типа записи)
успех строка 192.0.2.91
type
тип записи
успех строка A
id
идентификатор записи
успех строка f9efb0549e96abcb750de63b38c9576e
zone_id
идентификатор зоны, содержащей запись
успех строка abcede0bf9f0066f94029d2e6b73856a

Статус

Этот модуль помечен как превью, что означает, что его интерфейс не гарантированно будет обратной совместим.

Для получения помощи в разработке модулей, если вы заинтересованы, пожалуйста, прочитайте Документацию по сообществу и участию в разработке, Тестирование Ansible и Разработка модулей.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/cloudflare_dns_module.html

Spec-Zone.ru

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