open-vault/website/content/docs/commands/audit/list.mdx
Jeff Escalante ec620a7765
Implement MDX Remote (#10581)
* implement mdx remote

* fix an unfenced code block

* fix partials path

Co-authored-by: Jim Kalafut <jkalafut@hashicorp.com>
2020-12-17 16:53:33 -05:00

50 lines
1.3 KiB
Plaintext

---
layout: docs
page_title: audit list - Command
sidebar_title: <code>list</code>
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:
```shell-session
$ vault audit list
Path Type Description
---- ---- -----------
file/ file n/a
```
List detailed audit device information:
```shell-session
$ 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) included on all commands.
### Output Options
- `-format` `(string: "table")` - Print the output in the given format. Valid
formats are "table", "json", or "yaml". This can also be specified via the
`VAULT_FORMAT` environment variable.
### Command Options
- `-detailed` `(bool: false)` - Print detailed information such as options and
replication status about each auth device.