Модуль community.general.dnsimple – Взаимодействие с dnsimple.com (сервис DNS-хостинга)

Примечание

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

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

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

Для использования в playbook, укажите: community.general.dnsimple.

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

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

Управляет доменами и записями через API DNSimple, см. документацию: http://developer.dnsimple.com/.

Требования

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

dnsimple >= 2.0.0

Параметры

Параметр	Комментарии
account_api_token string	Токен API учетной записи. См. `account_email` для получения дополнительной информации.
account_email string	Электронная почта учетной записи. Если пропущено, будут проверены переменные окружения `DNSIMPLE_EMAIL` и `DNSIMPLE_API_TOKEN`. Если они не найдены, будет проверяться файл `.dnsimple`, см.: https://github.com/mikemaccana/dnsimple-python#getting-started. Конфигурационные файлы `.dnsimple` поддерживаются только в dnsimple-python<2.0.0
domain string	Домен для работы. Может быть именем домена (например, «mydomain.com») или числовым ID домена в DNSimple. Если пропущен, будет возвращен список доменов. Если домен указан, но домена не существует, он будет создан.
priority integer	Приоритет записи.
record string	Запись для добавления, если пусто, будет создана запись для домена, поддерживает подстановочный знак (*).
record_ids list / elements=string	Список записей, чтобы убедиться, что они либо существуют, либо не существуют.
sandbox boolean добавлено в community.general 3.5.0	Использовать среду песочницы DNSimple. Требуется отдельная учетная запись в среде песочницы dnsimple. См. https://developer.dnsimple.com/sandbox/ для получения дополнительной информации. Варианты: `false` ← (по умолчанию) `true`
solo boolean	Должна ли запись быть единственной для данного типа записи и имени записи. Использовать только с `state` установленным в `present` для записи. Варианты: `false` ← (по умолчанию) `true`
state string	Должна ли запись существовать или нет. Варианты: `"present"` ← (по умолчанию) `"absent"`
ttl integer	Время жизни (TTL) для новой записи в секундах. По умолчанию: `3600`
type string	Тип создаваемой записи DNS. Варианты: `"A"` `"ALIAS"` `"CNAME"` `"MX"` `"SPF"` `"URL"` `"TXT"` `"NS"` `"SRV"` `"NAPTR"` `"PTR"` `"AAAA"` `"SSHFP"` `"HINFO"` `"POOL"` `"CAA"`
value string	Значение записи. Должно быть указано при попытке убедиться, что запись существует.

Атрибуты

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

Примеры

- name: Authenticate using email and API token and fetch all domains
  community.general.dnsimple:
    account_email: test@example.com
    account_api_token: dummyapitoken
  delegate_to: localhost

- name: Delete a domain
  community.general.dnsimple:
    domain: my.com
    state: absent
  delegate_to: localhost

- name: Create a test.my.com A record to point to 127.0.0.1
  community.general.dnsimple:
    domain: my.com
    record: test
    type: A
    value: 127.0.0.1
  delegate_to: localhost
  register: record

- name: Delete record using record_ids
  community.general.dnsimple:
    domain: my.com
    record_ids: '{{ record["id"] }}'
    state: absent
  delegate_to: localhost

- name: Create a my.com CNAME record to example.com
  community.general.dnsimple:
    domain: my.com
    record: ''
    type: CNAME
    value: example.com
    state: present
  delegate_to: localhost

- name: Change TTL value for a record
  community.general.dnsimple:
    domain: my.com
    record: ''
    type: CNAME
    value: example.com
    ttl: 600
    state: present
  delegate_to: localhost

- name: Delete the record
  community.general.dnsimple:
    domain: my.com
    record: ''
    type: CNAME
    value: example.com
    state: absent
  delegate_to: localhost

Авторы

Alex Coomans (@drcapulet)

Ссылки на сборник

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