Модуль cisco.dnac.task_count_info – Информационный модуль для подсчета задач

Примечание

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

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

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

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

Новое в cisco.dnac 3.1.0

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

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

Получить все подсчеты задач.
Возвращает количество задач.

Примечание

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

Требования

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

dnacentersdk >= 2.7.2
python >= 3.5

Параметры

Параметр	Комментарии
data string	Параметр запроса данных. Извлекает задачи, содержащие эти данные.
dnac_debug boolean	Флаг для Cisco DNA Center SDK для включения отладки. Варианты: `false` ← (по умолчанию) `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` ← (по умолчанию)
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.
parentId string	Параметр запроса parentId. Извлекает задачи, имеющие этот идентификатор родителя.
progress string	Параметр запроса progress. Извлекает задачи, содержащие этот прогресс.
serviceType string	Параметр запроса serviceType. Извлекает задачи с этим типом службы.
startTime string	Параметр запроса startTime. Это начальное время эпохи, с которого необходимо извлекать задачи.
username string	Параметр запроса username. Извлекает задачи с этим именем пользователя.
validate_response_schema boolean	Флаг для Cisco DNA Center SDK для включения проверки текстов запросов на соответствие JSON-схеме. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

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

См. также

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

Примеры

- name: Get all Task Count
  cisco.dnac.task_count_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
  register: result

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

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

Ключ	Описание
dnac_response словарь	Словарь или список со значением, возвращаемым Cisco DNAC Python SDK Возвращается: всегда Пример: `{"response": 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_count_info_module.html