From 08c451c171a24f8db27d8d3b27ba31508ab5ab5f Mon Sep 17 00:00:00 2001 From: Zach Shilton <4624598+zchsh@users.noreply.github.com> Date: Fri, 22 Nov 2024 13:46:39 -0500 Subject: [PATCH] use plain markdown permalinks --- website/content/partials/cli/agent/args/file_path.mdx | 10 ++-------- website/content/partials/cli/agent/flags/config.mdx | 10 ++-------- website/content/partials/cli/agent/flags/exec.mdx | 8 +------- .../partials/cli/agent/flags/exit-after-auth.mdx | 10 ++-------- website/content/partials/cli/agent/flags/path.mdx | 8 +------- website/content/partials/cli/agent/flags/type.mdx | 10 ++-------- .../content/partials/cli/audit/args/device_path.mdx | 8 +------- .../content/partials/cli/audit/args/device_type.mdx | 10 ++-------- .../content/partials/cli/audit/args/file/file_path.mdx | 8 +------- website/content/partials/cli/audit/args/file/mode.mdx | 10 ++-------- .../content/partials/cli/audit/args/socket/address.mdx | 8 +------- .../partials/cli/audit/args/socket/socket_type.mdx | 8 +------- .../partials/cli/audit/args/socket/write_timeout.mdx | 8 +------- .../partials/cli/audit/args/syslog/facility.mdx | 8 +------- website/content/partials/cli/audit/args/syslog/tag.mdx | 8 +------- .../content/partials/cli/audit/flags/description.mdx | 8 +------- website/content/partials/cli/audit/flags/detailed.mdx | 10 ++-------- website/content/partials/cli/audit/flags/local.mdx | 8 +------- website/content/partials/cli/audit/flags/path.mdx | 8 +------- .../cli/audit/options/elide_list_responses.mdx | 8 +------- website/content/partials/cli/audit/options/exclude.mdx | 8 +------- .../content/partials/cli/audit/options/fallback.mdx | 8 +------- website/content/partials/cli/audit/options/filter.mdx | 8 +------- website/content/partials/cli/audit/options/format.mdx | 8 +------- .../partials/cli/audit/options/hmac_accessor.mdx | 8 +------- website/content/partials/cli/audit/options/log_raw.mdx | 8 +------- website/content/partials/cli/audit/options/prefix.mdx | 8 +------- website/content/partials/cli/shared/flags/log-file.mdx | 10 ++-------- .../partials/cli/shared/flags/log-rotate-bytes.mdx | 10 ++-------- .../partials/cli/shared/flags/log-rotate-duration.mdx | 8 +------- .../partials/cli/shared/flags/log-rotate-max-files.mdx | 8 +------- .../content/partials/global-settings/both/address.mdx | 8 +------- .../partials/global-settings/both/agent-address.mdx | 8 +------- .../content/partials/global-settings/both/ca-cert.mdx | 8 +------- .../content/partials/global-settings/both/ca-path.mdx | 8 +------- .../partials/global-settings/both/client-cert.mdx | 8 +------- .../partials/global-settings/both/client-key.mdx | 8 +------- .../global-settings/both/disable-redirects.mdx | 8 +------- .../content/partials/global-settings/both/format.mdx | 8 +------- .../partials/global-settings/both/log-format.mdx | 10 ++-------- .../partials/global-settings/both/log-level.mdx | 8 +------- website/content/partials/global-settings/both/mfa.mdx | 8 +------- .../partials/global-settings/both/namespace.mdx | 8 +------- .../partials/global-settings/both/tls-server-name.mdx | 8 +------- .../partials/global-settings/both/tls-skip-verify.mdx | 8 +------- .../content/partials/global-settings/both/wrap-ttl.mdx | 8 +------- .../partials/global-settings/env/cli_no_color.mdx | 8 +------- .../partials/global-settings/env/client_timeout.mdx | 8 +------- .../partials/global-settings/env/cluster_addr.mdx | 8 +------- .../partials/global-settings/env/http_proxy.mdx | 8 +------- .../content/partials/global-settings/env/license.mdx | 8 +------- .../partials/global-settings/env/license_path.mdx | 8 +------- .../partials/global-settings/env/max_retries.mdx | 8 +------- .../partials/global-settings/env/proxy_addr.mdx | 8 +------- .../partials/global-settings/env/rate_limit.mdx | 8 +------- .../partials/global-settings/env/redirect_addr.mdx | 8 +------- .../partials/global-settings/env/skip_verify.mdx | 10 ++-------- .../partials/global-settings/env/srv_lookup.mdx | 8 +------- website/content/partials/global-settings/env/token.mdx | 8 +------- .../content/partials/global-settings/flags/header.mdx | 8 +------- .../partials/global-settings/flags/non-interactive.mdx | 8 +------- .../global-settings/flags/output-curl-string.mdx | 8 +------- .../partials/global-settings/flags/output-policy.mdx | 8 +------- .../partials/global-settings/flags/policy-override.mdx | 8 +------- .../partials/global-settings/flags/unlock-key.mdx | 8 +------- 65 files changed, 76 insertions(+), 466 deletions(-) diff --git a/website/content/partials/cli/agent/args/file_path.mdx b/website/content/partials/cli/agent/args/file_path.mdx index bb0048aec7ea..2040d88430e8 100644 --- a/website/content/partials/cli/agent/args/file_path.mdx +++ b/website/content/partials/cli/agent/args/file_path.mdx @@ -1,11 +1,5 @@ - - - - -**`file_path (string : "./agent.hcl")`** - - +- `file_path (string : "./agent.hcl")` ((#agent-arg-file_path)) The path where Vault should save the generated configuration file. -**Example**: `"./agent/custom-config.hcl"` \ No newline at end of file +**Example**: `"./agent/custom-config.hcl"` diff --git a/website/content/partials/cli/agent/flags/config.mdx b/website/content/partials/cli/agent/flags/config.mdx index fee77d50aee3..c55cae4ea6b5 100644 --- a/website/content/partials/cli/agent/flags/config.mdx +++ b/website/content/partials/cli/agent/flags/config.mdx @@ -1,10 +1,4 @@ - - - - -**`-config (string : )`** - - +- `-config (string : )` ((#agent-flag-config)) Path to a single @@ -14,4 +8,4 @@ flag as needed to specify more than one discrete configuration file. If you specify more than one configuration file, Agent composes the source files into a single configuration file at runtime. -**Example**: `-config /path/to/file.hcl` \ No newline at end of file +**Example**: `-config /path/to/file.hcl` diff --git a/website/content/partials/cli/agent/flags/exec.mdx b/website/content/partials/cli/agent/flags/exec.mdx index b14c9d0a1618..9065130a6982 100644 --- a/website/content/partials/cli/agent/flags/exec.mdx +++ b/website/content/partials/cli/agent/flags/exec.mdx @@ -1,10 +1,4 @@ - - - - -**`-exec (string : "")`** - - +- `-exec (string : "")` ((#agent-flag-exec)) Path to the command for child processes with optional arguments. Relative paths start from the current working directory when executed. Corresponds to diff --git a/website/content/partials/cli/agent/flags/exit-after-auth.mdx b/website/content/partials/cli/agent/flags/exit-after-auth.mdx index c026ba5ec9a3..3cd691f6154c 100644 --- a/website/content/partials/cli/agent/flags/exit-after-auth.mdx +++ b/website/content/partials/cli/agent/flags/exit-after-auth.mdx @@ -1,12 +1,6 @@ - - - - -**`-exit-after-auth (bool : false)`** - - +- `-exit-after-auth (bool : false)` ((#agent-flag-exit-after-auth)) Exit with code `0` after a single successful auth. Success indicates successful token retrieval and write to sink. -**Example**: `-exit-after-auth` \ No newline at end of file +**Example**: `-exit-after-auth` diff --git a/website/content/partials/cli/agent/flags/path.mdx b/website/content/partials/cli/agent/flags/path.mdx index 051602f69c14..3c44ac788126 100644 --- a/website/content/partials/cli/agent/flags/path.mdx +++ b/website/content/partials/cli/agent/flags/path.mdx @@ -1,10 +1,4 @@ - - - - -**`-path (string : "")`** - - +- `-path (string : "")` ((#agent-flag-path)) Path to one or more `kv` secrets store. Paths that end with a wildcard (`*`) include all secrets under that path. diff --git a/website/content/partials/cli/agent/flags/type.mdx b/website/content/partials/cli/agent/flags/type.mdx index 8bc947549e21..dd98280c0357 100644 --- a/website/content/partials/cli/agent/flags/type.mdx +++ b/website/content/partials/cli/agent/flags/type.mdx @@ -1,10 +1,4 @@ - - - - -**`-type (enum : )`** - - +- `-type (enum : )` ((#agent-flag-type)) The configuration file entry to create. @@ -12,4 +6,4 @@ Enum | Description -------------- | ----------- `env-template` | Create environment variable templates from JSON keys in `kv` plugins -**Example**: `-type env-template` \ No newline at end of file +**Example**: `-type env-template` diff --git a/website/content/partials/cli/audit/args/device_path.mdx b/website/content/partials/cli/audit/args/device_path.mdx index ee0ebb70277a..5f1abfd2bdba 100644 --- a/website/content/partials/cli/audit/args/device_path.mdx +++ b/website/content/partials/cli/audit/args/device_path.mdx @@ -1,10 +1,4 @@ - - - - -**`device_path (string : )`** - - +- `device_path (string : )` ((#audit-arg-device_path)) The internal path where Vault accesses the audit device. Audit device paths are unique across all audit devices. diff --git a/website/content/partials/cli/audit/args/device_type.mdx b/website/content/partials/cli/audit/args/device_type.mdx index eabfab07f98b..ef3808f87b64 100644 --- a/website/content/partials/cli/audit/args/device_type.mdx +++ b/website/content/partials/cli/audit/args/device_type.mdx @@ -1,10 +1,4 @@ - - - - -**`audit-arg-device_type (enum : )`** - - +- `audit-arg-device_type (enum : )` ((#audit-arg-device_type)) The audit device type to create. @@ -12,4 +6,4 @@ Enum | Description -------- | ----------- `file` | Write log entries to a file on the Vault server. `socket` | Write log entries to an existing TCP, UDP, or UNIX socket. -`syslog` | Write log entries using the existing system logging protocol. \ No newline at end of file +`syslog` | Write log entries using the existing system logging protocol. diff --git a/website/content/partials/cli/audit/args/file/file_path.mdx b/website/content/partials/cli/audit/args/file/file_path.mdx index 4f3a3eac595a..391cfdfa0471 100644 --- a/website/content/partials/cli/audit/args/file/file_path.mdx +++ b/website/content/partials/cli/audit/args/file/file_path.mdx @@ -1,10 +1,4 @@ - - - - -**`file_path (string : )`** - - +- `file_path (string : )` ((#audit-arg-file-file_path)) Location on the audit log on the Vault server. Must be one of the following: diff --git a/website/content/partials/cli/audit/args/file/mode.mdx b/website/content/partials/cli/audit/args/file/mode.mdx index e416b915b5e7..7df9c650d0ff 100644 --- a/website/content/partials/cli/audit/args/file/mode.mdx +++ b/website/content/partials/cli/audit/args/file/mode.mdx @@ -1,13 +1,7 @@ - - - - -**`mode (string : "0600")`** - - +- `mode (string : "0600")` ((#audit-arg-file-mode)) The `chmod`-style octal permissions for the audit file. Set `mode` to "0000" to -prevent Vault from modifying the file mode. +prevent Vault from modifying the file mode. **Example**: `mode="0755"` diff --git a/website/content/partials/cli/audit/args/socket/address.mdx b/website/content/partials/cli/audit/args/socket/address.mdx index 38cd2cc80d5c..d2df30584ed1 100644 --- a/website/content/partials/cli/audit/args/socket/address.mdx +++ b/website/content/partials/cli/audit/args/socket/address.mdx @@ -1,10 +1,4 @@ - - - - -**`address (string : "")`** - - +- `address (string : "")` ((#audit-arg-socket-address)) Location of the socket as a server IP and port or a local path. diff --git a/website/content/partials/cli/audit/args/socket/socket_type.mdx b/website/content/partials/cli/audit/args/socket/socket_type.mdx index a564c6c0e420..622a2586f2ed 100644 --- a/website/content/partials/cli/audit/args/socket/socket_type.mdx +++ b/website/content/partials/cli/audit/args/socket/socket_type.mdx @@ -1,10 +1,4 @@ - - - - -**`socket_type (string : "tcp")`** - - +- `socket_type (string : "tcp")` ((#audit-arg-socket-socket_type)) Communication protocol expected by the socket. Vault can write to any [net.Dialer](https://pkg.go.dev/net#Dialer)-compatible socket. If a TCP socket diff --git a/website/content/partials/cli/audit/args/socket/write_timeout.mdx b/website/content/partials/cli/audit/args/socket/write_timeout.mdx index e5ea6950852b..c6b5fd4c8a31 100644 --- a/website/content/partials/cli/audit/args/socket/write_timeout.mdx +++ b/website/content/partials/cli/audit/args/socket/write_timeout.mdx @@ -1,10 +1,4 @@ - - - - -**`write_timeout (string : "2s")`** - - +- `write_timeout (string : "2s")` ((#audit-arg-socket-write_timeout)) Duration in seconds that Vault will wait for a write to complete over the socket. Setting `write_timeout` to `0` disables time outs and forces Vault to diff --git a/website/content/partials/cli/audit/args/syslog/facility.mdx b/website/content/partials/cli/audit/args/syslog/facility.mdx index 9de92fb008ff..b540210b405c 100644 --- a/website/content/partials/cli/audit/args/syslog/facility.mdx +++ b/website/content/partials/cli/audit/args/syslog/facility.mdx @@ -1,10 +1,4 @@ - - - - -**`facility (string : "AUTH")`** - - +- `facility (string : "AUTH")` ((#audit-arg-syslog-facility)) The process that generated the syslog entry (the syslog facility). diff --git a/website/content/partials/cli/audit/args/syslog/tag.mdx b/website/content/partials/cli/audit/args/syslog/tag.mdx index 7f1bd2e666f4..1f376f7bbfba 100644 --- a/website/content/partials/cli/audit/args/syslog/tag.mdx +++ b/website/content/partials/cli/audit/args/syslog/tag.mdx @@ -1,10 +1,4 @@ - - - - -**`tag (string : "vault")`** - - +- `tag (string : "vault")` ((#audit-arg-syslog-tag)) The program that generated the syslog entry. diff --git a/website/content/partials/cli/audit/flags/description.mdx b/website/content/partials/cli/audit/flags/description.mdx index dad60a6a20a1..c71ab32b38c9 100644 --- a/website/content/partials/cli/audit/flags/description.mdx +++ b/website/content/partials/cli/audit/flags/description.mdx @@ -1,10 +1,4 @@ - - - - -**`-description (string : "")`** - - +- `-description (string : "")` ((#audit-flag-description)) A human-friendly string that explains the purpose of the audit device. diff --git a/website/content/partials/cli/audit/flags/detailed.mdx b/website/content/partials/cli/audit/flags/detailed.mdx index 27a3db3de683..5b1a8c6f1697 100644 --- a/website/content/partials/cli/audit/flags/detailed.mdx +++ b/website/content/partials/cli/audit/flags/detailed.mdx @@ -1,12 +1,6 @@ - - - - -**`-detailed (bool : false)`** - - +- `-detailed (bool : false)` ((#audit-flag-detailed)) Print detailed information such as options and replication status about each audit device. -**Example**: `-detailed` \ No newline at end of file +**Example**: `-detailed` diff --git a/website/content/partials/cli/audit/flags/local.mdx b/website/content/partials/cli/audit/flags/local.mdx index f9667ac3f39e..352c377ea16c 100644 --- a/website/content/partials/cli/audit/flags/local.mdx +++ b/website/content/partials/cli/audit/flags/local.mdx @@ -1,10 +1,4 @@ - - - - -**`-local (bool : false)`** - - +- `-local (bool : false)` ((#audit-flag-local)) Indicates that the audit device is local to the Vault server and ignored by replication. diff --git a/website/content/partials/cli/audit/flags/path.mdx b/website/content/partials/cli/audit/flags/path.mdx index 4af182cd8996..fa8181daff64 100644 --- a/website/content/partials/cli/audit/flags/path.mdx +++ b/website/content/partials/cli/audit/flags/path.mdx @@ -1,10 +1,4 @@ - - - - -**`-path (string : "/")`** - - +- `-path (string : "/")` ((#audit-flag-path)) The internal path where Vault will access the audit device. Audit device paths must be unique across all audit devices. diff --git a/website/content/partials/cli/audit/options/elide_list_responses.mdx b/website/content/partials/cli/audit/options/elide_list_responses.mdx index 382e36a98c40..1c99326c262c 100644 --- a/website/content/partials/cli/audit/options/elide_list_responses.mdx +++ b/website/content/partials/cli/audit/options/elide_list_responses.mdx @@ -1,10 +1,4 @@ - - - - -**`elide_list_responses (bool : false)`** - - +- `elide_list_responses (bool : false)` ((#audit-option-elide_list_responses)) Replace the details for `response.data.keys` and `response.data.key_info` with the number of entries to reduce the size of audit records. See diff --git a/website/content/partials/cli/audit/options/exclude.mdx b/website/content/partials/cli/audit/options/exclude.mdx index 3ac7861a0070..4298c1f24c1f 100644 --- a/website/content/partials/cli/audit/options/exclude.mdx +++ b/website/content/partials/cli/audit/options/exclude.mdx @@ -1,10 +1,4 @@ - - - - -**`exclude (string : "")`** - - +- `exclude (string : "")` ((#audit-option-exclude)) Remove any fields matching the provided diff --git a/website/content/partials/cli/audit/options/fallback.mdx b/website/content/partials/cli/audit/options/fallback.mdx index d00c6699ffe9..e0498377d19a 100644 --- a/website/content/partials/cli/audit/options/fallback.mdx +++ b/website/content/partials/cli/audit/options/fallback.mdx @@ -1,10 +1,4 @@ - - - - -**`fallback (bool : false)`** - - +- `fallback (bool : false)` ((#audit-option-fallback)) The audit device is the fallback for filtering purposes. **Vault only supports one fallback audit device at a time**. diff --git a/website/content/partials/cli/audit/options/filter.mdx b/website/content/partials/cli/audit/options/filter.mdx index 42c2bc6a2d5d..4bd3c42f22c0 100644 --- a/website/content/partials/cli/audit/options/filter.mdx +++ b/website/content/partials/cli/audit/options/filter.mdx @@ -1,10 +1,4 @@ - - - - -**`filter (string : "")`** - - +- `filter (string : "")` ((#audit-option-filter)) Only write audit log entries matching the provided [filtering expression](/vault/docs/enterprise/audit/filtering) to the audit diff --git a/website/content/partials/cli/audit/options/format.mdx b/website/content/partials/cli/audit/options/format.mdx index 3dfac1137c3f..dc2fd1576cf4 100644 --- a/website/content/partials/cli/audit/options/format.mdx +++ b/website/content/partials/cli/audit/options/format.mdx @@ -1,10 +1,4 @@ - - - - -**`format (enum : json)`** - - +- `format (enum : json)` ((#audit-option-format)) Write audit log entries in the provided format. diff --git a/website/content/partials/cli/audit/options/hmac_accessor.mdx b/website/content/partials/cli/audit/options/hmac_accessor.mdx index 79f4968bd599..f9db35d3aea5 100644 --- a/website/content/partials/cli/audit/options/hmac_accessor.mdx +++ b/website/content/partials/cli/audit/options/hmac_accessor.mdx @@ -1,10 +1,4 @@ - - - - -**`hmac_accessor (bool : true)`** - - +- `hmac_accessor (bool : true)` ((#audit-option-hmac_accessor)) Hash all token accessor data before writing to the audit device. diff --git a/website/content/partials/cli/audit/options/log_raw.mdx b/website/content/partials/cli/audit/options/log_raw.mdx index d4a2eb3cd8d4..4127c6d9e3d5 100644 --- a/website/content/partials/cli/audit/options/log_raw.mdx +++ b/website/content/partials/cli/audit/options/log_raw.mdx @@ -1,10 +1,4 @@ - - - - -**`log_raw (bool : false)`** - - +- `log_raw (bool : false)` ((#audit-option-log_raw)) Hash all sensitive security information before writing to the audit device. diff --git a/website/content/partials/cli/audit/options/prefix.mdx b/website/content/partials/cli/audit/options/prefix.mdx index b4b2c2f08edf..9c6f18839b47 100644 --- a/website/content/partials/cli/audit/options/prefix.mdx +++ b/website/content/partials/cli/audit/options/prefix.mdx @@ -1,10 +1,4 @@ - - - - -**`prefix (string : "")`** - - +- `prefix (string : "")` ((#audit-option-prefix)) Prepend the provided string to each log entry when writing to the audit device. diff --git a/website/content/partials/cli/shared/flags/log-file.mdx b/website/content/partials/cli/shared/flags/log-file.mdx index cddc393b5ee5..07b5cda686bd 100644 --- a/website/content/partials/cli/shared/flags/log-file.mdx +++ b/website/content/partials/cli/shared/flags/log-file.mdx @@ -1,10 +1,4 @@ - - - - -**`-log-file (string : "./.log")`** - - +- `-log-file (string : "./.log")` ((#shared-flag-log-file)) Absolute path where Vault Agent saves logging data. @@ -13,4 +7,4 @@ Absolute path where Vault Agent saves logging data. - Paths ending with a name but not an extension use the `.log` extension. - Paths ending with a name and extension use the provided file name. -**Example**: `-log-file "/var/log/vault-logs/"` \ No newline at end of file +**Example**: `-log-file "/var/log/vault-logs/"` diff --git a/website/content/partials/cli/shared/flags/log-rotate-bytes.mdx b/website/content/partials/cli/shared/flags/log-rotate-bytes.mdx index bc476e701706..a73aaf7c7115 100644 --- a/website/content/partials/cli/shared/flags/log-rotate-bytes.mdx +++ b/website/content/partials/cli/shared/flags/log-rotate-bytes.mdx @@ -1,12 +1,6 @@ - - - - -**`-log-rotate-bytes (int : )`** - - +- `-log-rotate-bytes (int : )` ((#shared-flag-log-rotate-bytes)) File size, in bytes, after which log files must rotate. Leave `log-rotate-bytes` unset if you prefer not to limit log file size. -**Example**: `-log-rotate-bytes 1000000` \ No newline at end of file +**Example**: `-log-rotate-bytes 1000000` diff --git a/website/content/partials/cli/shared/flags/log-rotate-duration.mdx b/website/content/partials/cli/shared/flags/log-rotate-duration.mdx index f153382a9b2d..df5efa841d10 100644 --- a/website/content/partials/cli/shared/flags/log-rotate-duration.mdx +++ b/website/content/partials/cli/shared/flags/log-rotate-duration.mdx @@ -1,10 +1,4 @@ - - - - -**`-log-rotate-duration (string : "24h")`** - - +- `-log-rotate-duration (string : "24h")` ((#shared-flag-log-rotate-duration)) Amount of time, in `[s|m|h|d]` format, after which log files must rotate. diff --git a/website/content/partials/cli/shared/flags/log-rotate-max-files.mdx b/website/content/partials/cli/shared/flags/log-rotate-max-files.mdx index ad80b5d08606..34f3e32dc1cf 100644 --- a/website/content/partials/cli/shared/flags/log-rotate-max-files.mdx +++ b/website/content/partials/cli/shared/flags/log-rotate-max-files.mdx @@ -1,10 +1,4 @@ - - - - -**`-log-rotate-max-files (int : 0)`** - - +- `-log-rotate-max-files (int : 0)` ((#shared-flag-log-rotate-max-files)) The number of log file archives to preserve over time: diff --git a/website/content/partials/global-settings/both/address.mdx b/website/content/partials/global-settings/both/address.mdx index c59ca02ca87e..9827678ac2d2 100644 --- a/website/content/partials/global-settings/both/address.mdx +++ b/website/content/partials/global-settings/both/address.mdx @@ -1,10 +1,4 @@ - - - - -**`[-address | VAULT_ADDR] (string : 'https://127.0.0.1:8200')`** - - +- `[-address | VAULT_ADDR] (string : 'https://127.0.0.1:8200')` ((#global-address)) Address of the Vault server. diff --git a/website/content/partials/global-settings/both/agent-address.mdx b/website/content/partials/global-settings/both/agent-address.mdx index 23b4d108f4dc..8ac4ca3b8a06 100644 --- a/website/content/partials/global-settings/both/agent-address.mdx +++ b/website/content/partials/global-settings/both/agent-address.mdx @@ -1,10 +1,4 @@ - - - - -**`[-agent-address | VAULT_AGENT_ADDR] (string : "")`** - - +- `[-agent-address | VAULT_AGENT_ADDR] (string : "")` ((#global-agent-address)) Address of the Vault Agent, if used. diff --git a/website/content/partials/global-settings/both/ca-cert.mdx b/website/content/partials/global-settings/both/ca-cert.mdx index 1448c7fdc513..2b754ee43b09 100644 --- a/website/content/partials/global-settings/both/ca-cert.mdx +++ b/website/content/partials/global-settings/both/ca-cert.mdx @@ -1,10 +1,4 @@ - - - - -**`[-ca-cert | VAULT_CACERT] (string : "")`** - - +- `[-ca-cert | VAULT_CACERT] (string : "")` ((#global-ca-cert)) Path to a PEM-encoded CA certificate file on the local disk. Used to verify SSL certificates for the server. **Takes precedence over `-ca_path`**. diff --git a/website/content/partials/global-settings/both/ca-path.mdx b/website/content/partials/global-settings/both/ca-path.mdx index 43d41cb77d12..57d166edaa01 100644 --- a/website/content/partials/global-settings/both/ca-path.mdx +++ b/website/content/partials/global-settings/both/ca-path.mdx @@ -1,10 +1,4 @@ - - - - -**`[-ca-path | VAULT_CAPATH] (string : "")`** - - +- `[-ca-path | VAULT_CAPATH] (string : "")` ((#global-ca-path)) Path to a directory with PEM-encoded CA certificate files on the local disk. Used to verify SSL certificates for the server. diff --git a/website/content/partials/global-settings/both/client-cert.mdx b/website/content/partials/global-settings/both/client-cert.mdx index fa7c0b3ec5c1..7435eab349a3 100644 --- a/website/content/partials/global-settings/both/client-cert.mdx +++ b/website/content/partials/global-settings/both/client-cert.mdx @@ -1,10 +1,4 @@ - - - - -**`[-client-cert | VAULT_CLIENT_CERT] (string : "")`** - - +- `[-client-cert | VAULT_CLIENT_CERT] (string : "")` ((#global-client-cert)) Path to a PEM-encoded CA certificate file on the local disk. Used for TLS communication with the server. **The specified certificate must match to the diff --git a/website/content/partials/global-settings/both/client-key.mdx b/website/content/partials/global-settings/both/client-key.mdx index 16bde7074b2c..b2940afd07c2 100644 --- a/website/content/partials/global-settings/both/client-key.mdx +++ b/website/content/partials/global-settings/both/client-key.mdx @@ -1,10 +1,4 @@ - - - - -**`[-client-key | VAULT_CLIENT_KEY] (string : "")`** - - +- `[-client-key | VAULT_CLIENT_KEY] (string : "")` ((#global-client-key)) Path to a PEM-encoded private key that matches the client certificate set with `-client-cert`. diff --git a/website/content/partials/global-settings/both/disable-redirects.mdx b/website/content/partials/global-settings/both/disable-redirects.mdx index 9eb2676be020..6a3739ef840c 100644 --- a/website/content/partials/global-settings/both/disable-redirects.mdx +++ b/website/content/partials/global-settings/both/disable-redirects.mdx @@ -1,10 +1,4 @@ - - - - -**`[-disable-redirects | VAULT_DISABLE_REDIRECTS] (bool : false)`** - - +- `[-disable-redirects | VAULT_DISABLE_REDIRECTS] (bool : false)` ((#global-disable-redirects)) Disable the default CLI redirect behavior so the CLI honors the first redirect response from the underlying API instead of following the full HTTP redirect diff --git a/website/content/partials/global-settings/both/format.mdx b/website/content/partials/global-settings/both/format.mdx index ad3e5a245b87..d37213dca49e 100644 --- a/website/content/partials/global-settings/both/format.mdx +++ b/website/content/partials/global-settings/both/format.mdx @@ -1,10 +1,4 @@ - - - - -**`[-format | VAULT_FORMAT] (enum: table)`** - - +- `[-format | VAULT_FORMAT] (enum: table)` ((#global-format)) Set the CLI output format. diff --git a/website/content/partials/global-settings/both/log-format.mdx b/website/content/partials/global-settings/both/log-format.mdx index de3564b7ca0d..0cc0c7888569 100644 --- a/website/content/partials/global-settings/both/log-format.mdx +++ b/website/content/partials/global-settings/both/log-format.mdx @@ -1,10 +1,4 @@ - - - - -**`[-log-format | VAULT_LOG_FORMAT] (enum : standard)`** - - +- `[-log-format | VAULT_LOG_FORMAT] (enum : standard)` ((#global-log-format)) Format of log data: @@ -14,4 +8,4 @@ Format of log data: **Examples**: - CLI flag: `-log-format json` -- Environment variable: `export VAULT_LOG_FORMAT=json` \ No newline at end of file +- Environment variable: `export VAULT_LOG_FORMAT=json` diff --git a/website/content/partials/global-settings/both/log-level.mdx b/website/content/partials/global-settings/both/log-level.mdx index 206e149d8247..a6221d710fda 100644 --- a/website/content/partials/global-settings/both/log-level.mdx +++ b/website/content/partials/global-settings/both/log-level.mdx @@ -1,10 +1,4 @@ - - - - -**`[-log-level | VAULT_LOG_LEVEL] (enum : info)`** - - +- `[-log-level | VAULT_LOG_LEVEL] (enum : info)` ((#global-vault_log-level)) Default logging level for the Vault server. diff --git a/website/content/partials/global-settings/both/mfa.mdx b/website/content/partials/global-settings/both/mfa.mdx index 1bd495e1d644..0500797f8d09 100644 --- a/website/content/partials/global-settings/both/mfa.mdx +++ b/website/content/partials/global-settings/both/mfa.mdx @@ -1,10 +1,4 @@ - - - - -**`[-mfa | VAULT_MFA] (string : "")`** - - +- `[-mfa | VAULT_MFA] (string : "")` ((#global-mfa)) A multi-factor authentication (MFA) credential, in the format `mfa_method_name[:key[=value]]`, that the CLI should use to authenticate to diff --git a/website/content/partials/global-settings/both/namespace.mdx b/website/content/partials/global-settings/both/namespace.mdx index dcf81d6eac0e..89f3c122c81c 100644 --- a/website/content/partials/global-settings/both/namespace.mdx +++ b/website/content/partials/global-settings/both/namespace.mdx @@ -1,10 +1,4 @@ - - - - -**`[-namespace | -ns | VAULT_NAMESPACE] (string : )`** - - +- `[-namespace | -ns | VAULT_NAMESPACE] (string : )` ((#global-namespace)) Root namespace for the CLI command. Setting a default namespace allow relative mount paths. diff --git a/website/content/partials/global-settings/both/tls-server-name.mdx b/website/content/partials/global-settings/both/tls-server-name.mdx index 68f6c49bea00..8646968cde37 100644 --- a/website/content/partials/global-settings/both/tls-server-name.mdx +++ b/website/content/partials/global-settings/both/tls-server-name.mdx @@ -1,10 +1,4 @@ - - - - -**`[-tls-server-name | VAULT_TLS_SERVER_NAME] (string : "")`** - - +- `[-tls-server-name | VAULT_TLS_SERVER_NAME] (string : "")` ((#global-tls-server-name)) Name of the SNI host for TLS handshake resolution for TLS connections to Vault. diff --git a/website/content/partials/global-settings/both/tls-skip-verify.mdx b/website/content/partials/global-settings/both/tls-skip-verify.mdx index 884849a5745e..fb9782831e3d 100644 --- a/website/content/partials/global-settings/both/tls-skip-verify.mdx +++ b/website/content/partials/global-settings/both/tls-skip-verify.mdx @@ -1,10 +1,4 @@ - - - - -**`[-tls-skip-verify | VAULT_SKIP_VERIFY] (bool : false)`** - - +- `[-tls-skip-verify | VAULT_SKIP_VERIFY] (bool : false)` ((#global-tls-skip-verify)) Disable verification for all TLS certificates. **Use with caution**. Disabling TLS certificate verification decreases the security of data transmissions to and diff --git a/website/content/partials/global-settings/both/wrap-ttl.mdx b/website/content/partials/global-settings/both/wrap-ttl.mdx index 878fb8a288f7..cfc5d27baf9d 100644 --- a/website/content/partials/global-settings/both/wrap-ttl.mdx +++ b/website/content/partials/global-settings/both/wrap-ttl.mdx @@ -1,10 +1,4 @@ - - - - -**`[-wrap-ttl | VAULT_WRAP_TTL] (string : "")`** - - +- `[-wrap-ttl | VAULT_WRAP_TTL] (string : "")` ((#global-wrap-ttl)) Default time-to-live in `[s|m|h|d]` format for the Cubbyhole token used to wrap CLI responses. You must use `vault unwrap` to view response data before diff --git a/website/content/partials/global-settings/env/cli_no_color.mdx b/website/content/partials/global-settings/env/cli_no_color.mdx index ea1535049049..4fd725c371cd 100644 --- a/website/content/partials/global-settings/env/cli_no_color.mdx +++ b/website/content/partials/global-settings/env/cli_no_color.mdx @@ -1,10 +1,4 @@ - - - - -**`VAULT_CLI_NO_COLOR (bool : true)`** - - +- `VAULT_CLI_NO_COLOR (bool : true)` ((#global-cli_no_color)) Exclude ANSI color escape sequence characters from the CLI output. diff --git a/website/content/partials/global-settings/env/client_timeout.mdx b/website/content/partials/global-settings/env/client_timeout.mdx index 29533482aba0..bef1b5e2a03d 100644 --- a/website/content/partials/global-settings/env/client_timeout.mdx +++ b/website/content/partials/global-settings/env/client_timeout.mdx @@ -1,10 +1,4 @@ - - - - -**`VAULT_CLIENT_TIMEOUT (string : "60s")`** - - +- `VAULT_CLIENT_TIMEOUT (string : "60s")` ((#standard-vault_client_timeout)) Amount of time, in `[s|m|h|d]` format, the CLI should wait on a response from Vault. diff --git a/website/content/partials/global-settings/env/cluster_addr.mdx b/website/content/partials/global-settings/env/cluster_addr.mdx index fea888813f1b..7f1d356ea9d5 100644 --- a/website/content/partials/global-settings/env/cluster_addr.mdx +++ b/website/content/partials/global-settings/env/cluster_addr.mdx @@ -1,10 +1,4 @@ - - - - -**`VAULT_CLUSTER_ADDR (string : "")`** - - +- `VAULT_CLUSTER_ADDR (string : "")` ((#global-vault_cluster_addr)) Address of the local Vault node. Vault uses cluster addresses for cluster-to-cluster communication when running in high-availability mode. diff --git a/website/content/partials/global-settings/env/http_proxy.mdx b/website/content/partials/global-settings/env/http_proxy.mdx index 2d7f0d0ebb86..ae313c06ab28 100644 --- a/website/content/partials/global-settings/env/http_proxy.mdx +++ b/website/content/partials/global-settings/env/http_proxy.mdx @@ -1,10 +1,4 @@ - - - - -**`VAULT_HTTP_PROXY (string : "")`** - - +- `VAULT_HTTP_PROXY (string : "")` ((#global-vault_http_proxy)) Legacy alias for `VAULT_PROXY_ADDR`. diff --git a/website/content/partials/global-settings/env/license.mdx b/website/content/partials/global-settings/env/license.mdx index 704e0a3ca971..81dd46a12e3e 100644 --- a/website/content/partials/global-settings/env/license.mdx +++ b/website/content/partials/global-settings/env/license.mdx @@ -1,10 +1,4 @@ - - - - -**`VAULT_LICENSE (string : "")`** - - +- `VAULT_LICENSE (string : "")` ((#global-vault_license)) Vault Enterprise license string for the local server or node. `VAULT_LICENSE` takes precedence over `VAULT_LICENSE_PATH` **and** the `license_path` parameter diff --git a/website/content/partials/global-settings/env/license_path.mdx b/website/content/partials/global-settings/env/license_path.mdx index cd84d53f7d77..99094ec61ec1 100644 --- a/website/content/partials/global-settings/env/license_path.mdx +++ b/website/content/partials/global-settings/env/license_path.mdx @@ -1,10 +1,4 @@ - - - - -**`VAULT_LICENSE_PATH (string : "")`** - - +- `VAULT_LICENSE_PATH (string : "")` ((#global-vault_license_path)) Local path to a file containing a valid Vault Enterprise license for the server or node. `VAULT_LICENSE_PATH` takes precedence over the `license_path` parameter diff --git a/website/content/partials/global-settings/env/max_retries.mdx b/website/content/partials/global-settings/env/max_retries.mdx index 5a48277d22a0..dfae44fbad53 100644 --- a/website/content/partials/global-settings/env/max_retries.mdx +++ b/website/content/partials/global-settings/env/max_retries.mdx @@ -1,10 +1,4 @@ - - - - -**`VAULT_MAX_RETRIES (integer : 2)`** - - +- `VAULT_MAX_RETRIES (integer : 2)` ((#global-vault_max_retries)) The number of times the CLI should retry a request to the Vault server when the CLI receives one of the following recoverable error codes: diff --git a/website/content/partials/global-settings/env/proxy_addr.mdx b/website/content/partials/global-settings/env/proxy_addr.mdx index 060ffa321d94..d67e59d07447 100644 --- a/website/content/partials/global-settings/env/proxy_addr.mdx +++ b/website/content/partials/global-settings/env/proxy_addr.mdx @@ -1,10 +1,4 @@ - - - - -**`VAULT_PROXY_ADDR (string : "")`** - - +- `VAULT_PROXY_ADDR (string : "")` ((#global-vault_proxy_addr)) The HTTPS or HTTP address, including server and port, where clients can access Vault. Setting `VAULT_HTTP_PROXY` overrides the default proxy resolution diff --git a/website/content/partials/global-settings/env/rate_limit.mdx b/website/content/partials/global-settings/env/rate_limit.mdx index 25b8d60ffc07..4271f6a46e98 100644 --- a/website/content/partials/global-settings/env/rate_limit.mdx +++ b/website/content/partials/global-settings/env/rate_limit.mdx @@ -1,10 +1,4 @@ - - - - -**`VAULT_RATE_LIMIT (string : unset)`** - - +- `VAULT_RATE_LIMIT (string : unset)` ((#global-vault_rate_limit)) The number of operations per second, in `rate[:burst]` format, used to throttle requests between the CLI and the server. The `burst` value is optional and diff --git a/website/content/partials/global-settings/env/redirect_addr.mdx b/website/content/partials/global-settings/env/redirect_addr.mdx index 02b14449f6fb..7bb8bff43e09 100644 --- a/website/content/partials/global-settings/env/redirect_addr.mdx +++ b/website/content/partials/global-settings/env/redirect_addr.mdx @@ -1,10 +1,4 @@ - - - - -**`VAULT_REDIRECT_ADDR (string : "")`** - - +- `VAULT_REDIRECT_ADDR (string : "")` ((#global-vault_redirect_addr)) Local node address that listens for redirected client communication when Vault runs in high-availability mode. diff --git a/website/content/partials/global-settings/env/skip_verify.mdx b/website/content/partials/global-settings/env/skip_verify.mdx index 61075467deab..62d7dc6ef2cf 100644 --- a/website/content/partials/global-settings/env/skip_verify.mdx +++ b/website/content/partials/global-settings/env/skip_verify.mdx @@ -1,10 +1,4 @@ - - - - -**`VAULT_SKIP_VERIFY (bool : false)`** - - +- `VAULT_SKIP_VERIFY (bool : false)` ((#global-vault_skip_verify)) Allow communication between the CLI and Vault server before verifying the authentication certificate presented by Vault. @@ -14,7 +8,7 @@ authentication certificate presented by Vault. Do not use `VAULT_SKIP_VERIFY` in production. Skipping certificate - verification violates the Vault security model and voids any associated + verification violates the Vault security model and voids any associated security guarantees. diff --git a/website/content/partials/global-settings/env/srv_lookup.mdx b/website/content/partials/global-settings/env/srv_lookup.mdx index c16ee16b0bb2..18d23b4813af 100644 --- a/website/content/partials/global-settings/env/srv_lookup.mdx +++ b/website/content/partials/global-settings/env/srv_lookup.mdx @@ -1,10 +1,4 @@ - - - - -**`VAULT_SRV_LOOKUP (bool : false)`** - - +- `VAULT_SRV_LOOKUP (bool : false)` ((#global-vault_srv_lookup)) Use SRV records instead of standard DNS to look up hostnames as described in the Network Working Group draft diff --git a/website/content/partials/global-settings/env/token.mdx b/website/content/partials/global-settings/env/token.mdx index 56eb99eda3a4..79b8995bcc3e 100644 --- a/website/content/partials/global-settings/env/token.mdx +++ b/website/content/partials/global-settings/env/token.mdx @@ -1,10 +1,4 @@ - - - - -**`VAULT_TOKEN (string : "")`** - - +- `VAULT_TOKEN (string : "")` ((#global-vault_token)) A Vault-issued service token that authenticates the CLI user to Vault. See the [tokens concepts page](/vault/docs/concepts/tokens) for more information diff --git a/website/content/partials/global-settings/flags/header.mdx b/website/content/partials/global-settings/flags/header.mdx index c7c04454d036..53d7b87528a2 100644 --- a/website/content/partials/global-settings/flags/header.mdx +++ b/website/content/partials/global-settings/flags/header.mdx @@ -1,10 +1,4 @@ - - - - -**`-header (string : "")`** - - +- `-header (string : "")` ((#global-header)) Optional HTTP header in the form `"="` for the CLI request. Repeat the `-header` flag as needed with one string per flag. User-defined headers diff --git a/website/content/partials/global-settings/flags/non-interactive.mdx b/website/content/partials/global-settings/flags/non-interactive.mdx index fe6d1e0c3ac5..5ff01ff59101 100644 --- a/website/content/partials/global-settings/flags/non-interactive.mdx +++ b/website/content/partials/global-settings/flags/non-interactive.mdx @@ -1,10 +1,4 @@ - - - - -**`-non-interactive (bool : false)`** - - +- `-non-interactive (bool : false)` ((#global-non-interactive)) Prevent the CLI from asking users for input through the terminal. diff --git a/website/content/partials/global-settings/flags/output-curl-string.mdx b/website/content/partials/global-settings/flags/output-curl-string.mdx index e7e15184b85b..692fe3a89e47 100644 --- a/website/content/partials/global-settings/flags/output-curl-string.mdx +++ b/website/content/partials/global-settings/flags/output-curl-string.mdx @@ -1,10 +1,4 @@ - - - - -**`-output-curl-string (bool : false)`** - - +- `-output-curl-string (bool : false)` ((#global-output-curl-string)) Print the API call(s) required to execute the CLI command as `cURL` strings then exit without running the command. diff --git a/website/content/partials/global-settings/flags/output-policy.mdx b/website/content/partials/global-settings/flags/output-policy.mdx index 749240600e9b..171f6bb7957c 100644 --- a/website/content/partials/global-settings/flags/output-policy.mdx +++ b/website/content/partials/global-settings/flags/output-policy.mdx @@ -1,10 +1,4 @@ - - - - -**`-output-policy (bool : false)`** - - +- `-output-policy (bool : false)` ((#global-output-policy)) Print the Vault policy required to execute the CLI command as HCL then exit without running the command. diff --git a/website/content/partials/global-settings/flags/policy-override.mdx b/website/content/partials/global-settings/flags/policy-override.mdx index 340c12d93c7c..23caa939c6f1 100644 --- a/website/content/partials/global-settings/flags/policy-override.mdx +++ b/website/content/partials/global-settings/flags/policy-override.mdx @@ -1,10 +1,4 @@ - - - - -**`-policy-override (bool : false)`** - - +- `-policy-override (bool : false)` ((#global-policy-override)) Overrides any Sentinel policy where `enforcement_level` is "soft-mandatory". diff --git a/website/content/partials/global-settings/flags/unlock-key.mdx b/website/content/partials/global-settings/flags/unlock-key.mdx index 097b18a6f243..bb6dec5e06ce 100644 --- a/website/content/partials/global-settings/flags/unlock-key.mdx +++ b/website/content/partials/global-settings/flags/unlock-key.mdx @@ -1,10 +1,4 @@ - - - - -**`-unlock-key (string : )`** - - +- `-unlock-key (string : )` ((#global-unlock-key)) Plaintext key that unlocks the underlying API endpoint for a given namespace.