Fetch network device with image details - Cisco Catalyst Center API 3.1.3

{"type":"api","title":"Fetch network device with image details","meta":{"id":"/apps/pubhub/media/cisco-catalyst-center-api-3-1-3/9b7bce247bccb0311419e593770ef07f9552d9e1/d41c7da7-f399-330a-bd19-886309e55849","info":{"title":"Intent API","description":"Cisco Catalyst Center Platform v. 3.1.3","version":"3.1.3"},"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.3","servers":[{"url":"/"}]},"spec":{"operationId":"fetchNetworkDeviceWithImageDetails","tags":["Software Image Management (SWIM)"],"summary":"Fetch network device with image details","deprecated":false,"description":"The API retrieves information about running images and golden image bundle, if they are available for the network device. It also provides network device update status and image update status related to the golden image bundle and the compatible features supported by the network device. Network device with `networkDeviceImageStatus` set as `OUTDATED` is considered ready for update based on the golden image bundle.","parameters":[{"name":"id","description":"Network device identifier","required":true,"schema":{"type":"string","default":"application/json"},"in":"path"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"object","properties":{"id":{"type":"string","description":"Network device identifier."},"managementAddress":{"type":"string","description":"Either an IP address or a fully-qualified domain name."},"networkDevice":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the record is the `id`. If there is no supervisor engine involved, the `id` will be the same as the `productNameOrdinal`. However, if the supervisor engine is applicable, the `id` will be in the form of `\u003cproductNameOrdinal\u003e-\u003csupervisorProductNameOrdinal\u003e`."},"productNameOrdinal":{"type":"number","description":"Product name ordinal."},"productName":{"type":"string","description":"Name of product."},"supervisorProductName":{"type":"string","description":"Name of the Supervisor Engine Module, supported by the `productName`. Example: The `Cisco Catalyst 9404R Switch` chassis is capable of supporting different supervisor engine modules: the `Cisco Catalyst 9400 Supervisor Engine-1`, the `Cisco Catalyst 9400 Supervisor Engine-1XL`, the `Cisco Catalyst 9400 Supervisor Engine-1XL-Y`, etc."},"supervisorProductNameOrdinal":{"type":"number","description":"Supervisor Engine Module Ordinal, supported by the `productNameOrdinal`. Example: The `286315691` chassis ordinal is capable of supporting different supervisor engine module ordinals: `286316172`, `286316710`, `286320394` etc."}},"required":["id"],"description":"Details of the network device, such as the product name and product ordinal value."},"networkDeviceImageStatus":{"type":"string","enum":["OUTDATED","UP_TO_DATE","UNKNOWN","CONFLICTED","UNSUPPORTED"],"description":"The network device's current status concerns golden bundle images."},"networkDeviceUpdateStatus":{"type":"string","enum":["DISTRIBUTION_PENDING","DISTRIBUTION_IN_PROGRESS","DISTRIBUTION_FAILED","ACTIVATION_PENDING","ACTIVATION_IN_PROGRESS","ACTIVATION_FAILED","DEVICE_UP_TO_DATE","UNKNOWN"],"description":"The network device's current update status concerns golden images."},"goldenImages":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Software image identifier."},"name":{"type":"string","description":"Name of the image."},"version":{"type":"string","description":"Image version."},"imageType":{"type":"string","enum":["SYSTEM","SMU","PSIRT_SMU","SUBPACKAGE","ROMMON_SW","APDP","APSP"],"description":""},"goldenTaggingDetails":{"type":"object","properties":{"deviceRoles":{"type":"string","enum":["CORE","DISTRIBUTION","UNKNOWN","ACCESS","BORDER_ROUTER"],"description":"Role assigned to the network device."},"deviceTags":{"type":"string","description":"A device tag is either user-defined or system-defined and is associated with a given network device."},"siteId":{"type":"string","description":"The site id of the site from which these golden images originate."},"siteName":{"type":"string","description":"The name of the site from which these golden images originate."},"isInherited":{"type":"boolean","description":"Inherited flag is set to 'true' if the golden images are inherited from sites higher in the site hierarchy, and 'false' if they are from the native site."}},"description":"Golden image tagging criteria."}},"required":["id","name","version","imageType"]},"description":"List of golden images."},"installedImages":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Software image identifier"},"name":{"type":"string","description":"Network device running image."},"version":{"type":"string","description":"Image version."},"imageType":{"type":"string","enum":["SYSTEM","SMU","PSIRT_SMU","SUBPACKAGE","ROMMON_SW","APDP","APSP"],"description":"Image Type."}},"required":["name"]},"description":"Details of software images running on a network device."},"compatibleFeatures":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"Name of the compatible feature."},"value":{"type":"string","enum":["ENABLE","DISABLE"],"description":"Feature that can be enabled or disabled."}}},"description":"The list of functionalities or capabilities that are supported or compatible with a particular device. For example, it determines whether ISSU, Rommon update, etc. can be enabled on the device."}},"required":["id"],"description":""},"version":{"type":"string","description":"The version of the response."}},"description":"","$$ref":"#/components/schemas/fetchNetworkDeviceWithImageDetailsResponse"}}}},"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":{}},"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":{}},"502":{"description":"The server is (temporarily) unavailable.","content":{}},"503":{"description":"The server is (temporarily) unavailable.","content":{}},"504":{"description":"The server did not respond inside time restrictions and timed-out.","content":{}},"1XX":{"description":"Informational Responses - The server received the request and sent an informational response.","content":{}},"2XX":{"description":"Successful Responses - The server received the client request, understood it, and accepted it.","content":{}},"3XX":{"description":"Redirection Messages - The client must take additional action to complete the request.","content":{}},"4XX":{"description":"Client Error Responses - The client request caused the error.","content":{}},"5XX":{"description":"Server Error Responses - The server failed to fulfill the request.","content":{}}},"x-rapi-id":"ec9f-29d4-4faa-975d","x-rapi-overview":"The API retrieves information about running images and golden image bundle, if they are available for the network device. It also provides network device update status and image update status related to the golden image bundle and the compatible features supported by the network device. Network device with `networkDeviceImageStatus` set as `OUTDATED` is considered ready for update based on the golden image bundle.","x-rapi-domain":"Site Management","x-rapi-subdomain":"Software Image Management (SWIM)","x-rapi-version":"1.0.0","x-rapi-internalPath":"/intent/api/v1/networkDeviceImages/${id}","x-rapi-publicPath":"/dna/intent/api/v1/networkDeviceImages/${id}","x-rapi-registerInKONG":true,"x-rapi-banner":["Intent"],"x-rapi-deprecationMessage":"","x-rapi-rateLimiting":"100~MINUTE","__originalOperationId":"fetchNetworkDeviceWithImageDetails","method":"get","path":"/dna/intent/api/v1/networkDeviceImages/{id}"}}