Spec-Zone.ru › Ansible

модуль community.general.cloudflare_dns – Управление DNS-записями Cloudflare

Примечание

Этот модуль входит в коллекцию community.general (версия 12.6.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install community.general.

Чтобы использовать её в плейбуке, укажите: community.general.cloudflare_dns.

  • Краткое описание
  • Параметры
  • Атрибуты
  • Примеры
  • Возвращаемые значения

Краткое описание

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

Параметры

Параметр

Комментарии

account_api_key

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

строка

Ключ API аккаунта.

Обязателен для аутентификации с помощью ключей API.

Ключ API можно получить в нижней части страницы Cloudflare «Мой аккаунт», расположенной здесь: https://dash.cloudflare.com/.

account_email

строка

Адрес электронной почты аккаунта. Обязателен для аутентификации с помощью ключей API.

algorithm

целое число

Номер алгоритма.

Обязателен для type=DS и type=SSHFP, если задано state=present.

api_token

строка

добавлено в community.general 0.2.0

Токен API.

Обязателен для аутентификации с помощью токена API.

Токен API можно получить в нижней части страницы Cloudflare «Мой аккаунт», расположенной здесь: https://dash.cloudflare.com/.

Начиная с community.general 2.0.0, можно указать в переменной окружения CLOUDFLARE_TOKEN.

cert_usage

целое число

Номер использования сертификата.

Обязателен для type=TLSA, если задано state=present.

Варианты:

  • 0
  • 1
  • 2
  • 3

comment

строка

добавлено в community.general 10.1.0

Комментарии или примечания к DNS-записи.

flag

целое число

добавлено в community.general 8.0.0

Флаг критичности издателя.

Для некритичного флага задайте 0, для критичного — 128.

До community.general 12.3.0 допустимыми вариантами были только 0 и 1. Значение 1 по-прежнему доступно для обратной совместимости.

Обязателен для type=CAA, если задано state=present.

Варианты:

  • 0
  • 1
  • 128

hash_type

целое число

Номер типа хеша.

Обязателен для type=DS, type=SSHFP и type=TLSA, если задано state=present.

Варианты:

  • 1
  • 2

key_tag

целое число

Тег ключа DNSSEC.

Требуется для type=DS, если задано state=present.

port

целое число

Порт службы.

Обязателен для type=SRV и type=TLSA.

priority

целое число

Приоритет записи.

Обязателен для type=MX и type=SRV.

По умолчанию: 1

proto

строка

Протокол службы. Обязателен для type=SRV и type=TLSA.

Часто используются значения TCP и UDP.

proxied

логическое значение

Использовать прокси через сеть Cloudflare или только DNS.

Варианты:

  • false ← (по умолчанию)
  • true

record

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

строка

Добавляемая запись.

Обязателен, если задано state=present.

По умолчанию используется @ (то есть имя зоны).

По умолчанию: "@"

selector

целое число

Номер селектора.

Обязателен для type=TLSA, если задано state=present.

Варианты:

  • 0
  • 1

service

строка

Служба записи.

Обязателен для type=SRV.

solo

логическое значение

Должна ли эта запись быть единственной записью данного типа и с данным именем.

Используйте только с state=present.

Удаляет все остальные записи с тем же именем и типом.

Варианты:

  • false
  • true

state

строка

Должны ли записи существовать.

Варианты:

  • "absent"
  • "present" ← (по умолчанию)

tag

строка

добавлено в community.general 8.0.0

Ограничение CAA для издателя.

Обязателен для type=CAA, если задано state=present.

Варианты:

  • "issue"
  • "issuewild"
  • "iodef"

tags

список / элементы=строка

добавлено в community.general 10.1.0

Пользовательские теги DNS-записи.

timeout

целое число

Тайм-аут вызовов API Cloudflare.

По умолчанию: 30

ttl

целое число

TTL новой записи.

Должен быть в диапазоне от 120 до 2,147,483,647 секунд или равен 1 для автоматического режима.

По умолчанию: 1

type

строка

Тип создаваемой DNS-записи. Обязателен, если задано state=present.

Поддержка SPF удалена из community.general 9.0.0, поскольку Cloudflare больше не поддерживает этот тип записи.

Поддержка PTR добавлена в community.general 11.1.0.

Варианты:

  • "A"
  • "AAAA"
  • "CNAME"
  • "DS"
  • "MX"
  • "NS"
  • "SRV"
  • "SSHFP"
  • "TLSA"
  • "CAA"
  • "TXT"
  • "PTR"

value

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

строка

Значение записи.

Обязателен для state=present.

weight

целое число

Вес службы.

Обязателен для type=SRV.

По умолчанию: 1

zone

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

строка / обязательно

Имя зоны, с которой нужно работать (например, example.com).

Зона должна существовать заранее.

Атрибуты

Атрибут

Поддержка

Описание

check_mode

Поддержка: полная

Может работать в режиме check_mode и возвращать прогноз изменения состояния, не изменяя целевой объект.

diff_mode

Поддержка: нет

В режиме diff возвращает сведения об изменениях (или возможных изменениях в check_mode).

Примеры

- name: Create a test.example.net A record to point to 127.0.0.1
  community.general.cloudflare_dns:
    zone: example.net
    record: test
    type: A
    value: 127.0.0.1
    account_email: test@example.com
    account_api_key: dummyapitoken
  register: record

- name: Create a record using api token
  community.general.cloudflare_dns:
    zone: example.net
    record: test
    type: A
    value: 127.0.0.1
    api_token: dummyapitoken

- name: Create a record with comment and tags
  community.general.cloudflare_dns:
    zone: example.net
    record: test
    type: A
    value: 127.0.0.1
    comment: Local test website
    tags:
      - test
      - local
    api_token: dummyapitoken

- name: Create a example.net CNAME record to example.com
  community.general.cloudflare_dns:
    zone: example.net
    type: CNAME
    value: example.com
    account_email: test@example.com
    account_api_key: dummyapitoken
    state: present

- name: Change its TTL
  community.general.cloudflare_dns:
    zone: example.net
    type: CNAME
    value: example.com
    ttl: 600
    account_email: test@example.com
    account_api_key: dummyapitoken
    state: present

- name: Delete the record
  community.general.cloudflare_dns:
    zone: example.net
    type: CNAME
    value: example.com
    account_email: test@example.com
    account_api_key: dummyapitoken
    state: absent

- name: Create a example.net CNAME record to example.com and proxy through Cloudflare's network
  community.general.cloudflare_dns:
    zone: example.net
    type: CNAME
    value: example.com
    proxied: true
    account_email: test@example.com
    account_api_key: dummyapitoken
    state: present

# This deletes all other TXT records named "test.example.net"
- name: Create TXT record "test.example.net" with value "unique value"
  community.general.cloudflare_dns:
    domain: example.net
    record: test
    type: TXT
    value: unique value
    solo: true
    account_email: test@example.com
    account_api_key: dummyapitoken
    state: present

- name: Create an SRV record _foo._tcp.example.net
  community.general.cloudflare_dns:
    domain: example.net
    service: foo
    proto: tcp
    port: 3500
    priority: 10
    weight: 20
    type: SRV
    value: fooserver.example.net

- name: Create a SSHFP record login.example.com
  community.general.cloudflare_dns:
    zone: example.com
    record: login
    type: SSHFP
    algorithm: 4
    hash_type: 2
    value: 9dc1d6742696d2f51ca1f1a78b3d16a840f7d111eb9454239e70db31363f33e1

- name: Create a TLSA record _25._tcp.mail.example.com
  community.general.cloudflare_dns:
    zone: example.com
    record: mail
    port: 25
    proto: tcp
    type: TLSA
    cert_usage: 3
    selector: 1
    hash_type: 1
    value: 6b76d034492b493e15a7376fccd08e63befdad0edab8e442562f532338364bf3

- name: Create a CAA record subdomain.example.com
  community.general.cloudflare_dns:
    zone: example.com
    record: subdomain
    type: CAA
    flag: 0
    tag: issue
    value: ca.example.com

- name: Create a DS record for subdomain.example.com
  community.general.cloudflare_dns:
    zone: example.com
    record: subdomain
    type: DS
    key_tag: 5464
    algorithm: 8
    hash_type: 2
    value: B4EB5AC4467D2DFB3BAF9FB9961DC1B6FED54A58CDFAA3E465081EC86F89BFAB

- name: Create PTR record "1.2.0.192.in-addr.arpa" with value "test.example.com"
  community.general.cloudflare_dns:
    zone: 2.0.192.in-addr.arpa
    record: 1
    type: PTR
    value: test.example.com
    state: present

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

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

Ключ

Описание

record

dictionary

Словарь, содержащий данные записи.

Возвращается: при успешном выполнении, кроме случаев удаления записи

comment

string

добавлено в community.general 10.1.0

Комментарии или примечания о записи DNS.

Возвращается: при успешном выполнении

Пример: "Domain verification record"

comment_modified_on

string

добавлено в community.general 10.1.0

Дата и время последнего изменения комментария записи. Не указывается, если комментария нет.

Возвращается: при успешном выполнении

Пример: "2024-01-01T05:20:00.12345Z"

content

string

Содержимое записи (зависит от типа записи).

Возвращается: при успешном выполнении

Пример: "192.0.2.91"

created_on

string

Дата создания записи.

Возвращается: при успешном выполнении

Пример: "2016-03-25T19:09:42.516553Z"

data

dictionary

Дополнительные данные записи.

Возвращается: при успешном выполнении, если тип записи — SRV, DS, SSHFP, TLSA или CAA

Пример: {"name": "jabber", "port": 8080, "priority": 10, "proto": "_tcp", "service": "_xmpp", "target": "jabberhost.sample.com", "weight": 5}

id

string

ID записи.

Возвращается: при успешном выполнении

Пример: "f9efb0549e96abcb750de63b38c9576e"

locked

boolean

Документация отсутствует.

Возвращается: при успешном выполнении

Пример: false

meta

dictionary

Дополнительная информация о записи, относящаяся к Cloudflare.

Возвращается: при успешном выполнении

Пример: {"auto_added": false}

modified_on

string

Дата изменения записи.

Возвращается: при успешном выполнении

Пример: "2016-03-25T19:09:42.516553Z"

name

string

Имя записи в формате FQDN (включая _service и _proto для SRV).

Возвращается: при успешном выполнении

Пример: "www.sample.com"

priority

integer

Приоритет MX-записи.

Возвращается: при успешном выполнении, если тип записи — MX

Пример: 10

proxiable

boolean

Можно ли проксировать эту запись через Cloudflare.

Возвращается: при успешном выполнении

Пример: false

proxied

boolean

Проксируется ли запись через Cloudflare.

Возвращается: при успешном выполнении

Пример: false

tags

list / elements=string

добавлено в community.general 10.1.0

Пользовательские теги записи DNS.

Возвращается: при успешном выполнении

Пример: ["production", "app"]

tags_modified_on

string

добавлено в community.general 10.1.0

Дата и время последнего изменения тегов записи. Не указывается, если тегов нет.

Возвращается: при успешном выполнении

Пример: "2025-01-01T05:20:00.12345Z"

ttl

integer

Время жизни записи.

Возвращается: при успешном выполнении

Пример: 300

type

string

Тип записи.

Возвращается: при успешном выполнении

Пример: "A"

zone_id

string

ID зоны, содержащей запись.

Возвращается: при успешном выполнении

Пример: "abcede0bf9f0066f94029d2e6b73856a"

zone_name

string

Имя зоны, содержащей запись.

Возвращается: при успешном выполнении

Пример: "sample.com"

Авторы

  • Michael Gruener (@mgruener)

Ссылки на коллекцию

  • Отслеживание проблем
  • Репозиторий (исходный код)
  • Запросить помощь
  • Сообщить об ошибке
  • Предложить новую функцию
  • Общение

© 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/community/general/cloudflare_dns_module.html

Spec-Zone.ru

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