Skip to content

Commit

Permalink
communicator: fix reference to ssh_method in docs
Browse files Browse the repository at this point in the history
As pointed out in a Packer PR, the option's name does not match its real
name for the ssh file transfer method.

This commit fixes that mismatch.
  • Loading branch information
lbajolet-hashicorp committed Jun 3, 2024
1 parent b2dd4bc commit 69f501f
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@
**NOTE**: Guests using Windows with Win32-OpenSSH v9.1.0.0p1-Beta, scp
(the default protocol for copying data) returns a a non-zero error code since the MOTW
cannot be set, which cause any file transfer to fail. As a workaround you can override the transfer protocol
with SFTP instead `ssh_file_transfer_protocol = "sftp"`.
with SFTP instead `ssh_file_transfer_method = "sftp"`.

- `ssh_proxy_host` (string) - A SOCKS proxy host to use for SSH connection

Expand Down
2 changes: 1 addition & 1 deletion communicator/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ type SSH struct {
// **NOTE**: Guests using Windows with Win32-OpenSSH v9.1.0.0p1-Beta, scp
// (the default protocol for copying data) returns a a non-zero error code since the MOTW
// cannot be set, which cause any file transfer to fail. As a workaround you can override the transfer protocol
// with SFTP instead `ssh_file_transfer_protocol = "sftp"`.
// with SFTP instead `ssh_file_transfer_method = "sftp"`.
SSHFileTransferMethod string `mapstructure:"ssh_file_transfer_method"`
// A SOCKS proxy host to use for SSH connection
SSHProxyHost string `mapstructure:"ssh_proxy_host"`
Expand Down

0 comments on commit 69f501f

Please sign in to comment.