Модуль cisco.dnac.pnp_device_history_info – Информационный модуль для истории устройств Pnp

Примечание

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

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

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

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

Новая в cisco.dnac 3.1.0

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

Описание

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

Примечание

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

Требования

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

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 словарь	Дополнительные заголовки.
serialNumber строка	Параметр запроса serialNumber. Серийный номер устройства.
sort список / элементы=строка	Параметр запроса sort. Список полей для сортировки, разделенных запятыми.
sortOrder строка	Параметр запроса sortOrder. Порядок сортировки: возрастающий (asc) или убывающий (des).
validate_response_schema boolean	Флаг для Cisco DNA Center SDK, который включает валидацию тел запросов по схеме JSON. Выбираемые значения: `false` `true` ← (по умолчанию)

Примечания

Примечание

Используемые методы SDK: device_onboarding_pnp.DeviceOnboardingPnp.get_device_history,
Используемые пути: get /dna/intent/api/v1/onboarding/pnp-device/history,
Поддерживает check_mode
Плагин выполняется на узле управления и не использует плагины подключения ansible, а вместо этого встроенный менеджер подключения из Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения

См. также

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

Примеры

- name: Get all Pnp Device History
  cisco.dnac.pnp_device_history_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}}"
    serialNumber: string
    sort: []
    sortOrder: string
  register: result

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

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

Ключ	Описание
dnac_response словарь	Словарь или список с ответом, возвращённым Cisco DNAC Python SDK Возвращается: всегда Пример: `{"response": [{"details": "string", "errorFlag": true, "historyTaskInfo": {"addnDetails": [{"key": "string", "value": "string"}], "name": "string", "timeTaken": 0, "type": "string", "workItemList": [{"command": "string", "endTime": 0, "outputStr": "string", "startTime": 0, "state": "string", "timeTaken": 0}]}, "timestamp": 0}], "statusCode": 0}`

Ключ

Описание

dnac_response

словарь

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

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

Пример: {"response": [{"details": "string", "errorFlag": true, "historyTaskInfo": {"addnDetails": [{"key": "string", "value": "string"}], "name": "string", "timeTaken": 0, "type": "string", "workItemList": [{"command": "string", "endTime": 0, "outputStr": "string", "startTime": 0, "state": "string", "timeTaken": 0}]}, "timestamp": 0}], "statusCode": 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/pnp_device_history_info_module.html