{"type":"api","title":"Update Device Details","meta":{"id":"/apps/pubhub/media/cisco-catalyst-center-api-2-3-7-9/b3d6cc9fb9f506b3bc9099912aa8a6f9d87e0f0a/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":"updateDeviceDetails","tags":["Devices"],"deprecated":false,"summary":"Update Device Details","description":"Update the credentials, management IP address of a given device (or a set of devices) in Catalyst Center and trigger an inventory sync.","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, ssh. Use NO!$DATA!$ if no change is required. Required if type is NETWORK_DEVICE."},"computeDevice":{"type":"boolean","description":"Compute Device or not. Options are true / false."},"enablePassword":{"type":"string","description":"CLI enable password of the device. Required if device is configured to use enable password. Use NO!$DATA!$ if no change is required."},"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 / API key for Meraki Dashboard. Required if type is MERAKI_DASHBOARD or COMPUTE_DEVICE. Use NO!$DATA!$ if no change is required."},"httpPort":{"type":"string","description":"HTTP port of the device. Required if type is COMPUTE_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. Required if type is COMPUTE_DEVICE. Use NO!$DATA!$ if no change is required."},"ipAddress":{"type":"array","items":{"type":"string"},"description":"IP Address of the device. Required. Use 'api.meraki.com' for Meraki Dashboard."},"merakiOrgId":{"type":"array","items":{"type":"string"},"description":"Selected Meraki organization for which the devices needs to be imported. Required if type is MERAKI_DASHBOARD."},"netconfPort":{"type":"string","description":"Netconf Port of the device. cliTransport must be 'ssh' if netconf is provided. Netconf port is required for eWLC."},"password":{"type":"string","description":"CLI Password of the device. Required if type is NETWORK_DEVICE. Use NO!$DATA!$ if no change is required."},"serialNumber":{"type":"string","description":"Serial Number of the Device. Required if extendedDiscoveryInfo is 'DISCOVER_WITH_CANNED_DATA'."},"snmpAuthPassphrase":{"type":"string","description":"SNMPv3 auth passphrase of the device. Required if snmpMode is authNoPriv or authPriv. Use NO!$DATA!$ if no change is required."},"snmpAuthProtocol":{"type":"string","description":"SNMPv3 auth protocol. Supported values: sha, md5. Required if snmpMode is authNoPriv or authPriv. Use NODATACHANGE if no change is required."},"snmpMode":{"type":"string","description":"SNMPv3 mode. Supported values: noAuthnoPriv, authNoPriv, authPriv. Required if snmpVersion is v3. Use NODATACHANGE if no change is required."},"snmpPrivPassphrase":{"type":"string","description":"SNMPv3 priv passphrase. Required if snmpMode is authPriv. Use NO!$DATA!$ if no change is required."},"snmpPrivProtocol":{"type":"string","description":"SNMPv3 priv protocol. Supported values: AES128. Required if snmpMode is authPriv. Use NODATACHANGE if no change is required."},"snmpROCommunity":{"type":"string","description":"SNMP Read Community of the device. If snmpVersion is v2, at least one of snmpROCommunity and snmpRWCommunity is required. Use NO!$DATA!$ if no change is required."},"snmpRWCommunity":{"type":"string","description":"SNMP Write Community of the device. If snmpVersion is v2, at least one of snmpROCommunity and snmpRWCommunity is required. Use NO!$DATA!$ if no change is required."},"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. Required if snmpVersion is v3. Use NO!$DATA!$ if no change is required."},"snmpVersion":{"type":"string","description":"SNMP version. Values supported: v2, v3. Required if type is NETWORK_DEVICE, COMPUTE_DEVICE or THIRD_PARTY_DEVICE. Use NODATACHANGE if no change is required."},"type":{"type":"string","enum":["COMPUTE_DEVICE","MERAKI_DASHBOARD","NETWORK_DEVICE","THIRD_PARTY_DEVICE","NODATACHANGE"],"description":"Type of device being edited. Default is NETWORK_DEVICE."},"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 if type is NETWORK_DEVICE. Use NO!$DATA!$ if no change is required."}},"description":"","$$ref":"#/components/schemas/UpdateDeviceDetailsRequest"}}},"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/UpdateDeviceDetailsResponse"}}}},"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":"aeb9-eb67-460b-92df","x-rapi-overview":"Update the credentials, management IP address of a given device (or a set of devices) in Catalyst Center and trigger an inventory sync.","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":"updateDeviceDetails","method":"put","path":"/dna/intent/api/v1/network-device"}}