NetworkSettings

@Serializable
data class NetworkSettings(val bridge: String? = null, val sandboxID: String? = null, val hairpinMode: Boolean? = null, val linkLocalIPv6Address: String? = null, val linkLocalIPv6PrefixLen: Int? = null, val ports: Map<String, List<PortBinding>?>? = null, val sandboxKey: String? = null, val secondaryIPAddresses: List<Address>? = null, val secondaryIPv6Addresses: List<Address>? = null, val endpointID: String? = null, val gateway: String? = null, val globalIPv6Address: String? = null, val globalIPv6PrefixLen: Int? = null, val ipAddress: String? = null, val ipPrefixLen: Int? = null, val ipv6Gateway: String? = null, val macAddress: String? = null, val networks: Map<String, EndpointSettings>? = null)

NetworkSettings exposes the network settings in the API

Parameters

bridge

Name of the default bridge interface when dockerd's --bridge flag is set.

sandboxID

SandboxID uniquely represents a container's network stack.

hairpinMode

Indicates if hairpin NAT should be enabled on the virtual interface. Deprecated: This field is never set and will be removed in a future release.

linkLocalIPv6Address

IPv6 unicast address using the link-local prefix. Deprecated: This field is never set and will be removed in a future release.

linkLocalIPv6PrefixLen

Prefix length of the IPv6 unicast address. Deprecated: This field is never set and will be removed in a future release.

ports

PortMap describes the mapping of container ports to host ports, using the container's port-number and protocol as key in the format <port>/<protocol>, for example, 80/udp. If a container's port is mapped for multiple protocols, separate entries are added to the mapping table.

sandboxKey

SandboxKey is the full path of the netns handle

secondaryIPAddresses

Deprecated: This field is never set and will be removed in a future release.

secondaryIPv6Addresses

Deprecated: This field is never set and will be removed in a future release.

endpointID

EndpointID 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

Gateway 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

Global 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

Mask 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

ipAddress

IPv4 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

Mask 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

IPv6 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

macAddress

MAC 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

Information about all networks that the container is connected to.

Constructors

Link copied to clipboard
constructor(bridge: String? = null, sandboxID: String? = null, hairpinMode: Boolean? = null, linkLocalIPv6Address: String? = null, linkLocalIPv6PrefixLen: Int? = null, ports: Map<String, List<PortBinding>?>? = null, sandboxKey: String? = null, secondaryIPAddresses: List<Address>? = null, secondaryIPv6Addresses: List<Address>? = null, endpointID: String? = null, gateway: String? = null, globalIPv6Address: String? = null, globalIPv6PrefixLen: Int? = null, ipAddress: String? = null, ipPrefixLen: Int? = null, ipv6Gateway: String? = null, macAddress: String? = null, networks: Map<String, EndpointSettings>? = null)

Properties

Link copied to clipboard
@SerialName(value = "Bridge")
val bridge: String?
Link copied to clipboard
@SerialName(value = "EndpointID")
val endpointID: String?
Link copied to clipboard
@SerialName(value = "Gateway")
val gateway: String?
Link copied to clipboard
@SerialName(value = "GlobalIPv6Address")
val globalIPv6Address: String?
Link copied to clipboard
@SerialName(value = "GlobalIPv6PrefixLen")
val globalIPv6PrefixLen: Int?
Link copied to clipboard
@SerialName(value = "HairpinMode")
val hairpinMode: Boolean?
Link copied to clipboard
@SerialName(value = "IPAddress")
val ipAddress: String?
Link copied to clipboard
@SerialName(value = "IPPrefixLen")
val ipPrefixLen: Int?
Link copied to clipboard
@SerialName(value = "IPv6Gateway")
val ipv6Gateway: String?
Link copied to clipboard
@SerialName(value = "LinkLocalIPv6Address")
val linkLocalIPv6Address: String?
Link copied to clipboard
@SerialName(value = "LinkLocalIPv6PrefixLen")
val linkLocalIPv6PrefixLen: Int?
Link copied to clipboard
@SerialName(value = "MacAddress")
val macAddress: String?
Link copied to clipboard
@SerialName(value = "Networks")
val networks: Map<String, EndpointSettings>?
Link copied to clipboard
@SerialName(value = "Ports")
val ports: Map<String, List<PortBinding>?>?
Link copied to clipboard
@SerialName(value = "SandboxID")
val sandboxID: String?
Link copied to clipboard
@SerialName(value = "SandboxKey")
val sandboxKey: String?
Link copied to clipboard
@SerialName(value = "SecondaryIPAddresses")
val secondaryIPAddresses: List<Address>?
Link copied to clipboard
@SerialName(value = "SecondaryIPv6Addresses")
val secondaryIPv6Addresses: List<Address>?