Spec-Zone.ru › Ansible 2.6

dnsmadeeasy - Взаимодействие с dnsmadeeasy.com (услугой хостинга DNS).

Новое в версии 1.3.

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

Описание

  • Управляет записями DNS через REST API v2 службы DNS Made Easy. Обрабатывает только записи; манипуляции с доменами или поддержкой мониторинга/аккаунта пока отсутствуют. См.: https://www.dnsmadeeasy.com/integration/restapi/

Требования

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

  • hashlib
  • hmac

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
account_key
обязательно
Ключ API аккаунта.
account_secret
обязательно
Секретный ключ аккаунта.
autoFailover
bool

(добавлен в 2.4)
    Варианты:
  • нет ←
  • да
Если значение true, откат к основному IP-адресу выполняется вручную после переключения.
Если значение false, откат к основному IP-адресу выполняется автоматически после переключения.
contactList
обязательно

(добавлен в 2.4)
Значение по умолчанию:
""
Имя или идентификатор списка контактов, которым будет отправляться уведомление от мониторинга.
Значение по умолчанию '' означает владельца аккаунта.
domain
обязательно
Домен для работы. Может быть именем домена (например, "mydomain.com") или числовым идентификатором домена в DNS Made Easy (например, "839989") для более быстрого разрешения.
failover
bool

(добавлен в 2.4)
    Варианты:
  • нет ←
  • да
Если yes, добавить или изменить переключение.
Это применимо только к записям типа A.
httpFile
(добавлен в 2.4)
Файл по адресу Fqdn, запрашиваемый монитором для HTTP или HTTPS.
httpFqdn
(добавлен в 2.4)
Полное доменное имя, используемое монитором.
httpQueryString
(добавлен в 2.4)
Строка в httpFile, запрашиваемая монитором для HTTP или HTTPS.
ip1
(добавлен в 2.4)
Основной IP-адрес для переключения.
Требуется при добавлении или изменении монитора или переключения.
ip2
(добавлен в 2.4)
Дополнительный IP-адрес для переключения.
Требуется при добавлении или изменении переключения.
ip3
(добавлен в 2.4)
Третичный IP-адрес для переключения.
ip4
(добавлен в 2.4)
Четвертичный IP-адрес для переключения.
ip5
(добавлен в 2.4)
Пятеричный IP-адрес для переключения.
maxEmails
обязательно

(добавлен в 2.4)
Значение по умолчанию:
1
Количество электронных писем, отправляемых в список контактов монитором.
monitor
bool

(добавлен в 2.4)
    Варианты:
  • нет ←
  • да
Если yes, добавить или изменить монитор. Это применимо только к записям типа A.
port
обязательно

(добавлен в 2.4)
Значение по умолчанию:
80
Порт, используемый монитором.
protocol
обязательно

(добавлен в 2.4)
    Варианты:
  • TCP
  • UDP
  • HTTP ←
  • DNS
  • SMTP
  • HTTPS
Протокол, используемый монитором.
record_name
Имя записи для получения/создания/удаления/обновления. Если record_name не указан; все записи для домена будут возвращены в элементе "result", независимо от аргумента state.
record_ttl Значение по умолчанию:
1800
«Время жизни» записи. Количество секунд, в течение которого запись остается кэшированной в серверах DNS.
record_type
    Варианты:
  • A
  • AAAA
  • CNAME
  • ANAME
  • HTTPRED
  • MX
  • NS
  • PTR
  • SRV
  • TXT
Тип записи.
record_value
Значение записи. HTTPRED: <URL перенаправления>, MX: <приоритет> <целевое имя>, NS: <сервер имен>, PTR: <целевое имя>, SRV: <приоритет> <вес> <порт> <целевое имя>, TXT: <текстовое значение>.
Если record_value не указан; никаких изменений не будет внесено, и запись будет возвращена в 'result' (другими словами, этот модуль может использоваться для извлечения текущего идентификатора, типа и TTL записи).
sensitivity
обязательно

(добавлен в 2.4)
    Варианты:
  • Низкая
  • Средняя ←
  • Высокая
Количество проверок, выполняемых монитором перед переключением, где Низкая = 8, Средняя = 5, а Высокая = 3.
state
обязательно
    Варианты:
  • present
  • absent
указывает, должна ли запись существовать или нет
systemDescription
обязательно

(добавлен в 2.4)
Значение по умолчанию:
""
Описание, используемое монитором.
validate_certs
bool

(добавлен в 1.5.1)
    Варианты:
  • нет
  • да ←
Если no, сертификаты SSL не будут проверяться. Это следует использовать только на сайтах под личным контролем, использующих самозаверяющие сертификаты.

Примечания

