knife-ovh-cloud 1.0.0.pre.1

data/lib/chef/knife/ovh_cloud_vm_property_get.rb

@@ -0,0 +1,46 @@
+# Author:: Brian Dupras (<bdupras@rallydev.com>)
+# License:: Apache License, Version 2.0
+
+require 'chef/knife'
+require 'chef/knife/base_ovh_cloud_command'
+require 'rbvmomi'
+require 'netaddr'
+
+class Chef::Knife::OvhCloudVmPropertyGet < Chef::Knife::BaseOvhCloudCommand
+  banner "knife ovh cloud vm property get VMNAME PROPERTY.  Gets a vApp Property on VMNAME."
+
+  get_common_options
+
+  def run
+    $stdout.sync = true
+    vmname = @name_args[0]
+    if vmname.nil?
+      show_usage
+      fatal_exit("You must specify a virtual machine name")
+    end
+
+    property_name = @name_args[1]
+    if property_name.nil?
+      show_usage
+      fatal_exit("You must specify a PROPERTY name (e.g. annotation)")
+    end
+    property_name = property_name.to_sym
+
+    vim = get_vim_connection
+
+    dc = get_datacenter
+    folder = find_folder(get_config(:folder)) || dc.vmFolder
+
+    vm = find_in_folder(folder, RbVmomi::VIM::VirtualMachine, vmname) or
+        abort "VM #{vmname} not found"
+
+    existing_property = vm.config.vAppConfig.property.find { |p| p.props[:id] == property_name.to_s  }
+
+    if existing_property
+      puts existing_property.props[:value]
+    else
+      fatal_exit("PROPERTY [#{property_name.to_s}] not found")
+    end
+
+  end
+end

data/lib/chef/knife/ovh_cloud_vm_property_set.rb

@@ -0,0 +1,84 @@
+# Author:: Brian Dupras (<bdupras@rallydev.com>)
+# License:: Apache License, Version 2.0
+
+require 'chef/knife'
+require 'chef/knife/base_ovh_cloud_command'
+require 'rbvmomi'
+require 'netaddr'
+
+class Chef::Knife::OvhCloudVmPropertySet < Chef::Knife::BaseOvhCloudCommand
+  banner "knife ovh cloud vm property set VMNAME PROPERTY VALUE.  Sets a vApp Property on VMNAME."
+
+  get_common_options
+
+  option :ovf_environment_transport,
+         :long => "--ovf-environment-transport STRING",
+         :description => "Comma delimited string.  Configures the transports to use for properties. Supported values are: iso and com.vmware.guestInfo."
+
+  def run
+    $stdout.sync = true
+    vmname = @name_args[0]
+    if vmname.nil?
+      show_usage
+      fatal_exit("You must specify a virtual machine name")
+    end
+
+    property_name = @name_args[1]
+    if property_name.nil?
+      show_usage
+      fatal_exit("You must specify a PROPERTY name (e.g. annotation)")
+    end
+    property_name = property_name.to_sym
+
+    property_value = @name_args[2]
+    if property_value.nil?
+      show_usage
+      fatal_exit("You must specify a PROPERTY value")
+    end
+
+    vim = get_vim_connection
+
+    dc = get_datacenter
+    folder = find_folder(get_config(:folder)) || dc.vmFolder
+
+    vm = find_in_folder(folder, RbVmomi::VIM::VirtualMachine, vmname) or
+        abort "VM #{vmname} not found"
+
+    if vm.config.vAppConfig && vm.config.vAppConfig.property
+      existing_property = vm.config.vAppConfig.property.find { |p| p.props[:id] == property_name.to_s  }
+    end
+
+    if existing_property
+      operation = 'edit'
+      property_key = existing_property.props[:key]
+    else
+      operation = 'add'
+      property_key = property_name.object_id
+    end
+
+    vm_config_spec = RbVmomi::VIM.VirtualMachineConfigSpec(
+      :vAppConfig => RbVmomi::VIM.VmConfigSpec(
+        :property => [
+          RbVmomi::VIM.VAppPropertySpec(
+            :operation => operation,
+            :info => {
+              :key => property_key,
+              :id => property_name.to_s,
+              :type => 'string',
+              :userConfigurable => true,
+              :value => property_value
+            }
+          )
+        ]
+      )
+    )
+
+    unless config[:ovf_environment_transport].nil?
+      transport = config[:ovf_environment_transport].split(",")
+      transport = [""] if transport == [] ## because "".split returns [] and vmware wants [""]
+      vm_config_spec[:vAppConfig][:ovfEnvironmentTransport] = transport
+    end
+
+    vm.ReconfigVM_Task( :spec => vm_config_spec ).wait_for_completion
+  end
+end

