docker swarm unlock-key
Description
Manage the unlock key
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.
Swarm This command works with the Swarm orchestrator.
Usage
docker swarm unlock-key [OPTIONS]
Extended description
An unlock key is a secret key needed to unlock a manager after its Docker daemon restarts. These keys are only used when the autolock feature is enabled for the swarm.
You can view or rotate the unlock key using swarm unlock-key. To view the key,
run the docker swarm unlock-key command without any arguments:
Note
This is a cluster management command, and must be executed on a swarm manager node. To learn about managers and workers, refer to the Swarm mode section in the documentation.
For example uses of this command, refer to the examples section below.
Options
| Name, shorthand | Default | Description |
--quiet , -q |
Only display token | |
--rotate |
Rotate unlock key |
Examples
$ docker swarm unlock-key
To unlock a swarm manager after it restarts, run the `docker swarm unlock`
command and provide the following key:
SWMKEY-1-fySn8TY4w5lKcWcJPIpKufejh9hxx5KYwx6XZigx3Q4
Please remember to store this key in a password manager, since without it you
will not be able to restart the manager.
Use the --rotate flag to rotate the unlock key to a new, randomly-generated
key:
$ docker swarm unlock-key --rotate
Successfully rotated manager unlock key.
To unlock a swarm manager after it restarts, run the `docker swarm unlock`
command and provide the following key:
SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8
Please remember to store this key in a password manager, since without it you
will not be able to restart the manager.
The -q (or --quiet) flag only prints the key:
$ docker swarm unlock-key -q
SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8
--rotate
This flag rotates the unlock key, replacing it with a new randomly-generated key. The old unlock key will no longer be accepted.
--quiet
Only print the unlock key, without instructions.
Parent command
| Command | Description |
|---|---|
| docker swarm | Manage Swarm |
Related commands
| 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 |