Модуль cisco.dnac.issues_info – Информационный модуль для проблем

Примечание

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

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

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

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

Новое в cisco.dnac 3.1.0

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

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

Получение всех проблем.
API для получения списка глобальных проблем, проблем для конкретного устройства или проблемы для MAC-адреса конкретного клиентского устройства.

Примечание

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

Требования

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

dnacentersdk >= 2.7.2
python >= 3.5

Параметры

Параметр	Комментарии
aiDriven строка	Параметр запроса AiDriven. Значение, определяемое ИИ, проблемы: YES или NO (без учёта регистра) (Используйте только тогда, когда macAddress и deviceId не указаны).
deviceId строка	Параметр запроса DeviceId. Значение UUID устройства в содержимом проблемы.
dnac_debug логическое	Флаг для Cisco DNA Center SDK для включения отладки. Варианты: `false` ← (по умолчанию) `true`
dnac_host строка / обязательно	Имя хоста Cisco DNA Center.
dnac_password строка	Пароль Cisco DNA Center для аутентификации.
dnac_port целое число	Порт Cisco DNA Center. По умолчанию: `443`
dnac_username псевдонимы: user строка	Имя пользователя Cisco DNA Center для аутентификации. По умолчанию: `"admin"`
dnac_verify логическое	Флаг для включения или отключения проверки сертификата SSL. Варианты: `false` `true` ← (по умолчанию)
dnac_version строка	Сообщает SDK, какую версию Cisco DNA Center использовать. По умолчанию: `"2.3.7.6"`
endTime число с плавающей точкой	Параметр запроса EndTime. Конечное время в эпохе в миллисекундах временного окна запроса.
headers словарь	Дополнительные заголовки.
issueStatus строка	Параметр запроса IssueStatus. Значение статуса проблемы: ACTIVE, IGNORED, RESOLVED (без учёта регистра).
macAddress строка	Параметр запроса MacAddress. MAC-адрес устройства клиента проблемы (формат xx xx xx xx xx xx).
priority строка	Параметр запроса Priority. Приоритет проблемы: P1, P2, P3 или P4 (без учёта регистра) (Используйте только тогда, когда macAddress и deviceId не указаны).
siteId строка	Параметр запроса SiteId. Значение UUID сайта в содержимом проблемы.
startTime число с плавающей точкой	Параметр запроса StartTime. Начальное время в эпохе в миллисекундах временного окна запроса.
validate_response_schema логическое	Флаг для Cisco DNA Center SDK для включения проверки тел запросов на соответствие схеме JSON. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

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

См. также

Документация Cisco DNA Center по вопросам проблем (Issues): Полная справка по API проблем (Issues).

Примеры

- name: Get all Issues
  cisco.dnac.issues_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: 0
    endTime: 0
    siteId: string
    deviceId: string
    macAddress: string
    priority: string
    issueStatus: string
    aiDriven: string
  register: result

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

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

Ключ	Описание
dnac_response словарь	Словарь или список со значением, возвращённым Cisco DNAC Python SDK Возвращается: всегда Пример: `{"response": [{"aiDriven": "string", "category": "string", "clientMac": "string", "deviceId": "string", "deviceRole": "string", "issueId": "string", "issue_occurence_count": 0, "last_occurence_time": 0, "name": "string", "priority": "string", "siteId": "string", "status": "string"}], "totalCount": "string", "version": "string"}`

Ключ

Описание

dnac_response

словарь

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

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

Пример: {"response": [{"aiDriven": "string", "category": "string", "clientMac": "string", "deviceId": "string", "deviceRole": "string", "issueId": "string", "issue_occurence_count": 0, "last_occurence_time": 0, "name": "string", "priority": "string", "siteId": "string", "status": "string"}], "totalCount": "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/issues_info_module.html