Skip to content

dsdk / v1.47 / NetworkSettings

Type Alias: NetworkSettings ​

NetworkSettings: object

NetworkSettings exposes the network settings in the API

Type declaration ​

NameTypeDescription
Bridge?stringName of the default bridge interface when dockerd's --bridge flag is set.
EndpointID?stringEndpointID uniquely represents a service endpoint in a Sandbox.


> Deprecated: This field is only propagated when attached to the > default "bridge" network. Use the information from the "bridge" > network inside the Networks map instead, which contains the same > information. This field was deprecated in Docker 1.9 and is scheduled > to be removed in Docker 17.12.0
Gateway?stringGateway address for the default "bridge" network.


> Deprecated: This field is only propagated when attached to the > default "bridge" network. Use the information from the "bridge" > network inside the Networks map instead, which contains the same > information. This field was deprecated in Docker 1.9 and is scheduled > to be removed in Docker 17.12.0
GlobalIPv6Address?stringGlobal IPv6 address for the default "bridge" network.


> Deprecated: This field is only propagated when attached to the > default "bridge" network. Use the information from the "bridge" > network inside the Networks map instead, which contains the same > information. This field was deprecated in Docker 1.9 and is scheduled > to be removed in Docker 17.12.0
GlobalIPv6PrefixLen?numberMask length of the global IPv6 address.


> Deprecated: This field is only propagated when attached to the > default "bridge" network. Use the information from the "bridge" > network inside the Networks map instead, which contains the same > information. This field was deprecated in Docker 1.9 and is scheduled > to be removed in Docker 17.12.0
HairpinMode?booleanIndicates if hairpin NAT should be enabled on the virtual interface. Deprecated: This field is never set and will be removed in a future release.
IPAddress?stringIPv4 address for the default "bridge" network.


> Deprecated: This field is only propagated when attached to the > default "bridge" network. Use the information from the "bridge" > network inside the Networks map instead, which contains the same > information. This field was deprecated in Docker 1.9 and is scheduled > to be removed in Docker 17.12.0
IPPrefixLen?numberMask length of the IPv4 address.


> Deprecated: This field is only propagated when attached to the > default "bridge" network. Use the information from the "bridge" > network inside the Networks map instead, which contains the same > information. This field was deprecated in Docker 1.9 and is scheduled > to be removed in Docker 17.12.0
IPv6Gateway?stringIPv6 gateway address for this network.


> Deprecated: This field is only propagated when attached to the > default "bridge" network. Use the information from the "bridge" > network inside the Networks map instead, which contains the same > information. This field was deprecated in Docker 1.9 and is scheduled > to be removed in Docker 17.12.0
LinkLocalIPv6Address?stringIPv6 unicast address using the link-local prefix. Deprecated: This field is never set and will be removed in a future release.
LinkLocalIPv6PrefixLen?numberPrefix length of the IPv6 unicast address. Deprecated: This field is never set and will be removed in a future release.
MacAddress?stringMAC address for the container on the default "bridge" network.


> Deprecated: This field is only propagated when attached to the > default "bridge" network. Use the information from the "bridge" > network inside the Networks map instead, which contains the same > information. This field was deprecated in Docker 1.9 and is scheduled > to be removed in Docker 17.12.0
Networks?objectInformation about all networks that the container is connected to.
Ports?PortMap-
SandboxID?stringSandboxID uniquely represents a container's network stack.
SandboxKey?stringSandboxKey is the full path of the netns handle
SecondaryIPAddresses?Address[] | nullDeprecated: This field is never set and will be removed in a future release.
SecondaryIPv6Addresses?Address[] | nullDeprecated: This field is never set and will be removed in a future release.