SwarmJoinPostBody
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:.
- $joinToken : string|null
- Secret token for joining this swarm.
- $listenAddr : string|null
- Listen address used for inter-manager communication if the node.
- $remoteAddrs : array<string|int, string>|null
- Addresses of manager nodes already participating in the swarm.
- getAdvertiseAddr() : string|null
- Externally reachable address advertised to other nodes. This.
- getDataPathAddr() : string|null
- Address or interface to use for data path traffic (format:.
- getJoinToken() : string|null
- Secret token for joining this swarm.
- getListenAddr() : string|null
- Listen address used for inter-manager communication if the node.
- getRemoteAddrs() : array<string|int, string>|null
- Addresses of manager nodes already participating in the swarm.
- setAdvertiseAddr() : self
- Externally reachable address advertised to other nodes. This.
- setDataPathAddr() : self
- Address or interface to use for data path traffic (format:.
- setJoinToken() : self
- Secret token for joining this swarm.
- setListenAddr() : self
- Listen address used for inter-manager communication if the node.
- setRemoteAddrs() : self
- Addresses of manager nodes already participating in the swarm.
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
$joinToken
Secret token for joining this swarm.
protected
string|null
$joinToken
$listenAddr
Listen address used for inter-manager communication if the node.
protected
string|null
$listenAddr
$remoteAddrs
Addresses of manager nodes already participating in the swarm.
protected
array<string|int, string>|null
$remoteAddrs
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 —getJoinToken()
Secret token for joining this swarm.
public
getJoinToken() : string|null
Return values
string|null —getListenAddr()
Listen address used for inter-manager communication if the node.
public
getListenAddr() : string|null
interface used for the VXLAN Tunnel Endpoint (VTEP).
Return values
string|null —getRemoteAddrs()
Addresses of manager nodes already participating in the swarm.
public
getRemoteAddrs() : array<string|int, string>|null
Return values
array<string|int, string>|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 —setJoinToken()
Secret token for joining this swarm.
public
setJoinToken(string|null $joinToken) : self
Parameters
- $joinToken : string|null
Return values
self —setListenAddr()
Listen address used for inter-manager communication if the node.
public
setListenAddr(string|null $listenAddr) : self
interface used for the VXLAN Tunnel Endpoint (VTEP).
Parameters
- $listenAddr : string|null
Return values
self —setRemoteAddrs()
Addresses of manager nodes already participating in the swarm.
public
setRemoteAddrs(array<string|int, string>|null $remoteAddrs) : self
Parameters
- $remoteAddrs : array<string|int, string>|null