Documentation

NetworkSettings

Table of Contents

$bridge  : string|null
Name of the network'a bridge (for example, `docker0`).
$endpointID  : string|null
EndpointID uniquely represents a service endpoint in a Sandbox.
$gateway  : string|null
Gateway address for the default "bridge" network.
$globalIPv6Address  : string|null
Global IPv6 address for the default "bridge" network.
$globalIPv6PrefixLen  : int|null
Mask length of the global IPv6 address.
$hairpinMode  : bool|null
Indicates if hairpin NAT should be enabled on the virtual interface.
$iPAddress  : string|null
IPv4 address for the default "bridge" network.
$iPPrefixLen  : int|null
Mask length of the IPv4 address.
$iPv6Gateway  : string|null
IPv6 gateway address for this network.
$linkLocalIPv6Address  : string|null
IPv6 unicast address using the link-local prefix.
$linkLocalIPv6PrefixLen  : int|null
Prefix length of the IPv6 unicast address.
$macAddress  : string|null
MAC address for the container on the default "bridge" network.
$networks  : array<string|int, EndpointSettings>|null
Information about all networks that the container is connected to.
$ports  : array<string|int, array<string|int, PortBinding>>|null
PortMap describes the mapping of container ports to host ports, using the.
$sandboxID  : string|null
SandboxID uniquely represents a container's network stack.
$sandboxKey  : string|null
SandboxKey identifies the sandbox.
$secondaryIPAddresses  : array<string|int, Address>|null
$secondaryIPv6Addresses  : array<string|int, Address>|null
getBridge()  : string|null
Name of the network'a bridge (for example, `docker0`).
getEndpointID()  : string|null
EndpointID uniquely represents a service endpoint in a Sandbox.
getGateway()  : string|null
Gateway address for the default "bridge" network.
getGlobalIPv6Address()  : string|null
Global IPv6 address for the default "bridge" network.
getGlobalIPv6PrefixLen()  : int|null
Mask length of the global IPv6 address.
getHairpinMode()  : bool|null
Indicates if hairpin NAT should be enabled on the virtual interface.
getIPAddress()  : string|null
IPv4 address for the default "bridge" network.
getIPPrefixLen()  : int|null
Mask length of the IPv4 address.
getIPv6Gateway()  : string|null
IPv6 gateway address for this network.
getLinkLocalIPv6Address()  : string|null
IPv6 unicast address using the link-local prefix.
getLinkLocalIPv6PrefixLen()  : int|null
Prefix length of the IPv6 unicast address.
getMacAddress()  : string|null
MAC address for the container on the default "bridge" network.
getNetworks()  : array<string|int, EndpointSettings>|null
Information about all networks that the container is connected to.
getPorts()  : array<string|int, array<string|int, PortBinding>>|null
PortMap describes the mapping of container ports to host ports, using the.
getSandboxID()  : string|null
SandboxID uniquely represents a container's network stack.
getSandboxKey()  : string|null
SandboxKey identifies the sandbox.
getSecondaryIPAddresses()  : array<string|int, Address>|null
getSecondaryIPv6Addresses()  : array<string|int, Address>|null
setBridge()  : self
Name of the network'a bridge (for example, `docker0`).
setEndpointID()  : self
EndpointID uniquely represents a service endpoint in a Sandbox.
setGateway()  : self
Gateway address for the default "bridge" network.
setGlobalIPv6Address()  : self
Global IPv6 address for the default "bridge" network.
setGlobalIPv6PrefixLen()  : self
Mask length of the global IPv6 address.
setHairpinMode()  : self
Indicates if hairpin NAT should be enabled on the virtual interface.
setIPAddress()  : self
IPv4 address for the default "bridge" network.
setIPPrefixLen()  : self
Mask length of the IPv4 address.
setIPv6Gateway()  : self
IPv6 gateway address for this network.
setLinkLocalIPv6Address()  : self
IPv6 unicast address using the link-local prefix.
setLinkLocalIPv6PrefixLen()  : self
Prefix length of the IPv6 unicast address.
setMacAddress()  : self
MAC address for the container on the default "bridge" network.
setNetworks()  : self
Information about all networks that the container is connected to.
setPorts()  : self
PortMap describes the mapping of container ports to host ports, using the.
setSandboxID()  : self
SandboxID uniquely represents a container's network stack.
setSandboxKey()  : self
SandboxKey identifies the sandbox.
setSecondaryIPAddresses()  : self
setSecondaryIPv6Addresses()  : self

