{"type":"api","title":"Add border device in SDA Fabric","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":"addBorderDeviceInSDAFabric","tags":["SDA"],"deprecated":false,"summary":"Add border device in SDA Fabric","description":"Add border device in SDA Fabric","parameters":[],"requestBody":{"description":"request","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"deviceManagementIpAddress":{"type":"string","description":"Management Ip Address of the provisioned Device"},"siteNameHierarchy":{"type":"string","description":"Site Name Hierarchy of provisioned Device(site should be part of Fabric Site)"},"deviceRole":{"type":"array","items":{"type":"string"},"description":"Supported Device Roles in SD-Access fabric. Allowed roles are \"Border_Node\",\"Control_Plane_Node\",\"Edge_Node\". E.g. [\"Border_Node\"] or [\"Border_Node\", \"Control_Plane_Node\"] or [\"Border_Node\", \"Control_Plane_Node\",\"Edge_Node\"]"},"routeDistributionProtocol":{"type":"string","description":"Route Distribution Protocol for Control Plane Device. Allowed values are \"LISP_BGP\" or \"LISP_PUB_SUB\". Default value is \"LISP_BGP\""},"externalDomainRoutingProtocolName":{"type":"string","enum":["BGP"],"description":"External Domain Routing Protocol Name"},"externalConnectivityIpPoolName":{"type":"string","description":"External Connectivity IpPool Name"},"internalAutonomouSystemNumber":{"type":"string","description":"Internal Autonomous System Number"},"borderPriority":{"type":"string","description":"Border priority associated with a given device. Allowed range for Border Priority is [1-9]. A lower value indicates higher priority. E.g., a priority of 1 takes precedence over 5. Default priority would be set to 10."},"borderSessionType":{"type":"string","enum":["EXTERNAL","INTERNAL","ANYWHERE"],"description":" Border Session Type"},"connectedToInternet":{"type":"boolean","description":"Connected to Internet"},"sdaTransitNetworkName":{"type":"string","description":"SD-Access Transit Network Name"},"borderWithExternalConnectivity":{"type":"boolean","description":"Border With External Connectivity (Note: True for transit and False for non-transit border)"},"externalConnectivitySettings":{"type":"array","items":{"type":"object","properties":{"interfaceName":{"type":"string","description":"Interface Name"},"interfaceDescription":{"type":"string","description":"Interface Description"},"externalAutonomouSystemNumber":{"type":"string","description":"External Autonomous System Number peer (e.g.,1-65535)"},"l3Handoff":{"type":"array","items":{"type":"object","properties":{"virtualNetwork":{"type":"object","properties":{"virtualNetworkName":{"type":"string","description":"Virtual Network Name, that is associated to Fabric Site"},"vlanId":{"type":"string","description":"Vlan Id (e.g.,2-4096 except for reserved VLANs (1002-1005, 2046, 4095))"}},"description":"Virtual Network information of L3 Hand off"}}},"description":"L3 Handoff information"},"l2Handoff":{"type":"array","items":{"type":"object","properties":{"virtualNetworkName":{"type":"string","description":"Virtual Network Name, that is associated to Fabric Site"},"vlanName":{"type":"string","description":"Vlan Name of L2 Handoff"}}},"description":"L2 Handoff information"}}},"description":"External Connectivity Settings information of L3 and L2 Handoff"}}},"description":"Add Border Device API (Highlights : Supports multi device role,L3 Handoff and L2 Handoff )","$$ref":"#/components/schemas/AddBorderDeviceInSDAFabricRequest"}}},"required":true},"responses":{"200":{"description":"The request was successful. The result is contained in the response body.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["success","failed","pending",""],"description":"represents return status of API. status=success when API completed successfully, status=failed when API failed and has not completed the user request, status=pending when API execution is still in progression and user needs to track its further progress via taskId field."},"description":{"type":"string","description":"provides detailed information for API success or failure."},"taskId":{"type":"string","description":"Catalyst Center taskId that carried out the API execution. It will be provided if task was generated by API. For failed status, taskId may not be available "},"taskStatusUrl":{"type":"string","description":"/dna/intent/api/v1/task/\u003ctaskId\u003e , allows API progression via taskId for async API"},"executionStatusUrl":{"type":"string","description":"/dna/intent/api/v1/dnacaap/management/execution-status/\u003cexecutionId\u003e"},"executionId":{"type":"string","description":"uuid for API execution status"}},"description":"root element for generic response schema","$$ref":"#/components/schemas/AddBorderDeviceInSDAFabricResponse"}}}},"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":{}},"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":{}}},"x-rapi-id":"bead-7b34-43b9-96a7","x-rapi-overview":"Add border device in SDA Fabric","x-rapi-domain":"Connectivity","x-rapi-subdomain":"SDA","x-rapi-version":"1.0.0","x-rapi-banner":["Sunset"],"x-rapi-rateLimiting":"50~1","__originalOperationId":"addBorderDeviceInSDAFabric","method":"post","path":"/dna/intent/api/v1/business/sda/border-device"}}