github.com/hashicorp/packer@v1.14.3/website/content/partials/packer-plugin-sdk/communicator/SSH-not-required.mdx (about)

     1  <!-- Code generated from the comments of the SSH struct in communicator/config.go; DO NOT EDIT MANUALLY -->
     2  
     3  - `ssh_host` (string) - The address to SSH to. This usually is automatically configured by the
     4    builder.
     5  
     6  - `ssh_port` (int) - The port to connect to SSH. This defaults to `22`.
     7  
     8  - `ssh_username` (string) - The username to connect to SSH with. Required if using SSH.
     9  
    10  - `ssh_password` (string) - A plaintext password to use to authenticate with SSH.
    11  
    12  - `ssh_ciphers` ([]string) - This overrides the value of ciphers supported by default by Golang.
    13    The default value is [
    14      "aes128-gcm@openssh.com",
    15      "chacha20-poly1305@openssh.com",
    16      "aes128-ctr", "aes192-ctr", "aes256-ctr",
    17    ]
    18    
    19    Valid options for ciphers include:
    20    "aes128-ctr", "aes192-ctr", "aes256-ctr", "aes128-gcm@openssh.com",
    21    "chacha20-poly1305@openssh.com",
    22    "arcfour256", "arcfour128", "arcfour", "aes128-cbc", "3des-cbc",
    23  
    24  - `ssh_clear_authorized_keys` (bool) - If true, Packer will attempt to remove its temporary key from
    25    `~/.ssh/authorized_keys` and `/root/.ssh/authorized_keys`. This is a
    26    mostly cosmetic option, since Packer will delete the temporary private
    27    key from the host system regardless of whether this is set to true
    28    (unless the user has set the `-debug` flag). Defaults to "false";
    29    currently only works on guests with `sed` installed.
    30  
    31  - `ssh_key_exchange_algorithms` ([]string) - If set, Packer will override the value of key exchange (kex) algorithms
    32    supported by default by Golang. Acceptable values include:
    33    "curve25519-sha256@libssh.org", "ecdh-sha2-nistp256",
    34    "ecdh-sha2-nistp384", "ecdh-sha2-nistp521",
    35    "diffie-hellman-group14-sha1", and "diffie-hellman-group1-sha1".
    36  
    37  - `ssh_certificate_file` (string) - Path to user certificate used to authenticate with SSH.
    38    The `~` can be used in path and will be expanded to the
    39    home directory of current user.
    40  
    41  - `ssh_pty` (bool) - If `true`, a PTY will be requested for the SSH connection. This defaults
    42    to `false`.
    43  
    44  - `ssh_timeout` (duration string | ex: "1h5m2s") - The time to wait for SSH to become available. Packer uses this to
    45    determine when the machine has booted so this is usually quite long.
    46    Example value: `10m`.
    47    This defaults to `5m`, unless `ssh_handshake_attempts` is set.
    48  
    49  - `ssh_disable_agent_forwarding` (bool) - If true, SSH agent forwarding will be disabled. Defaults to `false`.
    50  
    51  - `ssh_handshake_attempts` (int) - The number of handshakes to attempt with SSH once it can connect.
    52    This defaults to `10`, unless a `ssh_timeout` is set.
    53  
    54  - `ssh_bastion_host` (string) - A bastion host to use for the actual SSH connection.
    55  
    56  - `ssh_bastion_port` (int) - The port of the bastion host. Defaults to `22`.
    57  
    58  - `ssh_bastion_agent_auth` (bool) - If `true`, the local SSH agent will be used to authenticate with the
    59    bastion host. Defaults to `false`.
    60  
    61  - `ssh_bastion_username` (string) - The username to connect to the bastion host.
    62  
    63  - `ssh_bastion_password` (string) - The password to use to authenticate with the bastion host.
    64  
    65  - `ssh_bastion_interactive` (bool) - If `true`, the keyboard-interactive used to authenticate with bastion host.
    66  
    67  - `ssh_bastion_private_key_file` (string) - Path to a PEM encoded private key file to use to authenticate with the
    68    bastion host. The `~` can be used in path and will be expanded to the
    69    home directory of current user.
    70  
    71  - `ssh_bastion_certificate_file` (string) - Path to user certificate used to authenticate with bastion host.
    72    The `~` can be used in path and will be expanded to the
    73    home directory of current user.
    74  
    75  - `ssh_file_transfer_method` (string) - `scp` or `sftp` - How to transfer files, Secure copy (default) or SSH
    76    File Transfer Protocol.
    77    
    78    **NOTE**: Guests using Windows with Win32-OpenSSH v9.1.0.0p1-Beta, scp
    79    (the default protocol for copying data) returns a non-zero error code since the MOTW
    80    cannot be set, which cause any file transfer to fail. As a workaround you can override the transfer protocol
    81    with SFTP instead `ssh_file_transfer_method = "sftp"`.
    82  
    83  - `ssh_proxy_host` (string) - A SOCKS proxy host to use for SSH connection
    84  
    85  - `ssh_proxy_port` (int) - A port of the SOCKS proxy. Defaults to `1080`.
    86  
    87  - `ssh_proxy_username` (string) - The optional username to authenticate with the proxy server.
    88  
    89  - `ssh_proxy_password` (string) - The optional password to use to authenticate with the proxy server.
    90  
    91  - `ssh_keep_alive_interval` (duration string | ex: "1h5m2s") - How often to send "keep alive" messages to the server. Set to a negative
    92    value (`-1s`) to disable. Example value: `10s`. Defaults to `5s`.
    93  
    94  - `ssh_read_write_timeout` (duration string | ex: "1h5m2s") - The amount of time to wait for a remote command to end. This might be
    95    useful if, for example, packer hangs on a connection after a reboot.
    96    Example: `5m`. Disabled by default.
    97  
    98  - `ssh_remote_tunnels` ([]string) - Remote tunnels forward a port from your local machine to the instance.
    99  	Format: ["REMOTE_PORT:LOCAL_HOST:LOCAL_PORT"]
   100  	Example: "9090:localhost:80" forwards localhost:9090 on your machine to port 80 on the instance. 
   101  
   102  - `ssh_local_tunnels` ([]string) - Local tunnels forward a port from the instance to your local machine.
   103  	Format: ["LOCAL_PORT:REMOTE_HOST:REMOTE_PORT"]
   104  	Example: "8080:localhost:3000" allows the instance to access your local machine’s port 3000 via localhost:8080.
   105  
   106  <!-- End of code generated from the comments of the SSH struct in communicator/config.go; -->