knife-vsphere 1.0.1 → 1.2.0

data/lib/chef/knife/vsphere_vm_markastemplate.rb

@@ -1,54 +1,48 @@
-#
-# Author:: Ezra Pagel (<ezra@cpan.org>)
-# Contributor:: Jesse Campbell (<hikeit@gmail.com>)
-# Contributor:: Bethany Erskine (<bethany@paperlesspost.com>)
-# Contributor:: Adrian Stanila (https://github.com/sacx)
-# License:: Apache License, Version 2.0
-#
-
-require 'chef/knife'
-require 'chef/knife/base_vsphere_command'
-require 'rbvmomi'
-
-# Clone an existing template into a new VM, optionally applying a customization specification.
-# usage:
-# knife vsphere vm markastemplate MyVM --folder /templates
-class Chef::Knife::VsphereVmMarkastemplate < Chef::Knife::BaseVsphereCommand
-
-  banner "knife vsphere vm markastemplate VMNAME"
-
-  get_common_options
-
-  option :folder,
-         :long => "--folder FOLDER",
-         :description => "The folder which contains the VM"
-
-  def run
-    $stdout.sync = true
-
-    vmname = @name_args[0]
-    if vmname.nil?
-      show_usage
-      fatal_exit("You must specify a virtual machine name")
-    end
-    config[:chef_node_name] = vmname unless config[:chef_node_name]
-    config[:vmname] = vmname
-
-    if get_config(:bootstrap) && get_config(:distro) && !@@chef_config_dir
-      fatal_exit("Can't find .chef for bootstrap files. chdir to a location with a .chef directory and try again")
-    end
-
-    vim = get_vim_connection
-
-    dc = get_datacenter
-
-    src_folder = find_folder(get_config(:folder)) || dc.vmFolder
-
-    vm = find_in_folder(src_folder, RbVmomi::VIM::VirtualMachine, config[:vmname]) or
-        abort "VM not found"
-
-    puts "Marking VM #{vmname} as template"
-    vm.MarkAsTemplate()
-    puts "Finished marking VM #{vmname} as template"
-  end
-end
+#
+# Author:: Ezra Pagel (<ezra@cpan.org>)
+# Contributor:: Jesse Campbell (<hikeit@gmail.com>)
+# Contributor:: Bethany Erskine (<bethany@paperlesspost.com>)
+# Contributor:: Adrian Stanila (https://github.com/sacx)
+# License:: Apache License, Version 2.0
+#
+
+require 'chef/knife'
+require 'chef/knife/base_vsphere_command'
+require 'rbvmomi'
+
+# Clone an existing template into a new VM, optionally applying a customization specification.
+# usage:
+# knife vsphere vm markastemplate MyVM --folder /templates
+class Chef::Knife::VsphereVmMarkastemplate < Chef::Knife::BaseVsphereCommand
+  banner 'knife vsphere vm markastemplate VMNAME'
+
+  common_options
+
+  option :folder,
+         long: '--folder FOLDER',
+         description: 'The folder which contains the VM'
+
+  def run
+    $stdout.sync = true
+
+    vmname = @name_args[0]
+    if vmname.nil?
+      show_usage
+      fatal_exit('You must specify a virtual machine name')
+    end
+    config[:chef_node_name] = vmname unless config[:chef_node_name]
+    config[:vmname] = vmname
+
+    vim_connection
+
+    dc = datacenter
+
+    src_folder = find_folder(get_config(:folder)) || dc.vmFolder
+
+    vm = find_in_folder(src_folder, RbVmomi::VIM::VirtualMachine, config[:vmname]) || abort('VM not found')
+
+    puts "Marking VM #{vmname} as template"
+    vm.MarkAsTemplate()
+    puts "Finished marking VM #{vmname} as template"
+  end
+end

data/lib/chef/knife/vsphere_vm_migrate.rb

