Модуль cisco.dnac.client_detail_info — Модуль информации для деталей клиента

Примечание

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

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

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

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

Новое в cisco.dnac 3.1.0

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

Описание

Получение всех деталей клиента.
Возвращает подробную информацию о клиенте, полученную по адресу MAC в любой момент времени.

Примечание

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

Требования

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

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 dictionary	Дополнительные заголовки.
macAddress string	Параметр запроса macAddress. MAC-адрес клиента.
timestamp float	Параметр запроса timestamp. Время эпохи (в миллисекундах), когда требуются данные о состоянии клиента.
validate_response_schema boolean	Флаг для Cisco DNA Center SDK, чтобы включить валидацию заголовков запросов с помощью JSON-схемы. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Используемые методы SDK — clients.Clients.get_client_detail,
Используемые пути — get /dna/intent/api/v1/client-detail,
Поддерживает check_mode
Плагин работает на узле управления и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключения Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения

См. также

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

Примеры

- name: Get all Client Detail
  cisco.dnac.client_detail_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}}"
    macAddress: string
    timestamp: 0
  register: result

Возвращаемые значения

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

Ключ	Описание
dnac_response dictionary	Словарь или список с ответом, возвращенным Cisco DNAC Python SDK Возвращается: всегда Пример: {"connectionInfo": {"band": "string", "channel": "string", "channelWidth": "string", "hostType": "string", "nwDeviceMac": "string", "nwDeviceName": "string", "protocol": "string", "spatialStream": "string", "timestamp": 0, "uapsd": "string", "wmm": "string"}, "detail": {"aaaServerEAPLatency": 0, "aaaServerFailedTransaction": 0, "aaaServerIp": "string", "aaaServerLatency": 0, "aaaServerMABLatency": 0, "aaaServerSuccessTransaction": 0, "aaaServerTransaction": 0, "apGroup": "string", "authType": "string", "avgRssi": "string", "avgSnr": "string", "bridgeVMMode": "string", "channel": "string", "clientConnection": "string", "clientType": "string", "connectedDevice": [{"band": "string", "id": "string", "ip address": "string", "mac": "string", "mgmtIp": "string", "mode": "string", "name": "string", "type": "string"}], "connectedUpn": "string", "connectedUpnId": "string", "connectedUpnOwner": "string", "connectionStatus": "string", "countryCode": "string", "dataRate": "string", "deviceForm": "string", "deviceVendor": "string", "dhcpDeclineIp": "string", "dhcpNakIp": "string", "dhcpServerDOLatency": 0, "dhcpServerFailedTransaction": 0, "dhcpServerIp": "string", "dhcpServerLatency": 0, "dhcpServerRALatency": 0, "dhcpServerSuccessTransaction": 0, "dhcpServerTransaction": 0, "dnsRequest": "string", "dnsResponse": "string", "dot11Protocol": "string", "dot11ProtocolCapability": "string", "duid": "string", "firmwareVersion": "string", "frequency": "string", "healthScore": [{"healthType": "string", "reason": "string", "score": 0}], "hostIpV4": "string", "hostIpV6": ["string"], "hostMac": "string", "hostName": "string", "hostOs": "string", "hostType": "string", "hostVersion": "string", "hwModel": "string", "id": "string", "identifier": "string", "intelCapable": true, "iosCapable": true, "isGuestUPNEndpoint": true, "issueCount": 0, "l2VirtualNetwork": "string", "l3VirtualNetwork": "string", "lastUpdated": 0, "latencyBe": 0, "latencyBg": 0, "latencyVideo": 0, "latencyVoice": 0, "linkSpeed": 0, "linkThreshold": "string", "location": "string", "maxRoamingDuration": "string", "modelName": "string", "onboarding": {"aaaRootcauseList": ["string"], "aaaServerIp": "string", "assocDoneTime": 0, "assocRootcauseList": ["string"], "authDoneTime": 0, "averageAssocDuration": "string", "averageAuthDuration": "string", "averageDhcpDuration": "string", "averageRunDuration": "string", "dhcpDoneTime": 0, "dhcpRootcauseList": ["string"], "dhcpServerIp": "string", "latestRootCauseList": ["string"], "maxAssocDuration": "string", "maxAuthDuration": "string", "maxDhcpDuration": "string", "maxRunDuration": "string", "otherRootcauseList": ["string"]}, "onboardingTime": 0, "port": "string", "portDescription": "string", "powerType": "string", "privateMac": true, "remoteEndDuplexMode": "string", "rssi": "string", "rssiIsInclude": "string", "rssiThreshold": "string", "rxBytes": "string", "rxLinkError": 0, "rxRate": 0, "rxRetryPct": "string", "salesCode": "string", "sessionDuration": "string", "sgt": "string", "slotId": 0, "snr": "string", "snrIsInclude": "string", "snrThreshold": "string", "ssid": "string", "subType": "string", "tracked": "string", "trustDetails": "string", "trustScore": "string", "txBytes": "string", "txLinkError": 0, "txRate": 0, "upnId": "string", "upnName": "string", "upnOwner": "string", "usage": 0, "userId": "string", "versionTime": 0, "vlanId": 0, "vnid": 0, "wlcName": "string", "wlcUuid": "string"}, "topology": {"links": [{"apRadioAdminStatus": "string", "apRadioOperStatus": "string", "id": "string", "interfaceDetails": [{"adminStatus": "string", "clientMacAddress": "string", "connectedDeviceIntName": "string", "duplex": "string", "portMode": "string"}], "label": ["string"], "linkStatus": "string", "portUtilization": 0, "source": "string", "sourceAdminStatus": "string", "sourceDuplexInfo": "string", "sourceInterfaceName": "string", "sourceLinkStatus": "string", "sourcePortMode": "string", "sourcePortVLANInfo": "string", "target": "string", "targetAdminStatus": "string", "targetDuplexInfo": "string", "targetInterfaceName": "string", "targetLinkStatus": "string", "targetPortMode": "string", "targetPortVLANInfo": "string"}], "nodes": [{"clients": 0, "connectedDevice": "string", "count": 0, "description": "string", "deviceType": "string", "fabricGroup": "string", "fabricRole": ["string"], "family": "string", "healthScore": 0, "id": "string", "ip": "string", "ipv6": ["string"], "level": 0, "name": "string", "nodeType": "string", "platformId": "string", "radioFrequency": "string", "role": "string", "softwareVersion": "string", "stackType": "string", "userId": "string"}]}}

