{"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":"Unique identifier of the network device"},"managementAddress":{"type":"string","description":"Management address of the network device"},"dnsResolvedManagementIpAddress":{"type":"string","description":"DNS-resolved management IP address of the network device"},"hostname":{"type":"string","description":"Hostname of the network device"},"macAddress":{"type":"string","description":"MAC address of the network device"},"serialNumbers":{"type":"array","items":{"type":"string"},"description":"Serial number of the network device. In case of stack device, there will be multiple serial numbers"},"type":{"type":"string","description":"Type of the network device. This list of types can be obtained from the API intent/networkDeviceProductNames productName field."},"family":{"type":"string","description":"Product family of the network device. For example, Switches, Routers, etc"},"series":{"type":"string","description":"The model range or series of the network device"},"status":{"type":"string","enum":["MANAGED","SYNC_NOT_STARTED","SYNC_INIT_FAILED","SYNC_PRECHECK_FAILED","SYNC_IN_PROGRESS","SYNC_INTERNAL_ERROR","SYNC_DISABLED","DELETING_DEVICE","UNDER_MAINTENANCE","QUARANTINED","UNASSOCIATED","UNREACHABLE","UNKNOWN"],"description":"Inventory related status of the network device. Refer features for more details"},"platformIds":{"type":"array","items":{"type":"string"},"description":"Platform identifier of the network device"},"softwareType":{"type":"string","description":"Type of software running on the network device. For example, IOS-XE, etc."},"softwareVersion":{"type":"string","description":"Version of the software running on the network device"},"vendor":{"type":"string","description":"Vendor of the network device"},"stackDevice":{"type":"boolean","description":"Flag indicating if the network device is a stack device"},"bootTime":{"type":"number","description":"The time at which the network device was last rebooted or powered on represented as epoch in milliseconds"},"role":{"type":"string","enum":["BORDER_ROUTER","CORE","DISTRIBUTION","ACCESS","UNKNOWN"],"description":"Role assigned to the network device"},"roleSource":{"type":"string","enum":["AUTO","MANUAL"],"description":"Indicates whether the network device's role was assigned automatically by the software or manually by an administrator."},"apEthernetMacAddress":{"type":"string","description":"Ethernet MAC address of the AP network device"},"apManagerInterfaceIpAddress":{"type":"string","description":"Management IP address of the AP network device"},"apWlcIpAddress":{"type":"string","description":"Management IP address of the WLC on which AP is associated to"},"deviceSupportLevel":{"type":"string","enum":["SUPPORTED","LIMITED","THIRD_PARTY","UNSUPPORTED"],"description":"The level of support Catalyst Center provides for the network device."},"snmpLocation":{"type":"string","description":"SNMP location of the network device"},"snmpContact":{"type":"string","description":"SNMP contact of the network device"},"reachabilityStatus":{"type":"string","enum":["REACHABLE","ONLY_PING_REACHABLE","UNREACHABLE","UNKNOWN"],"description":"Reachability status of the network device. Refer features for more details"},"reachabilityFailureReason":{"type":"string","description":"Reason for reachability failure. This message that provides more information about the reachability failure."},"managementState":{"type":"string","enum":["MANAGED","UNDER_MAINTENANCE","NEVER_MANAGED"],"description":"The status of the network device's manageability. Refer features for more details."},"lastSuccessfulResyncReasons":{"type":"array","items":{"type":"string"},"description":"List of reasons for the last successful resync of the device. If multiple resync requests are made before the device can start the resync, all the reasons will be captured. Possible values: ADD_DEVICE_SYNC, LINK_UP_DOWN, CONFIG_CHANGE, DEVICE_UPDATED_SYNC, AP_EVENT_BASED_SYNC, APP_REQUESTED_SYNC, PERIODIC_SYNC, UI_SYNC, CUSTOM, UNKNOWN, REFRESH_OBJECTS_FEATURE_BASED_SYNC"},"resyncStartTime":{"type":"number","description":"Start time for the last/ongoing resync represented as epoch in milliseconds"},"resyncEndTime":{"type":"number","description":"End time for the last resync represented as epoch in milliseconds"},"resyncReasons":{"type":"array","items":{"type":"string"},"description":"List of reasons for the ongoing/last resync on the device. If multiple resync requests were made before the resync could start, all the reasons will be captured as an array. Possible values: ADD_DEVICE_SYNC, LINK_UP_DOWN, CONFIG_CHANGE, DEVICE_UPDATED_SYNC, AP_EVENT_BASED_SYNC, APP_REQUESTED_SYNC, PERIODIC_SYNC, UI_SYNC, CUSTOM, UNKNOWN, REFRESH_OBJECTS_FEATURE_BASED_SYNC"},"resyncRequestedByApps":{"type":"array","items":{"type":"string"},"description":"List of applications that requested the last/ongoing resync on the device"},"pendingResyncRequestCount":{"type":"integer","description":"Number of pending resync requests for the device"},"pendingResyncRequestReasons":{"type":"array","items":{"type":"string"},"description":"List of reasons for the pending resync requests. Possible values: ADD_DEVICE_SYNC, LINK_UP_DOWN, CONFIG_CHANGE, DEVICE_UPDATED_SYNC, AP_EVENT_BASED_SYNC, APP_REQUESTED_SYNC, PERIODIC_SYNC, UI_SYNC, CUSTOM, UNKNOWN, REFRESH_OBJECTS_FEATURE_BASED_SYNC"},"resyncIntervalSource":{"type":"string","enum":["GLOBAL","CUSTOM","NA"],"description":"Source of the resync interval. Note: Please refer to PUT /dna/intent/api/v1/networkDevices/resyncIntervalSettings API to update the global resync interval."},"resyncIntervalMinutes":{"type":"integer","description":"The duration in minutes between the periodic resync attempts for the device"},"errorCode":{"type":"string","enum":["UNREACHABLE","ONLY_PING_REACHABLE","CREDENTIAL_MISSING","SNMP_TIMEOUT","SNMP_AUTH_ERROR","SNMP_UNSUPPORTED_AUTH","SNMP_UNSUPPORTED_PRIV","SNMP_DES_DEPRECATED","SNMP_UNSUPPORTED_SECURITY_LEVEL","SNMP_SPARSE_ERROR","SNMP_FAILED","CLI_TIMEOUT","CLI_CONNECTION_CLOSED","CLI_CONNECTION_ERROR","CLI_AUTH_ERROR","CLI_MISSING_ENABLE_PASSWORD","CLI_INCORRECT_ENABLE_PASSWORD","NETCONF_CONNECTION_ERROR","NETCONF_AUTH_ERROR","NETCONF_PORT_MISSING","NETCONF_ACCESS_DENIED","NETCONF_RPC_ERROR","HTTP_FAILED","QUARANTINED","SYNC_DELAYED","SYNC_CANCELLED","SYNC_DISABLED","WLAN_CONTROLLER_MISSING","SERIAL_NUMBER_CONFLICT","UNSUPPORTED_MANAGEMENT_IP","INCORRECT_THIRD_PARTY_CATEGORY","INCORRECT_NETWORK_DEVICE_CATEGORY","UNKNOWN"],"description":"Error code indicating the reason for the last resync failure"},"errorDescription":{"type":"string","description":"Additional information regarding the reason for resync failure. This is a human-readable error message and should not be expected programmatically."},"userDefinedFields":{"type":"object","properties":{},"description":"Map of all user defined fields and their values associated with the device. Refer to /dna/intent/api/v1/network-device/user-defined-field API to fetch all the user defined fields."}}},"description":""},"version":{"type":"string","description":"Version number of the response"}},"description":"","$$ref":"#/components/schemas/QueryNetworkDevicesWithFiltersResponse","title":"QueryNetworkDevicesWithFiltersResponse"}}