Spec-Zone.ru › Ansible 2.11

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

Примечание

Этот плагин является частью коллекции community.general (версия 2.0.1).

Для его установки используйте: 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
строка / обязательно
Ключ API для аутентификации, должен быть получен через netcup CCP (https://ccp.netcup.net)
api_password
строка / обязательно
Пароль API для аутентификации, должен быть получен через netcup CCP (https://ccp.netcup.net)
customer_id
целое число / обязательно
Идентификатор клиента Netcup
domain
строка / обязательно
Имя домена, для которого должны быть добавлены/удалены записи
priority
целое число
Приоритет записи. Требуется для type=MX
record
строка
По умолчанию:
"@"
Запись для добавления или удаления, поддерживает подстановку (*) . По умолчанию @ (например, имя зоны).

псевдонимы: имя
solo
логический тип
    Варианты:
  • нет ←
  • да
Определяет, должна ли запись быть единственной для данного типа и имени записи. Используйте только с state=present
Это приведет к удалению всех других записей с тем же именем и типом записи.
state
строка
    Варианты:
  • present ←
  • absent
Указывает, должна ли запись существовать или нет
type
строка / обязательно
    Варианты:
  • A
  • AAAA
  • MX
  • CNAME
  • CAA
  • SRV
  • TXT
  • TLSA
  • NS
  • DS
Тип записи
value
строка / обязательно
Значение записи

Примеры

- 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

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

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

Ключ Возвращаемое значение Описание
records
сложный тип
успех
список, содержащий все записи

id
целое число
успех
внутренний идентификатор записи

Пример:
12345
name
строка
успех
имя записи

Пример:
fancy-hostname
priority
целое число
успех
приоритет записи (актуален только для типа MX)

type
строка
успех
тип записи

Пример:
A
value
строка
успех
назначение записи

Пример:
127.0.0.1


Авторы

  • Nicolai Buchwitz (@nbuchwitz)

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

Spec-Zone.ru

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