data/lib/chef/knife/ovh_cloud_vm_query.rb

@@ -0,0 +1,48 @@
+# Author:: Brian Dupras (<bdupras@rallydev.com>)
+# License:: Apache License, Version 2.0
+
+require 'chef/knife'
+require 'chef/knife/base_ovh_cloud_command'
+require 'rbvmomi'
+require 'netaddr'
+
+class Chef::Knife::OvhCloudVmQuery < Chef::Knife::BaseOvhCloudCommand
+  banner "knife ovh cloud query VMNAME QUERY.  See \"http://pubs.vmware.com/vi3/sdk/ReferenceGuide/vim.VirtualMachine.html\" for allowed QUERY values."
+
+  get_common_options
+
+  def run
+    $stdout.sync = true
+    vmname = @name_args[0]
+    if vmname.nil?
+      show_usage
+      fatal_exit("You must specify a virtual machine name")
+    end
+
+    query_string = @name_args[1]
+    if query_string.nil?
+      show_usage
+      fatal_exit("You must specify a QUERY value (e.g. guest.ipAddress or network[0].name)")
+    end
+
+    vim = get_vim_connection
+
+    dc = get_datacenter
+    folder = find_folder(get_config(:folder)) || dc.vmFolder
+
+    vm = traverse_folders_for_vm(folder, vmname) or abort "VM #{vmname} not found"
+
+    # split QUERY by dots, and walk the object model
+    query = query_string.split '.'
+    result = vm
+    query.each do |part|
+      message, index = part.split(/[\[\]]/)
+      unless result.respond_to? message.to_sym
+        fatal_exit("\"#{query_string}\" not recognized.")
+      end
+
+      result = index ? result.send(message)[index.to_i] : result.send(message)
+    end
+    puts result
+  end
+end

data/lib/chef/knife/ovh_cloud_vm_snapshot.rb

