Skip to content

Type Alias: ContainerNetwork ​

ContainerNetwork = object

A network a container is connected to, with its address on it, as Docker reports it (DockerContainer.networks). The addresses are empty strings while the container is not running.

Properties ​

endpointId ​

endpointId: string

The ID of the container's endpoint on the network.


gateway ​

gateway: string

The network's IPv4 gateway (172.17.0.1).


ip ​

ip: string

The container's IPv4 address on the network (172.17.0.2).


ipPrefixLen ​

ipPrefixLen: number

The prefix length of the IPv4 subnet (16 for a /16).


ipv6 ​

ipv6: string

The container's global IPv6 address on the network, an empty string without IPv6.


ipv6Gateway ​

ipv6Gateway: string

The network's IPv6 gateway, an empty string without IPv6.


ipv6PrefixLen ​

ipv6PrefixLen: number

The prefix length of the IPv6 subnet.


mac ​

mac: string

The container's MAC address on the network (02:42:ac:11:00:02).


networkId ​

networkId: string

The network ID.


networkName ​

networkName: string

The network name (bridge, my-network).

Released under the MIT License.