{"type":"model","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":{"type":"object","properties":{"response":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":""},"name":{"type":"string","description":""},"managementIpAddress":{"type":"string","description":""},"platformId":{"type":"string","description":""},"deviceFamily":{"type":"string","description":""},"serialNumber":{"type":"string","description":""},"macAddress":{"type":"string","description":""},"deviceSeries":{"type":"string","description":""},"softwareVersion":{"type":"string","description":""},"productVendor":{"type":"string","description":""},"deviceRole":{"type":"string","description":""},"deviceType":{"type":"string","description":""},"communicationState":{"type":"string","description":""},"collectionStatus":{"type":"string","description":""},"haStatus":{"type":"string","description":""},"lastBootTime":{"type":"integer","description":""},"siteHierarchyId":{"type":"string","description":""},"siteHierarchy":{"type":"string","description":""},"siteId":{"type":"string","description":""},"deviceGroupHierarchyId":{"type":"string","description":""},"tagNames":{"type":"array","items":{"type":"string"},"description":""},"stackType":{"type":"string","description":""},"osType":{"type":"string","description":""},"ringStatus":{"type":"boolean","description":""},"maintenanceModeEnabled":{"type":"boolean","description":""},"upTime":{"type":"integer","description":""},"ipv4Address":{"type":"string","description":""},"ipv6Address":{"type":"string","description":""},"redundancyMode":{"type":"string","description":""},"featureFlagList":{"type":"array","items":{"type":"string"},"description":""},"haLastResetReason":{"type":"string","description":""},"redundancyPeerStateDerived":{"type":"string","description":""},"redundancyPeerState":{"type":"string","description":""},"redundancyStateDerived":{"type":"string","description":""},"redundancyState":{"type":"string","description":""},"wiredClientCount":{"type":"integer","description":""},"wirelessClientCount":{"type":"integer","description":""},"portCount":{"type":"integer","description":""},"physicalPortCount":{"type":"integer","description":""},"virtualPortCount":{"type":"integer","description":""},"clientCount":{"type":"integer","description":""},"apDetails":{"type":"object","properties":{"connectedWlcName":{"type":"string","description":""},"policyTagName":{"type":"string","description":""},"apOperationalState":{"type":"string","description":""},"powerSaveMode":{"type":"string","description":""},"operationalMode":{"type":"string","description":""},"resetReason":{"type":"string","description":""},"protocol":{"type":"string","description":""},"powerMode":{"type":"string","description":""},"connectedTime":{"type":"integer","description":""},"ledFlashEnabled":{"type":"boolean","description":""},"ledFlashSeconds":{"type":"integer","description":""},"subMode":{"type":"string","description":""},"homeApEnabled":{"type":"boolean","description":""},"powerType":{"type":"string","description":""},"apType":{"type":"string","description":""},"adminState":{"type":"string","description":""},"icapCapability":{"type":"string","description":""},"regulatoryDomain":{"type":"string","description":""},"ethernetMac":{"type":"string","description":""},"rfTagName":{"type":"string","description":""},"siteTagName":{"type":"string","description":""},"powerSaveModeCapable":{"type":"string","description":""},"powerProfile":{"type":"string","description":""},"flexGroup":{"type":"string","description":""},"powerCalendarProfile":{"type":"string","description":""},"apGroup":{"type":"string","description":""},"radios":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":""},"band":{"type":"string","description":""},"noise":{"type":"integer","description":""},"airQuality":{"type":"number","description":""},"interference":{"type":"number","description":""},"trafficUtil":{"type":"integer","description":""},"utilization":{"type":"number","description":""},"clientCount":{"type":"integer","description":""}}},"description":""}},"description":""},"metricsDetails":{"type":"object","properties":{"overallHealthScore":{"type":"integer","description":""},"cpuUtilization":{"type":"number","description":""},"cpuScore":{"type":"integer","description":""},"memoryUtilization":{"type":"number","description":""},"memoryScore":{"type":"integer","description":""},"avgTemperature":{"type":"number","description":""},"maxTemperature":{"type":"number","description":""},"discardScore":{"type":"integer","description":""},"discardInterfaces":{"type":"array","items":{"type":"string"},"description":""},"errorScore":{"type":"integer","description":""},"errorInterfaces":{"type":"array","items":{"type":"string"},"description":""},"interDeviceLinkScore":{"type":"integer","description":""},"interDeviceConnectedDownInterfaces":{"type":"array","items":{"type":"string"},"description":""},"linkUtilizationScore":{"type":"integer","description":""},"highLinkUtilizationInterfaces":{"type":"array","items":{"type":"string"},"description":""},"freeTimerScore":{"type":"integer","description":""},"freeTimer":{"type":"number","description":""},"packetPoolScore":{"type":"integer","description":""},"packetPool":{"type":"integer","description":""},"freeMemoryBufferScore":{"type":"integer","description":""},"freeMemoryBuffer":{"type":"number","description":""},"wqePoolScore":{"type":"integer","description":""},"wqePool":{"type":"integer","description":""},"apCount":{"type":"integer","description":""},"noiseScore":{"type":"integer","description":""},"utilizationScore":{"type":"integer","description":""},"interferenceScore":{"type":"integer","description":""},"airQualityScore":{"type":"integer","description":""}},"description":""},"fabricDetails":{"type":"object","properties":{"fabricRole":{"type":"array","items":{"type":"string"},"description":""},"fabricSiteName":{"type":"string","description":""},"transitFabrics":{"type":"array","items":{"type":"string"},"description":""},"l2Vns":{"type":"array","items":{"type":"string"},"description":""},"l3Vns":{"type":"array","items":{"type":"string"},"description":""},"fabricSiteId":{"type":"string","description":""},"networkProtocol":{"type":"string","description":""}},"description":""},"switchPoeDetails":{"type":"object","properties":{"portCount":{"type":"integer","description":""},"usedPortCount":{"type":"integer","description":""},"freePortCount":{"type":"integer","description":""},"powerConsumed":{"type":"number","description":""},"poePowerConsumed":{"type":"integer","description":""},"systemPowerConsumed":{"type":"number","description":""},"powerBudget":{"type":"integer","description":""},"poePowerAllocated":{"type":"number","description":""},"systemPowerAllocated":{"type":"integer","description":""},"powerRemaining":{"type":"number","description":""},"poeVersion":{"type":"string","description":""},"chassisCount":{"type":"integer","description":""},"moduleCount":{"type":"integer","description":""},"moduleDetails":{"type":"array","items":{"type":"object","properties":{"moduleId":{"type":"string","description":""},"chassisId":{"type":"string","description":""},"modulePortCount":{"type":"integer","description":""},"moduleUsedPortCount":{"type":"integer","description":""},"moduleFreePortCount":{"type":"integer","description":""},"modulePowerConsumed":{"type":"number","description":""},"modulePoePowerConsumed":{"type":"integer","description":""},"moduleSystemPowerConsumed":{"type":"number","description":""},"modulePowerBudget":{"type":"integer","description":""},"modulePoePowerAllocated":{"type":"number","description":""},"moduleSystemPowerAllocated":{"type":"integer","description":""},"modulePowerRemaining":{"type":"number","description":""},"interfacePowerMax":{"type":"integer","description":""}}},"description":""}},"description":""},"fabricMetricsDetails":{"type":"object","properties":{"overallFabricScore":{"type":"integer","description":""},"fabricTransitScore":{"type":"integer","description":""},"fabricSiteScore":{"type":"integer","description":""},"fabricVnScore":{"type":"integer","description":""},"fabsiteFcpScore":{"type":"integer","description":""},"fabsiteInfraScore":{"type":"integer","description":""},"fabsiteFsconnScore":{"type":"integer","description":""},"vnExitScore":{"type":"integer","description":""},"vnFcpScore":{"type":"integer","description":""},"vnStatusScore":{"type":"integer","description":""},"vnServiceScore":{"type":"integer","description":""},"transitControlPlaneScore":{"type":"integer","description":""},"transitServicesScore":{"type":"integer","description":""},"tcpConnScore":{"type":"integer","description":""},"bgpBgpSiteScore":{"type":"integer","description":""},"vniStatusScore":{"type":"integer","description":""},"pubsubTransitConnScore":{"type":"integer","description":""},"bgpPeerInfraVnScore":{"type":"integer","description":""},"internetAvailScore":{"type":"integer","description":""},"bgpEvpnScore":{"type":"integer","description":""},"lispTransitConnScore":{"type":"integer","description":""},"ctsEnvDataDownloadScore":{"type":"integer","description":""},"pubsubInfraVnScore":{"type":"integer","description":""},"peerScore":{"type":"integer","description":""},"bgpPeerScore":{"type":"integer","description":""},"remoteInternetAvailScore":{"type":"integer","description":""},"bgpTcpScore":{"type":"integer","description":""},"pubsubSessionScore":{"type":"integer","description":""},"aaaStatusScore":{"type":"integer","description":""},"lispCpConnScore":{"type":"integer","description":""},"bgpPubsubSiteScore":{"type":"integer","description":""},"mcastScore":{"type":"integer","description":""},"portChannelScore":{"type":"integer","description":""}},"description":""},"aggregateAttributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":""},"function":{"type":"string","description":""},"value":{"type":"number","description":""}}},"description":""}}},"description":""},"page":{"type":"object","properties":{"limit":{"type":"integer","description":""},"offset":{"type":"integer","description":""},"count":{"type":"integer","description":""},"sortBy":{"type":"string","description":""},"order":{"type":"string","description":""}},"description":""},"version":{"type":"string","description":""}},"description":"","$$ref":"#/components/schemas/GetsTheListOfNetworkDevicesBasedOnTheProvidedComplexFiltersAndAggregationFunctionsResponse","title":"GetsTheListOfNetworkDevicesBasedOnTheProvidedComplexFiltersAndAggregationFunctionsResponse"}}