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

Примечание

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

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

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

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

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

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

Управляет DNS-записями с помощью API Netcup. См. документацию: https://ccp.netcup.net/run/webservice/servers/endpoint.php.

Требования

Следующие требования должны быть выполнены на узле, который выполняет этот модуль.

nc-dnsapi >= 0.1.3

Параметры

Параметр	Комментарии
api_key string / обязательный	Ключ API для аутентификации. Его необходимо получить в CCP netcup (https://ccp.netcup.net).
api_password string / обязательный	Пароль API для аутентификации. Его необходимо получить в CCP netcup (https://ccp.netcup.net).
customer_id integer / обязательный	Идентификатор клиента Netcup.
domain string / обязательный	Домен, для которого следует добавить или удалить записи.
priority integer	Приоритет записи. Обязателен для `type=MX`.
record псевдонимы: name string	Запись для добавления или удаления; поддерживаются подстановочные символы (``). По умолчанию используется `@` (то есть имя зоны). По умолчанию:* `"@"`
solo boolean	Должна ли эта запись быть единственной записью с таким типом и именем. Используйте только с `state=present`. Удаляет все остальные записи с тем же именем и типом. Варианты: `false` ← (по умолчанию) `true`
state string	Должна ли запись существовать. Варианты: `"present"` ← (по умолчанию) `"absent"`
timeout integer добавлен в community.general 5.7.0	Тайм-аут HTTP(S)-соединения в секундах. По умолчанию: `5`
type string / обязательный	Тип записи. Поддержка `OPENPGPKEY`, `SMIMEA` и `SSHFP` добавлена в community.general 8.1.0. Для типов записей `OPENPGPKEY` и `SMIMEA` требуется nc-dnsapi >= 0.1.5. Для типа записи `SSHFP` требуется nc-dnsapi >= 0.1.6. Варианты: `"A"` `"AAAA"` `"MX"` `"CNAME"` `"CAA"` `"SRV"` `"TXT"` `"TLSA"` `"NS"` `"DS"` `"OPENPGPKEY"` `"SMIMEA"` `"SSHFP"`
value string / обязательный	Значение записи.

Атрибуты

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

Примеры

- name: Create a record of type A
  community.general.netcup_dns:
    api_key: "..."
    api_password: "..."
    customer_id: "..."
    domain: "example.com"
    name: "mail"
    type: "A"
    value: "127.0.0.1"

- name: Delete that record
  community.general.netcup_dns:
    api_key: "..."
    api_password: "..."
    customer_id: "..."
    domain: "example.com"
    name: "mail"
    type: "A"
    value: "127.0.0.1"
    state: absent

- name: Create a wildcard record
  community.general.netcup_dns:
    api_key: "..."
    api_password: "..."
    customer_id: "..."
    domain: "example.com"
    name: "*"
    type: "A"
    value: "127.0.1.1"

- name: Set the MX record for example.com
  community.general.netcup_dns:
    api_key: "..."
    api_password: "..."
    customer_id: "..."
    domain: "example.com"
    type: "MX"
    value: "mail.example.com"

- name: Set a record and ensure that this is the only one
  community.general.netcup_dns:
    api_key: "..."
    api_password: "..."
    customer_id: "..."
    name: "demo"
    domain: "example.com"
    type: "AAAA"
    value: "::1"
    solo: true

- name: Increase the connection timeout to avoid problems with an unstable connection
  community.general.netcup_dns:
    api_key: "..."
    api_password: "..."
    customer_id: "..."
    domain: "example.com"
    name: "mail"
    type: "A"
    value: "127.0.0.1"
    timeout: 30

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

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

Ключ	Описание
records list / элементы=dictionary	Список, содержащий все записи. Возвращается: success
id integer	Внутренний идентификатор записи. Возвращается: success Пример: `12345`
name string	Имя записи. Возвращается: success Пример: `"fancy-hostname"`
priority integer	Приоритет записи (имеет значение только для `records[].type=MX`). Возвращается: success Пример: `0`
type string	Тип записи. Возвращается: success Пример: `"A"`
value string	Адрес назначения записи. Возвращается: success Пример: `"127.0.0.1"`

Авторы

Nicolai Buchwitz (@nbuchwitz)

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

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