Merge pull request #2095 from rickard-von-essen/issue_2079

Fixes #2079 - Documentation parallel_tools_mode / guest_additions_mode
This commit is contained in:
Mitchell Hashimoto 2015-05-27 20:19:23 -07:00
commit 96b40322e0
4 changed files with 32 additions and 22 deletions

View File

@ -148,17 +148,19 @@ each category, the available options are alphabetized and described.
By default this is "output-BUILDNAME" where "BUILDNAME" is the name By default this is "output-BUILDNAME" where "BUILDNAME" is the name
of the build. of the build.
* `parallels_tools_guest_path` (string) - The path in the VM to upload Parallels * `parallels_tools_guest_path` (string) - The path in the virtual machine to upload
Tools. This only takes effect if `parallels_tools_mode` is not "disable". Parallels Tools. This only takes effect if `parallels_tools_mode` is "upload".
This is a [configuration template](/docs/templates/configuration-templates.html) This is a [configuration template](/docs/templates/configuration-templates.html)
that has a single valid variable: `Flavor`, which will be the value of that has a single valid variable: `Flavor`, which will be the value of
`parallels_tools_flavor`. By default the upload path is set to `parallels_tools_flavor`. By default this is "prl-tools-{{.Flavor}}.iso" which
`prl-tools-{{.Flavor}}.iso`. should upload into the login directory of the user.
* `parallels_tools_mode` (string) - The method by which Parallels Tools are * `parallels_tools_mode` (string) - The method by which Parallels Tools are made
made available to the guest for installation. Valid options are "upload", available to the guest for installation. Valid options are "upload", "attach",
"attach", or "disable". The functions of each of these should be or "disable". If the mode is "attach" the Parallels Tools ISO will be attached
self-explanatory. The default value is "upload". as a CD device to the virtual machine. If the mode is "upload" the Parallels
Tools ISO will be uploaded to the path specified by
`parallels_tools_guest_path`. The default value is "upload".
* `prlctl` (array of array of strings) - Custom `prlctl` commands to execute in * `prlctl` (array of array of strings) - Custom `prlctl` commands to execute in
order to further customize the virtual machine being created. The value of order to further customize the virtual machine being created. The value of

View File

@ -91,17 +91,19 @@ each category, the available options are alphabetized and described.
By default this is "output-BUILDNAME" where "BUILDNAME" is the name By default this is "output-BUILDNAME" where "BUILDNAME" is the name
of the build. of the build.
* `parallels_tools_guest_path` (string) - The path in the VM to upload Parallels * `parallels_tools_guest_path` (string) - The path in the VM to upload
Tools. This only takes effect if `parallels_tools_mode` is not "disable". Parallels Tools. This only takes effect if `parallels_tools_mode` is "upload".
This is a [configuration template](/docs/templates/configuration-templates.html) This is a [configuration template](/docs/templates/configuration-templates.html)
that has a single valid variable: `Flavor`, which will be the value of that has a single valid variable: `Flavor`, which will be the value of
`parallels_tools_flavor`. By default the upload path is set to `parallels_tools_flavor`. By default this is "prl-tools-{{.Flavor}}.iso" which
`prl-tools-{{.Flavor}}.iso`. should upload into the login directory of the user.
* `parallels_tools_mode` (string) - The method by which Parallels Tools are * `parallels_tools_mode` (string) - The method by which Parallels Tools are made
made available to the guest for installation. Valid options are "upload", available to the guest for installation. Valid options are "upload", "attach",
"attach", or "disable". The functions of each of these should be or "disable". If the mode is "attach" the Parallels Tools ISO will be attached
self-explanatory. The default value is "upload". as a CD device to the virtual machine. If the mode is "upload" the Parallels
Tools ISO will be uploaded to the path specified by
`parallels_tools_guest_path`. The default value is "upload".
* `prlctl` (array of array of strings) - Custom `prlctl` commands to execute in * `prlctl` (array of array of strings) - Custom `prlctl` commands to execute in
order to further customize the virtual machine being created. The value of order to further customize the virtual machine being created. The value of

View File

@ -106,9 +106,12 @@ each category, the available options are alphabetized and described.
* `guest_additions_mode` (string) - The method by which guest additions * `guest_additions_mode` (string) - The method by which guest additions
are made available to the guest for installation. Valid options are are made available to the guest for installation. Valid options are
"upload", "attach", or "disable". The functions of each of these should be "upload", "attach", or "disable". If the mode is "attach" the guest
self-explanatory. The default value is "upload". If "disable" is used, additions ISO will be attached as a CD device to the virtual machine.
guest additions won't be downloaded, either. If the mode is "upload" the guest additions ISO will be uploaded to
the path specified by `guest_additions_path`. The default value is
"upload". If "disable" is used, guest additions won't be downloaded,
either.
* `guest_additions_path` (string) - The path on the guest virtual machine * `guest_additions_path` (string) - The path on the guest virtual machine
where the VirtualBox guest additions ISO will be uploaded. By default this where the VirtualBox guest additions ISO will be uploaded. By default this

View File

@ -96,9 +96,12 @@ each category, the available options are alphabetized and described.
* `guest_additions_mode` (string) - The method by which guest additions * `guest_additions_mode` (string) - The method by which guest additions
are made available to the guest for installation. Valid options are are made available to the guest for installation. Valid options are
"upload", "attach", or "disable". The functions of each of these should be "upload", "attach", or "disable". If the mode is "attach" the guest
self-explanatory. The default value is "upload". If "disable" is used, additions ISO will be attached as a CD device to the virtual machine.
guest additions won't be downloaded, either. If the mode is "upload" the guest additions ISO will be uploaded to
the path specified by `guest_additions_path`. The default value is
"upload". If "disable" is used, guest additions won't be downloaded,
either.
* `guest_additions_path` (string) - The path on the guest virtual machine * `guest_additions_path` (string) - The path on the guest virtual machine
where the VirtualBox guest additions ISO will be uploaded. By default this where the VirtualBox guest additions ISO will be uploaded. By default this