From b4e13bf1ce60fa5307b0d99f56ba8974702f4055 Mon Sep 17 00:00:00 2001 From: sophia Date: Wed, 22 Apr 2020 10:28:22 -0400 Subject: [PATCH] Update winrm config docs --- plugins/communicators/winrm/config.rb | 2 +- .../docs/vagrantfile/winrm_settings.html.md | 18 +++++++++++------- 2 files changed, 12 insertions(+), 8 deletions(-) diff --git a/plugins/communicators/winrm/config.rb b/plugins/communicators/winrm/config.rb index d8c6ffd6a..723b8dc86 100644 --- a/plugins/communicators/winrm/config.rb +++ b/plugins/communicators/winrm/config.rb @@ -56,7 +56,7 @@ module VagrantPlugins errors << "winrm.port cannot be nil." if @port.nil? errors << "winrm.guest_port cannot be nil." if @guest_port.nil? errors << "winrm.max_tries cannot be nil." if @max_tries.nil? - errors << "winrm.retry_delay cannot be nil." if @max_tries.nil? + errors << "winrm.retry_delay cannot be nil." if @retry_delay.nil? errors << "winrm.timeout cannot be nil." if @timeout.nil? errors << "winrm.execution_time_limit cannot be nil." if @execution_time_limit.nil? unless @ssl_peer_verification == true || @ssl_peer_verification == false diff --git a/website/source/docs/vagrantfile/winrm_settings.html.md b/website/source/docs/vagrantfile/winrm_settings.html.md index 644f7277b..2edb281f6 100644 --- a/website/source/docs/vagrantfile/winrm_settings.html.md +++ b/website/source/docs/vagrantfile/winrm_settings.html.md @@ -33,7 +33,8 @@ what most public boxes are made as. By default this is empty, because the provider usually figures this out for you. -* `config.winrm.port` (integer) - The WinRM port to connect to, by default 5985. +* `config.winrm.port` (integer) - The WinRM port to connect to, by default 5985. If ssl +is enabled, the default port is 5986. * `config.winrm.guest_port` (integer) - The port on the guest that WinRM is running on. This is used by some providers to detect forwarded ports for WinRM. For @@ -51,22 +52,25 @@ the Windows machine must be configured appropriately. **Note:** It is strongly recommended that you only use basic authentication for debugging purposes. Credentials will be transferred in plain text. +* `config.winrm.execution_time_limit` (string) - The amount of time that is allowed to +complete task. This defaults to "PT2H", that is 2 hours. + * `config.winrm.ssl_peer_verification` (boolean) - When set to `false` ssl certificate -validation is not performed. +validation is not performed. By default this is true. * `config.winrm.timeout` (integer) - The maximum amount of time to wait for a response -from the endpoint. This defaults to 60 seconds. Note that this will not "timeout" +from the endpoint. This defaults to 1800 seconds. Note that this will not "timeout" commands that exceed this amount of time to process, it just requires the endpoint to report the status of the command before the given amount of time passes. -* `config.winrm.retry_limit` (integer) - The maximum number of times to retry opening -a shell after failure. This defaults to 3. +* `config.winrm.max_tries` (integer) - The maximum number of times to retry opening +a shell after failure. This defaults to 20. * `config.winrm.retry_delay` (integer) - The amount of time to wait between retries and -defaults to 10 seconds. +defaults to 2 seconds. * `config.winrm.codepage` (string) - The WINRS_CODEPAGE which is the client's console -output code page. The default is 65001 (UTF-8). +output code page. By default this is not set by Vagrant. **Note:** Versions of Windows older than Windows 7/Server 2008 R2 may exhibit undesirable behavior using the default UTF-8 codepage. When using these older