NetworkCLI

connect

connect(network, container, alias=None, driver_options=[], ip=None, ip6=None, links=[])

Connect a container to a network

Parameters:

Name	Type	Description	Default
network	ValidNetwork	The network to connect to	required
container	python_on_whales.components.container.cli_wrapper.ValidContainer	The container to connect	required
alias	Optional[str]	Add network-scoped alias for the container	None
driver_options	List[str]	Driver options for the network	[]
ip	Optional[str]	IPv4 address (e.g., "172.30.100.104")	None
ip6	Optional[str]	IPv6 address (e.g., "2001:db8::33")	None
links	List[python_on_whales.components.container.cli_wrapper.ValidContainer]	Add links to other containers	[]

create

create(name, attachable=False, driver=None, gateway=None, subnet=None, labels={}, options=[])

Creates a Docker network.

Parameters:

Name	Type	Description	Default
name	str	The name of the network	required

Returns

A `python_on_whales.Network`.

disconnect

disconnect(network, container, force=False)

Disconnect a container from a network

Parameters:

Name	Type	Description	Default
network	ValidNetwork	The name of the network.	required
container	python_on_whales.components.container.cli_wrapper.ValidContainer	The container to disconnect.	required

remove

remove(networks)

Removes a Docker network

Parameters:

Name	Type	Description	Default
networks	Union[ValidNetwork, List[ValidNetwork]]	One or more networks.	required