{"type":"api","title":"Updates an IP address subpool","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":"updatesAnIPAddressSubpool_","tags":["Network Settings"],"deprecated":false,"summary":"Updates an IP address subpool.","description":"Updates an IP address subpool, which reserves address space from a global pool (or global pools) for a particular site.\n\nRestrictions on updating an IP address subpool:\n- The `poolType` cannot be changed.\n- The `siteId` cannot be changed.\n- The `ipV4AddressSpace` may not be removed.\n- The `globalPoolId`, `subnet`, and `prefixLength` cannot be changed once it's already been set. However you may edit a subpool to add an IP address space if it does not already have one.\n","parameters":[{"name":"Content-Type","description":"Request body content type","required":true,"schema":{"type":"string","default":"application/json"},"in":"header"},{"name":"id","description":"The `id` of the IP address subpool to update.","required":true,"schema":{"type":"string","default":"application/json"},"in":"path"}],"requestBody":{"description":"request","content":{"application/json":{"schema":{"type":"object","properties":{"ipV4AddressSpace":{"type":"object","properties":{"subnet":{"type":"string","description":"The IP address component of the CIDR notation for this subnet."},"prefixLength":{"type":"number","description":"The network mask component, as a decimal, for the CIDR notation of this subnet."},"gatewayIpAddress":{"type":"string","description":"The gateway IP address for this subnet."},"dhcpServers":{"type":"array","items":{"type":"string"},"description":"The DHCP server(s) for this subnet."},"dnsServers":{"type":"array","items":{"type":"string"},"description":"The DNS server(s) for this subnet."},"slaacSupport":{"type":"boolean","description":"If the prefixLength is 64, this option may be enabled. Stateless Address Auto-configuration (SLAAC) allows network devices to select their IP address without the use of DHCP servers."},"globalPoolId":{"type":"string","description":"The non-tunnel global pool for this reserve pool (which matches this IP address type). Once added this value cannot be changed."}},"description":""},"ipV6AddressSpace":{"type":"object","properties":{"subnet":{"type":"string","description":"The IP address component of the CIDR notation for this subnet."},"prefixLength":{"type":"number","description":"The network mask component, as a decimal, for the CIDR notation of this subnet."},"gatewayIpAddress":{"type":"string","description":"The gateway IP address for this subnet."},"dhcpServers":{"type":"array","items":{"type":"string"},"description":"The DHCP server(s) for this subnet."},"dnsServers":{"type":"array","items":{"type":"string"},"description":"The DNS server(s) for this subnet."},"slaacSupport":{"type":"boolean","description":"If the prefixLength is 64, this option may be enabled. Stateless Address Auto-configuration (SLAAC) allows network devices to select their IP address without the use of DHCP servers."},"globalPoolId":{"type":"string","description":"The non-tunnel global pool for this reserve pool (which matches this IP address type). Once added this value cannot be changed."}},"description":""},"name":{"type":"string","description":"The name for this reserve IP pool. Only letters, numbers, '-' (hyphen), '_' (underscore), '.' (period), and '/' (forward slash) are allowed."},"poolType":{"type":"string","enum":["Generic","LAN","Management","Service","WAN"],"description":"Once created, a subpool type cannot be changed. LAN: Assigns IP addresses to LAN interfaces of applicable VNFs and underlay LAN automation. Management: Assigns IP addresses to management interfaces. A management network is a dedicated network connected to VNFs for VNF management. Service: Assigns IP addresses to service interfaces. Service networks are used for communication within VNFs. WAN: Assigns IP addresses to NFVIS for UCS-E provisioning. Generic: used for all other network types."},"siteId":{"type":"string","description":"The `id` of the site that this subpool belongs to. This must be the `id` of a non-Global site."}},"description":"","$$ref":"#/components/schemas/UpdatesAnIPAddressSubpoolRequest"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"version":{"type":"string","description":"Response Version e.g. : 1.0"},"response":{"type":"object","properties":{"url":{"type":"string","description":"URL to get task details e.g. : /api/v1/task/3200a44a-9186-4caf-8c32-419cd1f3d3f5"},"taskId":{"type":"string","description":"Task Id in uuid format. e.g. : 3200a44a-9186-4caf-8c32-419cd1f3d3f5 "}},"description":"Response containing task id in uuid format."}},"description":"Task Id Result","$$ref":"#/components/schemas/UpdatesAnIPAddressSubpoolResponse"}}}},"202":{"description":"Accepted","content":{}},"204":{"description":"The request was successful, however no content was returned.","content":{}},"206":{"description":"The GET request included a Range Header, and the server responded with the partial content matching the range.","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":{}},"403":{"description":"The server recognizes the authentication credentials, but the client is not authorized to perform this request.","content":{}},"404":{"description":"The client made a request for a resource that does not exist.","content":{}},"409":{"description":"The target resource is in a conflicted state (for example, an edit conflict where a resource is being edited by multiple users). Retrying the request later might succeed.","content":{}},"415":{"description":"The client sent a request body in a format that the server does not support (for example, XML to a server that only accepts JSON).","content":{}},"500":{"description":"The server could not fulfill the request.","content":{}},"501":{"description":"The server has not implemented the functionality required to fulfill the request.","content":{}},"502":{"description":"The server is (temporarily) unavailable.","content":{}},"503":{"description":"The server is (temporarily) unavailable.","content":{}},"504":{"description":"The server did not respond inside time restrictions and timed-out.","content":{}},"1XX":{"description":"Informational Responses - The server received the request and sent an informational response.","content":{}},"2XX":{"description":"Successful Responses - The server received the client request, understood it, and accepted it.","content":{}},"3XX":{"description":"Redirection Messages - The client must take additional action to complete the request.","content":{}},"4XX":{"description":"Client Error Responses - The client request caused the error.","content":{}},"5XX":{"description":"Server Error Responses - The server failed to fulfill the request.","content":{}}},"x-rapi-id":"968f-d8e4-465b-8ec2","x-rapi-overview":"Updates an IP address subpool, which reserves address space from a global pool (or global pools) for a particular site.\n\nRestrictions on updating an IP address subpool:\n- The `poolType` cannot be changed.\n- The `siteId` cannot be changed.\n- The `ipV4AddressSpace` may not be removed.\n- The `globalPoolId`, `subnet`, and `prefixLength` cannot be changed once it's already been set. However you may edit a subpool to add an IP address space if it does not already have one.\n","x-rapi-domain":"Site Management","x-rapi-subdomain":"Network Settings","x-rapi-version":"1.0.0","x-rapi-internalPath":"/intent/api/v1/ipam/siteIpAddressPools/${id}","x-rapi-publicPath":"/dna/intent/api/v1/ipam/siteIpAddressPools/${id}","x-rapi-registerInKONG":true,"x-rapi-banner":[],"x-rapi-rateLimiting":"50~MINUTE","__originalOperationId":"updatesAnIPAddressSubpool.","method":"put","path":"/dna/intent/api/v1/ipam/siteIpAddressPools/{id}"}}