Class: MiqVimEventMonitor

Inherits:
MiqVimInventory show all
Defined in:
lib/VMwareWebService/MiqVimEventMonitor.rb

Constant Summary collapse

ADD_VM_EVENTS =

The set of events for which fixupEvent should add a VM

['VmCreatedEvent', 'VmClonedEvent', 'VmDeployedEvent', 'VmRegisteredEvent']

Constants included from VimPropMaps

VimPropMaps::CorePropMap, VimPropMaps::EmsRefreshPropMap, VimPropMaps::EventMonitorPropMap, VimPropMaps::FullPropMap, VimPropMaps::PropMapVCenter, VimPropMaps::UpdatePropMapsByType, VimPropMaps::VimCoreUpdaterPropMap

Instance Attribute Summary

Attributes inherited from MiqVimInventory

#cacheLock, #configLock

Attributes inherited from MiqVimClientBase

#connId, #password, #server, #username

Attributes inherited from VimService

#about, #apiVersion, #isVirtualCenter, #serviceInstanceMor, #session_cookie, #sic, #v2, #v20, #v4, #v5, #v6

Instance Method Summary collapse

Methods inherited from MiqVimInventory

#addDVPObj, #addDVSObj, #addDataStore, #addDataStoreObj, #addExtensionManager, #addHostSystem, #addHostSystemObj, #addLicenseManager, #addObjByMor, #addObjHash, #addProperty, #addStoragePodObj, #addToCollection, #addVirtualMachine, #allPropsFromCache, #applyFilter, #applySelSpec, #applySelector, #assert_no_locks, #browseDiagnosticLog, #browseDiagnosticLogEx, cacheScope, cacheScope=, #cacheStats, #cancelTask, #clusterComputeResourceByMor, #clusterComputeResources, #clusterComputeResourcesByFilter, #clusterComputeResourcesByMor, #computeResourceByMor, #computeResources, #computeResourcesByFilter, #computeResourcesByMor, #conditionalCopy, #currentSession, #dataStoreByMor, #dataStores, #dataStoresByFilter, #dataStoresByFilter_local, #dataStoresByMor, #datacenterByMor, #datacenters, #datacentersByFilter, #datacentersByMor, #datastorePath, #deepClone, #deleteProperty, #dsName2mo, #dsName2mo_local, #dsName2path, #dsPath?, dsPath?, dsRelativePath, #dsRelativePath, #dupObj, #dvPortgroupByMor, #dvPortgroups, #dvPortgroupsByMor, #dvSwitchByMor, #dvSwitches, #dvSwitchesByMor, #extensionManagerByMor, #extensionManagersByFilter, #extensionManagersByMor, #folderByMor, #folders, #foldersByFilter, #foldersByMor, #getMoProp, #getMoPropMulti, #getMoPropMultiIter, #getMoProp_local, #getSelSpec, #getSelector, #getTaskMor, #getTasks, #getTasksByFilter, #hasProp?, #hostSystemByMor, #hostSystems, #hostSystemsByFilter, #hostSystemsByMor, #hostSystemsStorageDevice, #inventoryHash, #inventoryHash_locked, #isAlive?, #isDead, #isHostAgent?, #isVirtualCenter?, #keyExistsInCache?, #keyFromCache, #licenseManagerByMor, #licenseManagersByFilter, #licenseManagersByMor, #loadCache, #localVmPath, #logCacheCounts, #logUserEvent, #objFixUp, path2dsName, #path2dsName, #pollTask, #propFromCache, #propValue, #queryLogDescriptions, #refreshExtensionManager, #refreshLicenseManager, #refreshVirtualMachine, #removeExtensionManager, #removeLicenseManager, #removeObjByMor, #removeSelector, removeSelector, #removeVirtualMachine, #resetCache, #resourcePoolByMor, #resourcePools, #resourcePoolsByFilter, #resourcePoolsByMor, #selSpecToPropPath, setSelector, #setSelector, #snapshotFixup, #spec, #storagePodByMor, #storagePods, #storagePodsByMor, #updateSpec, #updateSpecByPropMap, #virtualAppByMor, #virtualApps, #virtualAppsByFilter, #virtualAppsByMor, #virtualMachineByMor, #virtualMachines, #virtualMachinesByFilter, #virtualMachinesByMor, #vmDatacenterName, #waitForTask

Methods included from MiqVimObjectSet

#objectSet

Methods included from MiqVimDump

#dumpAll, #dumpArray, #dumpClass, #dumpHash, #dumpHostInfo, #dumpMors, #dumpObj, #dumpToLog=, #globalIndent=, #indentedPrint

Methods included from VimPropMaps

#dupProps

Methods inherited from MiqVimClientBase

#acquireCloneTicket, #connect, #currentServerTime, #disconnect, #receiveTimeout, receiveTimeout, #receiveTimeout=, receiveTimeout=, #sdk_uri, #verify_callback

Methods inherited from VimService

