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

API calls for all endpoints tagged Node.

Summary

Functions

Link to this function

node_delete(connection, id, opts \\ [])

View Source

Delete a node

Parameters

  • connection (DockerEngineAPI.Connection): Connection to server
  • id (String.t): The ID or name of the node
  • opts (KeywordList): [optional] Optional parameters
    • :force (boolean()): Force remove a node from the swarm

Returns

} on success {:error, info} on failure

Link to this function

node_inspect(connection, id, opts \\ [])

View Source

Inspect a node

Parameters

  • connection (DockerEngineAPI.Connection): Connection to server
  • id (String.t): The ID or name of the node
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Link to this function

node_list(connection, opts \\ [])

View Source

List nodes

Parameters

  • connection (DockerEngineAPI.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters
    • :filters (String.t): Filters to process on the nodes list, encoded as JSON (a `map[string][]string`). Available filters: - `id=<node id>` - `label=<engine label>` - `membership=`(`accepted`|`pending`)` - `name=<node name>` - `node.label=<node label>` - `role=`(`manager`|`worker`)`

Returns

, ...]} on success {:error, info} on failure

Link to this function

node_update(connection, id, version, opts \\ [])

View Source

Update a node

Parameters

  • connection (DockerEngineAPI.Connection): Connection to server
  • id (String.t): The ID of the node
  • version (integer()): The version number of the node object being updated. This is required to avoid conflicting writes.
  • opts (KeywordList): [optional] Optional parameters
    • :body (NodeSpec):

Returns

} on success {:error, info} on failure