From 572de129d72066ecc3e63bc4a6f336c32e3c31e9 Mon Sep 17 00:00:00 2001 From: James Griffith Date: Fri, 18 Sep 2020 16:01:16 -0400 Subject: [PATCH] update documentation --- builder/vsphere/common/step_shutdown.go | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/builder/vsphere/common/step_shutdown.go b/builder/vsphere/common/step_shutdown.go index fab80dcd2..468caf675 100644 --- a/builder/vsphere/common/step_shutdown.go +++ b/builder/vsphere/common/step_shutdown.go @@ -16,16 +16,18 @@ import ( ) type ShutdownConfig struct { - // Specify a VM guest shutdown command. VMware guest tools are used by - // default. + // 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. Command string `mapstructure:"shutdown_command"` // 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'. Timeout time.Duration `mapstructure:"shutdown_timeout"` // 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 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"`