update to docs as suggested
This commit is contained in:
parent
c86a48fbc9
commit
c8ad66f419
|
@ -28,7 +28,7 @@ type ShutdownConfig struct {
|
||||||
// Packer normally halts the virtual machine after all provisioners have
|
// Packer normally halts the virtual machine after all provisioners have
|
||||||
// run when no `shutdown_command` is defined. If this is set to `true`, Packer
|
// 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
|
// *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.
|
// Packer will wait for a default of five minutes until the virtual machine is shutdown.
|
||||||
// The timeout can be changed using `shutdown_timeout` option.
|
// The timeout can be changed using `shutdown_timeout` option.
|
||||||
DisableShutdown bool `mapstructure:"disable_shutdown"`
|
DisableShutdown bool `mapstructure:"disable_shutdown"`
|
||||||
|
|
|
@ -1,14 +1,16 @@
|
||||||
<!-- Code generated from the comments of the ShutdownConfig struct in builder/vsphere/common/step_shutdown.go; DO NOT EDIT MANUALLY -->
|
<!-- Code generated from the comments of the ShutdownConfig struct in builder/vsphere/common/step_shutdown.go; DO NOT EDIT MANUALLY -->
|
||||||
|
|
||||||
- `shutdown_command` (string) - Specify a VM guest shutdown command. VMware guest tools are used by
|
- `shutdown_command` (string) - Specify a VM guest shutdown command. This command will be executed using
|
||||||
default.
|
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.
|
- `shutdown_timeout` (duration string | ex: "1h5m2s") - Amount of time to wait for graceful VM shutdown.
|
||||||
Defaults to 5m or five minutes.
|
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
|
- `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
|
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
|
*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.
|
Packer will wait for a default of five minutes until the virtual machine is shutdown.
|
||||||
The timeout can be changed using `shutdown_timeout` option.
|
The timeout can be changed using `shutdown_timeout` option.
|
||||||
|
|
Loading…
Reference in New Issue