Модуль community.general.dnsimple_info — получение основных сведений из API DNSimple

Примечание

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

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

Для установки используйте: ansible-galaxy collection install community.general.

Чтобы использовать модуль в плейбуке, укажите: community.general.dnsimple_info.

Добавлено в community.general 4.2.0

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

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

Получение существующих записей и доменов через API DNSimple.

Параметры

Параметр	Комментарии
account_id string / required	Идентификатор учетной записи для запроса.
api_key string / required	Используемый ключ API.
name string	Имя домена, сведения о котором требуется получить. Если параметр указан, возвращаются все связанные с этим доменом записи. Если параметр не указан, возвращаются все домены, связанные с идентификатором учетной записи.
record string	Запись для поиска. Если параметр указан, возвращается только эта запись, а не все записи.
sandbox boolean	Использовать ли среду песочницы. Варианты: `false` ← (по умолчанию) `true`

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: full Это действие не изменяет состояние.	Модуль может работать в режиме `check_mode` и возвращать прогноз изменения статуса без изменения целевого объекта.
diff_mode	Поддержка: N/A Это действие не изменяет состояние.	В режиме сравнения возвращает сведения об изменениях (или о том, что, возможно, необходимо изменить в `check_mode`).

Примеры

- name: Get all domains from an account
  community.general.dnsimple_info:
    account_id: "1234"
    api_key: "1234"

- name: Get all records from a domain
  community.general.dnsimple_info:
    name: "example.com"
    account_id: "1234"
    api_key: "1234"

- name: Get all info from a matching record
  community.general.dnsimple_info:
    name: "example.com"
    record: "subdomain"
    account_id: "1234"
    api_key: "1234"

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

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

Ключ	Описание
dnsimple_domain_info list / elements=dictionary	Возвращает список словарей со всеми доменами, связанными с указанным идентификатором учетной записи. Возвращается: при успешном выполнении, если `name` не указан Пример: `[{"account_id": 1234, "created_at": "2021-10-16T21:25:42Z", "id": 123456, "last_transferred_at": null, "name": "example.com", "reverse": false, "secondary": false, "updated_at": "2021-11-10T20:22:50Z"}]`
account_id integer	Идентификатор учетной записи. Возвращается: при успешном выполнении
created_at string	Время создания записи домена. Возвращается: при успешном выполнении
id integer	Идентификатор записи. Возвращается: при успешном выполнении
last_transferred_at string	Дата переноса домена или пустое значение, если переноса не было. Возвращается: при успешном выполнении
name string	Имя записи. Возвращается: при успешном выполнении
reverse boolean	Является ли запись записью обратной зоны. Возвращается: при успешном выполнении
updated_at string	Время обновления записи домена. Возвращается: при успешном выполнении
dnsimple_record_info list / elements=dictionary	Возвращает список словарей, соответствующих указанной записи. Возвращается: при успешном выполнении, если указаны `name` и `record` Пример: `[{"content": "1.2.3.4", "created_at": "2021-11-15T23:55:51Z", "id": 123456, "name": "catheadbiscuit", "parent_id": null, "priority": null, "regions": ["global"], "system_record": false, "ttl": 3600, "type": "A", "updated_at": "2021-11-15T23:55:51Z", "zone_id": "example.com"}]`
content string	Содержимое возвращенной записи. Возвращается: при успешном выполнении
created_at string	Время создания записи домена. Возвращается: при успешном выполнении
id integer	Идентификатор записи. Возвращается: при успешном выполнении
name string	Имя записи. Возвращается: при успешном выполнении
parent_id integer	Родительская запись или null. Возвращается: при успешном выполнении
priority string	Значение приоритета записи. Возвращается: при успешном выполнении
regions list / elements=string	Список регионов, в которых доступна запись. Возвращается: при успешном выполнении
system_record boolean	Является ли запись системной. Возвращается: при успешном выполнении
ttl integer	TTL записи. Возвращается: при успешном выполнении
type string	Тип записи. Возвращается: при успешном выполнении
updated_at string	Время обновления записи домена. Возвращается: при успешном выполнении
zone_id string	Идентификатор зоны, с которой связана запись. Возвращается: при успешном выполнении
dnsimple_records_info list / elements=dictionary	Возвращает список словарей со всеми записями указанного домена. Возвращается: при успешном выполнении, если указан `name`, но не указан `record` Пример: `[{"content": "ns1.dnsimple.com admin.dnsimple.com", "created_at": "2021-10-16T19:07:34Z", "id": 12345, "name": "catheadbiscuit", "parent_id": null, "priority": null, "regions": ["global"], "system_record": true, "ttl": 3600, "type": "SOA", "updated_at": "2021-11-15T23:55:51Z", "zone_id": "example.com"}]`
content string	Содержимое возвращенной записи. Возвращается: при успешном выполнении
created_at string	Время создания записи домена. Возвращается: при успешном выполнении
id integer	Идентификатор записи. Возвращается: при успешном выполнении
name string	Имя записи. Возвращается: при успешном выполнении
parent_id integer	Родительская запись или null. Возвращается: при успешном выполнении
priority string	Значение приоритета записи. Возвращается: при успешном выполнении
regions list / elements=string	Список регионов, в которых доступна запись. Возвращается: при успешном выполнении
system_record boolean	Является ли запись системной. Возвращается: при успешном выполнении
ttl integer	TTL записи. Возвращается: при успешном выполнении
type string	Тип записи. Возвращается: при успешном выполнении
updated_at string	Время обновления записи домена. Возвращается: при успешном выполнении
zone_id string	Идентификатор зоны, с которой связана запись. Возвращается: при успешном выполнении

Авторы

Edward Hilgendorf (@edhilgendorf)

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

© 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_info_module.html