Properties

$bridge

Name of the network'a bridge (for example, `docker0`).

protected string|null $bridge

$endpointID

EndpointID uniquely represents a service endpoint in a Sandbox.

protected string|null $endpointID


Deprecated: This field is only propagated when attached to the

$gateway

Gateway address for the default "bridge" network.

protected string|null $gateway


Deprecated: This field is only propagated when attached to the

$globalIPv6Address

Global IPv6 address for the default "bridge" network.

protected string|null $globalIPv6Address


Deprecated: This field is only propagated when attached to the

$globalIPv6PrefixLen

Mask length of the global IPv6 address.

protected int|null $globalIPv6PrefixLen


Deprecated: This field is only propagated when attached to the

$hairpinMode

Indicates if hairpin NAT should be enabled on the virtual interface.

protected bool|null $hairpinMode

$iPAddress

IPv4 address for the default "bridge" network.

protected string|null $iPAddress


Deprecated: This field is only propagated when attached to the

$iPPrefixLen

Mask length of the IPv4 address.

protected int|null $iPPrefixLen


Deprecated: This field is only propagated when attached to the

$iPv6Gateway

IPv6 gateway address for this network.

protected string|null $iPv6Gateway


Deprecated: This field is only propagated when attached to the

$linkLocalIPv6Address

IPv6 unicast address using the link-local prefix.

protected string|null $linkLocalIPv6Address

$linkLocalIPv6PrefixLen

Prefix length of the IPv6 unicast address.

protected int|null $linkLocalIPv6PrefixLen

$macAddress

MAC address for the container on the default "bridge" network.

protected string|null $macAddress


Deprecated: This field is only propagated when attached to the

$ports

PortMap describes the mapping of container ports to host ports, using the.

protected array<string|int, array<string|int, PortBinding>>|null $ports

$sandboxID

SandboxID uniquely represents a container's network stack.

protected string|null $sandboxID

$sandboxKey

SandboxKey identifies the sandbox.

protected string|null $sandboxKey

Methods

getBridge()

Name of the network'a bridge (for example, `docker0`).

public getBridge() : string|null
Return values
string|null —

getEndpointID()

EndpointID uniquely represents a service endpoint in a Sandbox.

public getEndpointID() : string|null


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

Return values
string|null —

getGateway()

Gateway address for the default "bridge" network.

public getGateway() : string|null


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

Return values
string|null —

getGlobalIPv6Address()

Global IPv6 address for the default "bridge" network.

public getGlobalIPv6Address() : string|null


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

Return values
string|null —

getGlobalIPv6PrefixLen()

Mask length of the global IPv6 address.

public getGlobalIPv6PrefixLen() : int|null


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

Return values
int|null —

getHairpinMode()

Indicates if hairpin NAT should be enabled on the virtual interface.

public getHairpinMode() : bool|null
Return values
bool|null —

getIPAddress()

IPv4 address for the default "bridge" network.

public getIPAddress() : string|null


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

Return values
string|null —

getIPPrefixLen()

Mask length of the IPv4 address.

public getIPPrefixLen() : int|null


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

Return values
int|null —

getIPv6Gateway()

IPv6 gateway address for this network.

public getIPv6Gateway() : string|null


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

Return values
string|null —

getLinkLocalIPv6Address()

IPv6 unicast address using the link-local prefix.

public getLinkLocalIPv6Address() : string|null
Return values
string|null —

getLinkLocalIPv6PrefixLen()

Prefix length of the IPv6 unicast address.

public getLinkLocalIPv6PrefixLen() : int|null
Return values
int|null —

getMacAddress()

MAC address for the container on the default "bridge" network.

public getMacAddress() : string|null


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

Return values
string|null —

getPorts()

PortMap describes the mapping of container ports to host ports, using the.

public getPorts() : array<string|int, array<string|int, PortBinding>>|null
Return values
array<string|int, array<string|int, PortBinding>>|null —

getSandboxID()

SandboxID uniquely represents a container's network stack.

public getSandboxID() : string|null
Return values
string|null —

