{"type":"api","title":"LAN Automation Status","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":"lANAutomationStatus","tags":["LAN Automation"],"summary":"LAN Automation Status","deprecated":false,"description":"Invoke this API to get the LAN Automation session status. ","parameters":[{"name":"offset","description":"Starting index of the LAN Automation session. Minimum value is 1.","required":false,"schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"limit","description":"Number of LAN Automation sessions to be retrieved. Limit value can range between 1 to 10.","required":false,"schema":{"type":"number","default":"application/json"},"in":"query"}],"responses":{"200":{"description":"The request was successful and the result is contained in the response body.","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"LAN Automation session id."},"discoveredDeviceSiteNameHierarchy":{"type":"string","description":"Discovered device site name."},"primaryDeviceManagmentIPAddress":{"type":"string","description":"Primary seed device management IP address."},"ipPools":{"type":"array","items":{"type":"object","properties":{"ipPoolName":{"type":"string","description":"Name of the IP pool."},"ipPoolRole":{"type":"string","description":"Role of the IP pool. Supported roles are: MAIN_POOL and PHYSICAL_LINK_POOL."}}},"description":"The list of IP pools with its name and role."},"primaryDeviceInterfaceNames":{"type":"array","items":{"type":"string"},"description":"The list of interfaces on primary seed via which the discovered devices are connected."},"status":{"type":"string","description":"Status of the LAN Automation session along with the number of discovered devices. "},"action":{"type":"string","description":"State (START/STOP) of the LAN Automation session. "},"creationTime":{"type":"string","description":"LAN Automation session creation time."},"multicastEnabled":{"type":"boolean","description":"Shows whether underlay multicast is enabled or not. "},"peerDeviceManagmentIPAddress":{"type":"string","description":"Peer seed device management IP address."},"discoveredDeviceList":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the device."},"serialNumber":{"type":"string","description":"Serial number of the device."},"state":{"type":"string","description":"State of the device (Added to inventory/Deleted from inventory)."},"ipAddressInUseList":{"type":"array","items":{"type":"string"},"description":"List of IP address used by the device."}}},"description":"List of discovered devices."},"redistributeIsisToBgp":{"type":"boolean","description":"Shows whether advertise LAN Automation summary route into BGP is enabled or not."},"discoveryLevel":{"type":"integer","description":"Level below primary seed device upto which the new devices will be LAN Automated by this session, level + seed = tier. Supported range for level is [1-5], default level is 2."},"discoveryTimeout":{"type":"integer","description":"Discovery timeout in minutes. Until this time, the stop processing will not be triggered. Any device contacting after the provided discovery timeout will not be processed, and a device reset and reload will be attempted to bring it back to the PnP agent state before process completion. The supported timeout range is in minutes [20-10080]."},"discoveryDevices":{"type":"array","items":{"type":"object","properties":{"deviceSerialNumber":{"type":"string","description":"Serial number of the device"},"deviceHostName":{"type":"string","description":"Hostname of the device"},"deviceManagementIPAddress":{"type":"string","description":"Management IP Address of the device"},"deviceSiteId":{"type":"string","description":"Site UUID of the device"},"deviceSiteNameHierarchy":{"type":"string","description":"Site name hierarchy of the device"},"isDeviceDiscovered":{"type":"boolean","description":"Discovery status of the device"},"isIPAllocated":{"type":"boolean","description":"IP Allocation status of the device"},"isIPAssigned":{"type":"boolean","description":"IP Assignment status of the device"},"pnpDeviceId":{"type":"string","description":"PnP device ID"}}},"description":"Specific devices that will be LAN Automated in this session. Any other device discovered via DHCP will be attempted for a reset and reload to bring it back to the PnP agent state at the end of the LAN Automation process before process completion. The maximum supported devices that can be provided for a session is 50."},"hostNamePrefix":{"type":"string","description":"Hostname prefix of the discovered devices"},"hostNameFileId":{"type":"string","description":"File ID for the uploaded file in the nw_orch namespace"}}},"description":""},"version":{"type":"string","description":""}},"description":"","$$ref":"#/components/schemas/LANAutomationStatusResponse"}}}},"404":{"description":"The request was not acceptable as the input parameter was not available. ","content":{}}},"x-rapi-id":"a4ab-087e-4ed9-a3bb","x-rapi-overview":"Invoke this API to get the LAN Automation session status. ","x-rapi-domain":"Site Management","x-rapi-subdomain":"LAN Automation","x-rapi-version":"1.0.0","x-rapi-internalPath":"/api/v1/lan-automation/status","x-rapi-publicPath":"/dna/intent/api/v1/lan-automation/status","x-rapi-registerInKONG":true,"x-rapi-banner":[],"x-rapi-rateLimiting":"100~MINUTE","__originalOperationId":"lANAutomationStatus","method":"get","path":"/dna/intent/api/v1/lan-automation/status"}}