path: root/devdocs/vagrant/vagrantfile%2Fwinssh_settings.html

<h1 id="winssh">  WinSSH </h1> <p>The WinSSH communicator is built specifically for the Windows native port of OpenSSH. It does not rely on a POSIX-like environment which removes the requirement of extra software installation (like cygwin) for proper functionality.</p> <p>For more information, see the <a href="https://github.com/PowerShell/Win32-OpenSSH/">Win32-OpenSSH project page</a>.</p> <h1 id="winssh-settings">  WinSSH Settings </h1> <p>The WinSSH communicator uses the same connection configuration options as the SSH communicator. These settings provide the information for the communicator to establish a connection to the VM.</p> <p>The configuration options below are specific to the WinSSH communicator.</p> <p><strong>Config namespace: <code>config.winssh</code></strong></p> <h2 id="available-settings">  Available Settings </h2> <ul> <li>
<p><a href="#config-winssh-forward_agent"><code>config.winssh.forward_agent</code></a> (boolean) - If <code>true</code>, agent forwarding over SSH connections is enabled. Defaults to false.</p> </li> <li>
<p><a href="#config-winssh-forward_env"><code>config.winssh.forward_env</code></a> (array of strings) - An array of host environment variables to forward to the guest. If you are familiar with OpenSSH, this corresponds to the <code>SendEnv</code> parameter.</p> <div class="highlight"><pre class="highlight ruby" data-language="ruby">config.winssh.forward_env = ["CUSTOM_VAR"]
</pre></div>
</li> <li>
<p><a href="#config-winssh-proxy_command"><code>config.winssh.proxy_command</code></a> (string) - A command-line command to execute that receives the data to send to SSH on stdin. This can be used to proxy the SSH connection. <code>%h</code> in the command is replaced with the host and <code>%p</code> is replaced with the port.</p> </li> <li>
<p><a href="#config-winssh-keep_alive"><code>config.winssh.keep_alive</code></a> (boolean) - If <code>true</code>, this setting SSH will send keep-alive packets every 5 seconds by default to keep connections alive.</p> </li> <li>
<p><a href="#config-winssh-shell"><code>config.winssh.shell</code></a> (string) - The shell to use when executing SSH commands from Vagrant. By default this is <code>cmd</code>. Valid values are <code>"cmd"</code> or <code>"powershell"</code>. Note that this has no effect on the shell you get when you run <code>vagrant ssh</code>. This configuration option only affects the shell to use when executing commands internally in Vagrant.</p> </li> <li>
<p><a href="#config-winssh-export_command_template"><code>config.winssh.export_command_template</code></a> (string) - The template used to generate exported environment variables in the active session. This can be useful when using a Bourne incompatible shell like C shell. The template supports two variables which are replaced with the desired environment variable key and environment variable value: <code>%ENV_KEY%</code> and <code>%ENV_VALUE%</code>. The default template for a <code>cmd</code> configured shell is:</p> <div class="highlight"><pre class="highlight ruby" data-language="ruby">config.winssh.export_command_template = 'set %ENV_KEY%="%ENV_VALUE%"'
</pre></div>
<p>The default template for a <code>powershell</code> configured shell is:</p> <div class="highlight"><pre class="highlight ruby" data-language="ruby">config.winssh.export_command_template = '$env:%ENV_KEY%="%ENV_VALUE%"'
</pre></div>
</li> <li>
<p><a href="#config-winssh-sudo_command"><code>config.winssh.sudo_command</code></a> (string) - The command to use when executing a command with <code>sudo</code>. This defaults to <code>%c</code> (assumes vagrant user is an administrator and needs no escalation). The <code>%c</code> will be replaced by the command that is being executed.</p> </li> <li>
<p><a href="#config-winssh-upload_directory"><code>config.winssh.upload_directory</code></a> (string) - The upload directory used on the guest to store scripts for execute. This is set to <code>C:\Windows\Temp</code> by default.</p> </li> </ul><div class="_attribution">
  <p class="_attribution-p">
    &copy; 2010&ndash;2018 Mitchell Hashimoto<br>Licensed under the MPL 2.0 License.<br>
    <a href="https://www.vagrantup.com/docs/vagrantfile/winssh_settings.html" class="_attribution-link">https://www.vagrantup.com/docs/vagrantfile/winssh_settings.html</a>
  </p>
</div>