From ccb3bec2a504d035d4bb8e18d3e04dcbf4e9b39d Mon Sep 17 00:00:00 2001 From: Seth Vargo Date: Thu, 7 Sep 2017 22:10:34 -0400 Subject: [PATCH] Add "operator step-down" command documentation --- .../docs/commands/operator/step-down.html.md | 30 +++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 website/source/docs/commands/operator/step-down.html.md diff --git a/website/source/docs/commands/operator/step-down.html.md b/website/source/docs/commands/operator/step-down.html.md new file mode 100644 index 0000000000..63764dc23d --- /dev/null +++ b/website/source/docs/commands/operator/step-down.html.md @@ -0,0 +1,30 @@ +--- +layout: "docs" +page_title: "operator step-down - Command" +sidebar_current: "docs-commands-operator-step-down" +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 Vault server at the given address to step +down from active duty. 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. + +## Examples + +Force a Vault server to step down as the leader: + +```text +$ vault operator step-down +Success! Stepped down: http://127.0.0.1:8200 +``` + +## Usage + +There are no flags beyond the [standard set of flags](/docs/commands/index.html) +included on all commands.