@@ -0,0 +1,129 @@
+#
+# License:: Apache License, Version 2.0
+#
+
+require 'chef/knife'
+require 'chef/knife/base_ovh_cloud_command'
+require 'rbvmomi'
+require 'netaddr'
+
+
+# Manage snapshots of a virtual machine
+class Chef::Knife::OvhCloudVmSnapshot < Chef::Knife::BaseOvhCloudCommand
+
+  banner "knife ovh cloud vm snapshot VMNAME (options)"
+
+  get_common_options
+
+  option :list,
+         :long => "--list",
+         :description => "The current tree of snapshots"
+
+  option :create_new_snapshot,
+         :long => "--create SNAPSHOT",
+         :description => "Create a new snapshot off of the current snapshot."
+
+  option :remove_named_snapshot,
+         :long => "--remove SNAPSHOT",
+         :description => "Remove a named snapshot."
+
+  option :revert_snapshot,
+         :long => "--revert SNAPSHOT",
+         :description => "Revert to a named snapshot."
+
+  option :revert_current_snapshot,
+         :long => "--revert-current",
+         :description => "Revert to current snapshot.",
+         :boolean => false
+
+  option :power,
+         :long => "--start",
+         :description => "Indicates whether to start the VM after a successful revert",
+         :boolean => false
+
+  def run
+
+    $stdout.sync = true
+
+    vmname = @name_args[0]
+    if vmname.nil?
+      show_usage
+      ui.fatal("You must specify a virtual machine name")
+      exit 1
+    end
+
+    vim = get_vim_connection
+
+    baseFolder = find_folder(get_config(:folder));
+
+    vm = find_in_folder(baseFolder, RbVmomi::VIM::VirtualMachine, vmname) or
+        abort "VM #{vmname} not found"
+
+    if vm.snapshot
+      snapshot_list = vm.snapshot.rootSnapshotList
+      current_snapshot = vm.snapshot.currentSnapshot
+    end
+
+    if config[:list] && vm.snapshot
+      puts "Current snapshot tree: "
+      puts "#{vmname}"
+      snapshot_list.each { |i| puts display_node(i, current_snapshot) }
+    end
+
+    if config[:create_new_snapshot]
+      vm.CreateSnapshot_Task(:name => config[:create_new_snapshot], :description => "", :memory => false, :quiesce => false)
+    end
+
+    if config[:remove_named_snapshot]
+      ss_name = config[:remove_named_snapshot]
+      snapshot = find_node(snapshot_list, ss_name)
+      puts "Found snapshot #{ss_name} removing."
+      snapshot.RemoveSnapshot_Task(:removeChildren => false)
+    end
+
+    if config[:revert_current_snapshot]
+      puts "Reverting to Current Snapshot"
+      vm.RevertToCurrentSnapshot_Task(:suppressPowerOn => false).wait_for_completion
+      if get_config(:power)
+        vm.PowerOnVM_Task.wait_for_completion
+        puts "Powered on virtual machine #{vmname}"
+      end
+    end
+
+    if config[:revert_snapshot]
+      ss_name = config[:revert_snapshot]
+      snapshot = find_node(snapshot_list, ss_name)
+      snapshot.RevertToSnapshot_Task(:suppressPowerOn => false).wait_for_completion
+      if get_config(:power)
+        vm.PowerOnVM_Task.wait_for_completion
+        puts "Powered on virtual machine #{vmname}"
+      end
+    end
+  end
+
+  def find_node(tree, name)
+    snapshot = nil
+    tree.each do |node|
+      if node.name == name
+        snapshot = node.snapshot
+      elsif !node.childSnapshotList.empty?
+        snapshot = find_node(node.childSnapshotList, name)
+      end
+    end
+    return snapshot
+  end
+
+  def display_node(node, current, shift=1)
+    out = ""
+    out << "+--"*shift
+    if node.snapshot == current
+      out << "#{ui.color(node.name, :cyan)}" << "\n"
+    else
+      out << "#{node.name}" << "\n"
+    end
+    if !node.childSnapshotList.empty?
+      node.childSnapshotList.each { |item| out << display_node(item, current, shift+1) }
+    end
+    out
+  end
+end

data/lib/chef/knife/ovh_cloud_vm_state.rb

