Spec-Zone.ru › Ansible

Модуль community.dns.hetzner_dns_record_info — Получение записей в службе DNS Hetzner

Примечание

Этот модуль является частью коллекции community.dns (версия 3.0.5).

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

Для её установки используйте: ansible-galaxy collection install community.dns.

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

Новая в community.dns 2.0.0

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

Обзор

  • Получает записи DNS в службе DNS Hetzner.

Параметры

Параметр

Комментарии

hetzner_token

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

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

Токен для API Hetzner.

Если не указан, будет считан из переменной среды HETZNER_DNS_TOKEN.

prefix

строка

Префикс записи DNS.

Это часть record перед zone_name. Например, если запись для изменения — www.example.com для зоны example.com, префикс равен www. Если запись в данном примере — example.com, префикс будет '' (пустая строка).

Если what является single_record или all_types_for_record, то обязательно указать один из record и prefix.

record

строка

Полная запись DNS для получения.

Если what является single_record или all_types_for_record, то обязательно указать один из record и prefix.

txt_character_encoding

строка

добавлен в community.dns 2.5.0

Как интерпретировать числовые последовательности (\xyz) — как восьмеричные или десятичные числа. Используется только когда txt_transformation=quoted.

По умолчанию изменилось на decimal в community.dns 3.0.0. Раньше значением по умолчанию было octal. Значение decimal совместимо с RFC 1035.

Варианты:

  • "decimal" ← (по умолчанию)
  • "octal"

txt_transformation

строка

Определяет, как значения TXT-записей преобразуются между API и входными/выходными данными модуля.

Значение api означает, что значения возвращаются из модуля так, как они возвращаются из API, и передаются в API так, как были переданы в модуль. Для проверки идемпотентности входная строка сравнивается со строками, возвращаемыми API. API может автоматически преобразовывать некоторые значения, например, разбивать длинные значения или добавлять кавычки, что может вызвать проблемы с идемпотентностью.

Значение unquoted автоматически преобразует значения, так что вы можете передавать необрамлённые значения, а модуль вернёт необрамлённые значения. Если вы передадите значения в кавычках, они будут двойными.

Значение quoted автоматически преобразует значения, поэтому вы должны использовать кавычки для значений, содержащих пробелы, символы, такие как кавычки и обратные слэши, и имеющие длину более 255 байт. Он также гарантирует, что значения, возвращаемые из API, имеют нормализованное кодирование.

Значение по умолчанию, unquoted, гарантирует, что вы можете работать со значениями, не беспокоясь о правильном использовании кавычек для DNS. Большинству пользователей следует использовать один из unquoted или quoted, но не api.

Примечание: код преобразования предполагает кодировку UTF-8 для значений. Если вам нужна другая кодировка, используйте txt_transformation=api и обработайте кодировку самостоятельно.

Варианты:

  • "api"
  • "quoted"
  • "unquoted" ← (по умолчанию)

type

строка

Тип записи DNS для получения.

Требуется, если what равно single_record.

Варианты:

  • "A"
  • "AAAA"
  • "CAA"
  • "CNAME"
  • "DANE"
  • "DS"
  • "HINFO"
  • "MX"
  • "NS"
  • "RP"
  • "SOA"
  • "SRV"
  • "TLSA"
  • "TXT"

what

строка

Определяет, получать ли одну запись и тип, все типы для записи или все записи. По умолчанию — одна запись и один тип.

Обратите внимание, что структура возвращаемых значений зависит от этого параметра.

Варианты:

  • "single_record" ← (по умолчанию)
  • "all_types_for_record"
  • "all_records"

zone_id

строка

Идентификатор зоны DNS для изменения.

Необходимо указать один из zone_name и zone_id.

zone_name

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

строка

Зона DNS для изменения.

Необходимо указать один из zone_name и zone_id.

Атрибуты

Атрибут

Поддержка

Описание

action_group

Группа действий: community.dns.hetzner

добавлено в community.dns 2.4.0

Используйте group/community.dns.hetzner в module_defaults для установки значений по умолчанию для данного модуля.

check_mode

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

Это действие не изменяет состояние.

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

diff_mode

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

Это действие не изменяет состояние.

В режиме diff будет возвращена информация о том, что изменилось (или, возможно, нуждается в изменении в check_mode).

См. также

См. также

community.dns.hetzner_dns_record_set_info

Получение наборов записей в сервисе DNS Hetzner.

community.dns.hetzner_dns_records плагин инвентаризации

Создание инвентаризации из записей DNS Hetzner.

Примеры

- name: Retrieve the details for the A records of new.foo.com
  community.dns.hetzner_dns_record_info:
    zone: foo.com
    record: new.foo.com
    type: A
    hetzner_token: access_token
  register: rec

- name: Print the A records
  ansible.builtin.debug:
    msg: "{{ rec.records }}"

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

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

Ключ

Описание

records

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

Список полученных записей.

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

Пример: [{"extra": {}, "record": "sample.example.com", "ttl": 3600, "type": "A", "value": "1.2.3.4"}]

extra

словарь

Дополнительная информация о записях.

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

Пример: {"created": "2021-07-09T11:18:37Z", "modified": "2021-07-09T11:18:37Z"}

prefix

строка

Префикс записи.

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

Пример: "sample"

record

строка

Имя записи.

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

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

ttl

целое число

TTL.

Будет возвращено none, если используется значение TTL по умолчанию для зоны.

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

Пример: 3600

type

строка

Тип записи DNS.

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

Пример: "A"

value

строка

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

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

Пример: "1.2.3.4"

zone_id

строка

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

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

Пример: "23"

Авторы

  • Markus Bergholz (@markuman)
  • Felix Fontein (@felixfontein)

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

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

© 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/dns/hetzner_dns_record_info_module.html

Spec-Zone.ru

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