Ключ

Описание

dnac_response

dictionary

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

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

Пример: {"connectionInfo": {"band": "string", "channel": "string", "channelWidth": "string", "hostType": "string", "nwDeviceMac": "string", "nwDeviceName": "string", "protocol": "string", "spatialStream": "string", "timestamp": 0, "uapsd": "string", "wmm": "string"}, "detail": {"aaaServerEAPLatency": 0, "aaaServerFailedTransaction": 0, "aaaServerIp": "string", "aaaServerLatency": 0, "aaaServerMABLatency": 0, "aaaServerSuccessTransaction": 0, "aaaServerTransaction": 0, "apGroup": "string", "authType": "string", "avgRssi": "string", "avgSnr": "string", "bridgeVMMode": "string", "channel": "string", "clientConnection": "string", "clientType": "string", "connectedDevice": [{"band": "string", "id": "string", "ip address": "string", "mac": "string", "mgmtIp": "string", "mode": "string", "name": "string", "type": "string"}], "connectedUpn": "string", "connectedUpnId": "string", "connectedUpnOwner": "string", "connectionStatus": "string", "countryCode": "string", "dataRate": "string", "deviceForm": "string", "deviceVendor": "string", "dhcpDeclineIp": "string", "dhcpNakIp": "string", "dhcpServerDOLatency": 0, "dhcpServerFailedTransaction": 0, "dhcpServerIp": "string", "dhcpServerLatency": 0, "dhcpServerRALatency": 0, "dhcpServerSuccessTransaction": 0, "dhcpServerTransaction": 0, "dnsRequest": "string", "dnsResponse": "string", "dot11Protocol": "string", "dot11ProtocolCapability": "string", "duid": "string", "firmwareVersion": "string", "frequency": "string", "healthScore": [{"healthType": "string", "reason": "string", "score": 0}], "hostIpV4": "string", "hostIpV6": ["string"], "hostMac": "string", "hostName": "string", "hostOs": "string", "hostType": "string", "hostVersion": "string", "hwModel": "string", "id": "string", "identifier": "string", "intelCapable": true, "iosCapable": true, "isGuestUPNEndpoint": true, "issueCount": 0, "l2VirtualNetwork": "string", "l3VirtualNetwork": "string", "lastUpdated": 0, "latencyBe": 0, "latencyBg": 0, "latencyVideo": 0, "latencyVoice": 0, "linkSpeed": 0, "linkThreshold": "string", "location": "string", "maxRoamingDuration": "string", "modelName": "string", "onboarding": {"aaaRootcauseList": ["string"], "aaaServerIp": "string", "assocDoneTime": 0, "assocRootcauseList": ["string"], "authDoneTime": 0, "averageAssocDuration": "string", "averageAuthDuration": "string", "averageDhcpDuration": "string", "averageRunDuration": "string", "dhcpDoneTime": 0, "dhcpRootcauseList": ["string"], "dhcpServerIp": "string", "latestRootCauseList": ["string"], "maxAssocDuration": "string", "maxAuthDuration": "string", "maxDhcpDuration": "string", "maxRunDuration": "string", "otherRootcauseList": ["string"]}, "onboardingTime": 0, "port": "string", "portDescription": "string", "powerType": "string", "privateMac": true, "remoteEndDuplexMode": "string", "rssi": "string", "rssiIsInclude": "string", "rssiThreshold": "string", "rxBytes": "string", "rxLinkError": 0, "rxRate": 0, "rxRetryPct": "string", "salesCode": "string", "sessionDuration": "string", "sgt": "string", "slotId": 0, "snr": "string", "snrIsInclude": "string", "snrThreshold": "string", "ssid": "string", "subType": "string", "tracked": "string", "trustDetails": "string", "trustScore": "string", "txBytes": "string", "txLinkError": 0, "txRate": 0, "upnId": "string", "upnName": "string", "upnOwner": "string", "usage": 0, "userId": "string", "versionTime": 0, "vlanId": 0, "vnid": 0, "wlcName": "string", "wlcUuid": "string"}, "topology": {"links": [{"apRadioAdminStatus": "string", "apRadioOperStatus": "string", "id": "string", "interfaceDetails": [{"adminStatus": "string", "clientMacAddress": "string", "connectedDeviceIntName": "string", "duplex": "string", "portMode": "string"}], "label": ["string"], "linkStatus": "string", "portUtilization": 0, "source": "string", "sourceAdminStatus": "string", "sourceDuplexInfo": "string", "sourceInterfaceName": "string", "sourceLinkStatus": "string", "sourcePortMode": "string", "sourcePortVLANInfo": "string", "target": "string", "targetAdminStatus": "string", "targetDuplexInfo": "string", "targetInterfaceName": "string", "targetLinkStatus": "string", "targetPortMode": "string", "targetPortVLANInfo": "string"}], "nodes": [{"clients": 0, "connectedDevice": "string", "count": 0, "description": "string", "deviceType": "string", "fabricGroup": "string", "fabricRole": ["string"], "family": "string", "healthScore": 0, "id": "string", "ip": "string", "ipv6": ["string"], "level": 0, "name": "string", "nodeType": "string", "platformId": "string", "radioFrequency": "string", "role": "string", "softwareVersion": "string", "stackType": "string", "userId": "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/client_detail_info_module.html