View Source DockerEngineAPI.Api.Swarm (docker_engine_api v1.43.0)

API calls for all endpoints tagged Swarm.

Summary

Functions

Link to this function

swarm_init(connection, body, opts \\ [])

View Source

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

Link to this function

swarm_inspect(connection, opts \\ [])

View Source

Inspect swarm

Parameters

  • connection (DockerEngineAPI.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Link to this function

swarm_join(connection, body, opts \\ [])

View Source

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

Link to this function

swarm_leave(connection, opts \\ [])

View Source

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

Link to this function

swarm_unlock(connection, body, opts \\ [])

View Source

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

Link to this function

swarm_unlockkey(connection, opts \\ [])

View Source

Get the unlock key

Parameters

  • connection (DockerEngineAPI.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Link to this function

swarm_update(connection, body, version, opts \\ [])

View Source

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