IP Pool

Location in GUI: Design » Network Settings » IP Address Pools

Diagram

Classes

network_settings (catalyst_center)

Name	Type	Constraint	Mandatory	Default Value
ip_pools	List	`[ip_pools]`	No

ip_pools (catalyst_center.network_settings)

Name	Type	Constraint	Mandatory	Default Value
name	String		Yes
ip_address_space	Choice	`IPv4`, `IPv6`	Yes	`IPv4`
type	Choice	`generic`, `tunnel`	No	`generic`
dhcp_servers	List	IP	No
dns_servers	List	IP	No
gateway	String		No
ip_pool_cidr	IP		No
ip_pools_reservations	List	`[ip_pools_reservations]`	No

ip_pools_reservations (catalyst_center.network_settings.ip_pools)

Name	Type	Constraint	Mandatory	Default Value
name	String		Yes
prefix_length	Integer	min: `1`, max: `32`	No
subnet	IP		No
gateway	IP		No
type	Choice	`generic`, `LAN`, `WAN`, `management`, `service`	No	`Generic`
dhcp_servers	List	IP	No
dns_servers	List	IP	No

Examples

catalyst_center:
  network_settings:
    ip_pools:
      - name: TF-pool-1
        ip_address_space: IPv4
        type: generic
        dhcp_servers:
          - 10.0.0.1
          - 10.0.0.2
        dns_servers:
          - 10.0.0.1
          - 10.0.0.2
        ip_pool_cidr: 10.0.0.0/16
        ip_pools_reservations:
          - name: IP_Pool_1
            prefix_length: 24
            subnet: 10.0.1.0
            type: generic
            dhcp_servers:
              - 10.0.0.1
              - 10.0.0.2
            dns_servers:
              - 10.0.0.1
              - 10.0.0.2

To associate IP pool reservations with site, use the following structure:

catalyst_center:
  sites:
    areas:
      - name: Canada
        parent_name: Global
        ip_pools_reservations:
          - IP_Pool_1