tpm enroll
Enterprise
Appropriate Vault Enterprise license required
Register a TPM in the Vault identity store.
$ vault tpm enroll [flags]
$ vault tpm enroll [-help | -h]
Description
vault tpm enroll registers the endorsement key (EK) public key of a TPM in the
Vault identity store and returns the TPM ID. By default, the command reads the
EK public key from the local TPM. To enroll a TPM on another host, use -ekpem
to provide its EK public key.
The command returns the TPM ID in the id field. To authorize the TPM, add the
ID to the tpm_ids parameter when you
create a TPM auth method role.
Command arguments
None.
Command options
None.
Command flags
-ekpem (string : "")
PEM-encoded endorsement key (EK) public key to enroll instead of the key that Vault reads from the local TPM. Use this flag to enroll a TPM on another host.
Example: -ekpem="$(cat ek-public.pem)"
-metadata (key=value : <none>)
Metadata to store with the TPM record, as a key=value pair. Repeat the flag to
add more than one pair.
Example: -metadata location=datacenter-east
-name (string : "")
Name of the TPM record in the identity store. If you omit this flag, Vault generates a name. If a record with this name already exists, Vault updates it instead of creating a new one.
Example: -name my-tpm
-tpm-device-path (string : "")
Path to the TPM device or to a Unix socket, such as /dev/tpmrm0 or
/dev/tpm0. Vault auto-detects the device when you omit this flag.
Example: -tpm-device-path /dev/tpmrm0
Standard flags
[-address | VAULT_ADDR] (string : 'https://127.0.0.1:8200')
Address of the Vault server.
Examples:
- CLI flag:
-address "https://mydomain/vault:8200" - Environment variable:
export VAULT_ADDR="https://mydomain/vault:8200"
[-agent-address | VAULT_AGENT_ADDR] (string : "")
Address of the Vault Agent, if used.
Examples:
- CLI flag:
-agent-address "https://mydomain/vault-agent:8200" - Environment variable:
export VAULT_AGENT_ADDR="https://mydomain/vault-agent:8200"
[-ca-cert | VAULT_CACERT] (string : "")
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.
Examples:
- CLI flag:
-ca-cert "/path/to/certs/mycert.pem" - Environment variable:
export VAULT_CACERT="/path/to/certs/mycert.pem"
[-ca-path | VAULT_CAPATH] (string : "")
Path to a directory with PEM-encoded CA certificate files on the local disk. Used to verify SSL certificates for the server.
Examples:
- CLI flag:
-ca-path "/path/to/certs/dir" - Environment variable:
export VAULT_CAPATH="/path/to/certs/dir"
[-client-cert | VAULT_CLIENT_CERT] (string : "")
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
private key specified with -client-key.
Examples:
- CLI flag:
-client-cert "/path/to/certs/mycert.pem" - Environment variable:
export VAULT_CLIENT_CERT="/path/to/certs/mycert.pem"
[-client-key | VAULT_CLIENT_KEY] (string : "")
Path to a PEM-encoded private key that matches the client certificate set with
-client-cert.
Examples:
- CLI flag:
-client-key "/path/to/keys/myprivatekey.pem" - Environment variable:
export VAULT_CLIENT_KEY="/path/to/keys/myprivatekey.pem"
[-disable-redirects | VAULT_DISABLE_REDIRECTS] (bool : false)
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 chain.
Examples:
- CLI flag:
-disable-redirects - Environment variable:
export VAULT_DISABLE_REDIRECTS=1
[-format | VAULT_FORMAT] (enum: table)
Set the CLI output format.
| Value | Description |
|---|---|
table | Structure the response as a table |
json | Structure the response as JSON data |
yaml | Structure the response as YAML data |
jsonx | Structure information as XML data |
Examples:
- CLI flag:
-format json - Environment variable:
export VAULT_FORMAT=json
-header (string : "")
Optional HTTP header in the form "<key>=<value>" for the CLI request. Repeat
the -header flag as needed with one string per flag. User-defined headers
cannot start with X-Vault-
Example: -header "Cache-Control=max-age=0"
[-mfa | VAULT_MFA] (string : "")
A multi-factor authentication (MFA) credential, in the format
mfa_method_id:passcode, that the CLI should use to authenticate to
Vault. The CLI adds MFA credentials to the X-Vault-MFA header when calling the
underlying API endpoint.
Examples:
- CLI flag:
-mfa "d16fd3c2-50de-0b9b-eed3-0301dadeca10:695452" - Environment variable:
export VAULT_MFA="d16fd3c2-50de-0b9b-eed3-0301dadeca10:695452"
[-namespace | -ns | VAULT_NAMESPACE] (string : <unset>)
Root namespace for the CLI command. Setting a default namespace allow relative mount paths.
Examples:
- CLI flag:
-namespace "admin" - Environment variable:
export VAULT_NAMESPACE="admin"
-non-interactive (bool : false)
Prevent the CLI from asking users for input through the terminal.
Example: -non-interactive
-output-curl-string (bool : false)
Print the API call(s) required to execute the CLI command as cURL strings
then exit without running the command.
Example: -output-curl-string
-output-policy (bool : false)
Print the Vault policy required to execute the CLI command as HCL then exit without running the command.
Example: -output-policy
-policy-override (bool : false)
Overrides any Sentinel policy where enforcement_level is "soft-mandatory".
Example: -policy-override
[-tls-server-name | VAULT_TLS_SERVER_NAME] (string : "")
Name of the SNI host for TLS handshake resolution for TLS connections to Vault.
Examples:
- CLI flag:
-tls-server-name "hostname.domain" - Environment variable:
export VAULT_TLS_SERVER_NAME="hostname.domain"
[-tls-skip-verify | VAULT_SKIP_VERIFY] (bool : false)
Disable verification for all TLS certificates. Use with caution. Disabling TLS certificate verification decreases the security of data transmissions to and from the Vault server.
Examples:
- CLI flag:
-tls-skip-verify - Environment variable:
export VAULT_SKIP_VERIFY=1
-unlock-key (string : <unset>)
Plaintext key that unlocks the underlying API endpoint for a given namespace.
Example: -unlock-key "7oXtdlmvRQ"
[-wrap-ttl | VAULT_WRAP_TTL] (string : "")
Default time-to-live in <number>[s|m|h|d] format for the Cubbyhole token used
to wrap CLI responses. You must use vault unwrap to view response data before
the duration expires. Leave wrap_ttl unset to leave CLI responses unwrapped.
Examples:
- CLI flag:
-wrap-ttl "5m" - Environment variable:
export VAULT_WRAP_TTL="5m"
Examples
Enroll the local TPM and name the record my-tpm:
$ vault tpm enroll -name=my-tpm -tpm-device-path=/dev/tpm0
Enroll the local TPM with metadata:
$ vault tpm enroll -name=my-tpm -metadata=location=datacenter-east
Print only the TPM ID:
$ vault tpm enroll -field=id -name=my-tpm -tpm-device-path=/dev/tpmrm0