Модуль cisco.dnac.network_device_config_task_info – Модуль информации для задачи конфигурации сетевого устройства

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: cisco.dnac.network_device_config_task_info.

Новое в cisco.dnac 6.14.0

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

Обзор

Получить все задачи конфигурации сетевого устройства.
Возвращает подробные сведения о задаче конфигурации по указанному идентификатору.

Примечание

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

Требования

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

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 словарь	Дополнительные заголовки.
parentTaskId строка	Параметр запроса parentTaskId. Идентификатор задачи.
validate_response_schema boolean	Флаг для Cisco DNA Center SDK для включения проверки тел запросов по схеме JSON. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Используемые методы SDK — configuration_archive.ConfigurationArchive.get_config_task_details
Используемые пути — get /dna/intent/api/v1/network-device-config/task
Поддерживает check_mode
Плагин работает на узле управления и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключения из Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения

См. также

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

Примеры

- name: Get all Network Device Config Task
  cisco.dnac.network_device_config_task_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}}"
    parentTaskId: string
  register: result

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

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

Ключ	Описание
dnac_response словарь	Словарь или список со значением ответа, возвращенным Cisco DNAC Python SDK Возвращается: всегда Пример: `{"response": [{"completionTime": 0, "detailMessage": "string", "deviceId": "string", "deviceIpAddress": "string", "errorCode": "string", "failureMessage": "string", "hostName": "string", "parentTaskId": "string", "startTime": 0, "taskId": "string", "taskStatus": "string", "taskType": "string"}], "version": "string"}`

Ключ

Описание

dnac_response

словарь

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

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

Пример: {"response": [{"completionTime": 0, "detailMessage": "string", "deviceId": "string", "deviceIpAddress": "string", "errorCode": "string", "failureMessage": "string", "hostName": "string", "parentTaskId": "string", "startTime": 0, "taskId": "string", "taskStatus": "string", "taskType": "string"}], "version": "string"}

Авторы

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/network_device_config_task_info_module.html