Added basic WinRM config website docs
This commit is contained in:
parent
407f8dad1e
commit
189fd3246b
|
@ -150,6 +150,7 @@
|
|||
<li<%= sidebar_current("vagrantfile-tips") %>><a href="/v2/vagrantfile/tips.html">Tips & Tricks</a></li>
|
||||
<li<%= sidebar_current("vagrantfile-machine") %>><a href="/v2/vagrantfile/machine_settings.html" class="nocap">config.vm</a></li>
|
||||
<li<%= sidebar_current("vagrantfile-ssh") %>><a href="/v2/vagrantfile/ssh_settings.html" class="nocap">config.ssh</a></li>
|
||||
<li<%= sidebar_current("vagrantfile-winrm") %>><a href="/v2/vagrantfile/winrm_settings.html" class="nocap">config.winrm</a></li>
|
||||
<li<%= sidebar_current("vagrantfile-vagrant") %>><a href="/v2/vagrantfile/vagrant_settings.html" class="nocap">config.vagrant</a></li>
|
||||
</ul>
|
||||
<% end %>
|
||||
|
|
|
@ -0,0 +1,45 @@
|
|||
---
|
||||
page_title: "config.winrm - Vagrantfile"
|
||||
sidebar_current: "vagrantfile-winrm"
|
||||
---
|
||||
|
||||
# WinRM Settings
|
||||
|
||||
**Config namespace: `config.winrm`**
|
||||
|
||||
The settings within `config.winrm` relate to configuring how Vagrant
|
||||
will access your Windows guest over WinRM. As with most Vagrant settings, the
|
||||
defaults are typically fine, but you can fine tune whatever you'd like.
|
||||
|
||||
These settings are only used if you've set your communicator type to `:winrm`.
|
||||
|
||||
## Available Settings
|
||||
|
||||
`config.winrm.username` - This sets the username that Vagrant will use
|
||||
to login to the WinRM web service by default. Providers are free to override
|
||||
this if they detect a more appropriate user. By default this is "vagrant,"
|
||||
since that is what most public boxes are made as.
|
||||
|
||||
<hr>
|
||||
|
||||
`config.winrm.password` - This sets a password that Vagrant will use to
|
||||
authenticate the WinRM user. By default this is "vagrant," since that is
|
||||
what most public boxes are made as.
|
||||
|
||||
<hr>
|
||||
|
||||
`config.winrm.host` - The hostname or IP to SSH into. By default this is
|
||||
empty, because the provider usually figures this out for you.
|
||||
|
||||
<hr>
|
||||
|
||||
`config.winrm.port` - The port to SSH into. By default this is port 22.
|
||||
|
||||
<hr>
|
||||
|
||||
`config.winrm.guest_port` - The port on the guest that SSH is running on. This
|
||||
is used by some providers to detect forwarded ports for SSH. For example, if
|
||||
this is set to 22 (the default), and Vagrant detects a forwarded port to
|
||||
port 22 on the guest from port 4567 on the host, Vagrant will attempt
|
||||
to use port 4567 to talk to the guest if there is no other option.
|
||||
|
Loading…
Reference in New Issue