@@ -0,0 +1,127 @@
+#
+# Author:: Ezra Pagel (<ezra@cpan.org>)
+# License:: Apache License, Version 2.0
+#
+
+require 'chef/knife'
+require 'chef/knife/base_ovh_cloud_command'
+require 'rbvmomi'
+require 'netaddr'
+
+PsOn = 'poweredOn'
+PsOff = 'poweredOff'
+PsSuspended = 'suspended'
+
+PowerStates = {
+    PsOn => 'powered on',
+    PsOff => 'powered off',
+    PsSuspended => 'suspended'
+}
+
+# Manage power state of a virtual machine
+class Chef::Knife::OvhCloudVmState < Chef::Knife::BaseOvhCloudCommand
+
+  banner "knife ovh cloud vm state VMNAME (options)"
+
+  get_common_options
+
+  option :state,
+         :short => "-s STATE",
+         :long => "--state STATE",
+         :description => "The power state to transition the VM into; one of on|off|suspended"
+
+  option :wait_port,
+         :short => "-w PORT",
+         :long => "--wait-port PORT",
+         :description => "Wait for VM to be accessible on a port"
+
+  option :shutdown,
+         :short => "-g",
+         :long => "--shutdown",
+         :description => "Guest OS shutdown"
+
+  option :recursive,
+         :short => "-r",
+         :long => "--recursive",
+         :description => "Search all folders"
+
+  def run
+
+    $stdout.sync = true
+
+    vmname = @name_args[0]
+    if vmname.nil?
+      show_usage
+      ui.fatal("You must specify a virtual machine name")
+      exit 1
+    end
+
+    vim = get_vim_connection
+
+	if get_config(:recursive)
+	  vms = get_vms(vmname)
+      if vms.length > 1
+	    abort "More than one VM with name #{vmname} found:\n" + vms.map{ |vm| get_path_to_object(vm) }.join("\n")
+	  end
+	  if vms.length == 0
+	    abort "VM #{vmname} not found"
+	  end
+	  vm = vms[0]
+	else
+      baseFolder = find_folder(get_config(:folder));
+
+      vm = find_in_folder(baseFolder, RbVmomi::VIM::VirtualMachine, vmname) or
+        abort "VM #{vmname} not found"
+	end
+
+    state = vm.runtime.powerState
+
+    if config[:state].nil?
+      puts "VM #{vmname} is currently " + PowerStates[vm.runtime.powerState]
+    else
+
+      case config[:state]
+        when 'on'
+          if state == PsOn
+            puts "Virtual machine #{vmname} was already powered on"
+          else
+            vm.PowerOnVM_Task.wait_for_completion
+            puts "Powered on virtual machine #{vmname}"
+          end
+        when 'off'
+          if state == PsOff
+            puts "Virtual machine #{vmname} was already powered off"
+          else
+            if get_config(:shutdown)
+              vm.ShutdownGuest
+              print "Waiting for virtual machine #{vmname} to shut down..."
+              until vm.runtime.powerState == PsOff do
+                sleep 2
+                print "."
+              end
+              puts "done"
+            else
+              vm.PowerOffVM_Task.wait_for_completion
+              puts "Powered off virtual machine #{vmname}"
+            end
+          end
+        when 'suspend'
+          if state == PowerStates['suspended']
+            puts "Virtual machine #{vmname} was already suspended"
+          else
+            vm.SuspendVM_Task.wait_for_completion
+            puts "Suspended virtual machine #{vmname}"
+          end
+        when 'reset'
+          vm.ResetVM_Task.wait_for_completion
+          puts "Reset virtual machine #{vmname}"
+      end
+
+      if get_config(:wait_port)
+        print "Waiting for port #{get_config(:wait_port)}..."
+        print "." until tcp_test_port_vm(vm, get_config(:wait_port))
+        puts "done"
+      end
+    end
+  end
+end

data/lib/chef/knife/ovh_cloud_vm_vmdk_add.rb

