Class: Chef::Knife::BaseVsphereCommand
- Inherits:
-
Chef::Knife
- Object
- Chef::Knife
- Chef::Knife::BaseVsphereCommand
- Defined in:
- lib/chef/knife/base_vsphere_command.rb
Direct Known Subclasses
VsphereClusterList, VsphereCpuRatio, VsphereCustomizationList, VsphereDatastoreFile, VsphereDatastoreList, VsphereDatastoreMaxfree, VsphereDatastoreclusterList, VsphereDatastoreclusterMaxfree, VsphereFolderList, VsphereHostsList, VspherePoolList, VspherePoolQuery, VspherePoolShow, VsphereTemplateList, VsphereVlanCreate, VsphereVlanList, VsphereVmCdrom, VsphereVmClone, VsphereVmConfig, VsphereVmDelete, VsphereVmDiskExtend, VsphereVmDiskList, VsphereVmExecute, VsphereVmFind, VsphereVmList, VsphereVmMarkastemplate, VsphereVmMigrate, VsphereVmMove, VsphereVmNet, VsphereVmNetworkAdd, VsphereVmNetworkDelete, VsphereVmNetworkList, VsphereVmNetworkSet, VsphereVmPropertyGet, VsphereVmPropertySet, VsphereVmQuery, VsphereVmShow, VsphereVmSnapshot, VsphereVmState, VsphereVmToolsconfig, VsphereVmVmdkAdd, VsphereVmVncset, VsphereVmWaitSysprep
Class Method Summary collapse
Instance Method Summary collapse
- #choose_datastore(dstores, size) ⇒ Object
- #conn_opts ⇒ Object
- #datacenter ⇒ Object
- #fatal_exit(msg) ⇒ Object
- #find_all_in_folder(folder, type) ⇒ Object
- #find_datastore(dsName) ⇒ Object
- #find_datastorecluster(dsName, folder = nil) ⇒ Object
- #find_datastores_regex(regex) ⇒ Object
- #find_device(vm, deviceName) ⇒ Object
- #find_folder(folderName) ⇒ Object
- #find_in_folder(folder, type, name) ⇒ Object
- #find_network(networkName) ⇒ Object
- #find_pool(poolName) ⇒ Object
- #find_pools_and_clusters(folder, poolname = nil) ⇒ Object
- #get_config(key) ⇒ Object
- #get_password_from_stdin ⇒ Object
- #get_path_to_object(object) ⇒ Object
- #get_vm(vmname) ⇒ Object
- #get_vms(vmname) ⇒ Object
- #linux?(config) ⇒ Boolean
- #number_to_human_size(number) ⇒ Object
- #password ⇒ Object
- #tcp_test_port(hostname, port) ⇒ Object
- #tcp_test_port_vm(vm, port) ⇒ Object
- #traverse_folders_for_computeresources(folder) ⇒ Object
- #traverse_folders_for_dc(folder, dcname) ⇒ Object
- #traverse_folders_for_pools(folder) ⇒ Object
- #traverse_folders_for_vm(folder, vmname) ⇒ Object
- #traverse_folders_for_vms(folder, vmname) ⇒ Object
- #vim_connection ⇒ Object
- #windows?(config) ⇒ Boolean
Methods inherited from Chef::Knife
Class Method Details
.common_options ⇒ Object
30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 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 |
# File 'lib/chef/knife/base_vsphere_command.rb', line 30 def self. option :vsphere_user, short: '-u USERNAME', long: '--vsuser USERNAME', description: 'The username for vsphere' option :vsphere_pass, short: '-p PASSWORD', long: '--vspass PASSWORD', description: 'The password for vsphere' option :vsphere_host, long: '--vshost HOST', description: 'The vsphere host' option :vsphere_dc, short: '-D DATACENTER', long: '--vsdc DATACENTER', description: 'The Datacenter for vsphere' option :vsphere_path, long: '--vspath SOAP_PATH', description: 'The vsphere SOAP endpoint path', default: '/sdk' option :vsphere_port, long: '--vsport PORT', description: 'The VI SDK port number to use', default: '443' option :vsphere_nossl, long: '--vsnossl', description: 'Disable SSL connectivity' option :vsphere_insecure, long: '--vsinsecure', description: 'Disable SSL certificate verification' option :folder, short: '-f FOLDER', long: '--folder FOLDER', description: 'The folder to get VMs from', default: '' option :proxy_host, long: '--proxyhost PROXY_HOSTNAME', description: 'Proxy hostname' option :proxy_port, long: '--proxyport PROXY_PORT', description: 'Proxy port' end |
Instance Method Details
#choose_datastore(dstores, size) ⇒ Object
256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 |
# File 'lib/chef/knife/base_vsphere_command.rb', line 256 def choose_datastore(dstores, size) vmdk_size_b = size.to_i * 1024 * 1024 * 1024 candidates = [] dstores.each do |store| avail = number_to_human_size(store.summary[:freeSpace]) cap = number_to_human_size(store.summary[:capacity]) puts "#{ui.color('Datastore', :cyan)}: #{store.name} (#{avail}(#{store.summary[:freeSpace]}) / #{cap})" # vm's can span multiple datastores, so instead of grabbing the first one # let's find the first datastore with the available space on a LUN the vm # is already using, or use a specified LUN (if given) next unless (store.summary[:freeSpace] - vmdk_size_b) > 0 # also let's not use more than 90% of total space to save room for snapshots. cap_remains = 100 * ((store.summary[:freeSpace].to_f - vmdk_size_b.to_f) / store.summary[:capacity].to_f) candidates.push(store) if cap_remains.to_i > 10 end if candidates.length > 0 vmdk_datastore = candidates[0] else puts 'Insufficient space on all LUNs designated or assigned to the virtual machine. Please specify a new target.' vmdk_datastore = nil end vmdk_datastore end |
#conn_opts ⇒ Object
102 103 104 105 106 107 108 109 110 111 112 113 114 |
# File 'lib/chef/knife/base_vsphere_command.rb', line 102 def conn_opts { host: get_config(:vsphere_host), path: get_config(:vsphere_path), port: get_config(:vsphere_port), use_ssl: !get_config(:vsphere_nossl), user: get_config(:vsphere_user), password: password, insecure: get_config(:vsphere_insecure), proxyHost: get_config(:proxy_host), proxyPort: get_config(:proxy_port) } end |
#datacenter ⇒ Object
208 209 210 211 |
# File 'lib/chef/knife/base_vsphere_command.rb', line 208 def datacenter dcname = get_config(:vsphere_dc) traverse_folders_for_dc(vim_connection.rootFolder, dcname) || abort('datacenter not found') end |
#fatal_exit(msg) ⇒ Object
371 372 373 374 |
# File 'lib/chef/knife/base_vsphere_command.rb', line 371 def fatal_exit(msg) ui.fatal(msg) exit 1 end |
#find_all_in_folder(folder, type) ⇒ Object
340 341 342 343 344 345 346 347 348 349 350 351 352 |
# File 'lib/chef/knife/base_vsphere_command.rb', line 340 def find_all_in_folder(folder, type) if folder.instance_of?(RbVmomi::VIM::ClusterComputeResource) || folder.instance_of?(RbVmomi::VIM::ComputeResource) folder = folder.resourcePool end if folder.instance_of?(RbVmomi::VIM::ResourcePool) folder.resourcePool.grep(type) elsif folder.instance_of?(RbVmomi::VIM::Folder) folder.childEntity.grep(type) else puts "Unknown type #{folder.class}, not enumerating" nil end end |
#find_datastore(dsName) ⇒ Object
294 295 296 297 298 |
# File 'lib/chef/knife/base_vsphere_command.rb', line 294 def find_datastore(dsName) dc = datacenter base_entity = dc.datastore base_entity.find { |f| f.info.name == dsName } || abort("no such datastore #{dsName}") end |
#find_datastorecluster(dsName, folder = nil) ⇒ Object
300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 |
# File 'lib/chef/knife/base_vsphere_command.rb', line 300 def find_datastorecluster(dsName, folder = nil) unless folder dc = datacenter folder = dc.datastoreFolder end folder.childEntity.each do |child| if child.class.to_s == 'Folder' ds = find_datastorecluster(dsName, child) return ds if ds elsif child.class.to_s == 'StoragePod' && child.name == dsName return child end end nil end |
#find_datastores_regex(regex) ⇒ Object
283 284 285 286 287 288 289 290 291 292 |
# File 'lib/chef/knife/base_vsphere_command.rb', line 283 def find_datastores_regex(regex) stores = [] puts "Looking for all datastores that match /#{regex}/" dc = datacenter base_entity = dc.datastore base_entity.each do |ds| stores.push ds if ds.name.match(/#{regex}/) end stores end |
#find_device(vm, deviceName) ⇒ Object
333 334 335 336 337 338 |
# File 'lib/chef/knife/base_vsphere_command.rb', line 333 def find_device(vm, deviceName) vm.config.hardware.device.each do |device| return device if device.deviceInfo.label == deviceName end nil end |
#find_folder(folderName) ⇒ Object
213 214 215 216 217 218 219 220 221 222 223 224 |
# File 'lib/chef/knife/base_vsphere_command.rb', line 213 def find_folder(folderName) dc = datacenter base_entity = dc.vmFolder entity_array = folderName.split('/') entity_array.each do |entityArrItem| if entityArrItem != '' base_entity = base_entity.childEntity.grep(RbVmomi::VIM::Folder).find { |f| f.name == entityArrItem } || abort("no such folder #{folderName} while looking for #{entityArrItem}") end end base_entity end |
#find_in_folder(folder, type, name) ⇒ Object
367 368 369 |
# File 'lib/chef/knife/base_vsphere_command.rb', line 367 def find_in_folder(folder, type, name) folder.childEntity.grep(type).find { |o| o.name == name } end |
#find_network(networkName) ⇒ Object
226 227 228 229 230 |
# File 'lib/chef/knife/base_vsphere_command.rb', line 226 def find_network(networkName) dc = datacenter base_entity = dc.network base_entity.find { |f| f.name == networkName } || abort("no such network #{networkName}") end |
#find_pool(poolName) ⇒ Object
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 |
# File 'lib/chef/knife/base_vsphere_command.rb', line 232 def find_pool(poolName) dc = datacenter base_entity = dc.hostFolder entity_array = poolName.split('/') entity_array.each do |entityArrItem| next if entityArrItem == '' if base_entity.is_a? RbVmomi::VIM::Folder base_entity = base_entity.childEntity.find { |f| f.name == entityArrItem } || abort("no such pool #{poolName} while looking for #{entityArrItem}") elsif base_entity.is_a?(RbVmomi::VIM::ClusterComputeResource) || base_entity.is_a?(RbVmomi::VIM::ComputeResource) base_entity = base_entity.resourcePool.resourcePool.find { |f| f.name == entityArrItem } || abort("no such pool #{poolName} while looking for #{entityArrItem}") elsif base_entity.is_a? RbVmomi::VIM::ResourcePool base_entity = base_entity.resourcePool.find { |f| f.name == entityArrItem } || abort("no such pool #{poolName} while looking for #{entityArrItem}") else abort "Unexpected Object type encountered #{base_entity.type} while finding resourcePool" end end base_entity = base_entity.resourcePool if !base_entity.is_a?(RbVmomi::VIM::ResourcePool) && base_entity.respond_to?(:resourcePool) base_entity end |
#find_pools_and_clusters(folder, poolname = nil) ⇒ Object
201 202 203 204 205 206 |
# File 'lib/chef/knife/base_vsphere_command.rb', line 201 def find_pools_and_clusters(folder, poolname = nil) pools = traverse_folders_for_pools(folder) clusters = traverse_folders_for_computeresources(folder) cluster_pool = clusters + pools poolname.nil? ? cluster_pool : cluster_pool.select { |p| p.name == poolname } end |
#get_config(key) ⇒ Object
83 84 85 86 87 88 |
# File 'lib/chef/knife/base_vsphere_command.rb', line 83 def get_config(key) key = key.to_sym rval = config[key].nil? ? Chef::Config[:knife][key] : config[key] Chef::Log.debug("value for config item #{key}: #{rval}") rval end |
#get_password_from_stdin ⇒ Object
120 121 122 |
# File 'lib/chef/knife/base_vsphere_command.rb', line 120 def get_password_from_stdin @password ||= ui.ask('Enter your password: ') { |q| q.echo = false } end |
#get_path_to_object(object) ⇒ Object
354 355 356 357 358 359 360 361 362 363 364 365 |
# File 'lib/chef/knife/base_vsphere_command.rb', line 354 def get_path_to_object(object) if object.is_a?(RbVmomi::VIM:: ManagedEntity) if object.parent.is_a?(RbVmomi::VIM:: ManagedEntity) return get_path_to_object(object.parent) + '/' + object.parent.name else return '' end else puts "Unknown type #{object.class}, not enumerating" nil end end |
#get_vm(vmname) ⇒ Object
124 125 126 127 128 |
# File 'lib/chef/knife/base_vsphere_command.rb', line 124 def get_vm(vmname) vim_connection base_folder = find_folder(get_config(:folder)) traverse_folders_for_vm(base_folder, vmname) end |
#get_vms(vmname) ⇒ Object
130 131 132 133 134 |
# File 'lib/chef/knife/base_vsphere_command.rb', line 130 def get_vms(vmname) vim_connection base_folder = find_folder(get_config(:folder)) traverse_folders_for_vms(base_folder, vmname) end |
#linux?(config) ⇒ Boolean
414 415 416 417 418 419 420 421 |
# File 'lib/chef/knife/base_vsphere_command.rb', line 414 def linux?(config) gid = config.guestId.downcase # This makes the assumption that if it isn't mac or windows it's linux # See https://www.vmware.com/support/developer/vc-sdk/visdk25pubs/ReferenceGuide/vim.vm.GuestOsDescriptor.GuestOsIdentifier.html for values is_linux_bool = !gid.include?('windows') && !gid.include?('darwin') Chef::Log.debug('Identified os as linux.') if is_linux_bool is_linux_bool end |
#number_to_human_size(number) ⇒ Object
316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 |
# File 'lib/chef/knife/base_vsphere_command.rb', line 316 def number_to_human_size(number) number = number.to_f storage_units_fmt = %w(byte kB MB GB TB) base = 1024 if number.to_i < base unit = storage_units_fmt[0] else max_exp = storage_units_fmt.size - 1 exponent = (Math.log(number) / Math.log(base)).to_i # Convert to base exponent = max_exp if exponent > max_exp # we need this to avoid overflow for the highest unit number /= base**exponent unit = storage_units_fmt[exponent] end format('%0.2f %s', number, unit) end |
#password ⇒ Object
90 91 92 93 94 95 96 97 98 99 100 |
# File 'lib/chef/knife/base_vsphere_command.rb', line 90 def password if !get_config(:vsphere_pass) # Password is not in the config file - grab it # from the command line get_password_from_stdin elsif get_config(:vsphere_pass).start_with?('base64:') Base64.decode64(get_config(:vsphere_pass)[7..-1]).chomp else get_config(:vsphere_pass) end end |
#tcp_test_port(hostname, port) ⇒ Object
385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 |
# File 'lib/chef/knife/base_vsphere_command.rb', line 385 def tcp_test_port(hostname, port) tcp_socket = TCPSocket.new(hostname, port) readable = IO.select([tcp_socket], nil, nil, 5) if readable Chef::Log.debug("sshd accepting connections on #{hostname}, banner is #{tcp_socket.gets}") if port == 22 true else false end rescue Errno::ETIMEDOUT false rescue Errno::EPERM false rescue Errno::ECONNREFUSED sleep 2 false rescue Errno::EHOSTUNREACH, Errno::ENETUNREACH sleep 2 false ensure tcp_socket && tcp_socket.close end |
#tcp_test_port_vm(vm, port) ⇒ Object
376 377 378 379 380 381 382 383 |
# File 'lib/chef/knife/base_vsphere_command.rb', line 376 def tcp_test_port_vm(vm, port) ip = vm.guest.ipAddress if ip.nil? sleep 2 return false end tcp_test_port(ip, port) end |
#traverse_folders_for_computeresources(folder) ⇒ Object
162 163 164 165 166 167 168 169 170 171 172 173 |
# File 'lib/chef/knife/base_vsphere_command.rb', line 162 def traverse_folders_for_computeresources(folder) retval = [] children = folder.children.find_all children.each do |child| if child.class == RbVmomi::VIM::ComputeResource || child.class == RbVmomi::VIM::ClusterComputeResource retval << child elsif child.class == RbVmomi::VIM::Folder retval.concat(traverse_folders_for_computeresources(child)) end end retval end |
#traverse_folders_for_dc(folder, dcname) ⇒ Object
188 189 190 191 192 193 194 195 196 197 198 199 |
# File 'lib/chef/knife/base_vsphere_command.rb', line 188 def traverse_folders_for_dc(folder, dcname) children = folder.children.find_all children.each do |child| if child.class == RbVmomi::VIM::Datacenter && child.name == dcname return child elsif child.class == RbVmomi::VIM::Folder dc = traverse_folders_for_dc(child, dcname) return dc if dc end end false end |
#traverse_folders_for_pools(folder) ⇒ Object
149 150 151 152 153 154 155 156 157 158 159 160 |
# File 'lib/chef/knife/base_vsphere_command.rb', line 149 def traverse_folders_for_pools(folder) retval = [] children = folder.children.find_all children.each do |child| if child.class == RbVmomi::VIM::ResourcePool retval << child elsif child.class == RbVmomi::VIM::Folder retval.concat(traverse_folders_for_pools(child)) end end retval end |
#traverse_folders_for_vm(folder, vmname) ⇒ Object
136 137 138 139 140 141 142 143 144 145 146 147 |
# File 'lib/chef/knife/base_vsphere_command.rb', line 136 def traverse_folders_for_vm(folder, vmname) children = folder.children.find_all children.each do |child| if child.class == RbVmomi::VIM::VirtualMachine && child.name == vmname return child elsif child.class == RbVmomi::VIM::Folder vm = traverse_folders_for_vm(child, vmname) return vm if vm end end false end |
#traverse_folders_for_vms(folder, vmname) ⇒ Object
175 176 177 178 179 180 181 182 183 184 185 186 |
# File 'lib/chef/knife/base_vsphere_command.rb', line 175 def traverse_folders_for_vms(folder, vmname) retval = [] children = folder.children.find_all children.each do |child| if child.class == RbVmomi::VIM::VirtualMachine && child.name == vmname retval << child elsif child.class == RbVmomi::VIM::Folder retval.concat(traverse_folders_for_vms(child, vmname)) end end retval end |
#vim_connection ⇒ Object
116 117 118 |
# File 'lib/chef/knife/base_vsphere_command.rb', line 116 def vim_connection config[:vim] ||= RbVmomi::VIM.connect conn_opts end |
#windows?(config) ⇒ Boolean
408 409 410 411 412 |
# File 'lib/chef/knife/base_vsphere_command.rb', line 408 def windows?(config) is_win_bool = config.guestId.downcase.include?('windows') Chef::Log.debug('Identified os as windows.') if is_win_bool is_win_bool end |