cisco.dnac.sensor_v1 模块 – Sensor V1 的资源模块
注意
此模块是 cisco.dnac 集合（版本 6.25.0）的一部分。
如果您正在使用 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.dnac。您需要进一步的要求才能使用此模块，请参阅 要求 了解详细信息。
要在 playbook 中使用它，请指定：cisco.dnac.sensor_v1。
cisco.dnac 3.1.0 中的新增功能
概要
管理资源 Sensor V1 的创建和删除操作。
Intent API，用于创建具有新 SSID、现有 SSID 或新 SSID 和现有 SSID 的 SENSOR 测试模板。
Intent API，用于删除现有的 SENSOR 测试模板。
注意
此模块具有相应的 action 插件。
要求
执行此模块的主机需要以下要求。
dnacentersdk >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
|---|---|
传感器的 apCoverage。 |
|
WIFI 频段。 |
|
要测试的 AP 数量。 |
|
RSSI 阈值。 |
|
测试的连接类型 WIRED、WIRELESS、BOTH。 |
|
Cisco DNA Center SDK 用于启用调试的标志。 选项
|
|
Cisco DNA Center 主机名。 |
|
用于身份验证的 Cisco DNA Center 密码。 |
|
Cisco DNA Center 端口。 默认值： |
|
用于身份验证的 Cisco DNA Center 用户名。 默认值： |
|
用于启用或禁用 SSL 证书验证的标志。 选项
|
|
通知 SDK 要使用的 Cisco DNA Center 版本。 默认值： |
|
加密模式。 |
|
传感器的 locationInfoList。 |
|
使用站点中的所有传感器进行测试。 选项
|
|
自定义管理 VLAN。 选项
|
|
站点 UUID。 |
|
站点类型。 |
|
MAC 地址。 |
|
管理 VLAN。 |
|
站点名称层次结构。 |
|
测试模板对象模型版本（必须为 2）。 |
|
传感器测试模板名称。 |
|
传感器的配置文件。 |
|
身份验证协议。 |
|
身份验证类型 OPEN、WPA2_PSK、WPA2_EaP、WEB_AUTH、MAB、DOT1X、OTHER。 |
|
证书下载 URL。 |
|
身份验证证书文件名。 |
|
证书密码短语。 |
|
证书状态 INACTIVE 或 ACTIVE。 |
|
证书传输协议 HTTP 或 HTTPS。 |
|
设备类型。 |
|
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。 |
|
指示使用外部 WEB 身份验证。 选项
|
|
外部 WEB 身份验证访问 URL。 |
|
传感器的 extWebAuthHtmlTag。 |
|
标签。 |
|
标记。 |
|
值。 |
|
外部身份验证门户。 |
|
外部 WEB 身份验证虚拟 IP。 |
|
传感器的 locationVlanList。 |
|
站点 UUID。 |
|
VLAN 数组。 |
|
用于加入 SSID 的密码字符串。 |
|
SSID 密码类型，ASCII 或 HEX。 |
|
配置文件名称。 |
|
当 passwordType 为 ASCII 时，SSID 的密码。 |
|
QoS 策略，可以是 PLATINUM、GOLD、SILVER 或 BRONZE。 |
|
安全证书注册协议，真 (true) 或假 (false)，或者对于不适用情况为 null。 选项
|
|
传感器的测试。 |
|
传感器的配置。 |
|
IPerf 方向（上传 UPLOAD、下载 DOWNLOAD、双向 BOTH）。 |
|
DNS 域名。 |
|
下行链路测试。 选项
|
|
IPerf 结束端口。 |
|
退出命令。 |
|
最终提示符。 |
|
NDT 服务器。 |
|
NDT 服务器路径。 |
|
NDT 服务器端口。 |
|
数据包数量。 |
|
Password. |
|
密码提示符。 |
|
文件传输的文件路径。 |
|
Radius 或 WEB 服务器端口。 |
|
探测类型。 |
|
文件传输、IPerf、邮件服务器和 radius 使用的协议（TCP、UDP、FTP、POP3、IMAP、CHAP、PAP）。 |
|
代理密码。 |
|
代理端口。 |
|
代理服务器。 |
|
代理用户名。 |
|
Ping、文件传输、邮件、radius、ssh 或 telnet 服务器。 |
|
IPerf 服务器列表。 |
|
共享密钥。 |
|
IPerf 起始端口。 |
|
文件传输类型（上传 UPLOAD、下载 DOWNLOAD、双向 BOTH）。 |
|
IPerf UDP 带宽。 |
|
上行链路测试。 选项
|
|
URL。 |
|
用户名。 |
|
用户名提示符。 |
|
测试的名称。 |
|
用于加入 SSID 的用户名字符串。 |
|
VLAN。 |
|
指示是否在允许列表中。 选项
|
|
立即运行（是 YES、否 NO）。 |
|
传感器的传感器。 |
|
是否为所有传感器添加。 选项
|
|
是否已分配。 选项
|
|
配置已更新，是 (YES) 或否 (NO)。 |
|
主机名。 |
|
传感器 ID。 |
|
IP 地址。 |
|
一个字符串到字符串列表的 IPerf 信息。 |
|
站点 UUID。 |
|
MAC 地址。 |
|
是否标记为卸载。 选项
|
|
传感器名称。 |
|
立即运行，是 (YES) 或否 (NO)。 |
|
传感器类型。 |
|
服务策略。 |
|
传感器设备状态，可以是 UP、DOWN 或 REBOOT。 |
|
交换机 MAC 地址。 |
|
交换机序列号。 |
|
交换机设备 UUID。 |
|
目标 AP 数组。 |
|
一个字符串到字符串的测试 MAC 地址。 |
|
有线应用程序消息。 |
|
有线应用程序状态。 |
|
是否为 XOR 传感器。 选项
|
|
传感器的 SSID。 |
|
身份验证协议。 |
|
身份验证类型 OPEN、WPA2_PSK、WPA2_EaP、WEB_AUTH、MAB、DOT1X、OTHER。 |
|
WIFI 频段，2.4GHz 或 5GHz。 |
|
证书下载 URL。 |
|
身份验证证书文件名。 |
|
证书密码短语。 |
|
证书状态 INACTIVE 或 ACTIVE。 |
|
证书传输协议 HTTP 或 HTTPS。 |
|
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。 |
|
指示使用外部 WEB 身份验证。 选项
|
|
外部 WEB 身份验证访问 URL。 |
|
传感器的 extWebAuthHtmlTag。 |
|
标签。 |
|
标记。 |
|
值。 |
|
外部身份验证门户。 |
|
外部 WEB 身份验证虚拟 IP。 |
|
三层 WEB 身份验证电子邮件地址。 |
|
三层 WEB 身份验证密码。 |
|
三层 WEB 身份验证安全设置。 |
|
三层 WEB 身份验证用户名。 |
|
用于加入 SSID 的密码字符串。 |
|
SSID 密码类型，ASCII 或 HEX。 |
|
SSID 配置文件名称字符串。 |
|
代理服务器密码。 |
|
代理服务器端口。 |
|
用于加入 SSID 的代理服务器。 |
|
代理服务器用户名。 |
|
当 passwordType 为 ASCII 时，SSID 的密码。 |
|
QoS 策略，可以是 PLATINUM、GOLD、SILVER 或 BRONZE。 |
|
安全证书注册协议，真 (true) 或假 (false)，或者对于不适用情况为 null。 选项
|
|
SSID 字符串。 |
|
传感器的测试。 |
|
传感器的配置。 |
|
IPerf 方向（上传 UPLOAD、下载 DOWNLOAD、双向 BOTH）。 |
|
DNS 域名。 |
|
下行链路测试。 选项
|
|
IPerf 结束端口。 |
|
退出命令。 |
|
最终提示符。 |
|
NDT 服务器。 |
|
NDT 服务器路径。 |
|
NDT 服务器端口。 |
|
数据包数量。 |
|
Password. |
|
密码提示符。 |
|
文件传输的文件路径。 |
|
Radius 或 WEB 服务器端口。 |
|
探测类型。 |
|
文件传输、IPerf、邮件服务器和 radius 使用的协议（TCP、UDP、FTP、POP3、IMAP、CHAP、PAP）。 |
|
代理密码。 |
|
代理端口。 |
|
代理服务器。 |
|
代理用户名。 |
|
Ping、文件传输、邮件、radius、ssh 或 telnet 服务器。 |
|
IPerf 服务器列表。 |
|
共享密钥。 |
|
IPerf 起始端口。 |
|
文件传输类型（上传 UPLOAD、下载 DOWNLOAD、双向 BOTH）。 |
|
IPerf UDP 带宽。 |
|
上行链路测试。 选项
|
|
URL。 |
|
用户名。 |
|
用户名提示符。 |
|
测试的名称。 |
|
传感器的第三方设置。 |
|
如果 SSID 是第三方则为真 (True)。 选项
|
|
用于加入 SSID 的用户名字符串。 |
|
指示是否在允许列表中。 选项
|
|
WLAN ID。 |
|
WLC IP 地址。 |
|
TemplateName 查询参数。 |
|
Cisco DNA Center SDK 的标志，用于启用根据 JSON 模式验证请求正文。 选项
|
|
传感器测试模板版本（必须为 2）。 |
注释
注意
使用的 SDK 方法是 sensors.Sensors.create_sensor_test_template_v1, sensors.Sensors.delete_sensor_test_v1,
使用的路径是 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 关于 Sensors CreateSensorTestTemplateV1 的文档
CreateSensorTestTemplateV1 API 的完整参考。
- Cisco DNA Center 关于 Sensors DeleteSensorTestV1 的文档
DeleteSensorTestV1 API 的完整参考。
示例
- name: Create
cisco.dnac.sensor_v1:
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_v1:
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
返回值
常见的返回值记录在 这里，以下是此模块独有的字段
键 |
描述 |
|---|---|
包含 Cisco DNAC Python SDK 返回的响应的字典或列表 返回： 总是 示例： |