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

Примечание

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

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

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

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

Новый в cisco.dnac 3.1.0

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

Описание

Получение всех данных о близости клиентов.
Этот API-интерфейс предоставит информацию о близости клиентов для конкретного беспроводного пользователя. Близость определяется присутствием в одном этаже в одно и то же время, что и указанный беспроводной пользователь. Рабочий процесс близости требует подписки на следующее событие через рабочий процесс уведомления о событиях до выполнения этого вызова API: NETWORK- CLIENTS-3-506 - Отчет о близости клиентов.

Примечание

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

Требования

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

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	Дополнительные заголовки.
number_days float	Параметр number_days запроса. Количество дней для отслеживания близости до текущей даты. По умолчанию и максимум до 14 дней.
time_resolution float	Параметр time_resolution запроса. Интервал времени (в минутах) для измерения близости. По умолчанию 15 минут с минимальными 5 минутами.
username string	Параметр username запроса. Имя пользователя беспроводного клиента, для которого требуется информация о близости.
validate_response_schema boolean	Флаг для Cisco DNA Center SDK для включения проверки тел запросов на соответствие схеме JSON. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

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

См. также

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

Примеры

- name: Get all Client Proximity
  cisco.dnac.client_proximity_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}}"
    username: string
    number_days: 0
    time_resolution: 0
  register: result

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

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

Ключ	Описание
dnac_response словарь	Словарь или список с ответом, возвращаемым Cisco DNAC Python SDK Возвращается: всегда Пример: `{"executionId": "string", "executionStatusUrl": "string", "message": "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_proximity_info_module.html