Модуль cisco.dnac.task_info — Модуль информации о задаче

Примечание

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

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

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

Чтобы использовать его в плейбуке, укажите: cisco.dnac.task_info.

Добавлен в cisco.dnac 3.1.0

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

Описание

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

Примечание

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

Требования

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

dnacentersdk >= 2.7.2
python >= 3.5

Параметры

Параметр	Комментарии
data string	Параметр запроса данных. Извлекает задачи, содержащие эти данные.
dnac_debug boolean	Флаг для Cisco DNA Center SDK для включения отладки. Варианты: `false` ← (default) `true`
dnac_host string / required	Имя хоста Cisco DNA Center.
dnac_password string	Пароль Cisco DNA Center для аутентификации.
dnac_port integer	Порт Cisco DNA Center. По умолчанию: `443`
dnac_username aliases: user string	Имя пользователя Cisco DNA Center для аутентификации. По умолчанию: `"admin"`
dnac_verify boolean	Флаг для включения или отключения проверки сертификата SSL. Варианты: `false` `true` ← (default)
dnac_version string	Сообщает SDK, какую версию Cisco DNA Center использовать. По умолчанию: `"2.3.7.6"`
endTime string	Параметр запроса endTime. Это конечное время эпохи, до которого необходимо извлечь записи аудита.
errorCode string	Параметр запроса errorCode. Извлекает задачи, имеющие этот код ошибки.
failureReason string	Параметр запроса failureReason. Извлекает задачи, содержащие эту причину сбоя.
headers dictionary	Дополнительные заголовки.
isError string	Параметр запроса isError. Извлекает задачи, завершившиеся успешно или неудачно. Допустимые значения true, false.
limit integer	Параметр запроса limit.
offset integer	Параметр запроса offset.
order string	Параметр запроса order. Порядок сортировки - asc или dsc.
parentId string	Параметр запроса parentId. Извлекает задачи, имеющие этот идентификатор родителя.
progress string	Параметр запроса progress. Извлекает задачи, содержащие этот прогресс.
serviceType string	Параметр запроса serviceType. Извлекает задачи с этим типом сервиса.
sortBy string	Параметр запроса sortBy. Сортирует результаты по этому полю.
startTime string	Параметр запроса startTime. Это начальное время эпохи, с которого необходимо извлекать задачи.
taskId string	Параметр пути taskId. UUID задачи.
username string	Параметр запроса username. Извлекает задачи с этим именем пользователя.
validate_response_schema boolean	Флаг для Cisco DNA Center SDK для включения проверки тел запросов на соответствие схеме JSON. Варианты: `false` `true` ← (default)

Примечания

Примечание

Используемые методы SDK: task.Task.get_task_by_id, task.Task.get_tasks,
Используемые пути: get /dna/intent/api/v1/task, get /dna/intent/api/v1/task/{taskId},
Поддерживает check_mode
Плагин работает на узле управления и не использует плагины подключения Ansible, а вместо этого встроенный менеджер подключений из Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления соединения

См. также

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

Примеры

- name: Get all Task
  cisco.dnac.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}}"
    startTime: string
    endTime: string
    data: string
    errorCode: string
    serviceType: string
    username: string
    progress: string
    isError: string
    failureReason: string
    parentId: string
    offset: 0
    limit: 0
    sortBy: string
    order: string
  register: result

- name: Get Task by id
  cisco.dnac.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}}"
    taskId: string
  register: result

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

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

Ключ	Описание
dnac_response словарь	Словарь или список со значением, возвращенным Cisco DNAC Python SDK Возвращаемое значение: всегда Пример: `{"response": {"additionalStatusURL": "string", "data": "string", "endTime": 0, "errorCode": "string", "errorKey": "string", "failureReason": "string", "id": "string", "instanceTenantId": "string", "isError": true, "lastUpdate": 0, "operationIdList": {}, "parentId": "string", "progress": "string", "rootId": "string", "serviceType": "string", "startTime": 0, "username": "string", "version": 0}, "version": "string"}`

Ключ

Описание

dnac_response

словарь

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

Возвращаемое значение: всегда

Пример: {"response": {"additionalStatusURL": "string", "data": "string", "endTime": 0, "errorCode": "string", "errorKey": "string", "failureReason": "string", "id": "string", "instanceTenantId": "string", "isError": true, "lastUpdate": 0, "operationIdList": {}, "parentId": "string", "progress": "string", "rootId": "string", "serviceType": "string", "startTime": 0, "username": "string", "version": 0}, "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/task_info_module.html