Documentation

NetworksCreatePostBody

Table of Contents

$attachable  : bool|null
Globally scoped network is manually attachable by regular.
$checkDuplicate  : bool|null
Check for networks with duplicate names. Since Network is.
$driver  : string|null
Name of the network driver plugin to use.
$enableIPv6  : bool|null
Enable IPv6 on the network.
$ingress  : bool|null
Ingress network is the network which provides the routing-mesh.
$internal  : bool|null
Restrict external access to the network.
$iPAM  : IPAM|null
$labels  : array<string|int, string>|null
User-defined key/value metadata.
$name  : string|null
The network's name.
$options  : array<string|int, string>|null
Network specific options to be used by the drivers.
getAttachable()  : bool|null
Globally scoped network is manually attachable by regular.
getCheckDuplicate()  : bool|null
Check for networks with duplicate names. Since Network is.
getDriver()  : string|null
Name of the network driver plugin to use.
getEnableIPv6()  : bool|null
Enable IPv6 on the network.
getIngress()  : bool|null
Ingress network is the network which provides the routing-mesh.
getInternal()  : bool|null
Restrict external access to the network.
getIPAM()  : IPAM|null
getLabels()  : array<string|int, string>|null
User-defined key/value metadata.
getName()  : string|null
The network's name.
getOptions()  : array<string|int, string>|null
Network specific options to be used by the drivers.
setAttachable()  : self
Globally scoped network is manually attachable by regular.
setCheckDuplicate()  : self
Check for networks with duplicate names. Since Network is.
setDriver()  : self
Name of the network driver plugin to use.
setEnableIPv6()  : self
Enable IPv6 on the network.
setIngress()  : self
Ingress network is the network which provides the routing-mesh.
setInternal()  : self
Restrict external access to the network.
setIPAM()  : self
setLabels()  : self
User-defined key/value metadata.
setName()  : self
The network's name.
setOptions()  : self
Network specific options to be used by the drivers.

Properties

$attachable

Globally scoped network is manually attachable by regular.

protected bool|null $attachable

$checkDuplicate

Check for networks with duplicate names. Since Network is.

protected bool|null $checkDuplicate

$ingress

Ingress network is the network which provides the routing-mesh.

protected bool|null $ingress

$options

Network specific options to be used by the drivers.

protected array<string|int, string>|null $options

Methods

getAttachable()

Globally scoped network is manually attachable by regular.

public getAttachable() : bool|null

containers from workers in swarm mode.

Return values
bool|null

getCheckDuplicate()

Check for networks with duplicate names. Since Network is.

public getCheckDuplicate() : bool|null

but it is not guaranteed to catch all name collisions.

Return values
bool|null

getDriver()

Name of the network driver plugin to use.

public getDriver() : string|null
Return values
string|null

getEnableIPv6()

Enable IPv6 on the network.

public getEnableIPv6() : bool|null
Return values
bool|null

getIngress()

Ingress network is the network which provides the routing-mesh.

public getIngress() : bool|null

in swarm mode.

Return values
bool|null

getInternal()

Restrict external access to the network.

public getInternal() : bool|null
Return values
bool|null

getLabels()

User-defined key/value metadata.

public getLabels() : array<string|int, string>|null
Return values
array<string|int, string>|null

getOptions()

Network specific options to be used by the drivers.

public getOptions() : array<string|int, string>|null
Return values
array<string|int, string>|null

setAttachable()

Globally scoped network is manually attachable by regular.

public setAttachable(bool|null $attachable) : self

containers from workers in swarm mode.

Parameters
$attachable : bool|null
Return values
self

setCheckDuplicate()

Check for networks with duplicate names. Since Network is.

public setCheckDuplicate(bool|null $checkDuplicate) : self

but it is not guaranteed to catch all name collisions.

Parameters
$checkDuplicate : bool|null
Return values
self

setDriver()

Name of the network driver plugin to use.

public setDriver(string|null $driver) : self
Parameters
$driver : string|null
Return values
self

setEnableIPv6()

Enable IPv6 on the network.

public setEnableIPv6(bool|null $enableIPv6) : self
Parameters
$enableIPv6 : bool|null
Return values
self

setIngress()

Ingress network is the network which provides the routing-mesh.

public setIngress(bool|null $ingress) : self

in swarm mode.

Parameters
$ingress : bool|null
Return values
self

setInternal()

Restrict external access to the network.

public setInternal(bool|null $internal) : self
Parameters
$internal : bool|null
Return values
self

setLabels()

User-defined key/value metadata.

public setLabels(array<string|int, string>|null $labels) : self
Parameters
$labels : array<string|int, string>|null
Return values
self

setName()

The network's name.

public setName(string|null $name) : self
Parameters
$name : string|null
Return values
self

setOptions()

Network specific options to be used by the drivers.

public setOptions(array<string|int, string>|null $options) : self
Parameters
$options : array<string|int, string>|null
Return values
self

Search results