| Parameter |
Choices/Defaults |
Comments |
|
authtype
-
|
Choices:
- token
- userpass
- github
- ldap
- approle
Default:
"token or environment variable `VAULT_AUTHTYPE`"
|
authentication type
|
|
aws_header
-
|
Default:
"to environment variable `VAULT_AWS_HEADER`"
|
X-Vault-AWS-IAM-Server-ID Header value to prevent replay attacks.
|
|
backend
-
|
|
type of secret backend
|
|
ca_cert
-
|
Default:
"to environment variable `VAULT_CACERT`"
|
Path to a PEM-encoded CA cert file to use to verify the Vault server TLS certificate
|
|
ca_path
-
|
Default:
"to environment variable `VAULT_CAPATH`"
|
Path to a directory of PEM-encoded CA cert files to verify the Vault server TLS certificate. If ca_cert is specified, its value will take precedence
|
|
cas_required
-
|
|
Check and set required for secret engine for kv version 2 only
|
|
client_cert
-
|
Default:
"to environment variable `VAULT_CLIENT_CERT`"
|
Path to a PEM-encoded client certificate for TLS authentication to the Vault server
|
|
client_key
-
|
Default:
"to environment variable `VAULT_CLIENT_KEY`"
|
Path to an unencrypted PEM-encoded private key matching the client certificate
|
|
config
-
|
Default:
{"default_lease_ttl": 2764800, "force_no_cache": false, "max_lease_ttl": 2764800}
|
config of secret backend
|
|
description
-
|
|
description of secret backend
|
|
login_mount_point
-
|
Default:
"value of authtype or environment varialbe `VAULT_LOGIN_MOUNT_POINT`"
|
authentication mount point
|
|
max_versions
-
|
|
Max versions for secret engine for kv version 2 only
|
|
name
-
|
|
name of secret backend
|
|
namespace
-
|
Default:
"to environment variable VAULT_NAMESPACE"
|
namespace for vault
|
|
options
-
|
|
Specifies mount type specific options that are passed to the backend. NOT included unless backend == kv
|
|
password
-
|
Default:
"to environment variable `VAULT_PASSWORD`"
|
password to login to vault.
|
|
state
-
|
|
{'state of secret backend. choices': 'enabled, present, disabled, absent'}
|
|
token
-
|
Default:
"to environment variable `VAULT_TOKEN`"
|
token for vault
|
|
url
-
|
Default:
"to environment variable `VAULT_ADDR`"
|
url for vault
|
|
username
-
|
Default:
"to environment variable `VAULT_USER`"
|
username to login to vault.
|
|
verify
-
|
Default:
"to environment variable `VAULT_SKIP_VERIFY`"
|
If set, do not verify presented TLS certificate before communicating with Vault server. Setting this variable is not recommended except during testing
|