@@ -0,0 +1,73 @@
+#
+# Author:: Raducu Deaconu (<rhadoo_io@yahoo.com>)
+# License:: Apache License, Version 2.0
+#
+require 'chef/knife'
+require 'chef/knife/base_vsphere_command'
+
+# migrate vm to specified resource pool , datastore and host
+class Chef::Knife::VsphereVmMigrate < Chef::Knife::BaseVsphereCommand
+  # migrate --resource-pool --dest-host --dest-datastore
+  banner 'knife vsphere vm migrate (options)'
+
+  common_options
+
+  option :dest_host,
+         long: '--dest-host HOST',
+         description: 'Destination host for the VM or template'
+
+  option :dest_datastore,
+         long: '--dest-datastore DATASTORE',
+         description: 'The destination datastore'
+
+  option :priority,
+         long: '--priority PRIORITY',
+         description: 'migration priority'
+
+  option :resource_pool,
+         long: '--resource-pool POOL',
+         description: 'The resource pool into which to put the VM'
+
+  def traverse_folders_for_pool(folder, poolname)
+    children = folder.children.find_all
+    children.each do |child|
+      if child.class == RbVmomi::VIM::ClusterComputeResource || child.class == RbVmomi::VIM::ComputeResource || child.class == RbVmomi::VIM::ResourcePool
+        return child if child.name == poolname
+      elsif child.class == RbVmomi::VIM::Folder
+        pool = traverse_folders_for_pool(child, poolname)
+        return pool if pool
+      end
+    end
+    false
+  end
+
+  def find_host_folder(folder, _type, name)
+    folder.host.find { |o| o.name == name }
+  end
+
+  def run
+    $stdout.sync = true
+    vmname = @name_args[0]
+    if vmname.nil?
+      show_usage
+      fatal_exit('You must specify a virtual machine name')
+    end
+
+    vim_connection
+    dc = datacenter
+    folder = find_folder(get_config(:folder)) || dc.vmFolder
+
+    vm = find_in_folder(folder, RbVmomi::VIM::VirtualMachine, vmname) || abort("VM #{vmname} not found")
+
+    priority = config[:priority]
+    dest_host = config[:dest_host]
+    ndc = find_datastore(config[:dest_datastore]) || abort('dest-datastore not found')
+    npool = find_pool(config[:resource_pool])
+    folderd = dc.hostFolder
+    pool = traverse_folders_for_pool(folderd, config[:resource_pool]) || abort("Pool #{poolname} not found")
+    h = find_host_folder(pool, RbVmomi::VIM::HostSystem, dest_host)
+    migrate_spec = RbVmomi::VIM.VirtualMachineRelocateSpec(datastore: ndc, pool: npool, host: h)
+    # puts migrate_spec.host.name
+    vm.RelocateVM_Task(spec: migrate_spec, priority: priority).wait_for_completion
+  end
+end

data/lib/chef/knife/vsphere_vm_move.rb

@@ -0,0 +1,88 @@
+#
+# Author:: Brian Dupras (<bdupras@rallydev.com>)
+# License:: Apache License, Version 2.0
+#
+require 'chef/knife'
+require 'chef/knife/base_vsphere_command'
+
+# Lists all known virtual machines in the configured datacenter
+class Chef::Knife::VsphereVmMove < Chef::Knife::BaseVsphereCommand
+  banner 'knife vsphere vm move'
+
+  common_options
+
+  option :dest_name,
+         long: '--dest-name NAME',
+         short: '-r',
+         description: 'Destination name of the VM or template'
+
+  option :dest_folder,
+         long: '--dest-folder FOLDER',
+         description: 'The destination folder into which the VM or template should be moved'
+
+  option :datastore,
+         long: '--datastore STORE',
+         description: 'The datastore into which to put the cloned VM'
+
+  option :thin_provision,
+         long: '--thin-provision',
+         description: 'Indicates whether disk should be thin provisioned.',
+         boolean: true
+
+  option :thick_provision,
+         long: '--thick-provision',
+         description: 'Indicates whether disk should be thick provisioned.',
+         boolean: true
+
+  # Convert VM
+  def convert_vm(vm)
+    dc = datacenter
+    hosts = find_all_in_folder(dc.hostFolder, RbVmomi::VIM::ComputeResource)
+    rp = hosts.first.resourcePool
+    rspec = RbVmomi::VIM.VirtualMachineRelocateSpec(pool: rp)
+
+    if get_config(:thin_provision)
+      puts "Thin provsisioning #{vm.name}"
+      rspec = RbVmomi::VIM.VirtualMachineRelocateSpec(datastore: find_datastore(get_config(:datastore)), transform: :sparse)
+    end
+
+    if get_config(:thick_provision)
+      puts "Thick provsisioning #{vm.name}"
+      rspec = RbVmomi::VIM.VirtualMachineRelocateSpec(datastore: find_datastore(get_config(:datastore)), transform: :flat)
+    end
+
+    task = vm.RelocateVM_Task(spec: rspec)
+    task.wait_for_completion
+  end
+
+  # Move VM
+  def move_vm(vm)
+    dest_name = config[:dest_name] || vmname
+    dest_folder = config[:dest_folder].nil? ? (vm.parent) : (find_folder(get_config(:dest_folder)))
+
+    vm.Rename_Task(newName: dest_name).wait_for_completion unless vmname == dest_name
+    dest_folder.MoveIntoFolder_Task(list: [vm]).wait_for_completion unless folder == dest_folder
+  end
+
+  def run
+    $stdout.sync = true
+    vmname = @name_args[0]
+    if vmname.nil?
+      show_usage
+      fatal_exit('You must specify a virtual machine name')
+    end
+
+    vim = vim_connection
+    dcname = get_config(:vsphere_dc)
+    dc = vim.serviceInstance.find_datacenter(dcname) || abort('datacenter not found')
+    folder = find_folder(get_config(:folder)) || dc.vmFolder
+
+    vm = find_in_folder(folder, RbVmomi::VIM::VirtualMachine, vmname) || abort("VM #{vmname} not found")
+
+    if get_config(:thin_provision) || get_config(:thick_provision)
+      convert_vm(vm)
+    else
+      move_vm(vm)
+    end
+  end
+end

