{"type":"api","title":"Update Device","meta":{"id":"/apps/pubhub/media/dna-center-235/0e427c513038595590fc5a0593cb0e208dd78571/2192edf3-d24e-3461-ab8c-12a97b547df4","swagger":"2.0","info":{"description":"Cisco DNA Center Platform v. 2.3.5","version":"2.3.5","title":"Intent API"},"schemes":["https"],"x-parser-conf":{"expand":0,"labelConfig":{"endpoint":"summary"}}},"spec":{"operationId":"updateDevice","tags":["Device Onboarding (PnP)"],"summary":"Update Device","description":"Updates device details specified by device id in PnP database","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"request","description":"request","required":true,"schema":{"type":"object","properties":{"_id":{"type":"string"},"deviceInfo":{"type":"object","properties":{"source":{"type":"string"},"serialNumber":{"type":"string"},"stack":{"type":"boolean"},"mode":{"type":"string"},"state":{"type":"string"},"location":{"type":"object","properties":{"siteId":{"type":"string"},"address":{"type":"string"},"latitude":{"type":"string"},"longitude":{"type":"string"},"altitude":{"type":"string"}}},"description":{"type":"string"},"onbState":{"type":"string"},"authenticatedMicNumber":{"type":"string"},"authenticatedSudiSerialNo":{"type":"string"},"capabilitiesSupported":{"type":"array","items":{"type":"string"}},"featuresSupported":{"type":"array","items":{"type":"string"}},"cmState":{"type":"string"},"firstContact":{"type":"number"},"lastContact":{"type":"number"},"macAddress":{"type":"string"},"pid":{"type":"string"},"deviceSudiSerialNos":{"type":"array","items":{"type":"string"}},"lastUpdateOn":{"type":"number"},"workflowId":{"type":"string"},"workflowName":{"type":"string"},"projectId":{"type":"string"},"projectName":{"type":"string"},"deviceType":{"type":"string"},"agentType":{"type":"string"},"imageVersion":{"type":"string"},"fileSystemList":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"writeable":{"type":"boolean"},"freespace":{"type":"number"},"name":{"type":"string"},"readable":{"type":"boolean"},"size":{"type":"number"}}}},"pnpProfileList":{"type":"array","items":{"type":"object","properties":{"profileName":{"type":"string"},"discoveryCreated":{"type":"boolean"},"createdBy":{"type":"string"},"primaryEndpoint":{"type":"object","properties":{"port":{"type":"number"},"protocol":{"type":"string"},"ipv4Address":{"type":"object","properties":{}},"ipv6Address":{"type":"object","properties":{}},"fqdn":{"type":"string"},"certificate":{"type":"string"}}},"secondaryEndpoint":{"type":"object","properties":{"port":{"type":"number"},"protocol":{"type":"string"},"ipv4Address":{"type":"object","properties":{}},"ipv6Address":{"type":"object","properties":{}},"fqdn":{"type":"string"},"certificate":{"type":"string"}}}}}},"imageFile":{"type":"string"},"httpHeaders":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}},"neighborLinks":{"type":"array","items":{"type":"object","properties":{"localInterfaceName":{"type":"string"},"localShortInterfaceName":{"type":"string"},"localMacAddress":{"type":"string"},"remoteInterfaceName":{"type":"string"},"remoteShortInterfaceName":{"type":"string"},"remoteMacAddress":{"type":"string"},"remoteDeviceName":{"type":"string"},"remotePlatform":{"type":"string"},"remoteVersion":{"type":"string"}}}},"lastSyncTime":{"type":"number"},"ipInterfaces":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string"},"macAddress":{"type":"string"},"ipv4Address":{"type":"object","properties":{}},"ipv6AddressList":{"type":"array","items":{"type":"object","properties":{}}},"name":{"type":"string"}}}},"hostname":{"type":"string"},"authStatus":{"type":"string"},"stackInfo":{"type":"object","properties":{"supportsStackWorkflows":{"type":"boolean"},"isFullRing":{"type":"boolean"},"stackMemberList":{"type":"array","items":{"type":"object","properties":{"serialNumber":{"type":"string"},"state":{"type":"string"},"role":{"type":"string"},"macAddress":{"type":"string"},"pid":{"type":"string"},"licenseLevel":{"type":"string"},"licenseType":{"type":"string"},"sudiSerialNumber":{"type":"string"},"hardwareVersion":{"type":"string"},"stackNumber":{"type":"number"},"softwareVersion":{"type":"string"},"priority":{"type":"number"}}}},"stackRingProtocol":{"type":"string"},"validLicenseLevels":{"type":"array","items":{"type":"string"}},"totalMemberCount":{"type":"number"}}},"reloadRequested":{"type":"boolean"},"addedOn":{"type":"number"},"siteId":{"type":"string"},"aaaCredentials":{"type":"object","properties":{"password":{"type":"string"},"username":{"type":"string"}}},"userMicNumbers":{"type":"array","items":{"type":"string"}},"userSudiSerialNos":{"type":"array","items":{"type":"string"}},"addnMacAddrs":{"type":"array","items":{"type":"string"}},"preWorkflowCliOuputs":{"type":"array","items":{"type":"object","properties":{"cli":{"type":"string"},"cliOutput":{"type":"string"}}}},"tags":{"type":"object","properties":{}},"sudiRequired":{"type":"boolean"},"smartAccountId":{"type":"string"},"virtualAccountId":{"type":"string"},"populateInventory":{"type":"boolean"},"siteName":{"type":"string"},"name":{"type":"string"}}},"systemResetWorkflow":{"type":"object","properties":{"_id":{"type":"string"},"state":{"type":"string"},"type":{"type":"string"},"description":{"type":"string"},"lastupdateOn":{"type":"number"},"imageId":{"type":"string"},"currTaskIdx":{"type":"number"},"addedOn":{"type":"number"},"tasks":{"type":"array","items":{"type":"object","properties":{"state":{"type":"string"},"type":{"type":"string"},"currWorkItemIdx":{"type":"number"},"taskSeqNo":{"type":"number"},"endTime":{"type":"number"},"startTime":{"type":"number"},"workItemList":{"type":"array","items":{"type":"object","properties":{"state":{"type":"string"},"command":{"type":"string"},"outputStr":{"type":"string"},"endTime":{"type":"number"},"startTime":{"type":"number"},"timeTaken":{"type":"number"}}}},"timeTaken":{"type":"number"},"name":{"type":"string"}}}},"addToInventory":{"type":"boolean"},"instanceType":{"type":"string"},"endTime":{"type":"number"},"execTime":{"type":"number"},"startTime":{"type":"number"},"useState":{"type":"string"},"configId":{"type":"string"},"name":{"type":"string"},"version":{"type":"number"},"tenantId":{"type":"string"}}},"systemWorkflow":{"type":"object","properties":{"_id":{"type":"string"},"state":{"type":"string"},"type":{"type":"string"},"description":{"type":"string"},"lastupdateOn":{"type":"number"},"imageId":{"type":"string"},"currTaskIdx":{"type":"number"},"addedOn":{"type":"number"},"tasks":{"type":"array","items":{"type":"object","properties":{"state":{"type":"string"},"type":{"type":"string"},"currWorkItemIdx":{"type":"number"},"taskSeqNo":{"type":"number"},"endTime":{"type":"number"},"startTime":{"type":"number"},"workItemList":{"type":"array","items":{"type":"object","properties":{"state":{"type":"string"},"command":{"type":"string"},"outputStr":{"type":"string"},"endTime":{"type":"number"},"startTime":{"type":"number"},"timeTaken":{"type":"number"}}}},"timeTaken":{"type":"number"},"name":{"type":"string"}}}},"addToInventory":{"type":"boolean"},"instanceType":{"type":"string"},"endTime":{"type":"number"},"execTime":{"type":"number"},"startTime":{"type":"number"},"useState":{"type":"string"},"configId":{"type":"string"},"name":{"type":"string"},"version":{"type":"number"},"tenantId":{"type":"string"}}},"workflow":{"type":"object","properties":{"_id":{"type":"string"},"state":{"type":"string"},"type":{"type":"string"},"description":{"type":"string"},"lastupdateOn":{"type":"number"},"imageId":{"type":"string"},"currTaskIdx":{"type":"number"},"addedOn":{"type":"number"},"tasks":{"type":"array","items":{"type":"object","properties":{"state":{"type":"string"},"type":{"type":"string"},"currWorkItemIdx":{"type":"number"},"taskSeqNo":{"type":"number"},"endTime":{"type":"number"},"startTime":{"type":"number"},"workItemList":{"type":"array","items":{"type":"object","properties":{"state":{"type":"string"},"command":{"type":"string"},"outputStr":{"type":"string"},"endTime":{"type":"number"},"startTime":{"type":"number"},"timeTaken":{"type":"number"}}}},"timeTaken":{"type":"number"},"name":{"type":"string"}}}},"addToInventory":{"type":"boolean"},"instanceType":{"type":"string"},"endTime":{"type":"number"},"execTime":{"type":"number"},"startTime":{"type":"number"},"useState":{"type":"string"},"configId":{"type":"string"},"name":{"type":"string"},"version":{"type":"number"},"tenantId":{"type":"string"}}},"runSummaryList":{"type":"array","items":{"type":"object","properties":{"details":{"type":"string"},"historyTaskInfo":{"type":"object","properties":{"type":{"type":"string"},"workItemList":{"type":"array","items":{"type":"object","properties":{"state":{"type":"string"},"command":{"type":"string"},"outputStr":{"type":"string"},"endTime":{"type":"number"},"startTime":{"type":"number"},"timeTaken":{"type":"number"}}}},"timeTaken":{"type":"number"},"addnDetails":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}},"name":{"type":"string"}}},"errorFlag":{"type":"boolean"},"timestamp":{"type":"number"}}}},"workflowParameters":{"type":"object","properties":{"topOfStackSerialNumber":{"type":"string"},"licenseLevel":{"type":"string"},"licenseType":{"type":"string"},"configList":{"type":"array","items":{"type":"object","properties":{"configParameters":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}},"configId":{"type":"string"}}}}}},"dayZeroConfig":{"type":"object","properties":{"config":{"type":"string"}}},"dayZeroConfigPreview":{"type":"object","properties":{}},"version":{"type":"number"},"tenantId":{"type":"string"}},"$$ref":"#/definitions/Device"},"in":"body"},{"name":"Content-Type","description":"Request body content type","default":"application/json","required":true,"type":"string","in":"header"},{"name":"id","description":"id","required":true,"type":"string","in":"path"}],"responses":{"200":{"description":"The request was successful. The result is contained in the response body.","schema":{"type":"object","properties":{"_id":{"type":"string"},"deviceInfo":{"type":"object","properties":{"source":{"type":"string"},"serialNumber":{"type":"string"},"stack":{"type":"boolean"},"mode":{"type":"string"},"state":{"type":"string"},"location":{"type":"object","properties":{"siteId":{"type":"string"},"address":{"type":"string"},"latitude":{"type":"string"},"longitude":{"type":"string"},"altitude":{"type":"string"}}},"description":{"type":"string"},"onbState":{"type":"string"},"authenticatedMicNumber":{"type":"string"},"authenticatedSudiSerialNo":{"type":"string"},"capabilitiesSupported":{"type":"array","items":{"type":"string"}},"featuresSupported":{"type":"array","items":{"type":"string"}},"cmState":{"type":"string"},"firstContact":{"type":"number"},"lastContact":{"type":"number"},"macAddress":{"type":"string"},"pid":{"type":"string"},"deviceSudiSerialNos":{"type":"array","items":{"type":"string"}},"lastUpdateOn":{"type":"number"},"workflowId":{"type":"string"},"workflowName":{"type":"string"},"projectId":{"type":"string"},"projectName":{"type":"string"},"deviceType":{"type":"string"},"agentType":{"type":"string"},"imageVersion":{"type":"string"},"fileSystemList":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"writeable":{"type":"boolean"},"freespace":{"type":"number"},"name":{"type":"string"},"readable":{"type":"boolean"},"size":{"type":"number"}}}},"pnpProfileList":{"type":"array","items":{"type":"object","properties":{"profileName":{"type":"string"},"discoveryCreated":{"type":"boolean"},"createdBy":{"type":"string"},"primaryEndpoint":{"type":"object","properties":{"port":{"type":"number"},"protocol":{"type":"string"},"ipv4Address":{"type":"object","properties":{}},"ipv6Address":{"type":"object","properties":{}},"fqdn":{"type":"string"},"certificate":{"type":"string"}}},"secondaryEndpoint":{"type":"object","properties":{"port":{"type":"number"},"protocol":{"type":"string"},"ipv4Address":{"type":"object","properties":{}},"ipv6Address":{"type":"object","properties":{}},"fqdn":{"type":"string"},"certificate":{"type":"string"}}}}}},"imageFile":{"type":"string"},"httpHeaders":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}},"neighborLinks":{"type":"array","items":{"type":"object","properties":{"localInterfaceName":{"type":"string"},"localShortInterfaceName":{"type":"string"},"localMacAddress":{"type":"string"},"remoteInterfaceName":{"type":"string"},"remoteShortInterfaceName":{"type":"string"},"remoteMacAddress":{"type":"string"},"remoteDeviceName":{"type":"string"},"remotePlatform":{"type":"string"},"remoteVersion":{"type":"string"}}}},"lastSyncTime":{"type":"number"},"ipInterfaces":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string"},"macAddress":{"type":"string"},"ipv4Address":{"type":"object","properties":{}},"ipv6AddressList":{"type":"array","items":{"type":"object","properties":{}}},"name":{"type":"string"}}}},"hostname":{"type":"string"},"authStatus":{"type":"string"},"stackInfo":{"type":"object","properties":{"supportsStackWorkflows":{"type":"boolean"},"isFullRing":{"type":"boolean"},"stackMemberList":{"type":"array","items":{"type":"object","properties":{"serialNumber":{"type":"string"},"state":{"type":"string"},"role":{"type":"string"},"macAddress":{"type":"string"},"pid":{"type":"string"},"licenseLevel":{"type":"string"},"licenseType":{"type":"string"},"sudiSerialNumber":{"type":"string"},"hardwareVersion":{"type":"string"},"stackNumber":{"type":"number"},"softwareVersion":{"type":"string"},"priority":{"type":"number"}}}},"stackRingProtocol":{"type":"string"},"validLicenseLevels":{"type":"array","items":{"type":"string"}},"totalMemberCount":{"type":"number"}}},"reloadRequested":{"type":"boolean"},"addedOn":{"type":"number"},"siteId":{"type":"string"},"aaaCredentials":{"type":"object","properties":{"password":{"type":"string"},"username":{"type":"string"}}},"userMicNumbers":{"type":"array","items":{"type":"string"}},"userSudiSerialNos":{"type":"array","items":{"type":"string"}},"addnMacAddrs":{"type":"array","items":{"type":"string"}},"preWorkflowCliOuputs":{"type":"array","items":{"type":"object","properties":{"cli":{"type":"string"},"cliOutput":{"type":"string"}}}},"tags":{"type":"object","properties":{}},"sudiRequired":{"type":"boolean"},"smartAccountId":{"type":"string"},"virtualAccountId":{"type":"string"},"populateInventory":{"type":"boolean"},"siteName":{"type":"string"},"name":{"type":"string"}}},"systemResetWorkflow":{"type":"object","properties":{"_id":{"type":"string"},"state":{"type":"string"},"type":{"type":"string"},"description":{"type":"string"},"lastupdateOn":{"type":"number"},"imageId":{"type":"string"},"currTaskIdx":{"type":"number"},"addedOn":{"type":"number"},"tasks":{"type":"array","items":{"type":"object","properties":{"state":{"type":"string"},"type":{"type":"string"},"currWorkItemIdx":{"type":"number"},"taskSeqNo":{"type":"number"},"endTime":{"type":"number"},"startTime":{"type":"number"},"workItemList":{"type":"array","items":{"type":"object","properties":{"state":{"type":"string"},"command":{"type":"string"},"outputStr":{"type":"string"},"endTime":{"type":"number"},"startTime":{"type":"number"},"timeTaken":{"type":"number"}}}},"timeTaken":{"type":"number"},"name":{"type":"string"}}}},"addToInventory":{"type":"boolean"},"instanceType":{"type":"string"},"endTime":{"type":"number"},"execTime":{"type":"number"},"startTime":{"type":"number"},"useState":{"type":"string"},"configId":{"type":"string"},"name":{"type":"string"},"version":{"type":"number"},"tenantId":{"type":"string"}}},"systemWorkflow":{"type":"object","properties":{"_id":{"type":"string"},"state":{"type":"string"},"type":{"type":"string"},"description":{"type":"string"},"lastupdateOn":{"type":"number"},"imageId":{"type":"string"},"currTaskIdx":{"type":"number"},"addedOn":{"type":"number"},"tasks":{"type":"array","items":{"type":"object","properties":{"state":{"type":"string"},"type":{"type":"string"},"currWorkItemIdx":{"type":"number"},"taskSeqNo":{"type":"number"},"endTime":{"type":"number"},"startTime":{"type":"number"},"workItemList":{"type":"array","items":{"type":"object","properties":{"state":{"type":"string"},"command":{"type":"string"},"outputStr":{"type":"string"},"endTime":{"type":"number"},"startTime":{"type":"number"},"timeTaken":{"type":"number"}}}},"timeTaken":{"type":"number"},"name":{"type":"string"}}}},"addToInventory":{"type":"boolean"},"instanceType":{"type":"string"},"endTime":{"type":"number"},"execTime":{"type":"number"},"startTime":{"type":"number"},"useState":{"type":"string"},"configId":{"type":"string"},"name":{"type":"string"},"version":{"type":"number"},"tenantId":{"type":"string"}}},"workflow":{"type":"object","properties":{"_id":{"type":"string"},"state":{"type":"string"},"type":{"type":"string"},"description":{"type":"string"},"lastupdateOn":{"type":"number"},"imageId":{"type":"string"},"currTaskIdx":{"type":"number"},"addedOn":{"type":"number"},"tasks":{"type":"array","items":{"type":"object","properties":{"state":{"type":"string"},"type":{"type":"string"},"currWorkItemIdx":{"type":"number"},"taskSeqNo":{"type":"number"},"endTime":{"type":"number"},"startTime":{"type":"number"},"workItemList":{"type":"array","items":{"type":"object","properties":{"state":{"type":"string"},"command":{"type":"string"},"outputStr":{"type":"string"},"endTime":{"type":"number"},"startTime":{"type":"number"},"timeTaken":{"type":"number"}}}},"timeTaken":{"type":"number"},"name":{"type":"string"}}}},"addToInventory":{"type":"boolean"},"instanceType":{"type":"string"},"endTime":{"type":"number"},"execTime":{"type":"number"},"startTime":{"type":"number"},"useState":{"type":"string"},"configId":{"type":"string"},"name":{"type":"string"},"version":{"type":"number"},"tenantId":{"type":"string"}}},"runSummaryList":{"type":"array","items":{"type":"object","properties":{"details":{"type":"string"},"historyTaskInfo":{"type":"object","properties":{"type":{"type":"string"},"workItemList":{"type":"array","items":{"type":"object","properties":{"state":{"type":"string"},"command":{"type":"string"},"outputStr":{"type":"string"},"endTime":{"type":"number"},"startTime":{"type":"number"},"timeTaken":{"type":"number"}}}},"timeTaken":{"type":"number"},"addnDetails":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}},"name":{"type":"string"}}},"errorFlag":{"type":"boolean"},"timestamp":{"type":"number"}}}},"workflowParameters":{"type":"object","properties":{"topOfStackSerialNumber":{"type":"string"},"licenseLevel":{"type":"string"},"licenseType":{"type":"string"},"configList":{"type":"array","items":{"type":"object","properties":{"configParameters":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}},"configId":{"type":"string"}}}}}},"dayZeroConfig":{"type":"object","properties":{"config":{"type":"string"}}},"dayZeroConfigPreview":{"type":"object","properties":{}},"version":{"type":"number"},"tenantId":{"type":"string"}},"$$ref":"#/definitions/UpdateDeviceResponse"}},"201":{"description":"The POST/PUT request was fulfilled and a new resource has been created. Information about the resource is in the response body."},"202":{"description":"The request was accepted for processing, but the processing has not been completed."},"204":{"description":"The request was successful, however no content was returned."},"206":{"description":"The GET request included a Range Header, and the server responded with the partial content matching the range."},"400":{"description":"The client made a request that the server could not understand (for example, the request syntax is incorrect)."},"401":{"description":"The client's authentication credentials included with the request are missing or invalid."},"403":{"description":"The server recognizes the authentication credentials, but the client is not authorized to perform this request."},"404":{"description":"The client made a request for a resource that does not exist."},"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."},"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)."},"500":{"description":"The server could not fulfill the request."},"501":{"description":"The server has not implemented the functionality required to fulfill the request."},"503":{"description":"The server is (temporarily) unavailable."},"504":{"description":"The server did not respond inside time restrictions and timed-out."}},"__originalOperationId":"updateDevice","method":"put","path":"/dna/intent/api/v1/onboarding/pnp-device/{id}"}}