Модуль cisco.dnac.network_device_info – Модуль информации о сетевом устройстве

Примечание

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

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

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

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

Новое в cisco.dnac 3.1.0

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

Описание

Получить все сетевые устройства.
Получить сетевое устройство по id.
Возвращает список сетевых устройств на основе критериев фильтрации, таких как IP-адрес управления, MAC-адрес, имя хоста и т.д.
Возвращает подробные данные о сетевом устройстве для заданного идентификатора устройства.

Примечание

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

Требования

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

dnacentersdk >= 2.7.2
python >= 3.5

Параметры

Параметр	Комментарии
associatedWlcIp список / элементы=строка	Параметр запроса associatedWlcIp.
collectionInterval список / элементы=строка	Параметр запроса CollectionInterval.
collectionStatus список / элементы=строка	Параметр запроса CollectionStatus.
deviceSupportLevel строка	Параметр запроса DeviceSupportLevel.
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"`
errorCode список / элементы=строка	Параметр запроса errorCode.
errorDescription список / элементы=строка	Параметр запроса errorDescription.
family список / элементы=строка	Параметр запроса family.
headers словарь	Дополнительные заголовки.
hostname список / элементы=строка	Параметр запроса hostname.
id строка	Параметр запроса id. Принимает разделенные запятыми идентификаторы и возвращает список сетевых устройств для заданных идентификаторов. Если предоставлены неверные или ненайденные идентификаторы, в списке будет возвращено пустое значение.
license_name список / элементы=строка	Параметр запроса License.name.
license_status список / элементы=строка	Параметр запроса License.status.
license_type список / элементы=строка	Параметр запроса License.type.
limit целое число	Параметр запроса limit. 1 <= limit <= 500 — максимальное количество устройств, возвращаемых в результате.
location список / элементы=строка	Параметр запроса location.
locationName список / элементы=строка	Параметр запроса locationName.
macAddress список / элементы=строка	Параметр запроса macAddress.

END_OF_DOCUMENT_MARKER

managementIpAddress list / elements=string	Параметр запроса ManagementIpAddress.
module_equpimenttype list / elements=string	Параметр запроса Module+equpimenttype.
module_name list / elements=string	Параметр запроса Module+name.
module_operationstatecode list / elements=string	Параметр запроса Module+operationstatecode.
module_partnumber list / elements=string	Параметр запроса Module+partnumber.
module_servicestate list / elements=string	Параметр запроса Module+servicestate.
module_vendorequipmenttype list / elements=string	Параметр запроса Module+vendorequipmenttype.
notSyncedForMinutes list / elements=string	Параметр запроса NotSyncedForMinutes.
offset integer	Параметр запроса Offset. Offset >= 1 X возвращает результаты, начиная с X-го устройства.
platformId list / elements=string	Параметр запроса PlatformId.
reachabilityStatus list / elements=string	Параметр запроса ReachabilityStatus.
role list / elements=string	Параметр запроса Role.
serialNumber list / elements=string	Параметр запроса SerialNumber.
series list / elements=string	Параметр запроса Series.
softwareType list / elements=string	Параметр запроса SoftwareType.
softwareVersion list / elements=string	Параметр запроса SoftwareVersion.
type list / elements=string	Параметр запроса Type.
upTime list / elements=string	Параметр запроса UpTime.
validate_response_schema boolean	Флаг для Cisco DNA Center SDK для включения проверки содержимого запросов на соответствие JSON-схеме. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Используемые методы SDK: devices.Devices.get_device_by_id, devices.Devices.get_device_list,
Используемые пути: get /dna/intent/api/v1/network-device, get /dna/intent/api/v1/network-device/{id},
Поддерживает check_mode
Плагин работает на узле управления и не использует плагины подключения Ansible, а вместо этого использует встроенный менеджер подключений из Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления соединения

См. также

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

Примеры

- name: Get all Network Device
  cisco.dnac.network_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}}"
    hostname: []
    managementIpAddress: []
    macAddress: []
    locationName: []
    serialNumber: []
    location: []
    family: []
    type: []
    series: []
    collectionStatus: []
    collectionInterval: []
    notSyncedForMinutes: []
    errorCode: []
    errorDescription: []
    softwareVersion: []
    softwareType: []
    platformId: []
    role: []
    reachabilityStatus: []
    upTime: []
    associatedWlcIp: []
    license_name: []
    license_type: []
    license_status: []
    module_name: []
    module_equpimenttype: []
    module_servicestate: []
    module_vendorequipmenttype: []
    module_partnumber: []
    module_operationstatecode: []
    id: string
    deviceSupportLevel: string
    offset: 0
    limit: 0
  register: result

- name: Get Network Device by id
  cisco.dnac.network_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 Возвращается: всегда Пример: {"response": {"apEthernetMacAddress": "string", "apManagerInterfaceIp": "string", "associatedWlcIp": "string", "bootDateTime": "string", "collectionInterval": "string", "collectionStatus": "string", "description": "string", "deviceSupportLevel": "string", "dnsResolvedManagementAddress": "string", "errorCode": "string", "errorDescription": "string", "family": "string", "hostname": "string", "id": "string", "instanceTenantId": "string", "instanceUuid": "string", "interfaceCount": "string", "inventoryStatusDetail": "string", "lastDeviceResyncStartTime": "string", "lastUpdateTime": 0, "lastUpdated": "string", "lineCardCount": "string", "lineCardId": "string", "location": "string", "locationName": "string", "macAddress": "string", "managedAtleastOnce": true, "managementIpAddress": "string", "managementState": "string", "memorySize": "string", "pendingSyncRequestsCount": "string", "platformId": "string", "reachabilityFailureReason": "string", "reachabilityStatus": "string", "reasonsForDeviceResync": "string", "reasonsForPendingSyncRequests": "string", "role": "string", "roleSource": "string", "serialNumber": "string", "series": "string", "snmpContact": "string", "snmpLocation": "string", "softwareType": "string", "softwareVersion": "string", "tagCount": "string", "tunnelUdpPort": "string", "type": "string", "upTime": "string", "uptimeSeconds": 0, "vendor": "string", "waasDeviceMode": "string"}, "version": "string"}

Ключ

Описание

dnac_response

словарь

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

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

Пример: {"response": {"apEthernetMacAddress": "string", "apManagerInterfaceIp": "string", "associatedWlcIp": "string", "bootDateTime": "string", "collectionInterval": "string", "collectionStatus": "string", "description": "string", "deviceSupportLevel": "string", "dnsResolvedManagementAddress": "string", "errorCode": "string", "errorDescription": "string", "family": "string", "hostname": "string", "id": "string", "instanceTenantId": "string", "instanceUuid": "string", "interfaceCount": "string", "inventoryStatusDetail": "string", "lastDeviceResyncStartTime": "string", "lastUpdateTime": 0, "lastUpdated": "string", "lineCardCount": "string", "lineCardId": "string", "location": "string", "locationName": "string", "macAddress": "string", "managedAtleastOnce": true, "managementIpAddress": "string", "managementState": "string", "memorySize": "string", "pendingSyncRequestsCount": "string", "platformId": "string", "reachabilityFailureReason": "string", "reachabilityStatus": "string", "reasonsForDeviceResync": "string", "reasonsForPendingSyncRequests": "string", "role": "string", "roleSource": "string", "serialNumber": "string", "series": "string", "snmpContact": "string", "snmpLocation": "string", "softwareType": "string", "softwareVersion": "string", "tagCount": "string", "tunnelUdpPort": "string", "type": "string", "upTime": "string", "uptimeSeconds": 0, "vendor": "string", "waasDeviceMode": "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/network_device_info_module.html