vault ssh <username@ip>

Establishes an SSH connection with the target machine

Arguments

NameDescription
username@ipSsh username and destination

Options

NameDescription
--help, -hDisplay help
-address <string>Address of the Vault server. The default is https://127.0.0.1:8200. This can also be specified via the VAULT_ADDR environment variable
-agent-address <string>Address of the Agent. This can also be specified via the VAULT_AGENT_ADDR environment variable
-ca-cert <string>Path on the local disk to a single PEM-encoded CA certificate to verify the Vault server's SSL certificate. This takes precedence over -ca-path. This can also be specified via the VAULT_CACERT environment variable
-ca-path <string>Path on the local disk to a directory of PEM-encoded CA certificates to verify the Vault server's SSL certificate. This can also be specified via the VAULT_CAPATH environment variable
-client-cert <string>Path on the local disk to a single PEM-encoded CA certificate to use for TLS authentication to the Vault server. If this flag is specified, -client-key is also required. This can also be specified via the VAULT_CLIENT_CERT environment variable
-client-key <string>Path on the local disk to a single PEM-encoded private key matching the client certificate from -client-cert. This can also be specified via the VAULT_CLIENT_KEY environment variable
-header-key <string>Key-value pair provided as key=value to provide http header added to any request done by the CLI.Trying to add headers starting with 'X-Vault-' is forbidden and will make the command fail This can be specified multiple times
-mfa <string>Supply MFA credentials as part of X-Vault-MFA header. This can also be specified via the VAULT_MFA environment variable
-namespace <string>The namespace to use for the command. Setting this is not necessary but allows using relative paths. -ns can be used as shortcut. The default is (not set). This can also be specified via the VAULT_NAMESPACE environment variable
-non-interactive <string>When set true, prevents asking the user for input via the terminal. The default is false
-output-curl-string <string>Instead of executing the request, print an equivalent cURL command string and exit. The default is false
-policy-override <string>Override a Sentinel policy that has a soft-mandatory enforcement_level specified The default is false
-tls-server-name <string>Name to use as the SNI host when connecting to the Vault server via TLS. This can also be specified via the VAULT_TLS_SERVER_NAME environment variable
-tls-skip-verify <string>Disable verification of TLS certificates. Using this option is highly discouraged as it decreases the security of data transmissions to and from the Vault server. The default is false. This can also be specified via the VAULT_SKIP_VERIFY environment variable
-unlock-key <string>Key to unlock a namespace API lock. The default is (not set)
-wrap-ttl <string>Wraps the response in a cubbyhole token with the requested TTL. The response is available via the 'vault unwrap' command. The TTL is specified as a numeric string with suffix like '30s' or '5m'. This can also be specified via the VAULT_WRAP_TTL environment variable
-field <string>Print only the field with the given name. Specifying this option will take precedence over other formatting directives. The result will not have a trailing newline making it ideal for piping to other processes
-format <string>Print the output in the given format. Valid formats are 'table', 'json', 'yaml', or 'pretty'. The default is table. This can also be specified via the VAULT_FORMAT environment variable
-mode <string>Name of the authentication mode (ca, dynamic, otp)
-mount-point <string>Mount point to the SSH secrets engine. The default is ssh/
-no-execPrint the generated credentials, but do not establish a connection. The default is false
-role <string>Name of the role to use to generate the key
-strict-host-key-checking <string>Value to use for the SSH configuration option 'StrictHostKeyChecking'. The default is ask. This can also be specified via the VAULT_SSH_STRICT_HOST_KEY_CHECKING environment variable
-user-known-hosts-file <string>Value to use for the SSH configuration option 'UserKnownHostsFile'. This can also be specified via the VAULT_SSH_USER_KNOWN_HOSTS_FILE environment variable
-host-key-hostnames <string>List of hostnames to delegate for the CA. The default value allows all domains and IPs. This is specified as a comma-separated list of values. The default is *. This can also be specified via the VAULT_SSH_HOST_KEY_HOSTNAMES environment variable
-host-key-mount-point <string>Mount point to the SSH secrets engine where host keys are signed. When given a value, Vault will generate a custom 'known_hosts' file with delegation to the CA at the provided mount point to verify the SSH connection's host keys against the provided CA. By default, host keys are validated against the user's local 'known_hosts' file. This flag forces strict key host checking and ignores a custom user known hosts file. This can also be specified via the VAULT_SSH_HOST_KEY_MOUNT_POINT environment variable
-private-key-path <string>Path to the SSH private key to use for authentication. This must be the corresponding private key to -public-key-path. The default is ~/.ssh/id_rsa
-public-key-path <string>Path to the SSH public key to send to Vault for signing. The default is ~/.ssh/id_rsa.pub
-ssh-executable <string>Path to the SSH executable to use when connecting to the host The default is ssh. This can also be specified via the VAULT_SSH_EXECUTABLE environment variable
-valid-principals <string>List of valid principal names to include in the generated user certificate. This is specified as a comma-separated list of values