Spec-Zone.ru › Ansible

community.dns.hosttech_dns_record_info модуль — Получение записей в службе DNS Hosttech

Примечание

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

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

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

Для использования в книге задач укажите: community.dns.hosttech_dns_record_info.

Новая функция в community.dns 2.0.0

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

Описание

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

Требования

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

  • lxml

Параметры

Параметр

Комментарии

hosttech_password

строка

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

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

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

hosttech_token

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

строка

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

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

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

С версии community.dns 1.2.0 можно использовать псевдоним api_token.

hosttech_username

строка

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

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

Взаимоисключительно с hosttech_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

Как интерпретировать числовые 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

целое число

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

Должен быть указан ровно один из zone_name и zone_id.

zone_name

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

строка

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

Должен быть указан ровно один из zone_name и zone_id.

Атрибуты

Атрибут

Поддержка

Описание

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_set_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_info:
    zone_name: foo.com
    record: new.foo.com
    type: A
    hosttech_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

словарь

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

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

Пример: {"comment": ""}

prefix

строка

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

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

Пример: "sample"

record

строка

Имя записи.

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

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

ttl

целое число

TTL.

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

Пример: 3600

type

строка

Тип записи DNS.

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

Пример: "A"

value

строка

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

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

Пример: "1.2.3.4"

zone_id

целое число

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

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

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

Spec-Zone.ru

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