модуль community.general.dnsimple — взаимодействие с dnsimple.com (службой DNS-хостинга)

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: 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`) или числовой идентификатор домена в 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/dnsimple_module.html