DockerEngineAPI.Api.Node (ex_docker_api v1.48.1)

API calls for all endpoints tagged Node.

Summary

Functions

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

Delete a node

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

Inspect a node

node_list(connection, opts \\ [])

List nodes

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

Update a node

Functions

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

@spec node_delete(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil}
  | {:ok, DockerEngineAPI.Model.ErrorResponse.t()}
  | {:error, Tesla.Env.t()}

Delete a node

Parameters

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

Returns

{:ok, nil} on success
{:error, Tesla.Env.t} on failure

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

@spec node_inspect(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, DockerEngineAPI.Model.Node.t()}
  | {:ok, DockerEngineAPI.Model.ErrorResponse.t()}
  | {:error, Tesla.Env.t()}

Inspect a node

Parameters

connection (DockerEngineAPI.Connection): Connection to server
id (String.t): The ID or name of the node
opts (keyword): Optional parameters

Returns

{:ok, DockerEngineAPI.Model.Node.t} on success
{:error, Tesla.Env.t} on failure

node_list(connection, opts \\ [])

@spec node_list(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, DockerEngineAPI.Model.ErrorResponse.t()}
  | {:ok, [DockerEngineAPI.Model.Node.t()]}
  | {:error, Tesla.Env.t()}

List nodes

Parameters

connection (DockerEngineAPI.Connection): Connection to server
opts (keyword): 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

{:ok, [%Node{}, ...]} on success
{:error, Tesla.Env.t} on failure

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

@spec node_update(Tesla.Env.client(), String.t(), integer(), keyword()) ::
  {:ok, nil}
  | {:ok, DockerEngineAPI.Model.ErrorResponse.t()}
  | {:error, Tesla.Env.t()}

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 (keyword): Optional parameters
- :body (NodeSpec):

Returns

{:ok, nil} on success
{:error, Tesla.Env.t} on failure