Spec-Zone.ru › Ansible

Модуль community.dns.hetzner_dns_record_set_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_set_info.

Новое в community.dns 2.0.0

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

Обзор

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

Параметры

Параметр

Комментарии

hetzner_token

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

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

Токен для API Hetzner.

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

prefix

строка

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

Префикс записи 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

Указывает, как обрабатывать числовые escape-последовательности (\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

строка

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

Идентификатор зоны 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_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_set_info:
    zone: foo.com
    record: new.foo.com
    type: A
    hetzner_token: access_token
  register: rec

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

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

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

Ключ

Описание

set

словарь

Извлечённый набор записей. Пустой, если набор записей не существует.

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

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

prefix

строка

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

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

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

Пример: "sample"

record

строка

Имя записи.

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

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

ttl

целое число

TTL.

Если в этом наборе есть записи с разными TTL, здесь будет представлено минимальное значение TTL.

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

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

Пример: 3600

ttls

список / элементы=целое число

Если в этом наборе есть записи с разными значениями TTL, это будет список значений TTL, встречающихся в записях.

Каждое уникальное значение TTL будет представлено один раз, и TTL отсортированы по возрастанию.

Возвращается: когда есть более одного уникального TTL

Пример: [300, 3600]

type

строка

Тип записи DNS.

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

Пример: "A"

value

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

Значение набора записей DNS.

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

Пример: ["1.2.3.4", "1.2.3.5"]

sets

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

Список извлечённых наборов записей.

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

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

prefix

строка

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

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

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

Пример: "sample"

record

строка

Имя записи.

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

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

ttl

целое число

TTL.

Если в этом наборе есть записи с разными TTL, здесь будет представлено минимальное значение TTL.

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

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

Пример: 3600

ttls

список / элементы=целое число

Если в этом наборе есть записи с разными значениями TTL, это будет список значений TTL, встречающихся в записях.

Каждое уникальное значение TTL будет представлено один раз, и TTL отсортированы по возрастанию.

Возвращается: когда есть более одного уникального TTL

Пример: [300, 3600]

type

строка

Тип записи DNS.

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

Пример: "A"

value

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

Значение набора записей DNS.

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

Пример: ["1.2.3.4", "1.2.3.5"]

zone_id

строка

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

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

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

Пример: "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_set_info_module.html

Spec-Zone.ru

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