mirror of
https://github.com/hashicorp/vault.git
synced 2025-08-16 03:27:01 +02:00
94fb339b31
* Tidy up of files * Add concepts page for filtering * Update 'Common configuration options' * Update table format (metrics) * Filtering metrics * audit specific filtering * Fix nav and naming of files * updates to audit filtering concept page * Tweaks * audit updates and glossary page addition for 'request' * update CLI docs (audit enable) * added metrics to 'all metrics' page * fallback example and link fix * improve links * updated based on feedback * some extra details on a request for glossary * format fix * use description on fallback device * test message properties * Sort out weird merge for events.mdx * Update website/content/docs/concepts/filtering/audit.mdx Co-authored-by: Violet Hynes <violet.hynes@hashicorp.com> * Update website/content/docs/concepts/filtering/audit.mdx Co-authored-by: Violet Hynes <violet.hynes@hashicorp.com> * Update website/content/docs/concepts/filtering/audit.mdx Co-authored-by: Violet Hynes <violet.hynes@hashicorp.com> * Update website/content/docs/concepts/filtering/audit.mdx Co-authored-by: Violet Hynes <violet.hynes@hashicorp.com> * Update website/content/docs/concepts/filtering/audit.mdx Co-authored-by: Violet Hynes <violet.hynes@hashicorp.com> * Intro paragraph about filtering/normal devices, and uppercase bullets * Fix casing on bullets and table layour * Uppercase bullets * Update website/content/docs/glossary.mdx Co-authored-by: Violet Hynes <violet.hynes@hashicorp.com> * Improvement? * PR feedback * Updated based on PR feedback * Include common options * Update website/content/docs/concepts/filtering/index.mdx Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * Update website/content/docs/concepts/filtering/index.mdx Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * Update website/content/docs/concepts/filtering/index.mdx Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * Update website/content/docs/concepts/filtering/index.mdx Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * Update website/content/docs/concepts/filtering/index.mdx Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * Update website/content/docs/concepts/filtering/index.mdx Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * Update website/content/docs/concepts/filtering/index.mdx Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * Update website/content/docs/concepts/filtering/index.mdx Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * Update website/content/docs/concepts/filtering/index.mdx Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * Update website/content/docs/concepts/filtering/index.mdx Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * Remove extra space * Update website/content/docs/concepts/filtering/index.mdx Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * Split out metrics * Update website/content/docs/concepts/filtering/index.mdx Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * Update website/content/docs/concepts/filtering/index.mdx Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * Update website/content/docs/concepts/filtering/index.mdx Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * Update website/content/docs/concepts/filtering/index.mdx Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * Update website/content/docs/concepts/filtering/index.mdx Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * Update website/content/docs/concepts/filtering/index.mdx Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * Update website/content/docs/concepts/filtering/index.mdx Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * Remove extra word * Updated table formatting, remove close code block etc. * Update website/content/docs/concepts/filtering/index.mdx Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> --------- Co-authored-by: Violet Hynes <violet.hynes@hashicorp.com> Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
48 lines
1.5 KiB
Plaintext
48 lines
1.5 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: audit enable - Command
|
|
description: The "audit enable" command enables an audit device at a given path.
|
|
---
|
|
|
|
# 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/":
|
|
|
|
```shell-session
|
|
$ 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
|
|
flags](/vault/docs/commands) included on all commands.
|
|
|
|
- `-description` `(string: "")` - Human-friendly description for the purpose of
|
|
this audit device.
|
|
|
|
- `-local` `(bool: false)` - Mark the audit device as a local-only device.
|
|
Local devices are not replicated or removed by replication.
|
|
|
|
- `-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.
|
|
|
|
All audit devices support the following common options which can be supplied after
|
|
the flags documented above:
|
|
|
|
@include 'audit-options-common.mdx'
|
|
|
|
For device specific options, refer to the relevant audit device type under the [Audit Devices](/vault/docs/audit)
|
|
overview.
|