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

Примечание

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

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

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

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

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

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

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

Требования

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

nc-dnsapi >= 0.1.3

Параметры

Параметр	Комментарии
api_key строка / обязательно	API ключ для аутентификации, должен быть получен через netcup CCP (https://ccp.netcup.net).
api_password строка / обязательно	API пароль для аутентификации, должен быть получен через netcup CCP (https://ccp.netcup.net).
customer_id целое число / обязательно	Идентификатор клиента Netcup.
domain строка / обязательно	Имя домена, в котором должны быть добавлены/удалены записи.
priority целое число	Приоритет записи. Требуется для `type=MX`.
record псевдонимы: name строка	Запись для добавления или удаления, поддерживает подстановочные знаки (``). По умолчанию `@` (то есть имя зоны). По умолчанию:* `"@"`
solo логическое значение	Должна ли запись быть единственной для данного типа записи и имени записи. Используйте только с `state=present`. Это удалит все другие записи с тем же именем и типом записи. Варианты: `false` ← (по умолчанию) `true`
state строка	Должна ли существовать запись или нет. Варианты: `"present"` ← (по умолчанию) `"absent"`
timeout целое число добавлено в community.general 5.7.0	Таймаут HTTP(S) соединения в секундах. По умолчанию: `5`
type строка / обязательно	Тип записи. Поддержка `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 строка / обязательно	Значение записи.

Атрибуты

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

Примеры

- 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 сложный	список, содержащий все записи Возвращаемое значение: успех
id целое число	внутренний идентификатор записи Возвращаемое значение: успех Пример: `12345`
name строка	имя записи Возвращаемое значение: успех Пример: `"fancy-hostname"`
priority целое число	приоритет записи (актуален только если тип=MX) Возвращаемое значение: успех Пример: `0`
type строка	тип записи Возвращаемое значение: успех Пример: `"A"`
value строка	назначение записи Возвращаемое значение: успех Пример: `"127.0.0.1"`

Авторы

Nicolai Buchwitz (@nbuchwitz)

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

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