{"type":"api","title":"LAN Automation Start V2","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":"lANAutomationStartV2","tags":["LAN Automation"],"deprecated":false,"summary":"LAN Automation Start V2","description":"Invoke V2 LAN Automation Start API, which supports optional auto-stop processing feature based on the provided timeout or a specific device list, or both. The stop processing will be executed automatically when either of the cases is satisfied, without specifically calling the stop API. The V2 API behaves similarly to V1 if no timeout or device list is provided, and the user needs to call the stop API for LAN Automation stop processing. With the V2 API, the user can also specify the level up to which the devices can be LAN automated.","parameters":[{"name":"Content-Type","description":"Request body content type","required":true,"schema":{"type":"string","default":"application/json"},"in":"header"}],"requestBody":{"description":"request","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"discoveredDeviceSiteNameHierarchy":{"type":"string","description":"Discovered device site name."},"primaryDeviceManagmentIPAddress":{"type":"string","description":"Primary seed management IP address."},"peerDeviceManagmentIPAddress":{"type":"string","description":"Peer seed management IP address."},"primaryDeviceInterfaceNames":{"type":"array","items":{"type":"string"},"description":"The list of interfaces on primary seed via which the discovered devices are connected."},"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 their names and roles."},"multicastEnabled":{"type":"boolean","description":" Enable underlay native multicast."},"hostNamePrefix":{"type":"string","description":"Host name prefix assigned to the discovered device."},"hostNameFileId":{"type":"string","description":"Use /dna/intent/api/v1/file/namespace/nw_orch API to get the file ID for the already uploaded file in the nw_orch namespace."},"redistributeIsisToBgp":{"type":"boolean","description":"Advertise LAN Automation summary route into BGP. "},"isisDomainPwd":{"type":"string","description":"IS-IS domain password in plain text."},"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]. If both timeout and discovery devices list are provided, the stop processing will be attempted whichever happens earlier. Users can always use the LAN Automation delete API to force stop processing."},"discoveryDevices":{"type":"array","items":{"type":"object","properties":{"deviceSerialNumber":{"type":"string","description":"Serial number of the device"},"deviceHostName":{"type":"string","description":"Hostname of the device"},"deviceSiteNameHierarchy":{"type":"string","description":"Site name hierarchy for the device, must be a child site of the discoveredDeviceSiteNameHierarchy or same if it’s not area type."},"deviceManagementIPAddress":{"type":"string","description":"Management IP Address of the device"}}},"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. If only the discovery devices list is provided and no timeout is provided, then the LAN Automation stop processing will get triggered when all devices from the list are discovered and added to inventory. If both the discovery devices list and timeout are provided, the stop processing will be attempted whichever happens earlier. Users can always use the LAN Automation Stop API to force stop processing."}}},"description":"","$$ref":"#/components/schemas/LANAutomationStartVRequest"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"object","properties":{"taskId":{"type":"string","description":"Task ID "},"url":{"type":"string","description":"url to check the status of task"}},"description":""},"version":{"type":"string","description":"version"}},"description":"","$$ref":"#/components/schemas/LANAutomationStartVResponse"}}}},"202":{"description":"The request was accepted and the response contains the id of the new LAN Automation session.","content":{}},"400":{"description":"The request was not acceptable due to error in the input parameter and the response contains information about the parameter error.","content":{}},"406":{"description":"The request was not acceptable due to incorrect input value or invalid settings/config on the device. The response contains information about the error code, message and detail.","content":{}},"500":{"description":"The request was not accepted due to internal error in the system and the response contains information about the error.","content":{}}},"x-rapi-id":"51ba-8921-46da-9bec","x-rapi-overview":"Invoke V2 LAN Automation Start API, which supports optional auto-stop processing feature based on the provided timeout or a specific device list, or both. The stop processing will be executed automatically when either of the cases is satisfied, without specifically calling the stop API. The V2 API behaves similarly to V1 if no timeout or device list is provided, and the user needs to call the stop API for LAN Automation stop processing. With the V2 API, the user can also specify the level up to which the devices can be LAN automated.","x-rapi-domain":"Site Management","x-rapi-subdomain":"LAN Automation","x-rapi-version":"1.0.0","x-rapi-internalPath":"/api/v1/lan-automation/deploy","x-rapi-publicPath":"/dna/intent/api/v2/lan-automation","x-rapi-registerInKONG":true,"x-rapi-banner":[],"x-rapi-rateLimiting":"50~MINUTE","__originalOperationId":"lANAutomationStartV2","method":"post","path":"/dna/intent/api/v2/lan-automation"}}