testcontainers::NetworkIpamPool Struct Reference

One IPAM address pool of a network — an IPAM.Config entry, both as sent by POST /networks/create (NetworkCreateSpec::ipam_pools) and as read back by GET /networks/{id} (NetworkInspect::ipam_pools). More...

#include <testcontainers/docker/ContainerSpec.hpp>

Public Attributes
std::string	subnet
	CIDR, e.g. "172.31.250.0/24" (create: required by the daemon).
std::string	gateway
	gateway address on the subnet
std::string	ip_range
	IPRange: a sub-CIDR to allocate container addresses from.
std::vector< std::pair< std::string, std::string > >	aux_addresses
	AuxiliaryAddresses (name -> IP): addresses on the subnet the IPAM driver must not hand out to containers (e.g.

Detailed Description

One IPAM address pool of a network — an IPAM.Config entry, both as sent by POST /networks/create (NetworkCreateSpec::ipam_pools) and as read back by GET /networks/{id} (NetworkInspect::ipam_pools).

An empty field is absent: omitted from the create body, "" when the daemon returns nothing.

Member Data Documentation

subnet

std::string testcontainers::NetworkIpamPool::subnet

CIDR, e.g. "172.31.250.0/24" (create: required by the daemon).

gateway

std::string testcontainers::NetworkIpamPool::gateway

gateway address on the subnet

ip_range

std::string testcontainers::NetworkIpamPool::ip_range

IPRange: a sub-CIDR to allocate container addresses from.

aux_addresses

std::vector<std::pair<std::string, std::string> > testcontainers::NetworkIpamPool::aux_addresses

AuxiliaryAddresses (name -> IP): addresses on the subnet the IPAM driver must not hand out to containers (e.g.

an external router). Create emits them in order (last wins on a duplicate name); inspect returns them sorted by name.