Примечание

  • Услуга DNS Made Easy требует, чтобы машины, взаимодействующие с API, имели правильно установленное время и часовой пояс. Убедитесь, что вы находитесь в пределах нескольких секунд от фактического времени, используя NTP.
  • Этот модуль возвращает запись(и) и монитор(ы) в элементе «result», когда ‘state’ установлено в ‘present’. Эти значения могут быть зарегистрированы и использованы в ваших playbook.
  • Только записи типа A могут иметь монитор или переключение.
  • Для добавления переключения требуются параметры ‘failover’, ‘autoFailover’, ‘port’, ‘protocol’, ‘ip1’ и ‘ip2’.
  • Для добавления монитора требуются параметры ‘monitor’, ‘port’, ‘protocol’, ‘maxEmails’, ‘systemDescription’ и ‘ip1’.
  • Монитор и переключение будут использовать общие параметры ‘port’, ‘protocol’ и ‘ip1’.

Примеры

# fetch my.com domain records
- dnsmadeeasy:
    account_key: key
    account_secret: secret
    domain: my.com
    state: present
  register: response

# create / ensure the presence of a record
- dnsmadeeasy:
    account_key: key
    account_secret: secret
    domain: my.com
    state: present
    record_name: test
    record_type: A
    record_value: 127.0.0.1

# update the previously created record
- dnsmadeeasy:
    account_key: key
    account_secret: secret
    domain: my.com
    state: present
    record_name: test
    record_value: 192.0.2.23

# fetch a specific record
- dnsmadeeasy:
    account_key: key
    account_secret: secret
    domain: my.com
    state: present
    record_name: test
  register: response

# delete a record / ensure it is absent
- dnsmadeeasy:
    account_key: key
    account_secret: secret
    domain: my.com
    record_type: A
    state: absent
    record_name: test

# Add a failover
- dnsmadeeasy:
    account_key: key
    account_secret: secret
    domain: my.com
    state: present
    record_name: test
    record_type: A
    record_value: 127.0.0.1
    failover: True
    ip1: 127.0.0.2
    ip2: 127.0.0.3

- dnsmadeeasy:
    account_key: key
    account_secret: secret
    domain: my.com
    state: present
    record_name: test
    record_type: A
    record_value: 127.0.0.1
    failover: True
    ip1: 127.0.0.2
    ip2: 127.0.0.3
    ip3: 127.0.0.4
    ip4: 127.0.0.5
    ip5: 127.0.0.6

# Add a monitor
- dnsmadeeasy:
    account_key: key
    account_secret: secret
    domain: my.com
    state: present
    record_name: test
    record_type: A
    record_value: 127.0.0.1
    monitor: yes
    ip1: 127.0.0.2
    protocol: HTTP  # default
    port: 80  # default
    maxEmails: 1
    systemDescription: Monitor Test A record
    contactList: my contact list

# Add a monitor with http options
- dnsmadeeasy:
    account_key: key
    account_secret: secret
    domain: my.com
    state: present
    record_name: test
    record_type: A
    record_value: 127.0.0.1
    monitor: yes
    ip1: 127.0.0.2
    protocol: HTTP  # default
    port: 80  # default
    maxEmails: 1
    systemDescription: Monitor Test A record
    contactList: 1174  # contact list id
    httpFqdn: http://my.com
    httpFile: example
    httpQueryString: some string

# Add a monitor and a failover
- dnsmadeeasy:
    account_key: key
    account_secret: secret
    domain: my.com
    state: present
    record_name: test
    record_type: A
    record_value: 127.0.0.1
    failover: True
    ip1: 127.0.0.2
    ip2: 127.0.0.3
    monitor: yes
    protocol: HTTPS
    port: 443
    maxEmails: 1
    systemDescription: monitoring my.com status
    contactList: emergencycontacts

# Remove a failover
- dnsmadeeasy:
    account_key: key
    account_secret: secret
    domain: my.com
    state: present
    record_name: test
    record_type: A
    record_value: 127.0.0.1
    failover: no

# Remove a monitor
- dnsmadeeasy:
    account_key: key
    account_secret: secret
    domain: my.com
    state: present
    record_name: test
    record_type: A
    record_value: 127.0.0.1
    monitor: no

Статус

Этот модуль помечен как превью, что означает, что его интерфейс не гарантирует обратную совместимость.

Техническое обслуживание

Этот модуль помечен как сообщество, что означает, что его поддерживает сообщество Ansible. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.

Список других модулей, поддерживаемых сообществом Ansible, см. в этом разделе.

Автор

  • Брис Берджесс (@briceburg)

Подсказка

Если вы обнаружите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/dnsmadeeasy_module.html

Spec-Zone.ru

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