Spec-Zone.ru › Ansible

Модуль community.dns.hosttech_dns_record_set_info – Получение наборов записей DNS в службе Hosttech DNS

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install community.dns. Для использования этого модуля требуются дополнительные зависимости. Подробнее см. Требования.

Для использования в плейбуке укажите: community.dns.hosttech_dns_record_set_info.

Добавлена в community.dns 0.1.0

  • Описание
  • Требования
  • Параметры
  • Атрибуты
  • См. также
  • Примеры
  • Значения возврата

Описание

  • Получает наборы записей DNS в службе Hosttech DNS.
  • В коллекции community.dns 2.0.0 этот модуль был переименован из community.dns.hosttech_dns_record_info в community.dns.hosttech_dns_record_set_info.

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

  • lxml
END_OF_DOCUMENT_MARKER

Параметры

Параметр

Комментарии

hosttech_password

строка

Пароль пользователя API Hosttech.

Если указан, также должен быть указан hosttech_username.

Взаимоисключительно с hosttech_token.

hosttech_token

алиасы: api_token

строка

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

Пароль пользователя API Hosttech.

Взаимоисключительно с hosttech_username и hosttech_password.

Начиная с community.dns 1.2.0, можно использовать псевдоним api_token.

hosttech_username

строка

Имя пользователя пользователя API Hosttech.

Если указан, также должен быть указан hosttech_password.

Взаимоисключительно с hosttech_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"
  • "MX"
  • "NS"
  • "PTR"
  • "SPF"
  • "SRV"
  • "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.
END_OF_DOCUMENT_MARKER

Атрибуты

Атрибут

Поддержка

Описание

action_group

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

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

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

check_mode

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

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

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

diff_mode

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

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

При использовании режима diff вернет детали изменений (или, возможно, требующих изменений в check_mode).

См. также

См. также

community.dns.hosttech_dns_record_info

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

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

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

Примеры

- name: Retrieve the details for the A records of new.foo.com
  community.dns.hosttech_dns_record_set_info:
    zone_name: foo.com
    record: new.foo.com
    type: A
    hosttech_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.

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

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

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

Пример: 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

Авторы

  • 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/hosttech_dns_record_set_info_module.html

Spec-Zone.ru

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