testcontainers-cpp 0.2.0
Native C++20 Testcontainers over the Docker Engine API
Loading...
Searching...
No Matches
testcontainers::NetworkCreateSpec Struct Reference

Options for POST /networks/create (richer than just name+labels). More...

#include <testcontainers/docker/ContainerSpec.hpp>

Public Attributes

std::string name
std::optional< std::string > driver
 e.g. "bridge" (default when unset)
bool internal = false
 no external connectivity
bool attachable = false
 standalone containers can attach
bool enable_ipv6 = false
 EnableIPv6.
std::optional< std::string > subnet
 shorthand: a leading IPAM pool's Subnet
std::optional< std::string > gateway
 shorthand: the leading pool's Gateway
std::vector< NetworkIpamPoolipam_pools
 IPAM address pools, emitted after the subnet/gateway shorthand pool when that is set (IPAM.Config keeps this order).
std::vector< std::pair< std::string, std::string > > options
 driver Options
std::vector< std::pair< std::string, std::string > > labels
 network Labels

Detailed Description

Options for POST /networks/create (richer than just name+labels).

Member Data Documentation

◆ name

std::string testcontainers::NetworkCreateSpec::name

◆ driver

std::optional<std::string> testcontainers::NetworkCreateSpec::driver

e.g. "bridge" (default when unset)

◆ internal

bool testcontainers::NetworkCreateSpec::internal = false

no external connectivity

◆ attachable

bool testcontainers::NetworkCreateSpec::attachable = false

standalone containers can attach

◆ enable_ipv6

bool testcontainers::NetworkCreateSpec::enable_ipv6 = false

EnableIPv6.

◆ subnet

std::optional<std::string> testcontainers::NetworkCreateSpec::subnet

shorthand: a leading IPAM pool's Subnet

◆ gateway

std::optional<std::string> testcontainers::NetworkCreateSpec::gateway

shorthand: the leading pool's Gateway

◆ ipam_pools

std::vector<NetworkIpamPool> testcontainers::NetworkCreateSpec::ipam_pools

IPAM address pools, emitted after the subnet/gateway shorthand pool when that is set (IPAM.Config keeps this order).

◆ options

std::vector<std::pair<std::string, std::string> > testcontainers::NetworkCreateSpec::options

driver Options

◆ labels

std::vector<std::pair<std::string, std::string> > testcontainers::NetworkCreateSpec::labels

network Labels