mirror of
https://github.com/hashicorp/vault.git
synced 2025-08-16 03:27:01 +02:00
718540a632
Updating the vault leader step down documentation to include some extra info about possible failed requests during leader step down * Add changelog.txt * Update website/content/docs/commands/operator/step-down.mdx Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
34 lines
1.3 KiB
Plaintext
34 lines
1.3 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: operator step-down - Command
|
|
description: |-
|
|
The "operator step-down" forces the Vault server at the given address to step
|
|
down from active duty.
|
|
---
|
|
|
|
# operator step-down
|
|
|
|
The `operator step-down` forces the active Vault node within an [HA cluster](/vault/docs/concepts/ha)
|
|
to step down from active duty. When executed against a non-active node, i.e. a
|
|
standby or [performance standby](/vault/docs/enterprise/performance-standby) node,
|
|
the request will be forwarded to the active node. While the
|
|
affected node will have a delay before attempting to acquire
|
|
the leader lock again, if no other Vault nodes acquire the
|
|
lock beforehand, it is possible for the same node to re-acquire
|
|
the lock and become active again. Due to the locking architecture, there may be a period of time
|
|
before another node grabs the lock and finishes transitioning to active operation where the cluster has no active node. During the period where none of the nodes are active, forwarding of requests to the leader node will fail.
|
|
|
|
## Examples
|
|
|
|
Force a Vault server to step down as the leader:
|
|
|
|
```shell-session
|
|
$ vault operator step-down
|
|
Success! Stepped down: http://127.0.0.1:8200
|
|
```
|
|
|
|
## Usage
|
|
|
|
There are no flags beyond the [standard set of flags](/vault/docs/commands)
|
|
included on all commands.
|