#acquireCloneTicket, #acquireMksTicket, #acquireTicket, #addHost_Task, #addInternetScsiSendTargets, #addInternetScsiStaticTargets, #addStandaloneHost_Task, #browseDiagnosticLog, #cancelTask, #cancelWaitForUpdates, #cloneVM_Task, #continueRetrievePropertiesEx, #createAlarm, #createCollectorForEvents, #createCustomizationSpec, #createFilter, #createFolder, #createNasDatastore, #createSnapshot_Task, #createVM_Task, #currentTime, #customizationSpecItemToXml, #deleteCustomizationSpec, #deselectVnicForNicType, #destroyCollector, #destroyPropertyFilter, #destroy_Task, #disableRuleset, #doesCustomizationSpecExist, #enableRuleset, #enterMaintenanceMode_Task, #exitMaintenanceMode_Task, #getAlarm, #getCustomizationSpec, #logUserEvent, #login, #logout, #markAsTemplate, #markAsVirtualMachine, #migrateVM_Task, #moveIntoFolder_Task, #powerDownHostToStandBy_Task, #powerOffVM_Task, #powerOnVM_Task, #powerUpHostFromStandBy_Task, #queryAvailablePerfMetric, #queryDescriptions, #queryDvsConfigTarget, #queryNetConfig, #queryOptions, #queryPerf, #queryPerfComposite, #queryPerfProviderSummary, #readNextEvents, #readPreviousEvents, #rebootGuest, #rebootHost_Task, #reconfigVM_Task, #reconfigureAlarm, #refreshFirewall, #refreshNetworkSystem, #refreshServices, #registerVM_Task, #relocateVM_Task, #removeAlarm, #removeAllSnapshots_Task, #removeSnapshot_Task, #renameSnapshot, #rename_Task, #resetCollector, #resetVM_Task, #restartService, #retrieveProperties, #retrievePropertiesCompat, #retrievePropertiesEx, #retrievePropertiesIter, #retrieveServiceContent, #revertToCurrentSnapshot_Task, #revertToSnapshot_Task, #rewindCollector, #searchDatastoreSubFolders_Task, #searchDatastore_Task, #selectVnicForNicType, #setCollectorPageSize, #setField, #setTaskDescription, #setTaskState, #shutdownGuest, #shutdownHost_Task, #standbyGuest, #startService, #stopService, #suspendVM_Task, #uninstallService, #unregisterVM, #updateDefaultPolicy, #updateServicePolicy, #updateSoftwareInternetScsiEnabled, #waitForUpdates, #waitForUpdatesEx, #xmlToCustomizationSpecItem

Constructor Details

#initialize(server, username, password, eventFilterSpec = nil, pgSize = 100, maxWait = 60) ⇒ MiqVimEventMonitor

Returns a new instance of MiqVimEventMonitor.



5
6
7
8
9
10
11
12
13
14
15
16
17
18
 
# File 'lib/VMwareWebService/MiqVimEventMonitor.rb', line 5

def initialize(server, username, password, eventFilterSpec = nil, pgSize = 100, maxWait = 60)
  super(server, username, password, :cache_scope_event_monitor)

  @eventFilterSpec = eventFilterSpec || VimHash.new("EventFilterSpec")
  @pgSize = pgSize
  @maxWait = maxWait
  @_monitorEvents = true
  @emPropCol = nil

  hostSystemsByMor
  # datacentersByMor
  virtualMachinesByMor
  # dataStoresByMor
end

Instance Method Details

#doEvent(e) ⇒ Object

Test: prevent clone of VM: rpo-clone-src



160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/VMwareWebService/MiqVimEventMonitor.rb', line 160

def doEvent(e)
  return if e['eventType'] != "TaskEvent"
  return if e['info']['name'] != "CloneVM_Task"
  return if e['vm']['name'] != "rpo-clone-src"
  begin
    cancelTask(String.new(e['info']['task'].to_str))
  rescue => err
    $vim_log.error err.to_s
    $vim_log.error err.backtrace.join("\n")
  end
end

#fixupEvent(event) ⇒ Object 



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
 
# File 'lib/VMwareWebService/MiqVimEventMonitor.rb', line 101

