Модуль community.general.nsupdate — управление DNS-записями

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: community.general.nsupdate.

Краткое описание
Требования
Параметры
Атрибуты
Примеры
Возвращаемые значения

Краткое описание

Создание, обновление и удаление DNS-записей с помощью обновлений DDNS.

Требования

На узле, где выполняется этот модуль, необходимы следующие компоненты.

dnspython
gssapi (при использовании аутентификации GSS-TSIG)

Параметры

Параметр	Комментарии
key_algorithm string	Укажите алгоритм ключа, используемый `key_secret`. Используйте `gss-tsig` для аутентификации GSS-TSIG (требуются библиотека gssapi и учётные данные Kerberos). `gss-tsig` добавлен в community.general 12.3.0. Варианты: `"HMAC-MD5.SIG-ALG.REG.INT"` `"hmac-md5"` ← (по умолчанию) `"hmac-sha1"` `"hmac-sha224"` `"hmac-sha256"` `"hmac-sha384"` `"hmac-sha512"` `"gss-tsig"`
key_name string	Используйте имя ключа TSIG для аутентификации на DNS `server`. Не требуется при использовании `key_algorithm=gss-tsig`.
key_secret string	Используйте секретный ключ TSIG, связанный с `key_name`, для аутентификации на `server`. Не требуется при использовании `key_algorithm=gss-tsig`.
port integer	Используйте этот TCP-порт при подключении к `server`. По умолчанию: `53`
protocol string	Задаёт транспортный протокол (TCP или UDP). TCP — рекомендуемый и более надёжный вариант. Варианты: `"tcp"` ← (по умолчанию) `"udp"`
record string / обязательный	Задаёт DNS-запись, которую нужно изменить. Если параметр zone не указан, значение должно быть абсолютным (заканчиваться точкой).
server string / обязательный	Выполняет изменения DNS на этом сервере, указанном IPv4/IPv6-адресом или FQDN. Поддержка FQDN добавлена в community.general 12.3.0.
state string	Управление DNS-записью. Варианты: `"present"` ← (по умолчанию) `"absent"`
ttl integer	Задаёт TTL записи. По умолчанию: `3600`
type string	Задаёт тип записи. По умолчанию: `"A"`
value list / elements=string	Задаёт значение записи.
zone string	DNS-запись изменяется в этой `zone`. Если параметр не указан, выполняется DNS-запрос для определения подходящей зоны.

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: full	Модуль можно запускать в режиме `check_mode`: он возвращает прогнозируемый статус изменений, не изменяя целевой объект.
diff_mode	Поддержка: none	В режиме diff возвращает подробную информацию об изменениях (или о том, что, возможно, требуется изменить в `check_mode`).

Примеры

- name: Add or modify ansible.example.org A to 192.168.1.1"
  community.general.nsupdate:
    key_name: "nsupdate"
    key_secret: "+bFQtBCta7j2vWkjPkAFtgA=="
    server: "10.1.1.1"
    zone: "example.org"
    record: "ansible"
    value: "192.168.1.1"

- name: Add or modify ansible.example.org A to 192.168.1.1, 192.168.1.2 and 192.168.1.3"
  community.general.nsupdate:
    key_name: "nsupdate"
    key_secret: "+bFQtBCta7j2vWkjPkAFtgA=="
    server: "10.1.1.1"
    zone: "example.org"
    record: "ansible"
    value: ["192.168.1.1", "192.168.1.2", "192.168.1.3"]

- name: Remove puppet.example.org CNAME
  community.general.nsupdate:
    key_name: "nsupdate"
    key_secret: "+bFQtBCta7j2vWkjPkAFtgA=="
    server: "10.1.1.1"
    zone: "example.org"
    record: "puppet"
    type: "CNAME"
    state: absent

- name: Add 1.1.168.192.in-addr.arpa. PTR for ansible.example.org
  community.general.nsupdate:
    key_name: "nsupdate"
    key_secret: "+bFQtBCta7j2vWkjPkAFtgA=="
    server: "10.1.1.1"
    record: "1.1.168.192.in-addr.arpa."
    type: "PTR"
    value: "ansible.example.org."
    state: present

- name: Remove 1.1.168.192.in-addr.arpa. PTR
  community.general.nsupdate:
    key_name: "nsupdate"
    key_secret: "+bFQtBCta7j2vWkjPkAFtgA=="
    server: "10.1.1.1"
    record: "1.1.168.192.in-addr.arpa."
    type: "PTR"
    state: absent

- name: Use FQDN for server instead of IP address
  community.general.nsupdate:
    key_name: "nsupdate"
    key_secret: "+bFQtBCta7j2vWkjPkAFtgA=="
    server: "ns1.example.org"
    zone: "example.org"
    record: "ansible"
    value: "192.168.1.1"

- name: Use GSS-TSIG authentication (requires Kerberos credentials)
  community.general.nsupdate:
    key_algorithm: "gss-tsig"
    server: "ns1.example.org"
    zone: "example.org"
    record: "ansible"
    value: "192.168.1.1"

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

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

Ключ	Описание
dns_rc integer	Код возврата `dnspython`. Возвращается: всегда Пример: `4`
dns_rc_str string	Код возврата `dnspython` (строковое представление). Возвращается: всегда Пример: `"REFUSED"`
record string	DNS-запись. Возвращается: при успешном выполнении Пример: `"ansible"`
ttl integer	TTL DNS-записи. Возвращается: при успешном выполнении Пример: `86400`
type string	Тип DNS-записи. Возвращается: при успешном выполнении Пример: `"CNAME"`
value list / elements=string	Значение(я) DNS-записи. Возвращается: при успешном выполнении Пример: `["192.168.1.1"]`
zone string	Зона DNS-записи. Возвращается: при успешном выполнении Пример: `"example.org."`

Авторы

Loic Blot (@nerzhul)

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

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