From c8ad66f419388884e23f0a5781e3e7fdd0f6467b Mon Sep 17 00:00:00 2001 From: James Griffith Date: Tue, 13 Oct 2020 16:29:33 -0400 Subject: [PATCH] update to docs as suggested --- builder/vsphere/common/step_shutdown.go | 2 +- .../vsphere/common/ShutdownConfig-not-required.mdx | 8 +++++--- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/builder/vsphere/common/step_shutdown.go b/builder/vsphere/common/step_shutdown.go index afb697cfa..e14b67957 100644 --- a/builder/vsphere/common/step_shutdown.go +++ b/builder/vsphere/common/step_shutdown.go @@ -28,7 +28,7 @@ type ShutdownConfig struct { // Packer normally halts the virtual machine after all provisioners have // run when no `shutdown_command` is defined. If this is set to `true`, Packer // *will not* halt the virtual machine but will assume that you will send the stop - // signal yourself through a script or the final provisioner. + // signal yourself through a preseed.cfg, a script or the final provisioner. // Packer will wait for a default of five minutes until the virtual machine is shutdown. // The timeout can be changed using `shutdown_timeout` option. DisableShutdown bool `mapstructure:"disable_shutdown"` diff --git a/website/pages/partials/builder/vsphere/common/ShutdownConfig-not-required.mdx b/website/pages/partials/builder/vsphere/common/ShutdownConfig-not-required.mdx index 85915de71..1b950c176 100644 --- a/website/pages/partials/builder/vsphere/common/ShutdownConfig-not-required.mdx +++ b/website/pages/partials/builder/vsphere/common/ShutdownConfig-not-required.mdx @@ -1,14 +1,16 @@ -- `shutdown_command` (string) - Specify a VM guest shutdown command. VMware guest tools are used by - default. +- `shutdown_command` (string) - Specify a VM guest shutdown command. This command will be executed using + the `communicator`. Otherwise the VMware guest tools are used to gracefully + shutdown the VM guest. - `shutdown_timeout` (duration string | ex: "1h5m2s") - Amount of time to wait for graceful VM shutdown. Defaults to 5m or five minutes. + This will likely need to be modified if the `communicator` is 'none'. - `disable_shutdown` (bool) - Packer normally halts the virtual machine after all provisioners have run when no `shutdown_command` is defined. If this is set to `true`, Packer *will not* halt the virtual machine but will assume that you will send the stop - signal yourself through the preseed.cfg or your final provisioner. + signal yourself through a preseed.cfg, a script or the final provisioner. Packer will wait for a default of five minutes until the virtual machine is shutdown. The timeout can be changed using `shutdown_timeout` option.