mirror of
https://github.com/hashicorp/vault.git
synced 2025-08-15 19:17:02 +02:00
676d1c69fe
* added note to warn of potential issues in disabling audit when using HMAC * added to command docs pages too
61 lines
1.4 KiB
Plaintext
61 lines
1.4 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: audit - Command
|
|
description: |-
|
|
The "audit" command groups subcommands for interacting with Vault's audit
|
|
devices. Users can list, enable, and disable audit devices.
|
|
---
|
|
|
|
# audit
|
|
|
|
The `audit` command groups subcommands for interacting with Vault's audit
|
|
devices. Users can list, enable, and disable audit devices.
|
|
|
|
For more information, please see the [audit device
|
|
documentation](/vault/docs/audit)
|
|
|
|
## Examples
|
|
|
|
Enable an audit device:
|
|
|
|
```shell-session
|
|
$ vault audit enable file file_path=/tmp/my-file.txt
|
|
Success! Enabled the file audit device at: file/
|
|
```
|
|
|
|
List all audit devices:
|
|
|
|
```shell-session
|
|
$ vault audit list
|
|
Path Type Description
|
|
---- ---- -----------
|
|
file/ file n/a
|
|
```
|
|
|
|
Disable an audit device:
|
|
|
|
```shell-session
|
|
$ vault audit disable file/
|
|
Success! Disabled audit device (if it was enabled) at: file/
|
|
```
|
|
|
|
~> Note: Once an audit device is disabled, you will no longer be able to HMAC values
|
|
for comparison with entries in the audit logs. This is true even if you re-enable
|
|
the audit device at the same path, as a new salt will be created for hashing.
|
|
|
|
## Usage
|
|
|
|
```text
|
|
Usage: vault audit <subcommand> [options] [args]
|
|
|
|
# ...
|
|
|
|
Subcommands:
|
|
disable Disables an audit device
|
|
enable Enables an audit device
|
|
list Lists enabled audit devices
|
|
```
|
|
|
|
For more information, examples, and usage about a subcommand, click on the name
|
|
of the subcommand in the sidebar.
|