Spec-Zone.ru › Ansible

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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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/.

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

cert_usage

целое число

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

Требуется для type=TLSA при state=present.

Варианты:

  • 0
  • 1
  • 2
  • 3

flag

целое число

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

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

Требуется для type=CAA при state=present.

Варианты:

  • 0
  • 1

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"

timeout

integer

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

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

ttl

integer

Значение TTL для нового записи.

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

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

type

string

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

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

Варианты:

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

value

aliases: content

string

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

Требуется для state=present.

weight

integer

Вес сервиса.

Требуется для type=SRV.

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

zone

aliases: domain

string / обязательно

Имя зоны для работы (например, “example.com”).

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

Атрибуты

Атрибут

Поддержка

Описание

check_mode

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

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

diff_mode

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

Возвратит подробную информацию о том, что изменилось (или, возможно, нуждается в изменении в 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 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

Значения возврата

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

Ключ

Описание

record

сложный

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

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

content

строка

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

Возвращается: при успехе

Пример: "192.0.2.91"

created_on

строка

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

Возвращается: при успехе

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

data

словарь

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

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

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

id

строка

Идентификатор записи.

Возвращается: при успехе

Пример: "f9efb0549e96abcb750de63b38c9576e"

locked

булево

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

Возвращается: при успехе

Пример: false

meta

словарь

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

Возвращается: при успехе

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

modified_on

строка

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

Возвращается: при успехе

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

name

строка

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

Возвращается: при успехе

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

priority

целое число

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

Возвращается: при успехе, если тип — MX

Пример: 10

proxiable

булево

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

Возвращается: при успехе

Пример: false

proxied

булево

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

Возвращается: при успехе

Пример: false

ttl

целое число

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

Возвращается: при успехе

Пример: 300

type

строка

Тип записи.

Возвращается: при успехе

Пример: "A"

zone_id

строка

Идентификатор зоны, содержащей запись.

Возвращается: при успехе

Пример: "abcede0bf9f0066f94029d2e6b73856a"

zone_name

строка

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

Возвращается: при успехе

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

Авторы

  • Michael Gruener (@mgruener)

Справочные ссылки

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

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

Spec-Zone.ru

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