data/lib/chef/knife/vsphere_vm_net.rb

@@ -0,0 +1,57 @@
+#
+# Author:: Raducu Deaconu (<rhadoo_io@yahoo.com>)
+# License:: Apache License, Version 2.0
+#
+require 'chef/knife'
+require 'chef/knife/base_vsphere_command'
+# Switch VM networking state up/down (on all network interfaces)
+class Chef::Knife::VsphereVmNet < Chef::Knife::BaseVsphereCommand
+  banner 'knife vsphere vm net STATE VMNAME'
+  common_options
+  def run
+    $stdout.sync = true
+    vmname = @name_args[1]
+    if vmname.nil?
+      show_usage
+      fatal_exit('You must specify a virtual machine name')
+    end
+
+    state = @name_args[0]
+    if state.nil?
+      show_usage
+      fatal_exit('You must specify networking state up/down')
+    end
+
+    if state == 'up'
+      if_state = true
+    elsif state == 'down'
+      if_state = false
+    end
+    vim_connection
+    dc = datacenter
+    folder = find_folder(get_config(:folder)) || dc.vmFolder
+    vm = find_in_folder(folder, RbVmomi::VIM::VirtualMachine, vmname) ||
+         abort("VM #{vmname} not found")
+    vm.config.hardware.device.each.grep(RbVmomi::VIM::VirtualEthernetCard) do |a|
+      backing = a.backing
+      key = a.key
+
+      puts "#{ui.color('Setting network adapter', :cyan)} :#{a.deviceInfo.label} on vlan :#{a.deviceInfo.summary} :#{state}"
+
+      conninfo = RbVmomi::VIM.VirtualDeviceConnectInfo(startConnected: true,
+                                                       allowGuestControl: true,
+                                                       connected: if_state)
+
+      ndevice = RbVmomi::VIM.VirtualE1000(key: key,
+                                          backing: backing,
+                                          connectable: conninfo)
+
+      device_spec = RbVmomi::VIM.VirtualDeviceConfigSpec(operation: :edit,
+                                                         device: ndevice)
+
+      vmspec = RbVmomi::VIM.VirtualMachineConfigSpec(deviceChange: [device_spec])
+
+      vm.ReconfigVM_Task(spec: vmspec).wait_for_completion
+    end
+  end
+end

data/lib/chef/knife/vsphere_vm_property_get.rb

@@ -1,46 +1,44 @@
-# Author:: Brian Dupras (<bdupras@rallydev.com>)
-# License:: Apache License, Version 2.0
-
-require 'chef/knife'
-require 'chef/knife/base_vsphere_command'
-require 'rbvmomi'
-require 'netaddr'
-
-class Chef::Knife::VsphereVmPropertyGet < Chef::Knife::BaseVsphereCommand
-  banner "knife vsphere 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
+# Author:: Brian Dupras (<bdupras@rallydev.com>)
+# License:: Apache License, Version 2.0
+
+require 'chef/knife'
+require 'chef/knife/base_vsphere_command'
+require 'rbvmomi'
+require 'netaddr'
+
+class Chef::Knife::VsphereVmPropertyGet < Chef::Knife::BaseVsphereCommand
+  banner 'knife vsphere vm property get VMNAME PROPERTY.  Gets a vApp Property on VMNAME.'
+
+  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_connection
+
+    dc = datacenter
+    folder = find_folder(get_config(:folder)) || dc.vmFolder
+
+    vm = find_in_folder(folder, RbVmomi::VIM::VirtualMachine, vmname) || 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}] not found")
+    end
+  end
+end

data/lib/chef/knife/vsphere_vm_property_set.rb

@@ -1,84 +1,83 @@
-# Author:: Brian Dupras (<bdupras@rallydev.com>)
-# License:: Apache License, Version 2.0
-
-require 'chef/knife'
-require 'chef/knife/base_vsphere_command'
-require 'rbvmomi'
-require 'netaddr'
-
-class Chef::Knife::VsphereVmPropertySet < Chef::Knife::BaseVsphereCommand
-  banner "knife vsphere 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
+# Author:: Brian Dupras (<bdupras@rallydev.com>)
+# License:: Apache License, Version 2.0
+
+require 'chef/knife'
+require 'chef/knife/base_vsphere_command'
+require 'rbvmomi'
+require 'netaddr'
+
+class Chef::Knife::VsphereVmPropertySet < Chef::Knife::BaseVsphereCommand
+  banner 'knife vsphere vm property set VMNAME PROPERTY VALUE.  Sets a vApp Property on VMNAME.'
+
+  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_connection
+
+    dc = datacenter
+    folder = find_folder(get_config(:folder)) || dc.vmFolder
+
+    vm = find_in_folder(folder, RbVmomi::VIM::VirtualMachine, vmname) || 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