@@ -0,0 +1,241 @@
+#
+# Author:: Brian Flad (<bflad417@gmail.com>)
+# License:: Apache License, Version 2.0
+#
+require 'chef/knife'
+require 'chef/knife/base_ovh_cloud_command'
+
+# Lists all known virtual machines in the configured datacenter
+class Chef::Knife::OvhCloudVmVmdkAdd < Chef::Knife::BaseOvhCloudCommand
+
+  banner "knife ovh cloud vm vmdk add"
+
+  get_common_options
+
+  option :vmdk_type,
+         :long => "--vmdk-type TYPE",
+         :description => "Type of VMDK"
+  # this is a bad idea as it will let you overcommit SAN by 400% or more. thick is a more "sane" default
+  $default[:vmdk_type] = "thin"
+
+  option :target_lun,
+         :long => "--target-lun NAME",
+         :description => "name of target LUN"
+
+  def run
+    $stdout.sync = true
+
+    vmname = @name_args[0]
+    if vmname.nil?
+      show_usage
+      ui.fatal("You must specify a virtual machine name")
+      exit 1
+    end
+
+    size = @name_args[1]
+    if size.nil?
+      ui.fatal "You need a VMDK size!"
+      show_usage
+      exit 1
+    end
+
+    vim = get_vim_connection
+    vdm = vim.serviceContent.virtualDiskManager
+    vm = get_vm(vmname)
+    if vm.nil?
+      puts "Could not find #{vmname}"
+      return
+    end
+
+    target_lun = get_config(:target_lun) unless get_config(:target_lun).nil?
+    vmdk_size_kb = size.to_i * 1024 * 1024
+
+    if target_lun.nil?
+      vmdk_datastore = choose_datastore(vm.datastore, size)
+      exit -1 if vmdk_datastore.nil?
+    else
+      vmdk_datastores = find_datastores_regex(target_lun)
+      vmdk_datastore = choose_datastore(vmdk_datastores, size)
+      exit -1 if vmdk_datastore.nil?
+      vmdk_dir = "[#{vmdk_datastore.name}] #{vmname}"
+      # create the vm folder on the LUN or subsequent operations will fail.
+      if not vmdk_datastore.exists? vmname
+        dc = get_datacenter
+        dc._connection.serviceContent.fileManager.MakeDirectory :name => vmdk_dir, :datacenter => dc, :createParentDirectories => false
+      end
+    end
+
+    puts "Choosing: #{vmdk_datastore.name}"
+
+    # now we need to inspect the files in this datastore to get our next file name
+    next_vmdk = 1
+    pc = vmdk_datastore._connection.serviceContent.propertyCollector
+    vms = vmdk_datastore.vm
+    vmFiles = pc.collectMultiple vms, 'layoutEx.file'
+    vmFiles.keys.each do |vm|
+      vmFiles[vm]["layoutEx.file"].each do |layout|
+        if layout.name.match(/^\[#{vmdk_datastore.name}\] #{vmname}\/#{vmname}_([0-9]+).vmdk/)
+          num = $1
+          if next_vmdk <= num.to_i
+            next_vmdk = num.to_i + 1
+          end
+        end
+      end
+    end
+    vmdk_fileName = "#{vmname}/#{vmname}_#{next_vmdk}.vmdk"
+    vmdk_name = "[#{vmdk_datastore.name}] #{vmdk_fileName}"
+    vmdk_type = get_config(:vmdk_type)
+    vmdk_type = "preallocated" if vmdk_type == "thick"
+    puts "Next vmdk name is => #{vmdk_name}"
+
+    # create the disk
+    if not vmdk_datastore.exists? vmdk_fileName
+      vmdk_spec = RbVmomi::VIM::FileBackedVirtualDiskSpec(
+          :adapterType => "lsiLogic",
+          :capacityKb => vmdk_size_kb,
+          :diskType => vmdk_type
+      )
+      ui.info "Creating VMDK"
+      ui.info "#{ui.color "Capacity:", :cyan} #{size} GB"
+      ui.info "#{ui.color "Disk:", :cyan} #{vmdk_name}"
+
+      if get_config(:noop)
+        ui.info "#{ui.color "Skipping disk creation process because --noop specified.", :red}"
+      else
+        vdm.CreateVirtualDisk_Task(
+            :datacenter => get_datacenter,
+            :name => vmdk_name,
+            :spec => vmdk_spec
+        ).wait_for_completion
+      end
+    end
+    ui.info "Attaching VMDK to #{vmname}"
+
+    # now we run through the SCSI controllers to see if there's an available one
+    available_controllers = Array.new()
+    use_controller = nil
+    scsi_tree = Hash.new()
+    vm.config.hardware.device.each do |device|
+      if device.is_a? RbVmomi::VIM::VirtualSCSIController
+        if scsi_tree[device.controllerKey].nil?
+          scsi_tree[device.key]=Hash.new()
+          scsi_tree[device.key]['children'] = Array.new();
+        end
+        scsi_tree[device.key]['device'] = device;
+      end
+      if device.class == RbVmomi::VIM::VirtualDisk
+        if scsi_tree[device.controllerKey].nil?
+          scsi_tree[device.controllerKey]=Hash.new()
+          scsi_tree[device.controllerKey]['children'] = Array.new();
+        end
+        scsi_tree[device.controllerKey]['children'].push(device)
+      end
+    end
+    scsi_tree.keys.sort.each do |controller|
+      if scsi_tree[controller]['children'].length < 15
+        available_controllers.push(scsi_tree[controller]['device'].deviceInfo.label)
+      end
+    end
+
+    if available_controllers.length > 0
+      use_controller = available_controllers[0]
+      puts "using #{use_controller}"
+    else
+
+      if scsi_tree.keys.length < 4
+
+        # Add a controller if none are available
+        puts "no controllers available. Will attempt to create"
+        new_scsi_key = scsi_tree.keys.sort[scsi_tree.length - 1] + 1
+        new_scsi_busNumber = scsi_tree[scsi_tree.keys.sort[scsi_tree.length - 1]]['device'].busNumber + 1
+
+        controller_device = RbVmomi::VIM::VirtualLsiLogicController(
+            :key => new_scsi_key,
+            :busNumber => new_scsi_busNumber,
+            :sharedBus => :noSharing
+        )
+
+        device_config_spec = RbVmomi::VIM::VirtualDeviceConfigSpec(
+            :device => controller_device,
+            :operation => RbVmomi::VIM::VirtualDeviceConfigSpecOperation("add")
+        )
+
+        vm_config_spec = RbVmomi::VIM::VirtualMachineConfigSpec(
+            :deviceChange => [device_config_spec]
+        )
+
+        if get_config(:noop)
+          ui.info "#{ui.color "Skipping controller creation process because --noop specified.", :red}"
+        else
+          vm.ReconfigVM_Task(:spec => vm_config_spec).wait_for_completion
+        end
+      else
+        ui.info "Controllers maxed out at 4."
+        exit -1
+      end
+    end
+
+    # now go back and get the new device's name
+    vm.config.hardware.device.each do |device|
+      if device.class == RbVmomi::VIM::VirtualLsiLogicController
+        if device.key == new_scsi_key
+          use_controller = device.deviceInfo.label
+        end
+      end
+    end
+
+    # add the disk
+    controller = find_device(vm, use_controller)
+
+    used_unitNumbers = Array.new()
+    scsi_tree.keys.sort.each do |c|
+      if controller.key == scsi_tree[c]['device'].key
+        used_unitNumbers.push(scsi_tree[c]['device'].scsiCtlrUnitNumber)
+        scsi_tree[c]['children'].each do |disk|
+          used_unitNumbers.push(disk.unitNumber)
+        end
+      end
+    end
+
+    available_unitNumbers = Array.new
+    (0 .. 15).each do |scsi_id|
+      if used_unitNumbers.grep(scsi_id).length > 0
+      else
+        available_unitNumbers.push(scsi_id)
+      end
+    end
+
+    # ensure we don't try to add the controllers SCSI ID
+    new_unitNumber = available_unitNumbers.sort[0]
+    puts "using SCSI ID #{new_unitNumber}"
+
+    vmdk_backing = RbVmomi::VIM::VirtualDiskFlatVer2BackingInfo(
+        :datastore => vmdk_datastore,
+        :diskMode => "persistent",
+        :fileName => vmdk_name
+    )
+
+    device = RbVmomi::VIM::VirtualDisk(
+        :backing => vmdk_backing,
+        :capacityInKB => vmdk_size_kb,
+        :controllerKey => controller.key,
+        :key => -1,
+        :unitNumber => new_unitNumber
+    )
+
+    device_config_spec = RbVmomi::VIM::VirtualDeviceConfigSpec(
+        :device => device,
+        :operation => RbVmomi::VIM::VirtualDeviceConfigSpecOperation("add")
+    )
+
+    vm_config_spec = RbVmomi::VIM::VirtualMachineConfigSpec(
+        :deviceChange => [device_config_spec]
+    )
+
+    if get_config(:noop)
+      ui.info "#{ui.color "Skipping disk attaching process because --noop specified.", :red}"
+    else
+      vm.ReconfigVM_Task(:spec => vm_config_spec).wait_for_completion
+    end
+  end
+end