Модуль cisco.dnac.maps_import_status_info – Модуль информации о статусе импорта карт

Примечание

Данный модуль является частью коллекции cisco.dnac (версия 6.20.0).

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

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

Для использования в playbook укажите: cisco.dnac.maps_import_status_info.

Новая в cisco.dnac 6.14.0

Обзор
Требования
Параметры
Примечания
См. также
Примеры
Значения возврата

Обзор

Получить статус всех импортов карт.
Получить статус операции импорта архива карты. Для операции импорта архива карты, которая только что была запущена, будет предоставлен результат проверки архива и предварительный просмотр того, что будет выполнено при выполнении импорта. После запроса выполнения импорта этот API предоставит статус импорта и, по завершении, сводку после импорта того, что выполнила операция.

Примечание

Для данного модуля существует соответствующий плагин действия.

Требования

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

dnacentersdk >= 2.7.2
python >= 3.5

Параметры

Параметр	Комментарии
dnac_debug boolean	Флаг для Cisco DNA Center SDK для включения отладки. Варианты: `false` ← (по умолчанию) `true`
dnac_host string / обязательно	Имя хоста Cisco DNA Center.
dnac_password string	Пароль Cisco DNA Center для аутентификации.
dnac_port integer	Порт Cisco DNA Center. По умолчанию: `443`
dnac_username алиасы: user string	Имя пользователя Cisco DNA Center для аутентификации. По умолчанию: `"admin"`
dnac_verify boolean	Флаг для включения или выключения проверки SSL-сертификата. Варианты: `false` `true` ← (по умолчанию)
dnac_version string	Информирует SDK о том, какую версию Cisco DNA Center использовать. По умолчанию: `"2.3.7.6"`
headers словарь	Дополнительные заголовки.
importContextUuid string	Параметр пути importContextUuid. Уникальный UUID контекста импорта, полученный в предыдущем и недавнем вызове API maps/import/start.
validate_response_schema boolean	Флаг для Cisco DNA Center SDK для включения проверки тел запросов на соответствие JSON-схеме. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Используемые методы SDK: sites.Sites.import_map_archive_import_status,
Используемые пути: get /dna/intent/api/v1/maps/import/{importContextUuid}/status,
Поддерживает check_mode
Плагин выполняется на узле управления и не использует плагины подключения ansible, а вместо этого встроенный диспетчер подключений из Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения

См. также

Документация Cisco DNA Center для ImportMapArchiveImportStatus: Полное описание API ImportMapArchiveImportStatus.

Примеры

- name: Get all Maps Import Status
  cisco.dnac.maps_import_status_info:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    headers: "{{my_headers | from_json}}"
    importContextUuid: string
  register: result

Значения возврата

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

Ключ	Описание
dnac_response словарь	Словарь или список с ответом, возвращенным Cisco DNAC Python SDK Возвращается: всегда Пример: `{"auditLog": {"children": [{}], "entitiesCount": [{"key": 0}], "entityName": "string", "entityType": "string", "errorEntitiesCount": [{"key": 0}], "errors": [{"message": "string"}], "infos": [{"message": "string"}], "matchingEntitiesCount": [{"key": 0}], "subTasksRootTaskId": "string", "successfullyImportedFloors": ["string"], "warnings": [{"message": "string"}]}, "status": "string", "uuid": {"leastSignificantBits": 0, "mostSignificantBits": 0}}`

Ключ

Описание

dnac_response

словарь

Словарь или список с ответом, возвращенным Cisco DNAC Python SDK

Возвращается: всегда

Пример: {"auditLog": {"children": [{}], "entitiesCount": [{"key": 0}], "entityName": "string", "entityType": "string", "errorEntitiesCount": [{"key": 0}], "errors": [{"message": "string"}], "infos": [{"message": "string"}], "matchingEntitiesCount": [{"key": 0}], "subTasksRootTaskId": "string", "successfullyImportedFloors": ["string"], "warnings": [{"message": "string"}]}, "status": "string", "uuid": {"leastSignificantBits": 0, "mostSignificantBits": 0}}

Авторы

Rafael Campos (@racampos)

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

© 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/cisco/dnac/maps_import_status_info_module.html