2017-09-08 02:06:44 +00:00
|
|
|
---
|
2020-01-18 00:18:09 +00:00
|
|
|
layout: docs
|
|
|
|
|
page_title: audit enable - Command
|
|
|
|
|
sidebar_title: <code>enable</code>
|
|
|
|
|
description: The "audit enable" command enables an audit device at a given path.
|
2017-09-08 02:06:44 +00:00
|
|
|
---
|
|
|
|
|
|
|
|
|
|
# audit enable
|
|
|
|
|
|
|
|
|
|
The `audit enable` command enables an audit device at a given path. If an audit
|
|
|
|
|
device already exists at the given path, an error is returned. Additional
|
|
|
|
|
options for configuring the audit device are provided as `KEY=VALUE`. Each audit
|
|
|
|
|
device declares its own set of configuration options.
|
|
|
|
|
|
|
|
|
|
Once an audit device is enabled, almost every request and response will be
|
|
|
|
|
logged to the device.
|
|
|
|
|
|
|
|
|
|
## Examples
|
|
|
|
|
|
|
|
|
|
Enable the audit device "file" enabled at "file/":
|
|
|
|
|
|
|
|
|
|
```text
|
|
|
|
|
$ vault audit enable file file_path=/tmp/my-file.txt
|
|
|
|
|
Success! Enabled the file audit device at: file/
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
|
|
|
|
The following flags are available in addition to the [standard set of
|
2020-01-22 20:05:41 +00:00
|
|
|
flags](/docs/commands) included on all commands.
|
2017-09-08 02:06:44 +00:00
|
|
|
|
|
|
|
|
- `-description` `(string: "")` - Human-friendly description for the purpose of
|
|
|
|
|
this audit device.
|
|
|
|
|
|
2020-01-18 00:18:09 +00:00
|
|
|
- `-local` `(bool: false)` - Mark the audit device as a local-only device.
|
|
|
|
|
Local devices are not replicated or removed by replication.
|
2017-09-08 02:06:44 +00:00
|
|
|
|
|
|
|
|
- `-path` `(string: "")` - Place where the audit device will be accessible. This
|
|
|
|
|
must be unique across all audit devices. This defaults to the "type" of the
|
|
|
|
|
audit device.
|
