{"type":"api","title":"Add IP Pool in SDA Virtual Network","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":{"operationId":"addIPPoolInSDAVirtualNetwork","tags":["SDA"],"deprecated":false,"summary":"Add IP Pool in SDA Virtual Network","description":"Add IP Pool in SDA Virtual Network","parameters":[],"requestBody":{"description":"request","content":{"application/json":{"schema":{"type":"object","properties":{"siteNameHierarchy":{"type":"string","description":" Path of sda Fabric Site"},"virtualNetworkName":{"type":"string","description":"Virtual Network Name, that is associated to Fabric Site"},"isLayer2Only":{"type":"boolean","description":"Layer2 Only enablement flag and default value is False "},"ipPoolName":{"type":"string","description":"Ip Pool Name, that is reserved to Fabric Site (Required for L3 and INFRA_VN)"},"vlanId":{"type":"string","description":"vlan Id(applicable for L3 , L2 and INFRA_VN)"},"vlanName":{"type":"string","description":"Vlan name represent the segment name, if empty, vlanName would be auto generated by API"},"autoGenerateVlanName":{"type":"boolean","description":"It will auto generate vlanName, if vlanName is empty(applicable for L3 and INFRA_VN)"},"trafficType":{"type":"string","enum":["Data","Voice"],"description":"Traffic type(applicable for L3 and L2)"},"scalableGroupName":{"type":"string","description":"Scalable Group Name(applicable for L3)"},"isL2FloodingEnabled":{"type":"boolean","description":"Layer2 flooding enablement flag(applicable for L3 , L2 and always true for L2 and default value is False )"},"isThisCriticalPool":{"type":"boolean","description":"Critical pool enablement flag(applicable for L3 and default value is False )"},"isWirelessPool":{"type":"boolean","description":"Wireless Pool enablement flag(applicable for L3 and L2 and default value is False )"},"isIpDirectedBroadcast":{"type":"boolean","description":"Ip Directed Broadcast enablement flag(applicable for L3 and default value is False )"},"isCommonPool":{"type":"boolean","description":"Common Pool enablement flag(applicable for L3 and L2 and default value is False )"},"isBridgeModeVm":{"type":"boolean","description":"Bridge Mode Vm enablement flag (applicable for L3 and L2 and default value is False )"},"poolType":{"type":"string","enum":["AP","Extended"],"description":"Pool Type (applicable for INFRA_VN)"}},"description":"Add New IpPool in SDA Virtual Network","$$ref":"#/components/schemas/AddIPPoolInSDAVirtualNetworkRequest"}}},"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/AddIPPoolInSDAVirtualNetworkResponse"}}}},"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":"2085-79ea-4ed9-8f4f","x-rapi-overview":"Add IP Pool in SDA Virtual Network","x-rapi-domain":"Connectivity","x-rapi-subdomain":"SDA","x-rapi-version":"1.0.0","x-rapi-banner":["Sunset"],"x-rapi-rateLimiting":"50~1","__originalOperationId":"addIPPoolInSDAVirtualNetwork","method":"post","path":"/dna/intent/api/v1/business/sda/virtualnetwork/ippool"}}