From f5be8ed04b3dbbb0236e6f7234831d6e469d786a Mon Sep 17 00:00:00 2001 From: Seth Vargo Date: Thu, 7 Sep 2017 22:06:48 -0400 Subject: [PATCH] Add "audit list" command documentation --- .../source/docs/commands/audit/list.html.md | 41 +++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 website/source/docs/commands/audit/list.html.md diff --git a/website/source/docs/commands/audit/list.html.md b/website/source/docs/commands/audit/list.html.md new file mode 100644 index 0000000000..cbcf0b3deb --- /dev/null +++ b/website/source/docs/commands/audit/list.html.md @@ -0,0 +1,41 @@ +--- +layout: "docs" +page_title: "audit list - Command" +sidebar_current: "docs-commands-audit-list" +description: |- + The "audit list" command lists the audit devices enabled. The output lists the + enabled audit devices and options for those devices. +--- + +# audit list + +The `audit list` command lists the audit devices enabled. The output lists the +enabled audit devices and options for those devices. + +## Examples + +List all audit devices: + +```text +$ vault audit list +Path Type Description +---- ---- ----------- +file/ file n/a +``` + +List detailed audit device information: + +```text +$ vault audit list -detailed +Path Type Description Replication Options +---- ---- ----------- ----------- ------- +file/ file n/a replicated file_path=/var/log/audit.log +``` + +## Usage + +The following flags are available in addition to the [standard set of +flags](/docs/commands/index.html) included on all commands. + +- `-detailed` `(bool: false)` - Print detailed information such as options and + replication status about each auth device.