getSandboxKey()

SandboxKey identifies the sandbox.

public getSandboxKey() : string|null
Return values
string|null —

getSecondaryIPAddresses()

public getSecondaryIPAddresses() : array<string|int, Address>|null
Return values
array<string|int, Address>|null —

getSecondaryIPv6Addresses()

public getSecondaryIPv6Addresses() : array<string|int, Address>|null
Return values
array<string|int, Address>|null —

setBridge()

Name of the network'a bridge (for example, `docker0`).

public setBridge(string|null $bridge) : self
Parameters
$bridge : string|null
Return values
self —

setEndpointID()

EndpointID uniquely represents a service endpoint in a Sandbox.

public setEndpointID(string|null $endpointID) : self


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

Parameters
$endpointID : string|null
Return values
self —

setGateway()

Gateway address for the default "bridge" network.

public setGateway(string|null $gateway) : self


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

Parameters
$gateway : string|null
Return values
self —

setGlobalIPv6Address()

Global IPv6 address for the default "bridge" network.

public setGlobalIPv6Address(string|null $globalIPv6Address) : self


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

Parameters
$globalIPv6Address : string|null
Return values
self —

setGlobalIPv6PrefixLen()

Mask length of the global IPv6 address.

public setGlobalIPv6PrefixLen(int|null $globalIPv6PrefixLen) : self


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

Parameters
$globalIPv6PrefixLen : int|null
Return values
self —

setHairpinMode()

Indicates if hairpin NAT should be enabled on the virtual interface.

public setHairpinMode(bool|null $hairpinMode) : self
Parameters
$hairpinMode : bool|null
Return values
self —

setIPAddress()

IPv4 address for the default "bridge" network.

public setIPAddress(string|null $iPAddress) : self


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

Parameters
$iPAddress : string|null
Return values
self —

setIPPrefixLen()

Mask length of the IPv4 address.

public setIPPrefixLen(int|null $iPPrefixLen) : self


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

Parameters
$iPPrefixLen : int|null
Return values
self —

setIPv6Gateway()

IPv6 gateway address for this network.

public setIPv6Gateway(string|null $iPv6Gateway) : self


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

Parameters
$iPv6Gateway : string|null
Return values
self —

setLinkLocalIPv6Address()

IPv6 unicast address using the link-local prefix.

public setLinkLocalIPv6Address(string|null $linkLocalIPv6Address) : self
Parameters
$linkLocalIPv6Address : string|null
Return values
self —

setLinkLocalIPv6PrefixLen()

Prefix length of the IPv6 unicast address.

public setLinkLocalIPv6PrefixLen(int|null $linkLocalIPv6PrefixLen) : self
Parameters
$linkLocalIPv6PrefixLen : int|null
Return values
self —

setMacAddress()

MAC address for the container on the default "bridge" network.

public setMacAddress(string|null $macAddress) : self


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

Parameters
$macAddress : string|null
Return values
self —

setNetworks()

Information about all networks that the container is connected to.

public setNetworks(array<string|int, EndpointSettings>|null $networks) : self
Parameters
$networks : array<string|int, EndpointSettings>|null
Return values
self —

setPorts()

PortMap describes the mapping of container ports to host ports, using the.

public setPorts(array<string|int, array<string|int, PortBinding>>|null $ports) : self
Parameters
$ports : array<string|int, array<string|int, PortBinding>>|null
Return values
self —

setSandboxID()

SandboxID uniquely represents a container's network stack.

public setSandboxID(string|null $sandboxID) : self
Parameters
$sandboxID : string|null
Return values
self —

setSandboxKey()

SandboxKey identifies the sandbox.

public setSandboxKey(string|null $sandboxKey) : self
Parameters
$sandboxKey : string|null
Return values
self —

setSecondaryIPAddresses()

public setSecondaryIPAddresses(array<string|int, Address>|null $secondaryIPAddresses) : self
Parameters
$secondaryIPAddresses : array<string|int, Address>|null
Return values
self —

setSecondaryIPv6Addresses()

public setSecondaryIPv6Addresses(array<string|int, Address>|null $secondaryIPv6Addresses) : self
Parameters
$secondaryIPv6Addresses : array<string|int, Address>|null
Return values
self —

Search results