class Client

Class Client.

Constants

BASE_URL

Methods

__construct(Curl $curl, string $docker_host)

No description

mixed
inspect()

No description

mixed
initialize(string $advertiseAddr, string $listenAddr = '0.0.0.0:2377', string $dataPathAddr = null, bool $forceNewCluster = false, array $spec = null)

No description

mixed
join(string $listenAddress, string $advertiseAddress, string $dataPathAddress, string $remoteAddress, string $joinToken)

No description

mixed
leave(bool $force = false)

No description

mixed
update(int $version, string $name, bool $rotateWorkerToken = false, bool $rotateManagerToken = false, bool $rotateManagerUnlockKey = false, array $labels = [], array $orchestration = [], array $raft = [], array $dispatcher = [], array $caConfig = [], array $encryptionConfig = [], array $taskDefaults = [])

No description

mixed
getUnlockKey()

No description

mixed
unlock(string $unlockKey)

No description

Details

at line 26
__construct(Curl $curl, string $docker_host)

Parameters

Curl $curl
string $docker_host

at line 38
mixed inspect()

Return Value

mixed

Exceptions

Exception

at line 54
mixed initialize(string $advertiseAddr, string $listenAddr = '0.0.0.0:2377', string $dataPathAddr = null, bool $forceNewCluster = false, array $spec = null)

Parameters

string $advertiseAddr
string $listenAddr
string $dataPathAddr
bool $forceNewCluster
array $spec

Return Value

mixed

Exceptions

Exception

See also

https://docs.docker.com/engine/api/v1.37/#operation/SwarmInit

at line 80
mixed join(string $listenAddress, string $advertiseAddress, string $dataPathAddress, string $remoteAddress, string $joinToken)

Parameters

string $listenAddress
string $advertiseAddress
string $dataPathAddress
string $remoteAddress
string $joinToken

Return Value

mixed

Exceptions

Exception

at line 106
mixed leave(bool $force = false)

Parameters

bool $force

Return Value

mixed

Exceptions

Exception

at line 120
mixed update(int $version, string $name, bool $rotateWorkerToken = false, bool $rotateManagerToken = false, bool $rotateManagerUnlockKey = false, array $labels = [], array $orchestration = [], array $raft = [], array $dispatcher = [], array $caConfig = [], array $encryptionConfig = [], array $taskDefaults = [])

Parameters

int $version
string $name
bool $rotateWorkerToken
bool $rotateManagerToken
bool $rotateManagerUnlockKey
array $labels
array $orchestration
array $raft
array $dispatcher
array $caConfig
array $encryptionConfig
array $taskDefaults

Return Value

mixed

Exceptions

Exception

See also

https://docs.docker.com/engine/api/v1.37/#operation/SwarmUpdate

at line 160
mixed getUnlockKey()

Return Value

mixed

Exceptions

Exception

at line 172
mixed unlock(string $unlockKey)

Parameters

string $unlockKey

Return Value

mixed

Exceptions

Exception