{"type":"api","title":"Duplicate sensor test template","meta":{"id":"/apps/pubhub/media/cisco-catalyst-center-api-2-3-7-9/a58b8872fdc3116cb1a0478252ee81e8011d37c2/6a3cd7ca-617e-374c-a10b-740a529a993e","info":{"title":"Intent API","description":"Cisco Catalyst Center Platform v. 2.3.7.9","version":"2.3.7.9"},"tags":[{"name":"Authentication","description":"Access Token Request"},{"name":"Sites","description":"Create sites, assign devices to them and get site health"},{"name":"Topology","description":"Get topology details and overall network health"},{"name":"Devices","description":"Manage network devices"},{"name":"Clients","description":"Get client (by MAC Address) health, status, and information"},{"name":"Users","description":"Obtain information about *Users* and associated connections and devices"},{"name":"Issues","description":"Obtain issue details, impacted hosts, and suggested actions for remediation"},{"name":"Site Design","description":"Design/provision NFV device to site/area/building/floor"},{"name":"Network Settings","description":"Manage Network Settings"},{"name":"Software Image Management (SWIM)","description":"Manage activation and distribution of software images"},{"name":"Device Onboarding (PnP)","description":"Zero-touch deployment of network devices"},{"name":"Configuration Templates","description":"Configure and manage CLI templates"},{"name":"Configuration Archive","description":"Export device configurations to an encrypted zip file"},{"name":"SDA","description":"(BETA) Configure and manage SDA wired fabric border devices"},{"name":"Sensors","description":"Manage sensor test templates"},{"name":"Wireless","description":"Configure and manage SSIDs, Wireless, and RF profiles in non-fabric wireless network"},{"name":"Command Runner","description":"Retrieve real-time device configuration and CLI keywords"},{"name":"Discovery","description":"Discover network devices and manage discovery jobs"},{"name":"Path Trace","description":"Network route and flow analysis"},{"name":"File","description":"Get configuration files by namespace and ID"},{"name":"Task","description":"Get information about asynchronous tasks"},{"name":"Tag","description":"Assign administrator-defined tags to network devices"},{"name":"Application Policy","description":"Create and manage applications, application sets, and application policies"},{"name":"Applications","description":"Intent API to get a list of applications for a specific site, a device, or a client device's MAC address"},{"name":"ITSM","description":"Provide the details of the various third party integrations that are supported"},{"name":"Event Management","description":"Event based notification to external handlers"},{"name":"Security Advisories","description":"Provides the details of advisories on the network and devices"},{"name":"Compliance","description":"Provides compliance status data on the devices"}],"x-parser-conf":{"expand":0,"labelConfig":{"endpoint":"summary"}},"openapi":"3.0.1","servers":[{"url":"/"}]},"spec":{"operationId":"duplicateSensorTestTemplate","tags":["Sensors"],"deprecated":false,"summary":"Duplicate sensor test template","description":"Intent API to duplicate an existing SENSOR test template","parameters":[],"requestBody":{"description":"request","content":{"application/json":{"schema":{"type":"object","properties":{"templateName":{"type":"string","description":"Source test template name"},"newTemplateName":{"type":"string","description":"Destination test template name"}},"description":"","$$ref":"#/components/schemas/DuplicateSensorTestTemplateRequest"}}},"required":true},"responses":{"200":{"description":"The request was successful. The result is contained in the response body.","content":{"application/json":{"schema":{"type":"object","properties":{"version":{"type":"string","description":""},"response":{"type":"object","properties":{"name":{"type":"string","description":"The sensor test template name"},"_id":{"type":"string","description":"The sensor test template unique identifier"},"version":{"type":"integer","description":"The sensor test template version (must be 2)"},"modelVersion":{"type":"integer","description":"Test template object model version (must be 2)"},"startTime":{"type":"integer","description":"Start time"},"lastModifiedTime":{"type":"integer","description":"Last modify time"},"numAssociatedSensor":{"type":"integer","description":"Number of associated sensor"},"location":{"type":"string","description":"Location string"},"siteHierarchy":{"type":"string","description":"Site hierarchy"},"status":{"type":"string","description":"Status of the test (RUNNING, NOTRUNNING)"},"connection":{"type":"string","description":"connection type of test: WIRED, WIRELESS, BOTH"},"actionInProgress":{"type":"string","description":"Indication of inprogress action"},"frequency":{"type":"object","properties":{"value":{"type":"integer","description":"Value of the unit"},"unit":{"type":"string","description":"Unit of the time value (NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS)"}},"description":"Frequency of the test"},"rssiThreshold":{"type":"integer","description":"RSSI threshold"},"numNeighborAPThreshold":{"type":"integer","description":"Number of neighboring AP threshold"},"scheduleInDays":{"type":"integer","description":"Bit-wise value of scheduled test days"},"wlans":{"type":"array","items":{"type":"string"},"description":"WLANs list"},"ssids":{"type":"array","items":{"type":"object","properties":{"bands":{"type":"string","description":"WIFI bands: 2.4GHz or 5GHz"},"ssid":{"type":"string","description":"The SSID string"},"profileName":{"type":"string","description":"The SSID profile name string"},"numAps":{"type":"integer","description":"Number of APs in the test"},"numSensors":{"type":"integer","description":"Number of Sensors in the test"},"layer3webAuthsecurity":{"type":"string","description":"Layer 3 WEB Auth security"},"layer3webAuthuserName":{"type":"string","description":"Layer 3 WEB Auth user name"},"layer3webAuthpassword":{"type":"string","description":"Layer 3 WEB Auth password"},"layer3webAuthEmailAddress":{"type":"string","description":"Layer 3 WEB Auth email address"},"thirdParty":{"type":"object","properties":{"selected":{"type":"boolean","description":"true: the SSID is third party"}},"description":"Indication of whether this SSID is third party (true or false)"},"id":{"type":"integer","description":"Identification number"},"wlanId":{"type":"integer","description":"WLAN ID"},"wlc":{"type":"string","description":"WLC IP addres"},"validFrom":{"type":"integer","description":"Valid From UTC timestamp"},"validTo":{"type":"integer","description":"Valid To UTC timestamp"},"status":{"type":"string","description":"WLAN status: ENABLED or DISABLED"},"proxyServer":{"type":"string","description":"Proxy server for onboarding SSID"},"proxyPort":{"type":"string","description":"Proxy server port"},"proxyUserName":{"type":"string","description":"Proxy server user name"},"proxyPassword":{"type":"string","description":"Proxy server password"},"authType":{"type":"string","description":"Authentication type: OPEN, WPA2_PSK, WPA2_EaP, WEB_AUTH, MAB, DOT1X, OTHER"},"psk":{"type":"string","description":"Password of SSID when passwordType is ASCII"},"username":{"type":"string","description":"User name string for onboarding SSID"},"password":{"type":"string","description":"Password string for onboarding SSID"},"passwordType":{"type":"string","description":"SSID password type: ASCII or HEX"},"eapMethod":{"type":"string","description":"WPA2_EAP methods: EAP-FAST, PEAP-MSCHAPv2, EAP-TLS, PEAP-TLS, EAP-TTLS-MSCHAPv2, EAP-TTLS-PAP, EAP-TTLS-CHAP, EAP-FAST-GTC, EAP-PEAP-GTC"},"scep":{"type":"boolean","description":"Secure certificate enrollment protocol: true or false or null for not applicable"},"authProtocol":{"type":"string","description":"Auth protocol"},"certfilename":{"type":"string","description":"Auth certificate file name"},"certxferprotocol":{"type":"string","description":"Certificate transfering protocol: HTTP or HTTPS"},"certstatus":{"type":"string","description":"Certificate status: INACTIVE or ACTIVE"},"certpassphrase":{"type":"string","description":"Certificate password phrase"},"certdownloadurl":{"type":"string","description":"Certificate download URL"},"extWebAuthVirtualIp":{"type":"string","description":"External WEB Auth virtual IP"},"extWebAuth":{"type":"boolean","description":"Indication of using external WEB Auth"},"whiteList":{"type":"boolean","description":"Indication of being on allowed list"},"extWebAuthPortal":{"type":"string","description":"External authentication portal"},"extWebAuthAccessUrl":{"type":"string","description":"External WEB Auth access URL"},"extWebAuthHtmlTag":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","description":""},"tag":{"type":"string","description":""},"value":{"type":"string","description":""}}},"description":"Array of external WEB Auth information"},"qosPolicy":{"type":"string","description":"QoS policy: PlATINUM, GOLD, SILVER, BRONZE"},"tests":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the test"},"config":{"type":"array","items":{"type":"object","properties":{"domains":{"type":"array","items":{"type":"string"},"description":"DNS domain name"},"server":{"type":"string","description":"Ping, file transfer, mail, radius, ssh, or telnet server"},"userName":{"type":"string","description":"User name"},"password":{"type":"string","description":"Password"},"url":{"type":"string","description":"URL"},"port":{"type":"integer","description":"Radius or WEB server port"},"protocol":{"type":"string","description":"Protocol used by file transfer, IPerf, mail server, and radius (TCP, UDP, FTP, POP3, IMAP, CHAP, PAP)"},"servers":{"type":"array","items":{"type":"string"},"description":"IPerf server list"},"direction":{"type":"string","description":"IPerf direction (UPLOAD, DOWNLOAD, BOTH)"},"startPort":{"type":"integer","description":"IPerf start port"},"endPort":{"type":"integer","description":"IPerf end port"},"udpBandwidth":{"type":"integer","description":"IPerf UDP bandwidth"},"probeType":{"type":"string","description":"Probe type"},"numPackets":{"type":"string","description":"Number of packets"},"pathToDownload":{"type":"string","description":"File path for file transfer"},"transferType":{"type":"string","description":"File transfer type (UPLOAD, DOWNLOAD, BOTH)"},"sharedSecret":{"type":"string","description":"Shared secret"},"ndtServer":{"type":"string","description":"NDT server"},"ndtServerPort":{"type":"string","description":"NDT server port"},"ndtServerPath":{"type":"string","description":"NDT server path"},"uplinkTest":{"type":"boolean","description":"Uplink test"},"downlinkTest":{"type":"boolean","description":"Downlink test"},"proxyServer":{"type":"string","description":"Proxy server"},"proxyPort":{"type":"string","description":"Proxy port"},"proxyUserName":{"type":"string","description":"Proxy user name"},"proxyPassword":{"type":"string","description":"Proxy password"},"userNamePrompt":{"type":"string","description":"User name prompt"},"passwordPrompt":{"type":"string","description":"Password prompt"},"exitCommand":{"type":"string","description":"Exit command"},"finalPrompt":{"type":"string","description":"Final prompt"}}},"description":"Array of config objects"}}},"description":"Array of test objects for this SSID"}}},"description":"The list of SSIDs. Each SSID map has the ssid specific information as well as the test configurations to be used in each ssid. Required at least 1 element"},"profiles":{"type":"array","items":{"type":"object","properties":{"authType":{"type":"string","description":"Authentication type: OPEN, WPA2_PSK, WPA2_EaP, WEB_AUTH, MAB, DOT1X, OTHER"},"psk":{"type":"string","description":"Password of SSID when passwordType is ASCII"},"username":{"type":"string","description":"User name string for onboarding SSID"},"password":{"type":"string","description":"Password string for onboarding SSID"},"passwordType":{"type":"string","description":"SSID password type: ASCII or HEX"},"eapMethod":{"type":"string","description":"WPA2_EAP methods: EAP-FAST, PEAP-MSCHAPv2, EAP-TLS, PEAP-TLS, EAP-TTLS-MSCHAPv2, EAP-TTLS-PAP, EAP-TTLS-CHAP, EAP-FAST-GTC, EAP-PEAP-GTC"},"scep":{"type":"boolean","description":"Secure certificate enrollment protocol: true or false or null for not applicable"},"authProtocol":{"type":"string","description":"Auth protocol"},"certfilename":{"type":"string","description":"Auth certificate file name"},"certxferprotocol":{"type":"string","description":"Certificate transfering protocol: HTTP or HTTPS"},"certstatus":{"type":"string","description":"Certificate status: INACTIVE or ACTIVE"},"certpassphrase":{"type":"string","description":"Certificate password phrase"},"certdownloadurl":{"type":"string","description":"Certificate download URL"},"extWebAuthVirtualIp":{"type":"string","description":"External WEB Auth virtual IP"},"extWebAuth":{"type":"boolean","description":"Indication of using external WEB Auth"},"whiteList":{"type":"boolean","description":"Indication of being on allowed list"},"extWebAuthPortal":{"type":"string","description":"External authentication portal"},"extWebAuthAccessUrl":{"type":"string","description":"External WEB Auth access URL"},"extWebAuthHtmlTag":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","description":""},"tag":{"type":"string","description":""},"value":{"type":"string","description":""}}},"description":"Array of external WEB Auth information"},"qosPolicy":{"type":"string","description":"QoS policy: PlATINUM, GOLD, SILVER, BRONZE"},"tests":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the test"},"config":{"type":"array","items":{"type":"object","properties":{"domains":{"type":"array","items":{"type":"string"},"description":"DNS domain name"},"server":{"type":"string","description":"Ping, file transfer, mail, radius, ssh, or telnet server"},"userName":{"type":"string","description":"User name"},"password":{"type":"string","description":"Password"},"url":{"type":"string","description":"URL"},"port":{"type":"integer","description":"Radius or WEB server port"},"protocol":{"type":"string","description":"Protocol used by file transfer, IPerf, mail server, and radius (TCP, UDP, FTP, POP3, IMAP, CHAP, PAP)"},"servers":{"type":"array","items":{"type":"string"},"description":"IPerf server list"},"direction":{"type":"string","description":"IPerf direction (UPLOAD, DOWNLOAD, BOTH)"},"startPort":{"type":"integer","description":"IPerf start port"},"endPort":{"type":"integer","description":"IPerf end port"},"udpBandwidth":{"type":"integer","description":"IPerf UDP bandwidth"},"probeType":{"type":"string","description":"Probe type"},"numPackets":{"type":"string","description":"Number of packets"},"pathToDownload":{"type":"string","description":"File path for file transfer"},"transferType":{"type":"string","description":"File transfer type (UPLOAD, DOWNLOAD, BOTH)"},"sharedSecret":{"type":"string","description":"Shared secret"},"ndtServer":{"type":"string","description":"NDT server"},"ndtServerPort":{"type":"string","description":"NDT server port"},"ndtServerPath":{"type":"string","description":"NDT server path"},"uplinkTest":{"type":"boolean","description":"Uplink test"},"downlinkTest":{"type":"boolean","description":"Downlink test"},"proxyServer":{"type":"string","description":"Proxy server"},"proxyPort":{"type":"string","description":"Proxy port"},"proxyUserName":{"type":"string","description":"Proxy user name"},"proxyPassword":{"type":"string","description":"Proxy password"},"userNamePrompt":{"type":"string","description":"User name prompt"},"passwordPrompt":{"type":"string","description":"Password prompt"},"exitCommand":{"type":"string","description":"Exit command"},"finalPrompt":{"type":"string","description":"Final prompt"}}},"description":"Array of config objects"}}},"description":"Array of test objects for this SSID"},"profileName":{"type":"string","description":"Profile name"},"deviceType":{"type":"string","description":"Device Type"},"vlan":{"type":"string","description":"VLAN"},"locationVlanList":{"type":"array","items":{"type":"object","properties":{"locationId":{"type":"string","description":"Site UUID"},"vlans":{"type":"array","items":{"type":"string"},"description":"Array of VLANs"}}},"description":"Array of site UUID-vlan map objects"}}},"description":"Used for wired: the profileName, deviceType, vlan, testMacAddress to use authentication info, etc."},"testScheduleMode":{"type":"string","description":"Test schedule mode (ONDEMAND, DEDICATED, SCHEDULED, CONTINUOUS, RUNNOW)"},"showWlcUpgradeBanner":{"type":"boolean","description":"Show WLC upgrade banner"},"radioAsSensorRemoved":{"type":"boolean","description":"Radio as sensor removed"},"encryptionMode":{"type":"string","description":"Encryption mode"},"runNow":{"type":"string","description":"Run now (YES, NO)"},"locationInfoList":{"type":"array","items":{"type":"object","properties":{"locationId":{"type":"string","description":"Site UUID"},"locationType":{"type":"string","description":"Site type"},"allSensors":{"type":"boolean","description":"Use all sensors in the site for test"},"siteHierarchy":{"type":"string","description":"Site name hierarhy"},"macAddressList":{"type":"array","items":{"type":"string"},"description":"MAC addresses"},"managementVlan":{"type":"string","description":"Management VLAN"},"customManagementVlan":{"type":"boolean","description":"Custom Management VLAN"}}},"description":"Location information list"},"sensors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Sensor name"},"macAddress":{"type":"string","description":"MAC address"},"switchMac":{"type":"string","description":"Switch MAC address"},"switchUuid":{"type":"string","description":"Switch device UUID"},"switchSerialNumber":{"type":"string","description":"Switch serial number"},"markedForUninstall":{"type":"boolean","description":"Is marked for uninstall"},"ipAddress":{"type":"string","description":"IP address"},"hostName":{"type":"string","description":"Host name"},"wiredApplicationStatus":{"type":"string","description":"Wired application status"},"wiredApplicationMessage":{"type":"string","description":"Wired application message"},"assigned":{"type":"boolean","description":"Is assigned"},"status":{"type":"string","description":"Sensor device status: UP, DOWN, REBOOT"},"xorSensor":{"type":"boolean","description":"Is XOR sensor"},"targetAPs":{"type":"array","items":{"type":"string"},"description":"Array of target APs"},"runNow":{"type":"string","description":"Run now: YES, NO"},"locationId":{"type":"string","description":"Site UUID"},"allSensorAddition":{"type":"boolean","description":"Is all sensor addition"},"configUpdated":{"type":"string","description":"Configuration updated: YES, NO"},"sensorType":{"type":"string","description":"Sensor type"},"testMacAddresses":{"type":"object","properties":{},"description":"A string-string test MAC address"},"id":{"type":"string","description":"Sensor ID"},"servicePolicy":{"type":"string","description":"Service policy"},"iPerfInfo":{"type":"object","properties":{},"description":"A string-stringList iPerf information"}}},"description":"Sensors"},"apCoverage":{"type":"array","items":{"type":"object","properties":{"bands":{"type":"string","description":"The WIFI bands"},"numberOfApsToTest":{"type":"integer","description":"Number of APs to test"},"rssiThreshold":{"type":"integer","description":"RSSI threshold"}}},"description":"The WIFI bands where the test will be run"}},"description":""}},"description":"","$$ref":"#/components/schemas/DuplicateSensorTestTemplateResponse"}}}},"202":{"description":"The request has been accepted for execution.","content":{}},"400":{"description":"The client made a request that the server could not understand (for example, the request syntax is incorrect).","content":{}},"401":{"description":"The client's authentication credentials included with the request are missing or invalid.","content":{}},"404":{"description":"The client made a request for a resource that does not exist.","content":{}},"500":{"description":"The server could not fulfill the request.","content":{}}},"x-rapi-id":"85a2-8837-4909-9021","x-rapi-overview":"Intent API to duplicate an existing SENSOR test template","x-rapi-domain":"Know Your Network","x-rapi-subdomain":"Sensors","x-rapi-version":"1.0.0","x-rapi-banner":["Intent"],"x-rapi-rateLimiting":"5~1","__originalOperationId":"duplicateSensorTestTemplate","method":"put","path":"/dna/intent/api/v1/sensorTestTemplate"}}