def fixupEvent(event)
  unless event.kind_of?(Hash)
    $vim_log.error "MiqVimEventMonitor.fixupEvent: Expecting Hash, got #{event.class}"
    if event.kind_of?(Array)
      event.each_index do |i|
        $vim_log.error "MiqVimEventMonitor.fixupEvent: event[#{i}] is a #{event[i].class}"
        $vim_log.error "\tMiqVimEventMonitor.fixupEvent: event[#{i}] = #{event[i].inspect}"
      end
    else
      $vim_log.error "\tMiqVimEventMonitor.fixupEvent: event = #{event.inspect}"
    end
    raise "MiqVimEventMonitor.fixupEvent: Expecting Hash, got #{event.class}"
  end

  event['eventType'] = event.xsiType.split("::").last
  @cacheLock.synchronize(:SH) do
    ['vm', 'sourceVm', 'srcTemplate'].each do |vmStr|
      next unless (eventVmObj = event[vmStr])
      addVirtualMachine(eventVmObj['vm']) if ADD_VM_EVENTS.include?(event['eventType'])
      next unless (vmObj = virtualMachinesByMor_locked[eventVmObj['vm']])

      eventVmObj['path'] = vmObj['summary']['config']['vmPathName']
      eventVmObj['uuid'] = vmObj['summary']['config']['uuid'].presence

      removeVirtualMachine(eventVmObj['vm']) if event['eventType'] == 'VmRemovedEvent'
    end
  end
  et = event['eventType']
  if et == 'VmRelocatedEvent' || et == 'VmMigratedEvent' || et == 'DrsVmMigratedEvent' || et == 'VmResourcePoolMovedEvent' ||
     (et == 'TaskEvent' && event['info']['name'] == 'MarkAsVirtualMachine')
    vmMor = event['vm']['vm']
    removeVirtualMachine(vmMor)
    addVirtualMachine(vmMor)
  end
  (event)
end

#monitorEvents ⇒ Object

def initialize



20
21
22
23
24
25
26
27
28
29
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
82
83
84
85
86
 
# File 'lib/VMwareWebService/MiqVimEventMonitor.rb', line 20

def monitorEvents
  raise "monitorEvents: no block given" unless block_given?

  eventHistoryCollector = createCollectorForEvents(@sic.eventManager, @eventFilterSpec)
  setCollectorPageSize(eventHistoryCollector, @pgSize)

  pfSpec = VimHash.new("PropertyFilterSpec") do |pfs|
    pfs.propSet = VimArray.new("ArrayOfPropertySpec") do |psa|
      psa << VimHash.new("PropertySpec") do |ps|
        ps.type = eventHistoryCollector.vimType
        ps.all = "false"
        ps.pathSet = "latestPage"
      end
    end
    pfs.objectSet = VimArray.new("ArrayOfObjectSpec") do |osa|
      osa << VimHash.new("ObjectSpec") do |os|
        os.obj = eventHistoryCollector
      end
    end
  end

  filterSpecRef = nil

  begin
      @emPropCol = @sic.propertyCollector
      filterSpecRef = createFilter(@emPropCol, pfSpec, "true")

      version = nil
      begin
          while @_monitorEvents
            updateSet = waitForUpdatesEx(@emPropCol, version, :max_wait => @maxWait)
            next if updateSet.nil?

            version = updateSet.version

            next if updateSet.filterSet.nil? || updateSet.filterSet.empty?
            fu = updateSet.filterSet[0]
            next if fu.filter != filterSpecRef
            objUpdate = fu.objectSet[0]
            next if objUpdate.kind != ObjectUpdateKind::Modify
            next if objUpdate.changeSet.empty?

            changeSetAry = []
            objUpdate.changeSet.each do |propChange|
              next unless propChange.name =~ /latestPage.*/
              next unless propChange.val
              if propChange.val.kind_of?(Array)
                propChange.val.each { |v| changeSetAry << fixupEvent(v) }
              else
                changeSetAry << fixupEvent(propChange.val)
              end
            end
            yield changeSetAry
          end
        rescue HTTPClient::ReceiveTimeoutError => terr
          retry if isAlive?
          $vim_log.debug "MiqVimEventMonitor.monitorEvents: connection lost"
          raise
        end
    rescue SignalException => err
    ensure
      $vim_log.info "MiqVimEventMonitor: calling destroyPropertyFilter"
      destroyPropertyFilter(filterSpecRef) if filterSpecRef
      $vim_log.info "MiqVimEventMonitor: returned from destroyPropertyFilter"
      disconnect
    end
end

#monitorEventsTest ⇒ Object 



149
150
151
152
153
154
155
 
# File 'lib/VMwareWebService/MiqVimEventMonitor.rb', line 149

def monitorEventsTest
  monitorEvents do |ea|
    ea.each do |e|
      puts e['message'] if e['message']
    end
  end
end

#monitorEventsToStdout ⇒ Object 



138
139
140
141
142
143
144
145
146
147
 
# File 'lib/VMwareWebService/MiqVimEventMonitor.rb', line 138

def monitorEventsToStdout
  monitorEvents do |ea|
    ea.each do |e|
      puts
      puts "*** New Event: #{e['eventType']}"
      dumpObj(e)
      # doEvent(e)
    end
  end
end

#stop ⇒ Object

def monitorEvents



88
89
90
91
92
93
94
95
96
 
# File 'lib/VMwareWebService/MiqVimEventMonitor.rb', line 88

def stop
  $vim_log.info "MiqVimEventMonitor stopping..."
  @_monitorEvents = false
  if @emPropCol
    $vim_log.info "MiqVimEventMonitor: calling cancelWaitForUpdates"
    cancelWaitForUpdates(@emPropCol)
    $vim_log.info "MiqVimEventMonitor: returned from cancelWaitForUpdates"
  end
end