View Source DockerEngineAPI.Api.Swarm (docker_engine_api v1.43.0)
API calls for all endpoints tagged Swarm
.
Summary
Functions
Initialize a new swarm
Inspect swarm
Join an existing swarm
Leave a swarm
Unlock a locked manager
Get the unlock key
Update a swarm
Functions
Initialize a new swarm
Parameters
- connection (DockerEngineAPI.Connection): Connection to server
- body (SwarmInitRequest):
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure
Inspect swarm
Parameters
- connection (DockerEngineAPI.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure
Join an existing swarm
Parameters
- connection (DockerEngineAPI.Connection): Connection to server
- body (SwarmJoinRequest):
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure
Leave a swarm
Parameters
- connection (DockerEngineAPI.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
- :force (boolean()): Force leave swarm, even if this is the last manager or that it will break the cluster.
Returns
} on success {:error, info} on failure
Unlock a locked manager
Parameters
- connection (DockerEngineAPI.Connection): Connection to server
- body (SwarmUnlockRequest):
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure
Get the unlock key
Parameters
- connection (DockerEngineAPI.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure
Update a swarm
Parameters
- connection (DockerEngineAPI.Connection): Connection to server
- body (SwarmSpec):
- version (integer()): The version number of the swarm object being updated. This is required to avoid conflicting writes.
- opts (KeywordList): [optional] Optional parameters
- :rotate_worker_token (boolean()): Rotate the worker join token.
- :rotate_manager_token (boolean()): Rotate the manager join token.
- :rotate_manager_unlock_key (boolean()): Rotate the manager unlock key.
Returns
} on success {:error, info} on failure