Add "audit list" command documentation

This commit is contained in:
Seth Vargo 2017-09-07 22:06:48 -04:00
parent 0b5c21168a
commit f5be8ed04b
No known key found for this signature in database
GPG key ID: C921994F9C27E0FF

View file

@ -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.