{"type":"api","title":"Add Device","meta":{"id":"/apps/pubhub/media/cisco-catalyst-center-api-2-3-7-4/5f0ebf004a2d4799bf23d5900695a35a48893d24/e3488c7c-70e3-3936-bce5-55e87fc57590","info":{"title":"Intent API","description":"Cisco Catalyst Center Platform v. 2.3.7.4","version":"2.3.7.4"},"x-parser-conf":{"expand":0,"labelConfig":{"endpoint":"summary"}}},"spec":{"operationId":"addDevice","tags":["Devices"],"deprecated":false,"summary":"Add Device","description":"Adds the device with given credential","parameters":[{"name":"Content-Type","description":"Request body content type","required":true,"schema":{"type":"string","default":"application/json"},"in":"header"}],"requestBody":{"description":"request","content":{"application/json":{"schema":{"type":"object","properties":{"cliTransport":{"type":"string","description":"CLI transport. Supported values: telnet, ssh2"},"computeDevice":{"type":"boolean","description":"Compute Device or not. Options are TRUE / FALSE"},"enablePassword":{"type":"string","description":"CLI enable password of the device "},"extendedDiscoveryInfo":{"type":"string","description":"This field holds that info as whether to add device with canned data or not. Supported values: DISCOVER_WITH_CANNED_DATA"},"httpPassword":{"type":"string","description":"HTTP password of the device"},"httpPort":{"type":"string","description":"HTTP port of the device"},"httpSecure":{"type":"boolean","description":"Flag to select HTTP / HTTPS protocol. Options are TRUE / FALSE. TRUE for HTTPS and FALSE for HTTP"},"httpUserName":{"type":"string","description":"HTTP Username of the device"},"ipAddress":{"type":"array","items":{"type":"string"},"description":"IP Address of the device"},"merakiOrgId":{"type":"array","items":{"type":"string"},"description":"Selected meraki organization for which the devices needs to be imported"},"netconfPort":{"type":"string","description":"Netconf Port of the device"},"password":{"type":"string","description":"CLI Password of the device"},"serialNumber":{"type":"string","description":"Serial Number of the Device"},"snmpAuthPassphrase":{"type":"string","description":"SNMPV3 auth passphrase of the device"},"snmpAuthProtocol":{"type":"string","description":"SNMPV3 auth protocol. Supported values: sha, md5"},"snmpMode":{"type":"string","description":"SNMPV3 mode. Supported values: noAuthnoPriv, authNoPriv, authPriv"},"snmpPrivPassphrase":{"type":"string","description":"SNMPV3 priv passphrase"},"snmpPrivProtocol":{"type":"string","description":"SNMPV3 priv protocol. Supported values: AES128"},"snmpROCommunity":{"type":"string","description":"SNMP Read Community of the device"},"snmpRWCommunity":{"type":"string","description":"SNMP Write Community of the device"},"snmpRetry":{"type":"integer","description":"SNMP retry count. Max value supported is 3. Default is Global SNMP retry (if exists) or 3."},"snmpTimeout":{"type":"integer","description":"SNMP timeout in seconds. Max value supported is 300. Default is Global SNMP timeout (if exists) or 5."},"snmpUserName":{"type":"string","description":"SNMPV3 user name of the device"},"snmpVersion":{"type":"string","description":"SNMP version. Values supported: v2, v3. Default is v2"},"type":{"type":"string","enum":["COMPUTE_DEVICE","MERAKI_DASHBOARD","NETWORK_DEVICE","FIREPOWER MANAGEMENT CENTER","THIRD PARTY DEVICE","NODATACHANGE"],"description":"Type of device being added."},"updateMgmtIPaddressList":{"type":"array","items":{"type":"object","properties":{"existMgmtIpAddress":{"type":"string","description":"ExistMgmtIpAddress IP Address of the device"},"newMgmtIpAddress":{"type":"string","description":"New IP Address to be Updated"}}},"description":"IPAddress of the device to be mapped to New IPAddress."},"userName":{"type":"string","description":"CLI user name of the device"}},"required":["cliTransport","enablePassword","ipAddress","password","snmpAuthPassphrase","snmpAuthProtocol","snmpMode","snmpPrivPassphrase","snmpPrivProtocol","snmpROCommunity","snmpRWCommunity","snmpRetry","snmpTimeout","snmpUserName","userName"],"description":"","$$ref":"#/components/schemas/addDeviceRequest"}}},"required":true},"responses":{"200":{"description":"The request was successful. The result is contained in the response body.","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"object","properties":{"taskId":{"type":"string","description":""},"url":{"type":"string","description":""}},"description":""},"version":{"type":"string","description":""}},"description":"","$$ref":"#/components/schemas/addDeviceResponse"}}}},"201":{"description":"The POST/PUT request was fulfilled and a new resource has been created. Information about the resource is in the response body.","content":{}},"202":{"description":"The request was accepted for processing, but the processing has not been completed.","content":{}},"204":{"description":"The request was successful, however no content was returned.","content":{}},"206":{"description":"The GET request included a Range Header, and the server responded with the partial content matching the range.","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":{}},"403":{"description":"The server recognizes the authentication credentials, but the client is not authorized to perform this request.","content":{}},"404":{"description":"The client made a request for a resource that does not exist.","content":{}},"409":{"description":"The target resource is in a conflicted state (for example, an edit conflict where a resource is being edited by multiple users). Retrying the request later might succeed.","content":{}},"415":{"description":"The client sent a request body in a format that the server does not support (for example, XML to a server that only accepts JSON).","content":{}},"500":{"description":"The server could not fulfill the request.","content":{}},"501":{"description":"The server has not implemented the functionality required to fulfill the request.","content":{}},"503":{"description":"The server is (temporarily) unavailable.","content":{}},"504":{"description":"The server did not respond inside time restrictions and timed-out.","content":{}}},"x-rapi-id":"4bb2-2af0-46fa-8f08","x-rapi-overview":"Adds the device with given credential","x-rapi-domain":"Know Your Network","x-rapi-subdomain":"Devices","x-rapi-version":"1.0.0","x-rapi-internalPath":"/api/v1/network-device","x-rapi-publicPath":"/dna/intent/api/v1/network-device","x-rapi-registerInKONG":true,"x-rapi-banner":[],"__originalOperationId":"addDevice","method":"post","path":"/dna/intent/api/v1/network-device"}}