Модуль cisco.dnac.sensor_test_template_edit – Модуль ресурса для редактирования шаблона теста датчика
Примечание
Этот модуль является частью коллекции cisco.dnac (версия 6.20.0).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить ее, используйте: ansible-galaxy collection install cisco.dnac. Для использования этого модуля требуются дополнительные компоненты. Подробности см. в разделе Требования.
Чтобы использовать его в книге задач, укажите: cisco.dnac.sensor_test_template_edit.
Новый в cisco.dnac 3.1.0
Описание
- Управление обновлением ресурса "Редактирование шаблона теста датчика".
- API намерений для развертывания, планирования, редактирования и существующего шаблона теста датчика.
Примечание
Данный модуль имеет соответствующий плагин действия.
Требования
Ниже перечислены требования к хосту, на котором выполняется данный модуль.
- dnacentersdk >= 2.7.2
- python >= 3.5
Параметры
Параметр | Комментарии |
|---|---|
_id строка | Уникальный идентификатор шаблона теста датчика, сгенерированный во время создания теста. |
actionInProgress строка | Указание о выполнении действия. |
apCoverage список / элементы=словарь | apCoverage шаблона редактирования теста датчика. |
|
bands строка |
Диапазоны Wi-Fi. |
|
numberOfApsToTest целое число |
Количество точек доступа для тестирования. |
|
rssiThreshold целое число |
Порог RSSI. |
connection строка | Тип подключения для тестирования: WIRED, WIRELESS, BOTH. |
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 строка | Режим шифрования. |
frequency словарь | Частота шаблона редактирования теста датчика. |
|
unit строка |
Единица измерения значения времени (НАНОСЕКУНДЫ, МИКРОСЕКУНДЫ, МИЛЛИСЕКУНДЫ, СЕКУНДЫ, МИНУТЫ, ЧАСЫ, ДНИ). |
|
value целое число |
Значение единицы измерения. |
lastModifiedTime целое число | Время последнего изменения. |
location строка | Строка местоположения. |
locationInfoList список / элементы=словарь | locationInfoList шаблона редактирования теста датчика. |
|
allSensors логический |
Использовать все датчики в месте для теста. Варианты:
|
|
customManagementVlan логический |
Пользовательский VLAN управления. Варианты:
|
|
locationId строка |
UUID сайта. |
|
locationType string |
Тип площадки. |
|
macAddressList list / elements=string |
MAC-адреса. |
|
managementVlan string |
Управляющий VLAN. |
|
siteHierarchy string |
Иерархия имен площадок. |
modelVersion integer | Версия модели объекта шаблона теста (должна быть 2). |
name string | Имя шаблона теста датчика, такое же, как в ‘templateName’. |
numAssociatedSensor integer | Количество связанных датчиков. |
numNeighborAPThreshold integer | Пороговое значение количества соседних точек доступа. |
profiles list / elements=dictionary | Профили Sensor Test Template Edit. |
|
authProtocol string |
Протокол аутентификации. |
|
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 Sensor Test Template Edit. |
|
label string |
Метка. |
|
tag string |
Тег. |
|
value string |
Значение. |
|
extWebAuthPortal string |
Внешний портал аутентификации. |
|
extWebAuthVirtualIp string |
Внешний виртуальный IP WEB-аутентификации. |
|
locationVlanList list / elements=dictionary |
locationVlanList Sensor Test Template Edit. |
|
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 |
Тесты Sensor Test Template Edit. |
|
config list / elements=dictionary |
Конфигурация Sensor Test Template Edit. |
|
direction string |
Направление IPerf (UPLOAD, DOWNLOAD, BOTH). |
|
domains list / elements=string |
Имя DNS-домена. |
|
downlinkTest boolean |
Тест нисходящей линии связи. Варианты:
|
|
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 |
Сервер пинга, передачи файлов, почты, RADIUS, SSH или telnet. |
|
servers list / elements=string |
Список серверов IPerf. |
|
string |
Общий секрет. |
|
startPort integer |
Начальный порт IPerf. |
|
transferType string |
Тип передачи файлов (UPLOAD, DOWNLOAD, BOTH). |
|
udpBandwidth integer |
Пропускная способность UDP IPerf. |
|
uplinkTest boolean |
Тест канала связи. Варианты:
|
|
url string |
URL. |
|
userName string |
Имя пользователя. |
|
userNamePrompt string |
Запрос имени пользователя. |
|
name string |
Название теста. |
|
username string |
Строка имени пользователя для подключения SSID. |
|
vlan string |
VLAN. |
|
whiteList boolean |
Признак наличия в списке разрешенных. Варианты:
|
radioAsSensorRemoved boolean | Удаление радио как сенсора. Варианты:
|
rssiThreshold integer | Пороговое значение RSSI. |
runNow string | Запуск сейчас (YES, NO). |
scheduleInDays integer | Значение, определяющее дни для планируемого теста. |
sensors list / elements=dictionary | Сенсоры шаблона теста. |
|
allSensorAddition boolean |
Добавление всех сенсоров. Варианты:
|
|
assigned boolean |
Присвоено. Варианты:
|
|
configUpdated string |
Конфигурация обновлена (YES, NO). |
|
hostName string |
Имя хоста. |
|
id string |
Идентификатор датчика. |
|
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-датчик. Варианты:
|
showWlcUpgradeBanner boolean | Показать баннер обновления WLC. Варианты:
|
siteHierarchy string | Иерархия сайта. |
ssids list / elements=dictionary | ssids модуля редактирования шаблона теста датчика. |
|
authProtocol string |
Протокол аутентификации. |
|
authType string |
Тип аутентификации ОТКРЫТЫЙ, WPA2_PSK, WPA2_EAP, WEB_AUTH, MAB, DOT1X, ДРУГОЙ. |
|
bands string |
WIFI диапазоны 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 / elements=dictionary |
extWebAuthHtmlTag модуля Sensor Test Template Edit. |
|
label string |
Метка. |
|
tag string |
Тег. |
|
value string |
Значение. |
|
extWebAuthPortal string |
Внешний портал аутентификации. |
|
extWebAuthVirtualIp string |
Внешний виртуальный IP-адрес WEB-аутентификации. |
|
id integer |
Идентификационный номер. |
|
layer3webAuthEmailAddress string |
Электронный адрес WEB-аутентификации уровня 3. |
|
layer3webAuthpassword string |
Пароль WEB-аутентификации уровня 3. |
|
layer3webAuthsecurity string |
Безопасность WEB-аутентификации уровня 3. |
|
layer3webAuthuserName string |
Имя пользователя WEB-аутентификации уровня 3. |
|
numAps integer |
Количество точек доступа в тесте. |
|
numSensors integer |
Количество датчиков в тесте. |
|
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. |
|
status string |
Состояние WLAN: ENABLED или DISABLED. |
|
tests list / elements=dictionary |
Тесты Sensor Test Template Edit. |
|
config list / elements=dictionary |
Конфигурация Sensor Test Template Edit. |
|
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 |
Тест канала обратной связи. Варианты:
|
|
url string |
URL. |
|
userName string |
Имя пользователя. |
|
userNamePrompt string |
Запрос имени пользователя. |
|
name string |
Название теста. |
|
thirdParty dictionary |
thirdParty модуля Sensor Test Template Edit. |
|
selected boolean |
SSID является сторонним (True). Варианты:
|
|
username string |
Строка имени пользователя для интеграции SSID. |
|
validFrom integer |
Маркировка начала действия в формате UTC. |
|
validTo integer |
Маркировка окончания действия в формате UTC. |
|
whiteList boolean |
Признак включения в разрешённый список. Варианты:
|
|
wlanId integer |
Идентификатор WLAN. |
|
wlc string |
IP-адрес WLC. |
startTime integer | Время начала. |
status string | Состояние теста (RUNNING, NOTRUNNING). |
templateName string | Имя шаблона теста, который необходимо изменить. |
testScheduleMode string | Режим расписания теста (ONDEMAND, DEDICATED, SCHEDULED, CONTINUOUS, RUNNOW). |
validate_response_schema boolean | Флаг для Cisco DNA Center SDK, чтобы включить проверку тел запросов по JSON-схеме. Варианты:
|
version integer | Версия шаблона теста датчика (должна быть 2). |
wlans list / elements=string | Список WLAN. |
Примечания
Примечание
- Используемый метод SDK — sensors.Sensors.edit_sensor_test_template,
- Используемые пути — put /dna/intent/api/v1/AssuranceScheduleSensorTest,
- Не поддерживает
check_mode - Плагин выполняется на узле управления и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключений из Cisco DNAC SDK
- Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения
См. также
См. также
- Документация Cisco DNA Center по Sensors EditSensorTestTemplate
-
Полное описание API EditSensorTestTemplate.
Примеры
- name: Update all
cisco.dnac.sensor_test_template_edit:
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}}"
_id: string
actionInProgress: string
apCoverage:
- bands: string
numberOfApsToTest: 0
rssiThreshold: 0
connection: string
encryptionMode: string
frequency:
unit: string
value: 0
lastModifiedTime: 0
location: string
locationInfoList:
- allSensors: true
customManagementVlan: true
locationId: string
locationType: string
macAddressList:
- string
managementVlan: string
siteHierarchy: string
modelVersion: 0
name: string
numAssociatedSensor: 0
numNeighborAPThreshold: 0
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
radioAsSensorRemoved: true
rssiThreshold: 0
runNow: string
scheduleInDays: 0
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
showWlcUpgradeBanner: true
siteHierarchy: string
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
id: 0
layer3webAuthEmailAddress: string
layer3webAuthpassword: string
layer3webAuthsecurity: string
layer3webAuthuserName: string
numAps: 0
numSensors: 0
password: string
passwordType: string
profileName: string
proxyPassword: string
proxyPort: string
proxyServer: string
proxyUserName: string
psk: string
qosPolicy: string
scep: true
ssid: string
status: 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
validFrom: 0
validTo: 0
whiteList: true
wlanId: 0
wlc: string
startTime: 0
status: string
templateName: string
testScheduleMode: string
version: 0
wlans:
- 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_test_template_edit_module.html