esx 0.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Sergio Rubio
+
+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,83 @@
+# ESX
+
+Simple rbvmomi wrapper to manage VMWare ESX hosts
+
+# Usage
+
+ESX ruby library includes a script to print ESX host information.
+
+    Usage: esx my-esx-host-here
+
+This will ask you for the username and password of the host.
+
+Sample output:
+
+    *********
+    ESXHOST1
+    *********
+    Memory Size:      32756
+    Memory Usage:     7429
+    Cpu Cores:        8
+    Power State:      poweredOn
+    
+    Virtual Machines:
+    +-------------------------+--------+------+------+-------+
+    | NAME                    | MEMORY | CPUS | NICS | DISKS |
+    +-------------------------+--------+------+------+-------+
+    | foobar                  | 128    | 1    | 1    | 1     |
+    | foobar2                 | 256    | 2    | 1    | 1     |
+    +-------------------------+--------+------+------+-------+
+    
+    Datastores:
+    +------------+--------------+--------------+-----------+------+---------------------------------------------------+
+    | NAME       | CAPACITY     | FREESPACE    | ACCESIBLE | TYPE | URL                                               |
+    +------------+--------------+--------------+-----------+------+---------------------------------------------------+
+    | datastore2 | 146565758976 | 145547591680 | VMFS      | true | /vmfs/volumes/4e611c69-16474ca5-d290-5ef3fc9a99c3 |
+    | datastore1 | 141465485312 | 20716716032  | VMFS      | true | /vmfs/volumes/4e6117e7-35c82a3e-ba79-5cf3fc9699c2 |
+    +------------+--------------+--------------+-----------+------+---------------------------------------------------+
+
+
+# Using the library
+
+    require 'rubygems'
+    require 'lib/esx.rb'
+    
+    
+    # Connect to the ESX Host
+    host = ESX::Host.connect 'my-esx-host', 'root', 'secret'
+    
+    # Print hypervisor info
+    puts
+    name = host.name.upcase
+    puts "*" * name.size
+    puts name
+    puts "*" * name.size
+    puts "Memory Size:      %s" % host.memory_size.bytes.to.megabytes.to_i
+    puts "Memory Usage:     %s" % host.memory_usage.bytes.to.megabytes.to_i
+    puts "Cpu Cores:        %s" % host.cpu_cores
+    puts "Power State:      %s" % host.power_state
+    
+    # Create a VM with 4GB disk, 128 MB mem, e1000 nic, 1CPU in datastore1
+    vm = host.create_vm :vm_name => 'foobar'
+    
+    # Create a VM with 5GB disk, 256 MB mem, e1000 nic, 1CPU in datastore2
+    vm = host.create_vm :vm_name => 'foobar2', :disk_size => 5000, :cpus => 2, :memory => 256, :datastore => 'datastore2'
+    
+    
+    host.virtual_machines.each do |vm|
+    
+      # PowerOff the VM if powered On
+      vm.power_off if (vm.name =~ /foobar/ and vm.power_state == 'poweredOn')
+    
+      # Destroy the VM if name matches foobar
+      if vm.name =~ /foobar.*/
+        vm.destroy
+      end
+    
+    end
+
+# Copyright
+
+Copyright (c) 2011 Sergio Rubio. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,41 @@
+require 'rubygems'
+require 'rake'
+require 'lib/esx.rb'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.version = ESX::VERSION
+  gem.name = "esx"
+  gem.homepage = "http://github.com/rubiojr/esx"
+  gem.license = "MIT"
+  gem.summary = %Q{Simple RbVmomi wrapper library to manage VMWare ESX hosts}
+  gem.description = %Q{Manage VMWare ESX hosts with ease}
+  gem.email = "rubiojr@frameos.org"
+  gem.authors = ["Sergio Rubio"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  gem.add_runtime_dependency 'alchemist'
+  gem.add_runtime_dependency 'rbvmomi'
+  gem.add_runtime_dependency 'terminal-table'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :build
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = ESX::VERSION
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "esx #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/bin/esx

@@ -0,0 +1,62 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'esx'
+require 'terminal-table/import'
+
+host_addr = ARGV[0]
+
+if host_addr.nil?
+  $stderr.puts 'Usage: esx HOST'
+  exit 1
+end
+
+print "Username: "
+user = $stdin.gets.strip.chomp
+
+
+system "stty -echo"
+print "Password: "
+pass = $stdin.gets.strip.chomp
+system "stty echo"
+puts
+
+begin
+
+  host = ESX::Host.connect(host_addr, user, pass)
+
+  puts
+  name = host.name.upcase
+  puts "*" * name.size
+  puts name
+  puts "*" * name.size
+  puts "Memory Size:      %s" % host.memory_size.bytes.to.megabytes.to_i
+  puts "Memory Usage:     %s" % host.memory_usage.bytes.to.megabytes.to_i
+  puts "Cpu Cores:        %s" % host.cpu_cores
+  puts "Power State:      %s" % host.power_state
+  puts "\nVirtual Machines:"
+  user_table = table do |t|
+    t.headings = "NAME","MEMORY","CPUS","NICS","DISKS"
+    host.virtual_machines.each do |vm|
+      t << [vm.name,vm.memory_size.bytes.to.megabytes.to_i, vm.cpus, vm.ethernet_cards_number, vm.virtual_disks_number]
+    end
+  end
+  puts user_table
+  puts "\nDatastores:"
+  user_table = table do |t|
+      t.headings = "NAME","CAPACITY","FREESPACE","ACCESIBLE","TYPE","URL"
+    host.datastores.each do |ds|
+      dsname = ds.name
+      if dsname.size > 20
+        dsname = dsname[0..19] + '...'
+      end
+      t << [dsname,ds.capacity, ds.free_space, ds.datastore_type, ds.accessible, ds.url]
+    end
+  end
+  puts user_table
+  puts
+
+rescue Exception => e
+  puts "Error connecting to the ESX host"
+  puts "\n#{e.message}"
+  puts e.backtrace
+end

data/examples/basics.rb

@@ -0,0 +1,36 @@
+require 'rubygems'
+require 'lib/esx.rb'
+
+
+# Connect to the ESX Host
+host = ESX::Host.connect 'my-esx-host', 'root', 'secret'
+
+# Print hypervisor info
+puts
+name = host.name.upcase
+puts "*" * name.size
+puts name
+puts "*" * name.size
+puts "Memory Size:      %s" % host.memory_size.bytes.to.megabytes.to_i
+puts "Memory Usage:     %s" % host.memory_usage.bytes.to.megabytes.to_i
+puts "Cpu Cores:        %s" % host.cpu_cores
+puts "Power State:      %s" % host.power_state
+
+# Create a VM with 4GB disk, 128 MB mem, e1000 nic, 1CPU in datastore1
+vm = host.create_vm :vm_name => 'foobar'
+
+# Create a VM with 5GB disk, 256 MB mem, e1000 nic, 1CPU in datastore2
+vm = host.create_vm :vm_name => 'foobar2', :disk_size => 5000, :cpus => 2, :memory => 256, :datastore => 'datastore2'
+
+
+host.virtual_machines.each do |vm|
+
+  # PowerOff the VM if powered On
+  vm.power_off if (vm.name =~ /foobar/ and vm.power_state == 'poweredOn')
+
+  # Destroy the VM if name matches foobar
+  if vm.name =~ /foobar.*/
+    vm.destroy
+  end
+
+end

data/lib/esx.rb

@@ -0,0 +1,256 @@
+require 'rubygems'
+require 'rbvmomi'
+require 'alchemist'
+
+module ESX
+  VERSION = '0.1'
+
+  class Host
+
+    # Connect to a ESX host
+    #
+    # Requires hostname/ip, username and password
+    #
+    # Host connection is insecure by default
+    def self.connect(host, user, password, insecure=true)
+      vim = RbVmomi::VIM.connect :host => host, :user => 'root', :password => 'temporal', :insecure => insecure
+      host = Host.new
+      host.vim = vim
+      host
+    end
+
+    def vim=(vim)
+      @_vim = vim
+      @_datacenter = @_vim.serviceInstance.find_datacenter
+      @_host = @_datacenter.hostFolder.children.first.host.first
+    end
+
+    # Returns the name of this host
+    #
+    def name
+      @_host.summary.config.name
+    end
+
+    # Host memory size in bytes
+    #
+    def memory_size
+      @_host.hardware.memorySize
+    end
+
+    # Number of CPU cores available in this host
+    #
+    def cpu_cores
+      @_host.hardware.cpuInfo.numCpuCores
+    end
+
+    # Power state of this host
+    #
+    def power_state
+      @_host.summary.runtime.powerState
+    end
+    
+    # Host memory usage in bytes 
+    #
+    def memory_usage
+      @_host.summary.quickStats.overallMemoryUsage.megabytes.to.bytes.to_i
+    end
+
+    
+    # Return a list of ESX::Datastore objects available in this host
+    #
+    def datastores
+      datastores = []
+      @_host.datastore.each do |ds|
+        datastores << Datastore.wrap(ds)
+      end
+      datastores
+    end
+
+    # Create a Virtual Machine
+    # 
+    # Requires a Hash with the following keys:
+    #
+    # {
+    #   :vm_name => name, (string, required)
+    #   :cpus => 1, #(int, optional)
+    #   :guest_id => 'otherGuest', #(string, optional)
+    #   :disk_size => 4096,  #(in MB, optional)
+    #   :memory => 128, #(in MB, optional)
+    #   :datastore => datastore1 #(string, optional)
+    # }
+    #
+    # Default values above.
+    def create_vm(specification)
+      spec = specification
+      spec[:cpus] = (specification[:cpus] || 1).to_i
+      spec[:guest_id] = specification[:guest_id] || 'otherGuest'
+      if specification[:disk_size]
+        spec[:disk_size] = (specification[:disk_size].to_i * 1024)
+      else
+        spec[:disk_size] = 4194304
+      end
+      spec[:memory] = (specification[:memory] || 128).to_i
+      if specification[:datastore]
+        spec[:datastore] = "[#{specification[:datastore]}]"
+      else
+        spec[:datastore] = '[datastore1]'
+      end
+      vm_cfg = {
+        :name => spec[:vm_name],
+        :guestId => spec[:guest_id],
+        :files => { :vmPathName => '[datastore1]' },
+        :numCPUs => spec[:cpus],
+        :memoryMB => spec[:memory],
+        :deviceChange => [
+          {
+            :operation => :add,
+            :device => RbVmomi::VIM.VirtualLsiLogicController(
+                             :key => 1000,
+                             :busNumber => 0,
+                             :sharedBus => :noSharing)
+          },
+          {
+            :operation => :add,
+            :fileOperation => :create,
+            :device => RbVmomi::VIM.VirtualDisk(
+                             :key => 0,
+                             :backing => RbVmomi::VIM.VirtualDiskFlatVer2BackingInfo(
+                                            :fileName => spec[:datastore],
+                                            :diskMode => :persistent,
+                                            :thinProvisioned => true),
+                             :controllerKey => 1000,
+                             :unitNumber => 0,
+                             :capacityInKB => spec[:disk_size])
+          },
+          {
+            :operation => :add,
+            :device => RbVmomi::VIM.VirtualE1000(
+              :key => 0,
+              :deviceInfo => {
+                :label => 'Network Adapter 1',
+                :summary => 'VM Network'
+              },
+              :backing => RbVmomi::VIM.VirtualEthernetCardNetworkBackingInfo(
+                :deviceName => 'VM Network'
+              ),
+              :addressType => 'generated')
+          }
+        ],
+        :extraConfig => [
+          {
+            :key => 'bios.bootOrder',
+            :value => 'ethernet0'
+          }
+        ]
+      }
+      VM.wrap(@_datacenter.vmFolder.CreateVM_Task(:config => vm_cfg, :pool => @_datacenter.hostFolder.children.first.resourcePool).wait_for_completion)
+    end
+
+    # Return product info as an array of strings containing
+    # 
+    # fullName, apiType, apiVersion, osType, productLineId, vendor, version
+    # 
+    def host_info 
+      [
+       @_host.summary.config.product.fullName,
+       @_host.summary.config.product.apiType,
+       @_host.summary.config.product.apiVersion,
+       @_host.summary.config.product.osType,
+       @_host.summary.config.product.productLineId,
+       @_host.summary.config.product.vendor,
+       @_host.summary.config.product.version
+      ]
+    end
+
+    # Return a list of VM available in the inventory
+    # 
+    def virtual_machines
+      vms = []
+      vm = @_datacenter.vmFolder.childEntity.each do |x| 
+        vms << VM.wrap(x)
+      end
+      vms
+    end
+
+  end
+
+  class VM
+
+    attr_accessor :memory_size, :cpus, :ethernet_cards_number
+    attr_accessor :name, :virtual_disks_number, :vm_object
+
+    # Wraps a RbVmomi::VirtualMachine object
+    #
+    # **This method should never be called manually.**
+    #
+    def self.wrap(vm)
+      _vm = VM.new
+      _vm.name = vm.name
+      _vm.memory_size = vm.summary.config.memorySizeMB.megabytes.to.bytes
+      _vm.cpus = vm.summary.config.numCpu
+      _vm.ethernet_cards_number = vm.summary.config.numEthernetCards 
+      _vm.virtual_disks_number = vm.summary.config.numVirtualDisks
+      _vm.vm_object = vm
+      _vm
+    end
+
+    # Returns the state of the VM as a string
+    # 'poweredOff', 'poweredOn'
+    # 
+    def power_state
+      vm_object.summary.runtime.powerState
+    end
+
+    # Power On a VM
+    def power_on
+      vm_object.PowerOnVM_Task.wait_for_completion
+    end
+
+    # Power Off a VM
+    def power_off
+      vm_object.PowerOffVM_Task.wait_for_completion
+    end
+
+    # Destroy the VirtualMaching removing it from the inventory
+    #
+    # This operation does not destroy VM disks
+    #
+    def destroy
+      disks = vm_object.config.hardware.device.grep(RbVmomi::VIM::VirtualDisk)
+      #disks.select { |x| x.backing.parent == nil }.each do |disk|
+      #  spec = {
+      #    :deviceChange => [
+      #      {
+      #        :operation => :remove,
+      #        :device => disk
+      #      }
+      #    ]
+      #  }
+      #  vm_object.ReconfigVM_Task(:spec => spec).wait_for_completion
+      #end
+      vm_object.Destroy_Task.wait_for_completion
+    end
+
+  end
+
+  class Datastore
+
+    attr_accessor :name, :capacity, :datastore_type, :free_space, :accessible
+    attr_accessor :url
+
+    #
+    # Internal method. Do not use
+    #
+    def self.wrap(ds)
+      @_datastore = ds
+      _ds = Datastore.new
+      _ds.name = ds.summary.name
+      _ds.capacity = ds.summary.capacity
+      _ds.free_space = ds.summary.freeSpace
+      _ds.datastore_type = ds.summary.type
+      _ds.accessible = ds.summary.accessible
+      _ds.url = ds.summary.url
+      _ds
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'esx'
+
+class Test::Unit::TestCase
+end

data/test/test_esx.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestEsx < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification 
+name: esx
+version: !ruby/object:Gem::Version 
+  hash: 9
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  version: "0.1"
+platform: ruby
+authors: 
+- Sergio Rubio
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-06 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id001
+  name: shoulda
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  version_requirements: *id002
+  name: bundler
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  version_requirements: *id003
+  name: jeweler
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id004
+  name: rcov
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id005
+  name: alchemist
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id006
+  name: rbvmomi
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id007
+  name: terminal-table
+  prerelease: false
+  type: :runtime
+description: Manage VMWare ESX hosts with ease
+email: rubiojr@frameos.org
+executables: 
+- esx
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.md
+files: 
+- .document
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/esx
+- examples/basics.rb
+- lib/esx.rb
+- test/helper.rb
+- test/test_esx.rb
+homepage: http://github.com/rubiojr/esx
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: Simple RbVmomi wrapper library to manage VMWare ESX hosts
+test_files: 
+- examples/basics.rb
+- test/helper.rb
+- test/test_esx.rb