Модуль community.general.dnsimple_info — Извлечение базовой информации из API DNSimple

Примечание

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

У вас, возможно, уже установлена эта коллекция, если вы используете пакет 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 строка / обязательно	Идентификатор учетной записи для запроса.
api_key строка / обязательно	Ключ API для использования.
name строка	Имя домена для извлечения информации. Если указано, будут возвращены все связанные записи для этого домена. Если не указано, будут возвращены все домены, связанные с идентификатором учетной записи.
record строка	Запись для поиска. Если указано, будет возвращена только эта запись вместо всех записей.
sandbox логическое	Использовать песочницу (sandbox) или нет. Варианты: `false` ← (по умолчанию) `true`

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная Это действие не изменяет состояние.	Может работать в режиме проверки и возвращать прогноз изменений состояния без изменения целевого объекта.
diff_mode	Поддержка: нет Это действие не изменяет состояние.	В режиме сравнения вернет подробности изменений (или, возможно, необходимости изменений в `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	Возвращает список словарей всех доменов, связанных с указанным ID учетной записи. Возвращается: успех, когда `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	ID учетной записи. Возвращается: успех
created_at string	Когда была создана запись домена. Возвращается: успех
id integer	ID записи. Возвращается: успех
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	ID записи. Возвращается: успех
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	ID зоны, с которой связана запись. Возвращается: успех

dnsimple_records_info список / элементы=словарь	Возвращает список словарей со всеми записями для предоставленного домена. Возвращено: успешно, когда `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 строка	Содержимое возвращенной записи. Возвращено: успешно
created_at строка	Время создания записи домена. Возвращено: успешно
id целое число	Идентификатор записи. Возвращено: успешно
name строка	Имя записи. Возвращено: успешно
parent_id целое число	Родительская запись или null. Возвращено: успешно
priority строка	Приоритет записи. Возвращено: успешно
regions список / элементы=строка	Список регионов, где доступна запись. Возвращено: успешно
system_record логическое значение	Является ли это системной записью. Возвращено: успешно
ttl целое число	TTL записи. Возвращено: успешно
type строка	Тип записи. Возвращено: успешно
updated_at строка	Время обновления записи домена. Возвращено: успешно
zone_id строка	Идентификатор зоны, с которой связана запись. Возвращено: успешно

Авторы

Edward Hilgendorf (@edhilgendorf)

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

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