{"type":"api","title":"Reserve IP Subpool","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":"reserveIPSubpool","tags":["Network Settings"],"deprecated":false,"summary":"Reserve IP Subpool","description":"Deprecated since Catalyst Center Release 2.3.7.9\nAlternative:\nPOST: /dna/intent/api/v1/ipam/siteIpAddressPools\nAPI to reserve an ip subpool from the global pool","parameters":[{"name":"siteId","description":"Site id to reserve the ip sub pool.","required":true,"schema":{"type":"string","default":"application/json"},"in":"path"}],"requestBody":{"description":"request","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of the reserve ip sub pool"},"type":{"type":"string","enum":["Generic","LAN","WAN","management","service"],"description":"Type of the reserve ip sub pool"},"ipv6AddressSpace":{"type":"boolean","description":"If the value is omitted or false only ipv4 input are required, otherwise both ipv6 and ipv4 are required"},"ipv4GlobalPool":{"type":"string","description":"IP v4 Global pool address with cidr, example: 175.175.0.0/16"},"ipv4Prefix":{"type":"boolean","description":"IPv4 prefix value is true, the ip4 prefix length input field is enabled , if it is false ipv4 total Host input is enable"},"ipv4PrefixLength":{"type":"integer","description":"The ipv4 prefix length is required when ipv4prefix value is true."},"ipv4Subnet":{"type":"string","description":"IPv4 Subnet address, example: 175.175.0.0. Either ipv4Subnet or ipv4TotalHost needs to be passed if creating IPv4 subpool."},"ipv4GateWay":{"type":"string","description":"Gateway ip address details, example: 175.175.0.1"},"ipv4DhcpServers":{"type":"array","items":{"type":"string"},"description":"IPv4 input for dhcp server ip example: [\"1.1.1.1\"]"},"ipv4DnsServers":{"type":"array","items":{"type":"string"},"description":"IPv4 input for dns server ip example: [\"4.4.4.4\"]"},"ipv6GlobalPool":{"type":"string","description":"IPv6 Global pool address with cidr this is required when Ipv6AddressSpace value is true, example: 2001:db8:85a3::/64"},"ipv6Prefix":{"type":"boolean","description":"Ipv6 prefix value is true, the ip6 prefix length input field is enabled , if it is false ipv6 total Host input is enable"},"ipv6PrefixLength":{"type":"integer","description":"IPv6 prefix length is required when the ipv6prefix value is true"},"ipv6Subnet":{"type":"string","description":"IPv6 Subnet address, example :2001:db8:85a3:0:100::. Either ipv6Subnet or ipv6TotalHost needs to be passed if creating IPv6 subpool."},"ipv6GateWay":{"type":"string","description":"Gateway ip address details, example: 2001:db8:85a3:0:100::1"},"ipv6DhcpServers":{"type":"array","items":{"type":"string"},"description":"IPv6 format dhcp server as input example : [\"2001:db8::1234\"]"},"ipv6DnsServers":{"type":"array","items":{"type":"string"},"description":"IPv6 format dns server input example: [\"2001:db8::1234\"]"},"ipv4TotalHost":{"type":"integer","description":"IPv4 total host is required when ipv4prefix value is false."},"ipv6TotalHost":{"type":"integer","description":"IPv6 total host is required when ipv6prefix value is false."},"slaacSupport":{"type":"boolean","description":""}},"description":"","$$ref":"#/components/schemas/ReserveIPSubpoolRequest"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"executionId":{"type":"string","description":""},"executionStatusUrl":{"type":"string","description":""},"message":{"type":"string","description":""}},"description":"","$$ref":"#/components/schemas/ReserveIPSubpoolResponse"}}}},"202":{"description":"The request has been accepted for execution.","content":{}},"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":"429f-aa81-4d3b-960a","x-rapi-overview":"API to reserve an ip subpool from the global pool","x-rapi-domain":"Site Management","x-rapi-subdomain":"Network Settings","x-rapi-version":"1.0.0","x-rapi-banner":["Intent","Sunset"],"x-rapi-rateLimiting":"100~1","__originalOperationId":"reserveIPSubpool","method":"post","path":"/dna/intent/api/v1/reserve-ip-subpool/{siteId}"}}