2020-03-18 18:46:47 -04:00
|
|
|
<!-- Code generated from the comments of the SSH struct in helper/communicator/config.go; DO NOT EDIT MANUALLY -->
|
|
|
|
|
|
2020-04-02 11:57:46 -04:00
|
|
|
- `ssh_host` (string) - The address to SSH to. This usually is automatically configured by the
|
|
|
|
|
builder.
|
|
|
|
|
|
|
|
|
|
- `ssh_port` (int) - The port to connect to SSH. This defaults to `22`.
|
|
|
|
|
|
|
|
|
|
- `ssh_username` (string) - The username to connect to SSH with. Required if using SSH.
|
|
|
|
|
|
|
|
|
|
- `ssh_password` (string) - A plaintext password to use to authenticate with SSH.
|
|
|
|
|
|
2020-06-17 19:46:29 -04:00
|
|
|
- `ssh_ciphers` ([]string) - This overrides the value of ciphers supported by default by golang.
|
|
|
|
|
The default value is [
|
|
|
|
|
"aes128-gcm@openssh.com",
|
|
|
|
|
"chacha20-poly1305@openssh.com",
|
|
|
|
|
"aes128-ctr", "aes192-ctr", "aes256-ctr",
|
|
|
|
|
]
|
|
|
|
|
|
|
|
|
|
Valid options for ciphers include:
|
|
|
|
|
"aes128-ctr", "aes192-ctr", "aes256-ctr", "aes128-gcm@openssh.com",
|
|
|
|
|
"chacha20-poly1305@openssh.com",
|
|
|
|
|
"arcfour256", "arcfour128", "arcfour", "aes128-cbc", "3des-cbc",
|
|
|
|
|
|
2020-04-02 11:57:46 -04:00
|
|
|
- `ssh_clear_authorized_keys` (bool) - If true, Packer will attempt to remove its temporary key from
|
|
|
|
|
`~/.ssh/authorized_keys` and `/root/.ssh/authorized_keys`. This is a
|
|
|
|
|
mostly cosmetic option, since Packer will delete the temporary private
|
|
|
|
|
key from the host system regardless of whether this is set to true
|
|
|
|
|
(unless the user has set the `-debug` flag). Defaults to "false";
|
|
|
|
|
currently only works on guests with `sed` installed.
|
|
|
|
|
|
|
|
|
|
- `ssh_pty` (bool) - If `true`, a PTY will be requested for the SSH connection. This defaults
|
|
|
|
|
to `false`.
|
|
|
|
|
|
|
|
|
|
- `ssh_timeout` (duration string | ex: "1h5m2s") - The time to wait for SSH to become available. Packer uses this to
|
|
|
|
|
determine when the machine has booted so this is usually quite long.
|
|
|
|
|
Example value: `10m`.
|
|
|
|
|
|
|
|
|
|
- `ssh_disable_agent_forwarding` (bool) - If true, SSH agent forwarding will be disabled. Defaults to `false`.
|
|
|
|
|
|
|
|
|
|
- `ssh_handshake_attempts` (int) - The number of handshakes to attempt with SSH once it can connect. This
|
|
|
|
|
defaults to `10`.
|
|
|
|
|
|
|
|
|
|
- `ssh_bastion_host` (string) - A bastion host to use for the actual SSH connection.
|
|
|
|
|
|
|
|
|
|
- `ssh_bastion_port` (int) - The port of the bastion host. Defaults to `22`.
|
|
|
|
|
|
|
|
|
|
- `ssh_bastion_agent_auth` (bool) - If `true`, the local SSH agent will be used to authenticate with the
|
|
|
|
|
bastion host. Defaults to `false`.
|
|
|
|
|
|
|
|
|
|
- `ssh_bastion_username` (string) - The username to connect to the bastion host.
|
|
|
|
|
|
|
|
|
|
- `ssh_bastion_password` (string) - The password to use to authenticate with the bastion host.
|
|
|
|
|
|
|
|
|
|
- `ssh_bastion_interactive` (bool) - If `true`, the keyboard-interactive used to authenticate with bastion host.
|
|
|
|
|
|
|
|
|
|
- `ssh_bastion_private_key_file` (string) - Path to a PEM encoded private key file to use to authenticate with the
|
|
|
|
|
bastion host. The `~` can be used in path and will be expanded to the
|
|
|
|
|
home directory of current user.
|
|
|
|
|
|
|
|
|
|
- `ssh_file_transfer_method` (string) - `scp` or `sftp` - How to transfer files, Secure copy (default) or SSH
|
|
|
|
|
File Transfer Protocol.
|
|
|
|
|
|
|
|
|
|
- `ssh_proxy_host` (string) - A SOCKS proxy host to use for SSH connection
|
|
|
|
|
|
|
|
|
|
- `ssh_proxy_port` (int) - A port of the SOCKS proxy. Defaults to `1080`.
|
|
|
|
|
|
|
|
|
|
- `ssh_proxy_username` (string) - The optional username to authenticate with the proxy server.
|
|
|
|
|
|
|
|
|
|
- `ssh_proxy_password` (string) - The optional password to use to authenticate with the proxy server.
|
|
|
|
|
|
|
|
|
|
- `ssh_keep_alive_interval` (duration string | ex: "1h5m2s") - How often to send "keep alive" messages to the server. Set to a negative
|
|
|
|
|
value (`-1s`) to disable. Example value: `10s`. Defaults to `5s`.
|
|
|
|
|
|
|
|
|
|
- `ssh_read_write_timeout` (duration string | ex: "1h5m2s") - The amount of time to wait for a remote command to end. This might be
|
|
|
|
|
useful if, for example, packer hangs on a connection after a reboot.
|
|
|
|
|
Example: `5m`. Disabled by default.
|
|
|
|
|
|
|
|
|
|
- `ssh_remote_tunnels` ([]string) -
|
2020-07-01 08:32:26 -04:00
|
|
|
- `ssh_local_tunnels` ([]string) -
|
