Documentation

SwarmInitPostBody

Table of Contents

$advertiseAddr  : string|null
Externally reachable address advertised to other nodes. This.
$dataPathAddr  : string|null
Address or interface to use for data path traffic (format:.
$dataPathPort  : int|null
DataPathPort specifies the data path port number for data traffic.
$defaultAddrPool  : array<string|int, string>|null
Default Address Pool specifies default subnet pools for global.
$forceNewCluster  : bool|null
Force creation of a new swarm.
$listenAddr  : string|null
Listen address used for inter-manager communication, as well.
$spec  : SwarmSpec|null
User modifiable swarm configuration.
$subnetSize  : int|null
SubnetSize specifies the subnet size of the networks created.
getAdvertiseAddr()  : string|null
Externally reachable address advertised to other nodes. This.
getDataPathAddr()  : string|null
Address or interface to use for data path traffic (format:.
getDataPathPort()  : int|null
DataPathPort specifies the data path port number for data traffic.
getDefaultAddrPool()  : array<string|int, string>|null
Default Address Pool specifies default subnet pools for global.
getForceNewCluster()  : bool|null
Force creation of a new swarm.
getListenAddr()  : string|null
Listen address used for inter-manager communication, as well.
getSpec()  : SwarmSpec|null
User modifiable swarm configuration.
getSubnetSize()  : int|null
SubnetSize specifies the subnet size of the networks created.
setAdvertiseAddr()  : self
Externally reachable address advertised to other nodes. This.
setDataPathAddr()  : self
Address or interface to use for data path traffic (format:.
setDataPathPort()  : self
DataPathPort specifies the data path port number for data traffic.
setDefaultAddrPool()  : self
Default Address Pool specifies default subnet pools for global.
setForceNewCluster()  : self
Force creation of a new swarm.
setListenAddr()  : self
Listen address used for inter-manager communication, as well.
setSpec()  : self
User modifiable swarm configuration.
setSubnetSize()  : self
SubnetSize specifies the subnet size of the networks created.

Properties

$advertiseAddr

Externally reachable address advertised to other nodes. This.

protected string|null $advertiseAddr

$dataPathAddr

Address or interface to use for data path traffic (format:.

protected string|null $dataPathAddr

$dataPathPort

DataPathPort specifies the data path port number for data traffic.

protected int|null $dataPathPort

$defaultAddrPool

Default Address Pool specifies default subnet pools for global.

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

$forceNewCluster

Force creation of a new swarm.

protected bool|null $forceNewCluster

$listenAddr

Listen address used for inter-manager communication, as well.

protected string|null $listenAddr

$subnetSize

SubnetSize specifies the subnet size of the networks created.

protected int|null $subnetSize

Methods

getAdvertiseAddr()

Externally reachable address advertised to other nodes. This.

public getAdvertiseAddr() : string|null

not specified, it will be automatically detected when possible.

Return values
string|null —

getDataPathAddr()

Address or interface to use for data path traffic (format:.

public getDataPathAddr() : string|null

management traffic of the cluster.

Return values
string|null —

getDataPathPort()

DataPathPort specifies the data path port number for data traffic.

public getDataPathPort() : int|null

if no port is set or is set to 0, default port 4789 will be used.

Return values
int|null —

getDefaultAddrPool()

Default Address Pool specifies default subnet pools for global.

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

getForceNewCluster()

Force creation of a new swarm.

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

getListenAddr()

Listen address used for inter-manager communication, as well.

public getListenAddr() : string|null

is omitted, the default swarm listening port is used.

Return values
string|null —

getSubnetSize()

SubnetSize specifies the subnet size of the networks created.

public getSubnetSize() : int|null

from the default subnet pool.

Return values
int|null —

setAdvertiseAddr()

Externally reachable address advertised to other nodes. This.

public setAdvertiseAddr(string|null $advertiseAddr) : self

not specified, it will be automatically detected when possible.

Parameters
$advertiseAddr : string|null
Return values
self —

setDataPathAddr()

Address or interface to use for data path traffic (format:.

public setDataPathAddr(string|null $dataPathAddr) : self

management traffic of the cluster.

Parameters
$dataPathAddr : string|null
Return values
self —

setDataPathPort()

DataPathPort specifies the data path port number for data traffic.

public setDataPathPort(int|null $dataPathPort) : self

if no port is set or is set to 0, default port 4789 will be used.

Parameters
$dataPathPort : int|null
Return values
self —

setDefaultAddrPool()

Default Address Pool specifies default subnet pools for global.

public setDefaultAddrPool(array<string|int, string>|null $defaultAddrPool) : self
Parameters
$defaultAddrPool : array<string|int, string>|null
Return values
self —

setForceNewCluster()

Force creation of a new swarm.

public setForceNewCluster(bool|null $forceNewCluster) : self
Parameters
$forceNewCluster : bool|null
Return values
self —

setListenAddr()

Listen address used for inter-manager communication, as well.

public setListenAddr(string|null $listenAddr) : self

is omitted, the default swarm listening port is used.

Parameters
$listenAddr : string|null
Return values
self —

setSubnetSize()

SubnetSize specifies the subnet size of the networks created.

public setSubnetSize(int|null $subnetSize) : self

from the default subnet pool.

Parameters
$subnetSize : int|null
Return values
self —

Search results