docker swarm update

Estimated reading time: 2 minutes

Edge only: This is the CLI reference for Docker CE Edge versions. Some of these options may not be available to Docker CE stable or Docker EE. You can view the stable version of this CLI reference or learn about Docker CE Edge.

Description

Update the swarm

API 1.24+  The client and daemon API must both be at least 1.24 to use this command. Use the docker version command on the client to check your client and daemon API versions.

Usage

docker swarm update [OPTIONS]

Options

Name, shorthand Default Description
--autolock Change manager autolocking setting (true|false)
--cert-expiry 2160h0m0s Validity period for node certificates (ns|us|ms|s|m|h)
--dispatcher-heartbeat 5s Dispatcher heartbeat period (ns|us|ms|s|m|h)
--external-ca Specifications of one or more certificate signing endpoints
--max-snapshots API 1.25+ 
Number of additional Raft snapshots to retain
--snapshot-interval 10000 API 1.25+ 
Number of log entries between Raft snapshots
--task-history-limit 5 Task history retention limit

Parent command

Command Description
docker swarm Manage Swarm
Command Description
docker swarm ca Display and rotate the root CA
docker swarm init Initialize a swarm
docker swarm join Join a swarm as a node and/or manager
docker swarm join-token Manage join tokens
docker swarm leave Leave the swarm
docker swarm unlock Unlock swarm
docker swarm unlock-key Manage the unlock key
docker swarm update Update the swarm

Extended description

Updates a swarm with new parameter values. This command must target a manager node.

Examples

$ docker swarm update --cert-expiry 720h