From 1a2b34165aa57b259cf4979fe92758ad6969b001 Mon Sep 17 00:00:00 2001 From: Lucas Bajolet Date: Mon, 3 Jun 2024 10:36:53 -0400 Subject: [PATCH] communicator: fix reference to ssh_method in docs 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. --- .../packer-plugin-sdk/communicator/SSH-not-required.mdx | 2 +- communicator/config.go | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/cmd/packer-sdc/internal/renderdocs/docs-partials/packer-plugin-sdk/communicator/SSH-not-required.mdx b/cmd/packer-sdc/internal/renderdocs/docs-partials/packer-plugin-sdk/communicator/SSH-not-required.mdx index 99706b6ae..e053caf73 100644 --- a/cmd/packer-sdc/internal/renderdocs/docs-partials/packer-plugin-sdk/communicator/SSH-not-required.mdx +++ b/cmd/packer-sdc/internal/renderdocs/docs-partials/packer-plugin-sdk/communicator/SSH-not-required.mdx @@ -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 diff --git a/communicator/config.go b/communicator/config.go index 16b3eb498..fb3132721 100644 --- a/communicator/config.go +++ b/communicator/config.go @@ -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"`