cisco.dnac.sensor модуль — Модуль ресурсов для датчика
Примечание
Этот модуль входит в коллекцию cisco.dnac (версия 6.20.0).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install cisco.dnac. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.
Чтобы использовать его в книге задач, укажите: cisco.dnac.sensor.
Новый в cisco.dnac 3.1.0
Обзор
- Управление операциями создания и удаления ресурса Датчик.
- API намерений для создания шаблона теста SENSOR с новым SSID, существующим SSID или и тем, и другим.
- API намерений для удаления существующего шаблона теста SENSOR.
Примечание
У этого модуля есть соответствующий плагин действий.
Требования
Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.
- dnacentersdk >= 2.7.2
- python >= 3.5
Параметры
Параметр | Комментарии |
|---|---|
apCoverage список / элементы=словарь | Область действия точек доступа сенсора. |
|
bands строка |
Диапазоны Wi-Fi. |
|
numberOfApsToTest целое число |
Количество точек доступа для тестирования. |
|
rssiThreshold целое число |
Пороговое значение RSSI. |
connection строка | Тип подключения для теста: проводное, беспроводное, оба. |
dnac_debug логическое | Флаг для включения отладки в SDK Cisco DNA Center. Варианты:
|
dnac_host строка / обязательно | Имя хоста Cisco DNA Center. |
dnac_password строка | Пароль для аутентификации в Cisco DNA Center. |
dnac_port целое число | Порт Cisco DNA Center. По умолчанию: |
dnac_username псевдонимы: user строка | Имя пользователя Cisco DNA Center для аутентификации. По умолчанию: |
dnac_verify логическое | Флаг для включения/выключения проверки сертификатов SSL. Варианты:
|
dnac_version строка | Указывает SDK, какую версию Cisco DNA Center использовать. По умолчанию: |
encryptionMode строка | Режим шифрования. |
locationInfoList список / элементы=словарь | Список местоположений сенсора. |
|
allSensors логическое |
Использовать все сенсоры в сайте для теста. Варианты:
|
|
customManagementVlan логическое |
Пользовательский VLAN управления. Варианты:
|
|
locationId строка |
UUID сайта. |
|
locationType строка |
Тип сайта. |
|
macAddressList список / элементы=строка |
Список MAC-адресов. |
|
managementVlan строка |
VLAN управления. |
|
siteHierarchy строка |
Иерархия названия сайта. |
modelVersion целое число | Версия модели объекта шаблона теста (должно быть 2). |
name строка | Название шаблона теста сенсора. |
profiles список / элементы=словарь | Профили сенсора. |
|
authProtocol строка |
Протокол аутентификации. |
|
authType string |
Тип аутентификации OPEN, WPA2_PSK, WPA2_EaP, WEB_AUTH, MAB, DOT1X, OTHER. |
|
certdownloadurl string |
URL загрузки сертификата. |
|
certfilename string |
Имя файла сертификата аутентификации. |
|
certpassphrase string |
Пароль сертификата. |
|
certstatus string |
Статус сертификата INACTIVE или ACTIVE. |
|
certxferprotocol string |
Протокол передачи сертификата HTTP или HTTPS. |
|
deviceType string |
Тип устройства. |
|
eapMethod string |
Методы WPA2_EAP EAP-FAST, PEAP-MSCHAPv2, EAP-TLS, PEAP-TLS, EAP-TTLS-MSCHAPv2, EAP-TTLS-PAP, EAP-TTLS-CHAP, EAP-FAST-GTC, EAP-PEAP-GTC. |
|
extWebAuth boolean |
Указание на использование внешней WEB-аутентификации. Варианты:
|
|
extWebAuthAccessUrl string |
URL доступа к внешнему WEB-серверу аутентификации. |
|
extWebAuthHtmlTag list / elements=dictionary |
extWebAuthHtmlTag датчика. |
|
label string |
Метка. |
|
tag string |
Тег. |
|
value string |
Значение. |
|
extWebAuthPortal string |
Внешний портал аутентификации. |
|
extWebAuthVirtualIp string |
Внешний виртуальный IP-адрес WEB-аутентификации. |
|
locationVlanList list / elements=dictionary |
locationVlanList датчика. |
|
locationId string |
UUID сайта. |
|
vlans list / elements=string |
Массив VLAN. |
|
password string |
Строка пароля для подключения к SSID. |
|
passwordType string |
Тип пароля SSID ASCII или HEX. |
|
profileName string |
Имя профиля. |
|
psk string |
Пароль SSID, когда passwordType имеет значение ASCII. |
|
qosPolicy string |
Политика QoS PlATINUM, GOLD, SILVER, BRONZE. |
|
scep boolean |
Протокол безопасной регистрации сертификатов true или false или null, если не применимо. Варианты:
|
|
tests list / elements=dictionary |
Тесты датчика. |
|
config list / elements=dictionary |
Конфигурация датчика. |
|
direction string |
Направление IPerf (UPLOAD, DOWNLOAD, BOTH). |
|
domains list / elements=string |
Имя DNS-домена. |
|
downlinkTest boolean |
Тест нисходящей линии связи. Choices:
|
|
endPort integer |
Конечный порт IPerf. |
|
exitCommand string |
Команда выхода. |
|
finalPrompt string |
Заключительный приглашение. |
|
ndtServer string |
Сервер NDT. |
|
ndtServerPath string |
Путь к серверу NDT. |
|
ndtServerPort string |
Порт сервера NDT. |
|
numPackets integer |
Количество пакетов. |
|
password string |
Пароль. |
|
passwordPrompt string |
Запрос пароля. |
|
pathToDownload string |
Путь к файлу для передачи файлов. |
|
port integer |
Порт сервера Radius или WEB. |
|
probeType string |
Тип зонда. |
|
protocol string |
Протокол, используемый передачей файлов, IPerf, почтовым сервером и Radius (TCP, UDP, FTP, POP3, IMAP, CHAP, PAP). |
|
proxyPassword string |
Пароль прокси. |
|
proxyPort string |
Порт прокси. |
|
proxyServer string |
Прокси-сервер. |
|
proxyUserName string |
Имя пользователя прокси. |
|
server string |
Сервер Ping, передачи файлов, почты, Radius, SSH или Telnet. |
|
servers list / elements=string |
Список серверов IPerf. |
|
string |
Секретный ключ. |
|
startPort integer |
Начальный порт IPerf. |
|
transferType string |
Тип передачи файлов (UPLOAD, DOWNLOAD, BOTH). |
|
udpBandwidth integer |
Пропускная способность UDP IPerf. |
|
uplinkTest boolean |
Тест восходящей линии связи. Choices:
|
|
url string |
URL. |
|
userName string |
Имя пользователя. |
|
userNamePrompt string |
Запрос имени пользователя. |
|
name string |
Имя теста. |
|
username string |
Имя пользователя для подключения SSID. |
|
vlan string |
VLAN. |
|
whiteList boolean |
Указание включения в разрешённый список. Варианты:
|
runNow string | Запустить сейчас (ДА, НЕТ). |
sensors list / elements=dictionary | Датчики датчиков. |
|
allSensorAddition boolean |
Добавление всех датчиков. Варианты:
|
|
assigned boolean |
Присвоено. Варианты:
|
|
configUpdated string |
Конфигурация обновлена ДА, НЕТ. |
|
hostName string |
Имя хоста. |
|
id string |
ID датчика. |
|
ipAddress string |
IP-адрес. |
|
iPerfInfo dictionary |
Строка-список строк информации iPerf. |
|
locationId string |
UUID сайта. |
|
macAddress string |
MAC-адрес. |
|
markedForUninstall boolean |
Отмечен для удаления. Варианты:
|
|
name string |
Имя датчика. |
|
runNow string |
Запустить сейчас ДА, НЕТ. |
|
sensorType string |
Тип датчика. |
|
servicePolicy string |
Политика сервиса. |
|
status string |
Статус устройства датчика ВКЛ, ВЫКЛ, ПЕРЕЗАГРУЗКА. |
|
switchMac string |
MAC-адрес коммутатора. |
|
switchSerialNumber string |
Серийный номер коммутатора. |
|
switchUuid string |
UUID устройства коммутатора. |
|
targetAPs list / elements=string |
Массив целевых точек доступа. |
|
testMacAddresses dictionary |
Строка-строковый тест MAC-адреса. |
|
wiredApplicationMessage string |
Проводное сообщение приложения. |
|
wiredApplicationStatus string |
Статус проводного приложения. |
|
xorSensor boolean |
Является ли датчик XOR. Варианты:
|
ssids list / элементы=словарь | SSID датчика. |
|
authProtocol string |
Протокол аутентификации. |
|
authType string |
Тип аутентификации: OPEN, WPA2_PSK, WPA2_EaP, WEB_AUTH, MAB, DOT1X, OTHER. |
|
bands string |
Диапазоны Wi-Fi 2.4 ГГц или 5 ГГц. |
|
certdownloadurl string |
URL для загрузки сертификата. |
|
certfilename string |
Имя файла сертификата аутентификации. |
|
certpassphrase string |
Фраза пароля сертификата. |
|
certstatus string |
Статус сертификата: НЕАКТИВЕН или АКТИВЕН. |
|
certxferprotocol string |
Протокол передачи сертификата HTTP или HTTPS. |
|
eapMethod string |
Методы WPA2_EAP: EAP-FAST, PEAP-MSCHAPv2, EAP-TLS, PEAP-TLS, EAP-TTLS-MSCHAPv2, EAP-TTLS-PAP, EAP-TTLS-CHAP, EAP-FAST-GTC, EAP-PEAP-GTC. |
|
extWebAuth boolean |
Указание использования внешней WEB-аутентификации. Варианты:
|
|
extWebAuthAccessUrl string |
Внешний URL доступа к WEB-аутентификации. |
|
extWebAuthHtmlTag list / элементы=словарь |
extWebAuthHtmlTag датчика. |
|
label string |
Метка. |
|
tag string |
Тег. |
|
value string |
Значение. |
|
extWebAuthPortal string |
Портал внешней аутентификации. |
|
extWebAuthVirtualIp string |
Виртуальный IP-адрес внешней WEB-аутентификации. |
|
layer3webAuthEmailAddress string |
Электронный адрес Layer 3 WEB-аутентификации. |
|
layer3webAuthpassword string |
Пароль Layer 3 WEB-аутентификации. |
|
layer3webAuthsecurity string |
Безопасность Layer 3 WEB-аутентификации. |
|
layer3webAuthuserName string |
Имя пользователя Layer 3 WEB-аутентификации. |
|
password string |
Строка пароля для SSID. |
|
passwordType string |
Тип пароля SSID: ASCII или HEX. |
|
profileName string |
Имя профиля SSID. |
|
proxyPassword string |
Пароль прокси-сервера. |
|
proxyPort string |
Порт прокси-сервера. |
|
proxyServer string |
Прокси-сервер для подключения SSID. |
|
proxyUserName string |
Имя пользователя прокси-сервера. |
|
psk string |
Пароль SSID, когда passwordType имеет значение ASCII. |
|
qosPolicy string |
Политика QoS: PlATINUM, GOLD, SILVER, BRONZE. |
|
scep boolean |
Протокол безопасной регистрации сертификатов: true, false или null (не применимо). Choices:
|
|
ssid string |
Строка SSID. |
|
tests list / elements=dictionary |
Тесты датчика. |
|
config list / elements=dictionary |
Конфигурация датчика. |
|
direction string |
Направление IPerf (UPLOAD, DOWNLOAD, BOTH). |
|
domains list / elements=string |
Имя DNS-домена. |
|
downlinkTest boolean |
Тест нисходящей линии связи. Choices:
|
|
endPort integer |
Конечный порт IPerf. |
|
exitCommand string |
Команда выхода. |
|
finalPrompt string |
Конечный пригласительный текст. |
|
ndtServer string |
Сервер NDT. |
|
ndtServerPath string |
Путь к серверу NDT. |
|
ndtServerPort string |
Порт сервера NDT. |
|
numPackets integer |
Количество пакетов. |
|
password string |
Пароль. |
|
passwordPrompt string |
Запрос пароля. |
|
pathToDownload string |
Путь к файлу для передачи файлов. |
|
port integer |
Порт сервера Radius или WEB-сервера. |
|
probeType string |
Тип зонда. |
|
protocol string |
Протокол, используемый для передачи файлов, IPerf, почтового сервера и Radius (TCP, UDP, FTP, POP3, IMAP, CHAP, PAP). |
|
proxyPassword string |
Пароль прокси. |
|
proxyPort string |
Порт прокси. |
|
proxyServer string |
Прокси-сервер. |
|
proxyUserName string |
Имя пользователя прокси. |
|
server string |
Сервер Ping, передачи файлов, почты, Radius, SSH или Telnet. |
|
servers список / элементы=строка |
Список серверов IPerf. |
|
строка |
Общий секрет. |
|
startPort целое число |
Начальный порт IPerf. |
|
transferType строка |
Тип передачи файла (UPLOAD, DOWNLOAD, BOTH). |
|
udpBandwidth целое число |
Пропускная способность UDP IPerf. |
|
uplinkTest логическое значение |
Тест канала связи. Варианты:
|
|
url строка |
URL. |
|
userName строка |
Имя пользователя. |
|
userNamePrompt строка |
Запрос имени пользователя. |
|
name строка |
Имя теста. |
|
thirdParty словарь |
Третья сторона датчика. |
|
selected логическое значение |
SSID является третьей стороной. Варианты:
|
|
username строка |
Строка имени пользователя для включения SSID. |
|
whiteList логическое значение |
Указание на включение в разрешенный список. Варианты:
|
|
wlanId целое число |
Идентификатор WLAN. |
|
wlc строка |
IP-адрес WLC. |
templateName строка | Параметр запроса templateName. |
validate_response_schema логическое значение | Флаг для Cisco DNA Center SDK, разрешающий проверку тел запросов по схеме JSON. Варианты:
|
version целое число | Версия шаблона теста датчика (должна быть 2). |
Примечания
Примечание
- Используемые методы SDK: sensors.Sensors.create_sensor_test_template, sensors.Sensors.delete_sensor_test,
- Используемые пути: post /dna/intent/api/v1/sensor, delete /dna/intent/api/v1/sensor,
- Не поддерживает
check_mode - Плагин работает на контрольном узле и не использует плагины подключения ansible, а вместо этого встроенный менеджер подключений из Cisco DNAC SDK
- Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения
См. также
См. также
- Документация Cisco DNA Center по датчикам CreateSensorTestTemplate
-
Полное описание API CreateSensorTestTemplate.
- Документация Cisco DNA Center по датчикам DeleteSensorTest
-
Полное описание API DeleteSensorTest.
Примеры
- name: Create
cisco.dnac.sensor:
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}}"
state: present
apCoverage:
- bands: string
numberOfApsToTest: 0
rssiThreshold: 0
connection: string
encryptionMode: string
locationInfoList:
- allSensors: true
customManagementVlan: true
locationId: string
locationType: string
macAddressList:
- string
managementVlan: string
siteHierarchy: string
modelVersion: 0
name: string
profiles:
- authProtocol: string
authType: string
certdownloadurl: string
certfilename: string
certpassphrase: string
certstatus: string
certxferprotocol: string
deviceType: string
eapMethod: string
extWebAuth: true
extWebAuthAccessUrl: string
extWebAuthHtmlTag:
- label: string
tag: string
value: string
extWebAuthPortal: string
extWebAuthVirtualIp: string
locationVlanList:
- locationId: string
vlans:
- string
password: string
passwordType: string
profileName: string
psk: string
qosPolicy: string
scep: true
tests:
- config:
- direction: string
domains:
- string
downlinkTest: true
endPort: 0
exitCommand: string
finalPrompt: string
ndtServer: string
ndtServerPath: string
ndtServerPort: string
numPackets: 0
password: string
passwordPrompt: string
pathToDownload: string
port: 0
probeType: string
protocol: string
proxyPassword: string
proxyPort: string
proxyServer: string
proxyUserName: string
server: string
servers:
- string
sharedSecret: string
startPort: 0
transferType: string
udpBandwidth: 0
uplinkTest: true
url: string
userName: string
userNamePrompt: string
name: string
username: string
vlan: string
whiteList: true
runNow: string
sensors:
- allSensorAddition: true
assigned: true
configUpdated: string
hostName: string
iPerfInfo: {}
id: string
ipAddress: string
locationId: string
macAddress: string
markedForUninstall: true
name: string
runNow: string
sensorType: string
servicePolicy: string
status: string
switchMac: string
switchSerialNumber: string
switchUuid: string
targetAPs:
- string
testMacAddresses: {}
wiredApplicationMessage: string
wiredApplicationStatus: string
xorSensor: true
ssids:
- authProtocol: string
authType: string
bands: string
certdownloadurl: string
certfilename: string
certpassphrase: string
certstatus: string
certxferprotocol: string
eapMethod: string
extWebAuth: true
extWebAuthAccessUrl: string
extWebAuthHtmlTag:
- label: string
tag: string
value: string
extWebAuthPortal: string
extWebAuthVirtualIp: string
layer3webAuthEmailAddress: string
layer3webAuthpassword: string
layer3webAuthsecurity: string
layer3webAuthuserName: string
password: string
passwordType: string
profileName: string
proxyPassword: string
proxyPort: string
proxyServer: string
proxyUserName: string
psk: string
qosPolicy: string
scep: true
ssid: string
tests:
- config:
- direction: string
domains:
- string
downlinkTest: true
endPort: 0
exitCommand: string
finalPrompt: string
ndtServer: string
ndtServerPath: string
ndtServerPort: string
numPackets: 0
password: string
passwordPrompt: string
pathToDownload: string
port: 0
probeType: string
protocol: string
proxyPassword: string
proxyPort: string
proxyServer: string
proxyUserName: string
server: string
servers:
- string
sharedSecret: string
startPort: 0
transferType: string
udpBandwidth: 0
uplinkTest: true
url: string
userName: string
userNamePrompt: string
name: string
thirdParty:
selected: true
username: string
whiteList: true
wlanId: 0
wlc: string
version: 0
- name: Delete all
cisco.dnac.sensor:
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}}"
state: absent
templateName: string
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
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/sensor_module.html
