Class: Fog::Compute::Vsphere::Real
- Inherits:
-
Object
- Object
- Fog::Compute::Vsphere::Real
- Includes:
- Shared
- Defined in:
- lib/fog/vsphere/compute.rb,
lib/fog/vsphere/requests/compute/vm_clone.rb,
lib/fog/vsphere/requests/compute/create_vm.rb,
lib/fog/vsphere/requests/compute/vm_reboot.rb,
lib/fog/vsphere/requests/compute/get_folder.rb,
lib/fog/vsphere/requests/compute/vm_destroy.rb,
lib/fog/vsphere/requests/compute/vm_migrate.rb,
lib/fog/vsphere/requests/compute/get_cluster.rb,
lib/fog/vsphere/requests/compute/get_network.rb,
lib/fog/vsphere/requests/compute/vm_power_on.rb,
lib/fog/vsphere/requests/compute/current_time.rb,
lib/fog/vsphere/requests/compute/list_folders.rb,
lib/fog/vsphere/requests/compute/vm_power_off.rb,
lib/fog/vsphere/requests/compute/get_datastore.rb,
lib/fog/vsphere/requests/compute/list_clusters.rb,
lib/fog/vsphere/requests/compute/list_networks.rb,
lib/fog/vsphere/requests/compute/vm_config_vnc.rb,
lib/fog/vsphere/requests/compute/get_datacenter.rb,
lib/fog/vsphere/requests/compute/list_datastores.rb,
lib/fog/vsphere/requests/compute/list_vm_volumes.rb,
lib/fog/vsphere/requests/compute/list_datacenters.rb,
lib/fog/vsphere/requests/compute/vm_reconfig_cpus.rb,
lib/fog/vsphere/requests/compute/get_resource_pool.rb,
lib/fog/vsphere/requests/compute/list_vm_interfaces.rb,
lib/fog/vsphere/requests/compute/vm_reconfig_memory.rb,
lib/fog/vsphere/requests/compute/get_virtual_machine.rb,
lib/fog/vsphere/requests/compute/list_resource_pools.rb,
lib/fog/vsphere/requests/compute/vm_reconfig_hardware.rb,
lib/fog/vsphere/requests/compute/list_virtual_machines.rb
Instance Attribute Summary
Attributes included from Shared
#vsphere_is_vcenter, #vsphere_rev, #vsphere_server, #vsphere_username
Instance Method Summary collapse
- #create_vm(attributes = { }) ⇒ Object
- #current_time ⇒ Object
- #get_cluster(name, datacenter_name) ⇒ Object
- #get_datacenter(name) ⇒ Object
- #get_datastore(name, datacenter_name) ⇒ Object
- #get_folder(path, datacenter_name, type = nil) ⇒ Object
- #get_network(name, datacenter_name) ⇒ Object
- #get_resource_pool(name, cluster_name, datacenter_name) ⇒ Object
- #get_virtual_machine(id, datacenter_name = nil) ⇒ Object
-
#initialize(options = {}) ⇒ Real
constructor
A new instance of Real.
- #list_clusters(filters = { }) ⇒ Object
- #list_datacenters(filters = {}) ⇒ Object
- #list_datastores(filters = { }) ⇒ Object
-
#list_folders(filters = { }) ⇒ Object
Grabs all sub folders within a given path folder.
- #list_networks(filters = { }) ⇒ Object
- #list_resource_pools(filters = { }) ⇒ Object
- #list_virtual_machines(options = { }) ⇒ Object
-
#list_vm_interfaces(vm_id) ⇒ Object
> VirtualE1000( addressType: “assigned”, backing: VirtualEthernetCardNetworkBackingInfo( deviceName: “VM Network”, dynamicProperty: [], network: Network(“network-163”), useAutoDetect: false ), connectable: VirtualDeviceConnectInfo( allowGuestControl: true, connected: true, dynamicProperty: [], startConnected: true, status: “ok” ), controllerKey: 100, deviceInfo: Description( dynamicProperty: [], label: “Network adapter 1”, summary: “VM Network” ), dynamicProperty: [], key: 4000, macAddress: “00:50:56:a9:00:28”, unitNumber: 7,.
-
#list_vm_volumes(vm_id) ⇒ Object
- VirtualDisk( backing: VirtualDiskFlatVer2BackingInfo( contentId: “a172d19487e878e17d6b16ff2505d7eb”, datastore: Datastore(“datastore-162”), diskMode: “persistent”, dynamicProperty: [], fileName: “[Storage1
-
rhel6-mfojtik/rhel6-mfojtik.vmdk“, split: false, thinProvisioned: true, uuid: ”6000C29c-a47d-4cd9-5249-c371de775f06“, writeThrough: false ), capacityInKB: 8388608, controllerKey: 1000, deviceInfo: Description( dynamicProperty: [], label: ”Hard disk 1“, summary: ”8,388,608 KB“ ), dynamicProperty: [], key: 2001, shares: SharesInfo( dynamicProperty: [], level: ”normal“, shares: 1000 ), unitNumber: 1 )].
- #raw_clusters(datacenter) ⇒ Object
- #raw_datastores(datacenter_name) ⇒ Object
- #raw_networks(datacenter_name) ⇒ Object
-
#vm_clone(options = {}) ⇒ Object
Clones a VM from a template or existing machine on your vSphere Server.
- #vm_config_vnc(options = { }) ⇒ Object
- #vm_destroy(options = {}) ⇒ Object
-
#vm_get_vnc(uuid) ⇒ Object
return a hash of VNC attributes required to view the console.
- #vm_migrate(options = {}) ⇒ Object
- #vm_power_off(options = {}) ⇒ Object
- #vm_power_on(options = {}) ⇒ Object
- #vm_reboot(options = {}) ⇒ Object
- #vm_reconfig_cpus(options = {}) ⇒ Object
- #vm_reconfig_hardware(options = {}) ⇒ Object
- #vm_reconfig_memory(options = {}) ⇒ Object
Constructor Details
#initialize(options = {}) ⇒ Real
Returns a new instance of Real.
177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 |
# File 'lib/fog/vsphere/compute.rb', line 177 def initialize(={}) require 'rbvmomi' @vsphere_username = [:vsphere_username] @vsphere_password = [:vsphere_password] @vsphere_server = [:vsphere_server] @vsphere_port = [:vsphere_port] || 443 @vsphere_path = [:vsphere_path] || '/sdk' @vsphere_ns = [:vsphere_ns] || 'urn:vim25' @vsphere_rev = [:vsphere_rev] || '4.0' @vsphere_ssl = [:vsphere_ssl] || true @vsphere_expected_pubkey_hash = [:vsphere_expected_pubkey_hash] @vsphere_must_reauthenticate = false @connection = nil # This is a state variable to allow digest validation of the SSL cert bad_cert = false loop do begin @connection = RbVmomi::VIM.new :host => @vsphere_server, :port => @vsphere_port, :path => @vsphere_path, :ns => @vsphere_ns, :rev => @vsphere_rev, :ssl => @vsphere_ssl, :insecure => bad_cert break rescue OpenSSL::SSL::SSLError raise if bad_cert bad_cert = true end end if bad_cert then validate_ssl_connection end # Negotiate the API revision if not [:vsphere_rev] rev = @connection.serviceContent.about.apiVersion @connection.rev = [ rev, ENV['FOG_VSPHERE_REV'] || '4.1' ].min end @vsphere_is_vcenter = @connection.serviceContent.about.apiType == "VirtualCenter" @vsphere_rev = @connection.rev authenticate end |
Instance Method Details
#create_vm(attributes = { }) ⇒ Object
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 |
# File 'lib/fog/vsphere/requests/compute/create_vm.rb', line 5 def create_vm attributes = { } # build up vm configuration vm_cfg = { :name => attributes[:name], :guestId => attributes[:guest_id], :files => { :vmPathName => vm_path_name(attributes) }, :numCPUs => attributes[:cpus], :memoryMB => attributes[:memory_mb], :deviceChange => device_change(attributes), :extraConfig => extra_config(attributes), } resource_pool = if attributes[:resource_pool] get_raw_resource_pool(attributes[:resource_pool], attributes[:cluster], attributes[:datacenter]) else get_raw_cluster(attributes[:cluster], attributes[:datacenter]).resourcePool end vmFolder = get_raw_vmfolder(attributes[:path], attributes[:datacenter]) vm = vmFolder.CreateVM_Task(:config => vm_cfg, :pool => resource_pool).wait_for_completion vm.config.instanceUuid rescue => e raise e, "failed to create vm: #{e}" end |
#current_time ⇒ Object
6 7 8 9 |
# File 'lib/fog/vsphere/requests/compute/current_time.rb', line 6 def current_time current_time = @connection.serviceInstance.CurrentTime { 'current_time' => current_time } end |
#get_cluster(name, datacenter_name) ⇒ Object
5 6 7 8 9 |
# File 'lib/fog/vsphere/requests/compute/get_cluster.rb', line 5 def get_cluster(name, datacenter_name) cluster = get_raw_cluster(name, datacenter_name) raise(Fog::Compute::Vsphere::NotFound) unless cluster cluster_attributes(cluster, datacenter_name) end |
#get_datacenter(name) ⇒ Object
5 6 7 8 9 |
# File 'lib/fog/vsphere/requests/compute/get_datacenter.rb', line 5 def get_datacenter name dc = find_raw_datacenter(name) raise(Fog::Compute::Vsphere::NotFound) unless dc {:name => dc.name, :status => dc.overallStatus} end |
#get_datastore(name, datacenter_name) ⇒ Object
5 6 7 8 9 |
# File 'lib/fog/vsphere/requests/compute/get_datastore.rb', line 5 def get_datastore(name, datacenter_name) datastore = get_raw_datastore(name, datacenter_name) raise(Fog::Compute::Vsphere::NotFound) unless datastore datastore_attributes(datastore, datacenter_name) end |
#get_folder(path, datacenter_name, type = nil) ⇒ Object
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 |
# File 'lib/fog/vsphere/requests/compute/get_folder.rb', line 5 def get_folder(path, datacenter_name, type = nil) type ||= 'vm' # Cycle through all types of folders. case type when 'vm', :vm # if you're a vm then grab the VM. folder = get_raw_vmfolder(path, datacenter_name) raise(Fog::Compute::Vsphere::NotFound) unless folder folder_attributes(folder, datacenter_name) when 'network', :network raise "not implemented" when 'datastore', :datastore raise "not implemented" else raise ArgumentError, "#{type} is unknown" end end |
#get_network(name, datacenter_name) ⇒ Object
5 6 7 8 9 |
# File 'lib/fog/vsphere/requests/compute/get_network.rb', line 5 def get_network(name, datacenter_name) network = get_raw_network(name, datacenter_name) raise(Fog::Compute::Vsphere::NotFound) unless network network_attributes(network, datacenter_name) end |
#get_resource_pool(name, cluster_name, datacenter_name) ⇒ Object
5 6 7 8 9 |
# File 'lib/fog/vsphere/requests/compute/get_resource_pool.rb', line 5 def get_resource_pool(name, cluster_name, datacenter_name) resource_pool = get_raw_resource_pool(name, cluster_name, datacenter_name) raise(Fog::Compute::Vsphere::NotFound) unless resource_pool resource_pool_attributes(resource_pool, cluster_name, datacenter_name) end |
#get_virtual_machine(id, datacenter_name = nil) ⇒ Object
5 6 7 |
# File 'lib/fog/vsphere/requests/compute/get_virtual_machine.rb', line 5 def get_virtual_machine(id, datacenter_name = nil) convert_vm_mob_ref_to_attr_hash(get_vm_ref(id, datacenter_name)) end |
#list_clusters(filters = { }) ⇒ Object
5 6 7 8 9 10 11 |
# File 'lib/fog/vsphere/requests/compute/list_clusters.rb', line 5 def list_clusters(filters = { }) datacenter_name = filters[:datacenter] raw_clusters(datacenter_name).map do |cluster| cluster_attributes(cluster, datacenter_name) end end |
#list_datacenters(filters = {}) ⇒ Object
6 7 8 9 10 11 12 13 14 |
# File 'lib/fog/vsphere/requests/compute/list_datacenters.rb', line 6 def list_datacenters filters = {} raw_datacenters.map do |dc| { :id => managed_obj_id(dc), :name => dc.name, :status => dc.overallStatus } end end |
#list_datastores(filters = { }) ⇒ Object
5 6 7 8 9 10 11 12 13 |
# File 'lib/fog/vsphere/requests/compute/list_datastores.rb', line 5 def list_datastores(filters = { }) datacenter_name = filters[:datacenter] # default to show all datastores only_active = filters[:accessible] || false raw_datastores(datacenter_name).map do |datastore| next if only_active and !datastore.summary.accessible datastore_attributes(datastore, datacenter_name) end.compact end |
#list_folders(filters = { }) ⇒ Object
Grabs all sub folders within a given path folder.
Parameters
-
filters<~Hash>:
-
:datacenter<~String> - REQUIRED Your datacenter where you’re looking for folders. Example: ‘my-datacenter-name’ (passed if you are using the models/collections)
eg: vspconn.datacenters.first.vm_folders('mypath')
-
:path<~String> - Your path where you’re looking for more folders, if return = none you will get an error. If you don’t define it will look in the main datacenter folder for any folders in that datacenter.
-
Example Usage Testing Only:
vspconn = Fog::Compute[:vsphere]
mydc = vspconn.datacenters.first
folders = mydc.vm_folders
23 24 25 26 27 28 29 |
# File 'lib/fog/vsphere/requests/compute/list_folders.rb', line 23 def list_folders(filters = { }) path = filters[:path] || filters['path'] || '' datacenter_name = filters[:datacenter] get_raw_vmfolders(path, datacenter_name).map do |folder| folder_attributes(folder, datacenter_name) end end |
#list_networks(filters = { }) ⇒ Object
5 6 7 8 9 10 11 12 13 |
# File 'lib/fog/vsphere/requests/compute/list_networks.rb', line 5 def list_networks(filters = { }) datacenter_name = filters[:datacenter] # default to show all networks only_active = filters[:accessible] || false raw_networks(datacenter_name).map do |network| next if only_active and !network.summary.accessible network_attributes(network, datacenter_name) end.compact end |
#list_resource_pools(filters = { }) ⇒ Object
5 6 7 8 9 10 11 12 |
# File 'lib/fog/vsphere/requests/compute/list_resource_pools.rb', line 5 def list_resource_pools(filters = { }) datacenter_name = filters[:datacenter] cluster_name = filters[:cluster] cluster = get_raw_cluster(cluster_name, datacenter_name) list_raw_resource_pools(cluster).map do |resource_pool| resource_pool_attributes(resource_pool, cluster_name, datacenter_name) end end |
#list_virtual_machines(options = { }) ⇒ Object
5 6 7 8 9 10 11 12 13 14 15 16 17 18 |
# File 'lib/fog/vsphere/requests/compute/list_virtual_machines.rb', line 5 def list_virtual_machines( = { }) # Listing all VM's can be quite slow and expensive. Try and optimize # based on the available options we have. These conditions are in # ascending order of time to complete for large deployments. [:folder] ||= ['folder'] if ['instance_uuid'] then [connection.get_virtual_machine(['instance_uuid'])] elsif [:folder] && [:datacenter] then list_all_virtual_machines_in_folder([:folder], [:datacenter]) else list_all_virtual_machines() end end |
#list_vm_interfaces(vm_id) ⇒ Object
> VirtualE1000(
addressType: “assigned”, backing: VirtualEthernetCardNetworkBackingInfo(
deviceName: "VM Network",
dynamicProperty: [],
network: Network("network-163"),
useAutoDetect: false
), connectable: VirtualDeviceConnectInfo(
allowGuestControl: true,
connected: true,
dynamicProperty: [],
startConnected: true,
status: "ok"
), controllerKey: 100, deviceInfo: Description(
dynamicProperty: [],
label: "Network adapter 1",
summary: "VM Network"
), dynamicProperty: [], key: 4000, macAddress: “00:50:56:a9:00:28”, unitNumber: 7,
31 32 33 34 35 36 37 38 39 40 41 42 43 |
# File 'lib/fog/vsphere/requests/compute/list_vm_interfaces.rb', line 31 def list_vm_interfaces(vm_id) get_vm_ref(vm_id).config.hardware.device.grep(RbVmomi::VIM::VirtualEthernetCard).map do |nic| { :name => nic.deviceInfo.label, :mac => nic.macAddress, :network => nic.backing.network.name, :status => nic.connectable.status, :summary => nic.deviceInfo.summary, :type => nic.class, } end end |
#list_vm_volumes(vm_id) ⇒ Object
[VirtualDisk(
backing: VirtualDiskFlatVer2BackingInfo(
contentId: "a172d19487e878e17d6b16ff2505d7eb",
datastore: Datastore("datastore-162"),
diskMode: "persistent",
dynamicProperty: [],
fileName: "[Storage1] rhel6-mfojtik/rhel6-mfojtik.vmdk",
split: false,
thinProvisioned: true,
uuid: "6000C29c-a47d-4cd9-5249-c371de775f06",
writeThrough: false
),
capacityInKB: 8388608,
controllerKey: 1000,
deviceInfo: Description(
dynamicProperty: [],
label: "Hard disk 1",
summary: "8,388,608 KB"
),
dynamicProperty: [],
key: 2001,
shares: SharesInfo( dynamicProperty: [], level: "normal", shares: 1000 ),
unitNumber: 1
)]
30 31 32 33 34 35 36 37 38 39 40 41 42 |
# File 'lib/fog/vsphere/requests/compute/list_vm_volumes.rb', line 30 def list_vm_volumes(vm_id) get_vm_ref(vm_id).disks.map do |vol| { :id => vol.backing.uuid, :thin => vol.backing.thinProvisioned, :mode => vol.backing.diskMode, :filename => vol.backing.fileName, :datastore => (vol.backing.datastore.name rescue(nil)), :size => vol.capacityInKB, :name => vol.deviceInfo.label } end end |
#raw_clusters(datacenter) ⇒ Object
13 14 15 |
# File 'lib/fog/vsphere/requests/compute/list_clusters.rb', line 13 def raw_clusters(datacenter) find_raw_datacenter(datacenter).hostFolder.childEntity.grep(RbVmomi::VIM::ClusterComputeResource) end |
#raw_datastores(datacenter_name) ⇒ Object
15 16 17 |
# File 'lib/fog/vsphere/requests/compute/list_datastores.rb', line 15 def raw_datastores(datacenter_name) find_raw_datacenter(datacenter_name).datastore end |
#raw_networks(datacenter_name) ⇒ Object
15 16 17 |
# File 'lib/fog/vsphere/requests/compute/list_networks.rb', line 15 def raw_networks(datacenter_name) find_raw_datacenter(datacenter_name).network end |
#vm_clone(options = {}) ⇒ Object
Clones a VM from a template or existing machine on your vSphere Server.
Parameters
-
options<~Hash>:
-
‘template_path’<~String> - REQUIRED The path to the machine you want to clone FROM. (Example: “/Datacenter/DataCenterNameHere/FolderNameHere/VMNameHere”)
-
‘name’<~String> - REQUIRED The VMName of the Destination
-
‘resource_pool’<~String> - The resource pool on your datacenter cluster you want to use.
-
‘dest_folder’<~String> - Destination Folder of where ‘name’ will be placed on your cluster. *NOT TESTED OR VALIDATED*
-
‘power_on’<~Boolean> - Whether to power on machine after clone. Defaults to true.
-
‘wait’<~Boolean> - Whether the method should wait for the virtual machine to close finish cloning before returning information from vSphere. Returns the value of the machine if it finishes cloning in 150 seconds (1m30s) else it returns nil. ‘wait’ Defaults to nil. Saves a little time.
-
‘transform’<~String> - Not documented - see www.vmware.com/support/developer/vc-sdk/visdk41pubs/ApiReference/vim.vm.RelocateSpec.html
-
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 |
# File 'lib/fog/vsphere/requests/compute/vm_clone.rb', line 56 def vm_clone( = {}) # Option handling = () # Added for people still using options['path'] template_path = ['path'] || ['template_path'] notfound = lambda { raise Fog::Compute::Vsphere::NotFound, "Could not find VM template" } # Find the template in the folder. This is more efficient than # searching ALL VM's looking for the template. # Tap gets rid of the leading empty string and "Datacenters" element # and returns the array. path_elements = template_path.split('/').tap { |ary| ary.shift 2 } # The DC name itself. template_dc = path_elements.shift # If the first path element contains "vm" this denotes the vmFolder # and needs to be shifted out path_elements.shift if path_elements[0] == 'vm' # The template name. The remaining elements are the folders in the # datacenter. template_name = path_elements.pop dc = find_raw_datacenter(template_dc) # Get the VM Folder (Group) efficiently vm_folder = dc.vmFolder # Walk the tree resetting the folder pointer as we go folder = path_elements.inject(vm_folder) do |current_folder, sub_folder_name| # JJM VIM::Folder#find appears to be quite efficient as it uses the # searchIndex It certainly appears to be faster than # VIM::Folder#inventory since that returns _all_ managed objects of # a certain type _and_ their properties. sub_folder = current_folder.find(sub_folder_name, RbVmomi::VIM::Folder) raise ArgumentError, "Could not descend into #{sub_folder_name}. Please check your path." unless sub_folder sub_folder end # Now find the template itself using the efficient find method vm_mob_ref = folder.find(template_name, RbVmomi::VIM::VirtualMachine) # Now find _a_ resource pool to use for the clone if one is not specified if ( .has_key?('resource_pool') ) resource_pool = ['resource_pool'] elsif ( vm_mob_ref.resourcePool == nil ) # If the template is really a template then there is no associated resource pool, # so we need to find one using the template's parent host or cluster esx_host = vm_mob_ref.collect!('runtime.host')['runtime.host'] # The parent of the ESX host itself is a ComputeResource which has a resourcePool resource_pool = esx_host.parent.resourcePool else # If the vm given did return a valid resource pool, default to using it for the clone. # Even if specific pools aren't implemented in this environment, we will still get back # at least the cluster or host we can pass on to the clone task resource_pool = vm_mob_ref.resourcePool end relocation_spec=nil if ( ['linked_clone'] ) # cribbed heavily from the rbvmomi clone_vm.rb # this chunk of code reconfigures the disk of the clone source to be read only, # and then creates a delta disk on top of that, this is required by the API in order to create # linked clondes disks = vm_mob_ref.config.hardware.device.select do |vm_device| vm_device.class == RbVmomi::VIM::VirtualDisk end disks.select{|vm_device| vm_device.backing.parent == nil}.each do |disk| disk_spec = { :deviceChange => [ { :operation => :remove, :device => disk }, { :operation => :add, :fileOperation => :create, :device => disk.dup.tap{|disk_backing| disk_backing.backing = disk_backing.backing.dup; disk_backing.backing.fileName = "[#{disk.backing.datastore.name}]"; disk_backing.backing.parent = disk.backing } }, ] } vm_mob_ref.ReconfigVM_Task(:spec => disk_spec).wait_for_completion end # Next, create a Relocation Spec instance relocation_spec = RbVmomi::VIM.VirtualMachineRelocateSpec(:pool => resource_pool, :diskMoveType => :moveChildMostDiskBacking) else relocation_spec = RbVmomi::VIM.VirtualMachineRelocateSpec(:pool => resource_pool, :transform => ['transform'] || 'sparse') end # And the clone specification clone_spec = RbVmomi::VIM.VirtualMachineCloneSpec(:location => relocation_spec, :powerOn => .has_key?('power_on') ? ['power_on'] : true, :template => false) task = vm_mob_ref.CloneVM_Task(:folder => .has_key?('dest_folder') ? ['dest_folder'] : vm_mob_ref.parent, :name => ['name'], :spec => clone_spec) # Waiting for the VM to complete allows us to get the VirtulMachine # object of the new machine when it's done. It is HIGHLY recommended # to set 'wait' => true if your app wants to wait. Otherwise, you're # going to have to reload the server model over and over which # generates a lot of time consuming API calls to vmware. if ['wait'] then # REVISIT: It would be awesome to call a block passed to this # request to notify the application how far along in the process we # are. I'm thinking of updating a progress bar, etc... new_vm = task.wait_for_completion else tries = 0 new_vm = begin # Try and find the new VM (folder.find is quite efficient) folder.find(['name'], RbVmomi::VIM::VirtualMachine) or raise Fog::Vsphere::Errors::NotFound rescue Fog::Vsphere::Errors::NotFound tries += 1 if tries <= 10 then sleep 15 retry end nil end end # Return hash { 'vm_ref' => new_vm ? new_vm._ref : nil, 'vm_attributes' => new_vm ? convert_vm_mob_ref_to_attr_hash(new_vm) : {}, 'task_ref' => task._ref } end |
#vm_config_vnc(options = { }) ⇒ Object
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 |
# File 'lib/fog/vsphere/requests/compute/vm_config_vnc.rb', line 5 def vm_config_vnc( = { }) raise ArgumentError, "instance_uuid is a required parameter" unless .has_key? 'instance_uuid' search_filter = { :uuid => ['instance_uuid'], 'vmSearch' => true, 'instanceUuid' => true } vm_mob_ref = @connection.searchIndex.FindAllByUuid(search_filter).first task = vm_mob_ref.ReconfigVM_Task(:spec => { :extraConfig => [ { :key => 'RemoteDisplay.vnc.enabled', :value => [:enabled] ? 'true' : 'false' }, { :key => 'RemoteDisplay.vnc.password', :value => [:password].to_s }, { :key => 'RemoteDisplay.vnc.port', :value => [:port].to_s || '5910' } ] }) task.wait_for_completion { 'task_state' => task.info.state } end |
#vm_destroy(options = {}) ⇒ Object
6 7 8 9 10 11 12 13 |
# File 'lib/fog/vsphere/requests/compute/vm_destroy.rb', line 6 def vm_destroy( = {}) raise ArgumentError, "instance_uuid is a required parameter" unless .has_key? 'instance_uuid' vm_mob_ref = get_vm_ref(['instance_uuid']) task = vm_mob_ref.Destroy_Task task.wait_for_completion { 'task_state' => task.info.state } end |
#vm_get_vnc(uuid) ⇒ Object
return a hash of VNC attributes required to view the console
22 23 24 25 26 27 28 29 30 31 |
# File 'lib/fog/vsphere/requests/compute/vm_config_vnc.rb', line 22 def vm_get_vnc uuid search_filter = { :uuid => uuid, 'vmSearch' => true, 'instanceUuid' => true } vm = @connection.searchIndex.FindAllByUuid(search_filter).first Hash[vm.config.extraConfig.map do |config| if config.key =~ /^RemoteDisplay\.vnc\.(\w+)$/ [$1.to_sym, config.value] end end.compact] end |
#vm_migrate(options = {}) ⇒ Object
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 |
# File 'lib/fog/vsphere/requests/compute/vm_migrate.rb', line 6 def vm_migrate( = {}) #priority is the only required option, and it has a sane default option. priority = ['priority'].nil? ? 'defaultPriority' : ["priority"] raise ArgumentError, "instance_uuid is a required parameter" unless .has_key? 'instance_uuid' # Find the VM Object search_filter = { :uuid => ['instance_uuid'], 'vmSearch' => true, 'instanceUuid' => true } vm_mob_ref = @connection.searchIndex.FindAllByUuid(search_filter).first unless vm_mob_ref.kind_of? RbVmomi::VIM::VirtualMachine raise Fog::Vsphere::Errors::NotFound, "Could not find VirtualMachine with instance uuid #{['instance_uuid']}" end task = vm_mob_ref.MigrateVM_Task(:pool => ['pool'], :host => ['host'], :priority => "#{priority}", :state => ['state'] ) task.wait_for_completion { 'task_state' => task.info.state } end |
#vm_power_off(options = {}) ⇒ Object
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 |
# File 'lib/fog/vsphere/requests/compute/vm_power_off.rb', line 6 def vm_power_off( = {}) = { 'force' => false }.merge() raise ArgumentError, "instance_uuid is a required parameter" unless .has_key? 'instance_uuid' search_filter = { :uuid => ['instance_uuid'], 'vmSearch' => true, 'instanceUuid' => true } vm_mob_ref = @connection.searchIndex.FindAllByUuid(search_filter).first if ['force'] then task = vm_mob_ref.PowerOffVM_Task task.wait_for_completion { 'task_state' => task.info.result, 'power_off_type' => 'cut_power' } else vm_mob_ref.ShutdownGuest { 'task_state' => "running", 'power_off_type' => 'shutdown_guest', } end end |
#vm_power_on(options = {}) ⇒ Object
6 7 8 9 10 11 12 13 14 15 16 |
# File 'lib/fog/vsphere/requests/compute/vm_power_on.rb', line 6 def vm_power_on( = {}) raise ArgumentError, "instance_uuid is a required parameter" unless .has_key? 'instance_uuid' search_filter = { :uuid => ['instance_uuid'], 'vmSearch' => true, 'instanceUuid' => true } vm_mob_ref = @connection.searchIndex.FindAllByUuid(search_filter).first task = vm_mob_ref.PowerOnVM_Task task.wait_for_completion # 'success', 'running', 'queued', 'error' { 'task_state' => task.info.state } end |
#vm_reboot(options = {}) ⇒ Object
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 |
# File 'lib/fog/vsphere/requests/compute/vm_reboot.rb', line 6 def vm_reboot( = {}) = { 'force' => false }.merge() raise ArgumentError, "instance_uuid is a required parameter" unless .has_key? 'instance_uuid' search_filter = { :uuid => ['instance_uuid'], 'vmSearch' => true, 'instanceUuid' => true } vm_mob_ref = @connection.searchIndex.FindAllByUuid(search_filter).first if ['force'] then task = vm_mob_ref.ResetVM_Task task.wait_for_completion { 'task_state' => task.info.result, 'reboot_type' => 'reset_power' } else vm_mob_ref.RebootGuest { 'task_state' => "running", 'reboot_type' => 'reboot_guest' } end end |
#vm_reconfig_cpus(options = {}) ⇒ Object
5 6 7 8 9 10 |
# File 'lib/fog/vsphere/requests/compute/vm_reconfig_cpus.rb', line 5 def vm_reconfig_cpus( = {}) raise ArgumentError, "cpus is a required parameter" unless .has_key? 'cpus' raise ArgumentError, "instance_uuid is a required parameter" unless .has_key? 'instance_uuid' hardware_spec={'numCPUs' => ['cpus']} vm_reconfig_hardware('instance_uuid' => ['instance_uuid'], 'hardware_spec' => hardware_spec ) end |
#vm_reconfig_hardware(options = {}) ⇒ Object
5 6 7 8 9 10 11 12 |
# File 'lib/fog/vsphere/requests/compute/vm_reconfig_hardware.rb', line 5 def vm_reconfig_hardware( = {}) raise ArgumentError, "hardware_spec is a required parameter" unless .has_key? 'hardware_spec' raise ArgumentError, "instance_uuid is a required parameter" unless .has_key? 'instance_uuid' vm_mob_ref = get_vm_by_ref(['instance_uuid']) task = vm_mob_ref.ReconfigVM_Task(:spec => RbVmomi::VIM.VirtualMachineConfigSpec(['hardware_spec'])) task.wait_for_completion { 'task_state' => task.info.state } end |
#vm_reconfig_memory(options = {}) ⇒ Object
5 6 7 8 9 10 |
# File 'lib/fog/vsphere/requests/compute/vm_reconfig_memory.rb', line 5 def vm_reconfig_memory( = {}) raise ArgumentError, "memory is a required parameter" unless .has_key? 'memory' raise ArgumentError, "instance_uuid is a required parameter" unless .has_key? 'instance_uuid' hardware_spec={'memoryMB' => ['memory']} vm_reconfig_hardware('instance_uuid' => ['instance_uuid'], 'hardware_spec' => hardware_spec ) end |