djo-vagrant-vsphere 1.6.1

data/Gemfile

@@ -0,0 +1,16 @@
+source 'http://rubygems.org'
+
+gemspec
+
+group :development do
+  # We depend on Vagrant for development, but we don't add it as a
+  # gem dependency because we expect to be installed within the
+  # Vagrant environment itself using `vagrant plugin`.
+
+  ruby '2.0.0'
+  gem 'vagrant', git: 'git://github.com/mitchellh/vagrant.git', tag: 'v1.6.4'
+end
+
+group :plugins do
+  gem 'vagrant-vsphere', path: '.'
+end

data/LICENSE.txt

@@ -0,0 +1,24 @@
+Copyright (c) 2013-2015 Regents of the University of Colorado
+
+This software was developed by the National Snow and Ice Data Center with funding from multiple sources.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,310 @@
+[![Build Status](https://travis-ci.org/nsidc/vagrant-vsphere.svg?branch=master)](https://travis-ci.org/nsidc/vagrant-vsphere) [![Gem Version](https://badge.fury.io/rb/vagrant-vsphere.svg)](http://badge.fury.io/rb/vagrant-vsphere)
+
+# Vagrant vSphere Provider
+
+This is a [Vagrant](http://www.vagrantup.com) 1.6.4+ plugin that adds a
+[vSphere](http://pubs.vmware.com/vsphere-50/index.jsp?topic=%2Fcom.vmware.wssdk.apiref.doc_50%2Fright-pane.html)
+provider to Vagrant, allowing Vagrant to control and provision machines using
+VMware. New machines are created from virtual machines or templates which must
+be configured prior to using this provider.
+
+This provider is built on top of the
+[RbVmomi](https://github.com/vmware/rbvmomi) Ruby interface to the vSphere API.
+
+## Requirements
+
+* Vagrant 1.6.4+
+* VMware with vSphere API
+* Ruby 1.9+
+* libxml2, libxml2-dev, libxslt, libxslt-dev
+
+## Current Version
+**version: 1.6.0**
+
+vagrant-vsphere (**version: 1.6.0**) is available from
+[RubyGems.org](https://rubygems.org/gems/vagrant-vsphere)
+
+## Installation
+
+Install using standard Vagrant plugin method:
+
+```bash
+vagrant plugin install vagrant-vsphere
+```
+
+This will install the plugin from RubyGems.org.
+
+Alternatively, you can clone this repository and build the source with `gem
+build vSphere.gemspec`. After the gem is built, run the plugin install command
+from the build directory.
+
+### Potential Installation Problems
+
+The requirements for [Nokogiri](http://nokogiri.org/) must be installed before
+the plugin can be installed. See the
+[Nokogiri tutorial](http://nokogiri.org/tutorials/installing_nokogiri.html) for
+detailed instructions.
+
+The plugin forces use of Nokogiri ~> 1.5 to prevent conflicts with older
+versions of system libraries, specifically zlib.
+
+## Usage
+
+After installing the plugin, you must create a vSphere box. The example_box
+directory contains a metadata.json file that can be used to create a dummy box
+with the command:
+
+```bash
+tar cvzf dummy.box ./metadata.json
+```
+
+This can be installed using the standard Vagrant methods or specified in the
+Vagrantfile.
+
+After creating the dummy box, make a Vagrantfile that looks like the following:
+
+```ruby
+Vagrant.configure("2") do |config|
+  config.vm.box = 'dummy'
+  config.vm.box_url = './example_box/dummy.box'
+
+  config.vm.provider :vsphere do |vsphere|
+    vsphere.host = 'HOST NAME OF YOUR VSPHERE INSTANCE'
+    vsphere.compute_resource_name = 'YOUR COMPUTE RESOURCE'
+    vsphere.resource_pool_name = 'YOUR RESOURCE POOL'
+    vsphere.template_name = '/PATH/TO/YOUR VM TEMPLATE'
+    vsphere.name = 'NEW VM NAME'
+    vsphere.user = 'YOUR VMWARE USER'
+    vsphere.password = 'YOUR VMWARE PASSWORD'
+  end
+end
+```
+
+And then run `vagrant up --provider=vsphere`.
+
+### Custom Box
+
+The bulk of this configuration can be included as part of a custom box. See the
+[Vagrant documentation](http://docs.vagrantup.com/v2/boxes.html) and the Vagrant
+[AWS provider](https://github.com/mitchellh/vagrant-aws/tree/master/example_box)
+for more information and an example.
+
+### Supported Commands
+
+Currently the only implemented actions are `up`, `halt`, `reload`, `destroy`,
+and `ssh`.
+
+`up` supports provisioning of the new VM with the standard Vagrant provisioners.
+
+## Configuration
+
+This provider has the following settings, all are required unless noted:
+
+* `host` - IP or name for the vSphere API
+* `insecure` - _Optional_ verify SSL certificate from the host
+* `user` - user name for connecting to vSphere
+* `password` - password for connecting to vSphere. If no value is given, or the
+  value is set to `:ask`, the user will be prompted to enter the password on
+  each invocation.
+* `data_center_name` - _Optional_ datacenter containing the computed resource,
+  the template and where the new VM will be created, if not specified the first
+  datacenter found will be used
+* `compute_resource_name` - _Required if cloning from template_ the name of the
+  host containing the resource pool for the new VM
+* `resource_pool_name` - the resource pool for the new VM. If not supplied, and
+  cloning from a template, uses the root resource pool
+* `clone_from_vm` - _Optional_ use a virtual machine instead of a template as
+  the source for the cloning operation
+* `template_name` - the VM or VM template to clone (including the full folder path)
+* `vm_base_path` - _Optional_ path to folder where new VM should be created, if
+  not specified template's parent folder will be used
+* `name` - _Optional_ name of the new VM, if missing the name will be auto
+  generated
+* `customization_spec_name` - _Optional_ customization spec for the new VM
+* `data_store_name` - _Optional_ the datastore where the VM will be located
+* `linked_clone` - _Optional_ link the cloned VM to the parent to share virtual
+  disks
+* `proxy_host` - _Optional_ proxy host name for connecting to vSphere via proxy
+* `proxy_port` - _Optional_ proxy port number for connecting to vSphere via
+  proxy
+* `vlan` - _Optional_ vlan to connect the first NIC to
+* `memory_mb` - _Optional_ Configure the amount of memory (in MB) for the new VM
+* `cpu_count` - _Optional_ Configure the number of CPUs for the new VM
+* `mac` - _Optional_ Used to set the mac address of the new VM
+* `cpu_reservation` - _Optional_ Configure the CPU time (in MHz) to reserve for this VM
+* `mem_reservation` - _Optional_ Configure the memory (in MB) to reserve for this VM
+* `addressType` - _Optional_ Configure the address type of the
+  [vSphere Virtual Ethernet Card](https://www.vmware.com/support/developer/vc-sdk/visdk2xpubs/ReferenceGuide/vim.vm.device.VirtualEthernetCard.html)
+* `custom_attribute` - _Optional_ Add a
+  [custom attribute](https://www.google.com/url?sa=t&rct=j&q=&esrc=s&source=web&cd=1&cad=rja&uact=8&ved=0CB4QFjAAahUKEwiWwbWX59jHAhVBC5IKHa3HAEU&url=http%3A%2F%2Fpubs.vmware.com%2Fvsphere-51%2Ftopic%2Fcom.vmware.vsphere.vcenterhost.doc%2FGUID-25244732-D473-4857-A471-579257B6D95F.html&usg=AFQjCNGTSl4cauFrflUJpBeTBb0Yv7R13g&sig2=a9he6W2qVvBSZ5lCiXnENA)
+  to the VM upon creation. This method takes a key/value pair,
+  e.g. `vsphere.custom_attribute('timestamp', Time.now.to_s)`, and may be called
+  multiple times to set different attributes.
+
+### Cloning from a VM rather than a template
+
+To clone from an existing VM rather than a template, set `clone_from_vm` to
+true. If this value is set, `compute_resource_name` and `resource_pool_name` are
+not required.
+
+### Template_Name
+
+* The template name includes the actual template name and the directory path
+  containing the template.
+* **For example:** if the template is a directory called **vagrant-templates**
+  and the template is called **ubuntu-lucid-template** the `template_name`
+  setting would be:
+
+```
+vsphere.template_name = "vagrant-templates/ubuntu-lucid-template"
+```
+
+![Vagrant Vsphere Screenshot](https://raw.githubusercontent.com/nsidc/vagrant-vsphere/master/vsphere_screenshot.png)
+
+### VM_Base_Path
+
+* The new vagrant VM will be created in the same directory as the template it
+  originated from.
+* To create the VM in a directory other than the one where the template was
+  located, include the **vm_base_path** setting.
+* **For example:** if the machines will be stored in a directory called
+  **vagrant-machines** the `vm_base_path` would be:
+
+```
+vsphere.vm_base_path = "vagrant-machines"
+```
+
+![Vagrant Vsphere Screenshot](https://raw.githubusercontent.com/nsidc/vagrant-vsphere/master/vsphere_screenshot.png)
+
+### Setting a static IP address
+
+To set a static IP, add a private network to your vagrant file:
+
+```ruby
+config.vm.network 'private_network', ip: '192.168.50.4'
+```
+
+The IP address will only be set if a customization spec name is given. The
+customization spec must have network adapter settings configured with a static
+IP address(just an unused address NOT the address you want the VM to be). The
+config.vm.network line will overwrite the ip in the customization spec with the one you set.
+For each private network specified, there needs to be a corresponding network adapter in
+the customization spec. An error will be thrown if there are more networks than
+adapters.
+
+### Auto name generation
+
+The name for the new VM will be automagically generated from the Vagrant machine
+name, the current timestamp and a random number to allow for simultaneous
+executions.
+
+This is useful if running Vagrant from multiple directories or if multiple
+machines are defined in the Vagrantfile.
+
+### Setting addressType for network adapter
+
+This sets the addressType of the network adapter, for example 'Manual' to
+be able to set a manual mac address.
+This value may depend on the version of vSphere you use. It may be necessary
+to set this in combination with the mac field, in order to set a manual
+mac address. For valid values for this field see VirtualEthernetCard api
+documentation of vSphere.
+
+```ruby
+vsphere.addressType = 'Manual'
+```
+
+### Setting the MAC address
+
+To set a static MAC address, add a `vsphere.mac` to your `Vagrantfile`.
+In some cases you must also set `vsphere.addressType` (see above)
+to make this work:
+
+```ruby
+vsphere.mac = '00:50:56:XX:YY:ZZ'
+```
+
+Take care to avoid using invalid or duplicate VMware MAC addresses, as this can
+easily break networking.
+
+## Troubleshooting
+
+### vCenter
+ESXi is not supported. Make sure to connect to a vCenter server and not directly to an ESXi host. [ESXi vs vCenter](http://www.mustbegeek.com/difference-between-vsphere-esxi-and-vcenter/)
+
+### Permissions
+If you have permission issues:
+
+1. give the connecting user read only access to everything, and full permission to a specific data center.  Narrow the permissions down after a VM is created.
+2. Be sure the path to the VM is correct. see  the "Template_Name" screenshots above for more information.
+
+## Example Usage
+
+### FILE: Vagrantfile
+
+```ruby
+VAGRANT_INSTANCE_NAME   = "vagrant-vsphere"
+
+Vagrant.configure("2") do |config|
+  config.vm.box     = 'vsphere'
+  config.vm.box_url = 'https://vagrantcloud.com/ssx/boxes/vsphere-dummy/versions/0.0.1/providers/vsphere.box'
+
+  config.vm.hostname = VAGRANT_INSTANCE_NAME
+  config.vm.define VAGRANT_INSTANCE_NAME do |d|
+  end
+
+  config.vm.provider :vsphere do |vsphere|
+    vsphere.host                  = 'vsphere.local'
+    vsphere.name                  = VAGRANT_INSTANCE_NAME
+    vsphere.compute_resource_name = 'vagrant01.vsphere.local'
+    vsphere.resource_pool_name    = 'vagrant'
+    vsphere.template_name         = 'vagrant-templates/ubuntu14041'
+    vsphere.vm_base_path          = "vagrant-machines"
+
+    vsphere.user     = 'vagrant-user@vsphere'
+    vsphere.password = '***************'
+    vsphere.insecure = true
+
+    vsphere.custom_attribute('timestamp', Time.now.to_s)
+  end
+end
+```
+
+### Vagrant Up
+
+```bash
+vagrant up --provider=vsphere
+```
+### Vagrant SSH
+
+```bash
+vagrant ssh
+```
+
+### Vagrant Destroy
+
+```bash
+vagrant destroy
+```
+
+## Version History
+
+See
+[`CHANGELOG.md`](https://github.com/nsidc/vagrant-vsphere/blob/master/CHANGELOG.md).
+
+## Contributing
+
+See
+[`DEVELOPMENT.md`](https://github.com/nsidc/vagrant-vsphere/blob/master/DEVELOPMENT.md).
+
+## License
+
+The Vagrant vSphere Provider is licensed under the MIT license. See
+[LICENSE.txt][license].
+
+[license]: https://raw.github.com/nsidc/vagrant-vsphere/master/LICENSE.txt
+
+## Credit
+
+This software was developed by the National Snow and Ice Data Center with
+funding from multiple sources.

data/Rakefile

@@ -0,0 +1,20 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+# Immediately sync all stdout so that tools like buildbot can
+# immediately load in the output.
+$stdout.sync = true
+$stderr.sync = true
+
+# Change to the directory of this file.
+Dir.chdir(File.expand_path('../', __FILE__))
+
+Bundler::GemHelper.install_tasks
+
+RSpec::Core::RakeTask.new
+
+RuboCop::RakeTask.new
+
+task default: %w(rubocop spec)

data/example_box/metadata.json

@@ -0,0 +1,3 @@
+{
+  "provider": "vsphere"
+}

data/lib/vSphere/action.rb

@@ -0,0 +1,195 @@
+require 'vagrant'
+require 'vagrant/action/builder'
+
+module VagrantPlugins
+  module VSphere
+    module Action
+      include Vagrant::Action::Builtin
+
+      # Vagrant commands
+      def self.action_destroy
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use ConnectVSphere
+
+          b.use Call, IsRunning do |env, b2|
+            if env[:result]
+              if env[:force_confirm_destroy]
+                b2.use PowerOff
+                next
+              end
+
+              b2.use Call, GracefulHalt, :poweroff, :running do |env2, b3|
+                b3.use PowerOff unless env2[:result]
+              end
+            end
+          end
+          b.use Destroy
+        end
+      end
+
+      def self.action_provision
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsCreated do |env, b2|
+            unless env[:result]
+              b2.use MessageNotCreated
+              next
+            end
+
+            b2.use Call, IsRunning do |env2, b3|
+              unless env2[:result]
+                b3.use MessageNotRunning
+                next
+              end
+
+              b3.use Provision
+              b3.use SyncedFolders
+            end
+          end
+        end
+      end
+
+      def self.action_ssh
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsCreated do |env, b2|
+            unless env[:result]
+              b2.use MessageNotCreated
+              next
+            end
+
+            b2.use Call, IsRunning do |env2, b3|
+              unless env2[:result]
+                b3.use MessageNotRunning
+                next
+              end
+
+              b3.use SSHExec
+            end
+          end
+        end
+      end
+
+      def self.action_ssh_run
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsCreated do |env, b2|
+            unless env[:result]
+              b2.use MessageNotCreated
+              next
+            end
+
+            b2.use Call, IsRunning do |env2, b3|
+              unless env2[:result]
+                b3.use MessageNotRunning
+                next
+              end
+
+              b3.use SSHRun
+            end
+          end
+        end
+      end
+
+      def self.action_up
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use HandleBox
+          b.use ConfigValidate
+          b.use ConnectVSphere
+          b.use Call, IsCreated do |env, b2|
+            if env[:result]
+              b2.use MessageAlreadyCreated
+              next
+            end
+
+            b2.use Clone
+          end
+          b.use Call, IsRunning do |env, b2|
+            b2.use PowerOn unless env[:result]
+          end
+          b.use CloseVSphere
+          b.use WaitForCommunicator
+          b.use Provision
+          b.use SyncedFolders
+          b.use SetHostname
+        end
+      end
+
+      def self.action_halt
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use ConnectVSphere
+          b.use Call, IsCreated do |env, b2|
+            unless env[:result]
+              b2.use MessageNotCreated
+              next
+            end
+
+            b2.use Call, IsRunning do |env2, b3|
+              unless env2[:result]
+                b3.use MessageNotRunning
+                next
+              end
+
+              b3.use Call, GracefulHalt, :poweroff, :running do |env3, b4|
+                b4.use PowerOff unless env3[:result]
+              end
+            end
+          end
+          b.use CloseVSphere
+        end
+      end
+
+      def self.action_reload
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConnectVSphere
+          b.use Call, IsCreated do |env, b2|
+            unless env[:result]
+              b2.use MessageNotCreated
+              next
+            end
+            b2.use action_halt
+            b2.use action_up
+          end
+        end
+      end
+
+      # vSphere specific actions
+      def self.action_get_state
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use HandleBox
+          b.use ConfigValidate
+          b.use ConnectVSphere
+          b.use GetState
+          b.use CloseVSphere
+        end
+      end
+
+      def self.action_get_ssh_info
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use ConnectVSphere
+          b.use GetSshInfo
+          b.use CloseVSphere
+        end
+      end
+
+      # autoload
+      action_root = Pathname.new(File.expand_path('../action', __FILE__))
+      autoload :Clone, action_root.join('clone')
+      autoload :CloseVSphere, action_root.join('close_vsphere')
+      autoload :ConnectVSphere, action_root.join('connect_vsphere')
+      autoload :Destroy, action_root.join('destroy')
+      autoload :GetSshInfo, action_root.join('get_ssh_info')
+      autoload :GetState, action_root.join('get_state')
+      autoload :IsCreated, action_root.join('is_created')
+      autoload :IsRunning, action_root.join('is_running')
+      autoload :MessageAlreadyCreated, action_root.join('message_already_created')
+      autoload :MessageNotCreated, action_root.join('message_not_created')
+      autoload :MessageNotRunning, action_root.join('message_not_running')
+      autoload :PowerOff, action_root.join('power_off')
+      autoload :PowerOn, action_root.join('power_on')
+    end
+  end
+end