Модуль cisco.dnac.wireless_accesspoint_configuration_summary_info – Модуль информации для сводного обзора конфигурации беспроводного точки доступа

Примечание

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

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

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

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

Добавлена в cisco.dnac 3.1.0

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

Обзор

Получение сводного обзора конфигурации всех беспроводных точек доступа.
Пользователи могут запросить информацию о конфигурации точки доступа по MAC-адресу Ethernet.

Примечание

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

Требования

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

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

Примечания

Примечание

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

См. также

Документация Cisco DNA Center для Wireless GetAccessPointConfiguration: Полное описание API GetAccessPointConfiguration.

Примеры

- name: Get all Wireless Accesspoint Configuration Summary
  cisco.dnac.wireless_accesspoint_configuration_summary_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}}"
    key: string
  register: result

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

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

Ключ	Описание
dnac_response dictionary	Словарь или список с ответом, возвращённым Cisco DNAC Python SDK Возвращается: всегда Пример: {"_creationOrderIndex": 0, "_isBeingChanged": true, "_orderedListOEAssocName": {}, "_orderedListOEIndex": 0, "adminStatus": "string", "apHeight": 0, "apMode": "string", "apName": "string", "authEntityClass": {}, "authEntityId": {}, "changeLogList": {}, "deployPending": "string", "displayName": "string", "ethMac": "string", "failoverPriority": "string", "instanceCreatedOn": {}, "instanceId": 0, "instanceOrigin": {}, "instanceTenantId": "string", "instanceUpdatedOn": {}, "instanceUuid": {}, "instanceVersion": 0, "internalKey": {"id": 0, "longType": "string", "type": "string", "url": "string"}, "lazyLoadedEntities": {}, "ledBrightnessLevel": 0, "ledStatus": "string", "location": "string", "macAddress": "string", "meshDTOs": [{}], "primaryControllerName": "string", "primaryIpAddress": "string", "radioDTOs": [{"_creationOrderIndex": 0, "_isBeingChanged": true, "_orderedListOEAssocName": {}, "_orderedListOEIndex": 0, "adminStatus": "string", "antennaAngle": 0, "antennaElevAngle": 0, "antennaGain": 0, "antennaPatternName": "string", "authEntityClass": {}, "authEntityId": {}, "changeLogList": {}, "channelAssignmentMode": "string", "channelNumber": 0, "channelWidth": "string", "cleanAirSI": "string", "deployPending": "string", "displayName": "string", "ifType": 0, "ifTypeValue": "string", "instanceCreatedOn": {}, "instanceId": 0, "instanceOrigin": {}, "instanceTenantId": "string", "instanceUpdatedOn": {}, "instanceUuid": {}, "instanceVersion": 0, "internalKey": {"id": 0, "longType": "string", "type": "string", "url": "string"}, "lazyLoadedEntities": {}, "macAddress": "string", "powerAssignmentMode": "string", "powerlevel": 0, "radioBand": {}, "radioRoleAssignment": {}, "slotId": 0}], "secondaryControllerName": "string", "secondaryIpAddress": "string", "tertiaryControllerName": "string", "tertiaryIpAddress": "string"}

Ключ

Описание

dnac_response

dictionary

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

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

Пример: {"_creationOrderIndex": 0, "_isBeingChanged": true, "_orderedListOEAssocName": {}, "_orderedListOEIndex": 0, "adminStatus": "string", "apHeight": 0, "apMode": "string", "apName": "string", "authEntityClass": {}, "authEntityId": {}, "changeLogList": {}, "deployPending": "string", "displayName": "string", "ethMac": "string", "failoverPriority": "string", "instanceCreatedOn": {}, "instanceId": 0, "instanceOrigin": {}, "instanceTenantId": "string", "instanceUpdatedOn": {}, "instanceUuid": {}, "instanceVersion": 0, "internalKey": {"id": 0, "longType": "string", "type": "string", "url": "string"}, "lazyLoadedEntities": {}, "ledBrightnessLevel": 0, "ledStatus": "string", "location": "string", "macAddress": "string", "meshDTOs": [{}], "primaryControllerName": "string", "primaryIpAddress": "string", "radioDTOs": [{"_creationOrderIndex": 0, "_isBeingChanged": true, "_orderedListOEAssocName": {}, "_orderedListOEIndex": 0, "adminStatus": "string", "antennaAngle": 0, "antennaElevAngle": 0, "antennaGain": 0, "antennaPatternName": "string", "authEntityClass": {}, "authEntityId": {}, "changeLogList": {}, "channelAssignmentMode": "string", "channelNumber": 0, "channelWidth": "string", "cleanAirSI": "string", "deployPending": "string", "displayName": "string", "ifType": 0, "ifTypeValue": "string", "instanceCreatedOn": {}, "instanceId": 0, "instanceOrigin": {}, "instanceTenantId": "string", "instanceUpdatedOn": {}, "instanceUuid": {}, "instanceVersion": 0, "internalKey": {"id": 0, "longType": "string", "type": "string", "url": "string"}, "lazyLoadedEntities": {}, "macAddress": "string", "powerAssignmentMode": "string", "powerlevel": 0, "radioBand": {}, "radioRoleAssignment": {}, "slotId": 0}], "secondaryControllerName": "string", "secondaryIpAddress": "string", "tertiaryControllerName": "string", "tertiaryIpAddress": "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/wireless_accesspoint_configuration_summary_info_module.html