Skip to content

satl node

Manage swarm nodes

$ satl node [OPTIONS] <COMMAND>

satl node is a group: it always takes one of the subcommands below.

satl node ls

List nodes in the swarm

$ satl node ls [OPTIONS]

Options

Option Description
-q, --quiet Only display IDs

satl node inspect

Display detailed information on one or more nodes

$ satl node inspect [OPTIONS] <NODE>...

Arguments

Argument Description
<NODE>... Nodes to inspect; self means the node serving this request

Options

Option Description
--pretty Print the information in a human friendly format

satl node update

Update a node

$ satl node update [OPTIONS] <NODE>

Arguments

Argument Description
<NODE> The node to update

Options

Option Description
--label-add <KEY=VALUE> Add or update a node label (key=value)
--label-rm <KEY> Remove a node label if it exists
--availability <STATE> Availability of the node
Values: active, pause, drain
--role <ROLE> Role of the node
Values: worker, manager

satl node rm

Remove one or more nodes from the swarm

$ satl node rm [OPTIONS] <NODE>...

Arguments

Argument Description
<NODE>... Nodes to remove

Options

Option Description
-f, --force Force remove a node from the swarm

satl node promote

Promote one or more nodes to manager in the swarm

$ satl node promote [OPTIONS] <NODE>...

Arguments

Argument Description
<NODE>... Nodes to promote or demote

satl node demote

Demote one or more nodes from manager in the swarm

$ satl node demote [OPTIONS] <NODE>...

Arguments

Argument Description
<NODE>... Nodes to promote or demote

Global options

Accepted by every satl command.

Option Description
--host <URL> Daemon socket to connect to (docker-style URL)
Default: unix:///var/run/satl.sock
Environment: DOCKER_HOST
-h, --help Print help
-V, --version Print version

Generated from satl 0.1.0 by make gen. Change it in the SatL source or in overlay/cli.yml, never here.