From bfb1da6499fd3a2e7b9ece322a5cd625dfc202f7 Mon Sep 17 00:00:00 2001 From: bugbuilder Date: Sun, 9 Jul 2017 21:45:57 -0400 Subject: [PATCH] Adding documentation --- .../post-processors/vsphere-template.html.md | 58 +++++++++++++++++++ website/source/layouts/docs.erb | 3 + 2 files changed, 61 insertions(+) create mode 100644 website/source/docs/post-processors/vsphere-template.html.md diff --git a/website/source/docs/post-processors/vsphere-template.html.md b/website/source/docs/post-processors/vsphere-template.html.md new file mode 100644 index 000000000..e7351c7f6 --- /dev/null +++ b/website/source/docs/post-processors/vsphere-template.html.md @@ -0,0 +1,58 @@ +--- +description: | + The Packer vSphere Template post-processor takes an artifact from the VMware-iso builder + and allows to mark a VM as a template and leaving it in a path of choice. +layout: docs +page_title: 'vSphere Template - Post-Processors' +sidebar_current: 'docs-post-processors-vSphere-template' +--- + +# vSphere Template Post-Processor + +Type: `vsphere-tpl` + +The Packer vSphere template post-processor takes an artifact from the VMware-iso builder +allows to mark a VM as a template and leaving it in a path of choice. + +## Example + +An example is shown below, showing only the post-processor configuration: + +``` json +{ + "type":"vsphere-tpl", + "host":"vcenter.local", + "username":"root", + "password":"sssh_is_a_secret", + "datacenter":"murlock", + "vm_name":"distro-7.3", + "folder":"/packer-templates/os/distro-7" +} +``` + +## Configuration + +There are many configuration options available for the post-processor. They are +segmented below into two categories: required and optional parameters. Within +each category, the available configuration keys are alphabetized. + +Required: + +- `host` (string) - The vSphere host that contains the VM built by the vmware-iso. + +- `insecure` (boolean) - If it's true Skip verification of server certificate. + Default is false + +- `password` (string) - Password to use to authenticate to the + vSphere endpoint. + +- `username` (string) - The username to use to authenticate to the + vSphere endpoint. + +- `vm_name` (string) - The name of the VM once it is uploaded. + +Optional: + +- `folder` (string) - Target path where the template is created. + +- `datacenter` (string) - If you have more than one, you will need to specified one. diff --git a/website/source/layouts/docs.erb b/website/source/layouts/docs.erb index bb8b6fa71..8cd3159f8 100644 --- a/website/source/layouts/docs.erb +++ b/website/source/layouts/docs.erb @@ -270,6 +270,9 @@ > vSphere + > + vSphere Template +