Модуль cisco.dnac.pnp_device_info – Модуль информации для устройства Pnp
Примечание
Этот модуль является частью коллекции cisco.dnac (версия 6.20.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install cisco.dnac. Для использования этого модуля требуются дополнительные зависимости. Подробности см. в разделе Требования.
Для использования в плейбуке укажите: cisco.dnac.pnp_device_info.
Новинка в cisco.dnac 3.1.0
Обзор
- Получить все устройства Pnp.
- Получить устройство Pnp по идентификатору.
- Возвращает детали устройства, указанные по идентификатору устройства.
- Возвращает список устройств Plug & Play, основанный на фильтрационных критериях. По умолчанию возвращает 50 устройств. Этот конечный пункт поддерживает пагинацию и сортировку.
Примечание
Этот модуль имеет соответствующий плагин действия.
Требования
Ниже перечислены требования, необходимые на хосте, который выполняет этот модуль.
- dnacentersdk >= 2.7.2
- python >= 3.5
Параметры
Параметр | Комментарии |
|---|---|
dnac_debug boolean | Флаг для Cisco DNA Center SDK для включения отладки. Варианты:
|
dnac_host string / required | Имя хоста Cisco DNA Center. |
dnac_password string | Пароль Cisco DNA Center для аутентификации. |
dnac_port integer | Порт Cisco DNA Center. По умолчанию: |
dnac_username aliases: user string | Имя пользователя Cisco DNA Center для аутентификации. По умолчанию: |
dnac_verify boolean | Флаг для включения или отключения проверки сертификата SSL. Варианты:
|
dnac_version string | Сообщает SDK, какую версию Cisco DNA Center использовать. По умолчанию: |
headers dictionary | Дополнительные заголовки. |
hostname string | Параметр запроса hostname. Имя хоста устройства. |
id string | Параметр пути id. |
lastContact boolean | Параметр запроса LastContact. Устройство связалось lastContact > 0. Варианты:
|
limit integer | Параметр запроса limit. Ограничивает количество результатов. |
macAddress string | Параметр запроса MacAddress. MAC-адрес устройства. |
name list / elements=string | Параметр запроса name. Имя устройства. |
offset integer | Параметр запроса offset. Индекс первого результата. |
onbState list / elements=string | Параметр запроса OnbState. Состояние подключения устройства. |
pid list / elements=string | Параметр запроса pid. Идентификатор продукта устройства. |
serialNumber list / elements=string | Параметр запроса SerialNumber. Серийный номер устройства. |
siteName string | Параметр запроса SiteName. Имя площадки устройства. |
smartAccountId list / elements=string | Параметр запроса SmartAccountId. Учетная запись Smart устройства. |
sort list / elements=string | Параметр запроса sort. Список полей для сортировки, разделенных запятыми. |
sortOrder string | Параметр запроса SortOrder. Порядок сортировки: по возрастанию (asc) или по убыванию (des). |
source list / elements=string | Параметр запроса source. Источник устройства. |
state_ list / elements=string | Параметр запроса state. Состояние устройства. |
validate_response_schema boolean | Флаг для Cisco DNA Center SDK, который включает валидацию заголовков запросов по схеме JSON. Варианты:
|
virtualAccountId список / элементы=строка | Параметр запроса VirtualAccountId. Виртуальная учетная запись устройства. |
workflowId список / элементы=строка | Параметр запроса WorkflowId. Идентификатор рабочего процесса устройства. |
workflowName список / элементы=строка | Параметр запроса WorkflowName. Название рабочего процесса устройства. |
Примечания
Примечание
- Используемые методы SDK: device_onboarding_pnp.DeviceOnboardingPnp.get_device_by_id, device_onboarding_pnp.DeviceOnboardingPnp.get_device_list,
- Используемые пути: get /dna/intent/api/v1/onboarding/pnp-device, get /dna/intent/api/v1/onboarding/pnp-device/{id},
- Поддерживает
check_mode - Плагин работает на контрольном узле и не использует плагины подключения Ansible, а вместо этого использует встроенный менеджер подключений Cisco DNAC SDK
- Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения
См. также
См. также
- Документация Cisco DNA Center по Device Onboarding (PnP) GetDeviceById
-
Полная справка по API GetDeviceById.
- Документация Cisco DNA Center по Device Onboarding (PnP) GetDeviceList2
-
Полная справка по API GetDeviceList2.
Примеры
- name: Get all Pnp Device
cisco.dnac.pnp_device_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}}"
limit: 0
offset: 0
sort: []
sortOrder: string
serialNumber: []
state_: []
onbState: []
name: []
pid: []
source: []
workflowId: []
workflowName: []
smartAccountId: []
virtualAccountId: []
lastContact: True
macAddress: string
hostname: string
siteName: string
register: result
- name: Get Pnp Device by id
cisco.dnac.pnp_device_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}}"
id: string
register: result
Значения возврата
Общие значения возврата описаны здесь, следующие — это поля, уникальные для данного модуля:
Ключ | Описание |
|---|---|
dnac_response словарь | Словарь или список со значением, возвращенным Cisco DNAC Python SDK Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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_info_module.html
