Class: MiqVimCoreUpdater

Inherits:
MiqVimClientBase show all
Includes:
MiqVimDump, MiqVimObjectSet, VimPropMaps
Defined in:
lib/VMwareWebService/MiqVimCoreUpdater.rb

Constant Summary

Constants included from VimPropMaps

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

Instance Attribute Summary

Attributes inherited from MiqVimClientBase

#connId, #password, #server, #username

Attributes inherited from VimService

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

Instance Method Summary collapse

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, propMap = nil, maxWait = 60) ⇒ MiqVimCoreUpdater

Returns a new instance of MiqVimCoreUpdater.



11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/VMwareWebService/MiqVimCoreUpdater.rb', line 11

def initialize(server, username, password, propMap = nil, maxWait = 60)
  super(server, username, password)

  @propMap    = propMap || VimCoreUpdaterPropMap
  if @v4
    @propMap = dupProps(@propMap)
    addProperty(:VirtualMachine, "runtime.memoryOverhead")
  end

  @propCol    = @sic.propertyCollector
  @rootFolder = @sic.rootFolder
  @objectSet  = objectSet
  @updateSpec = updateSpec
  @maxWait    = maxWait

  @debugUpdates = false

  connect

  @alive = true
end

Instance Method Details

#addProperty(key, property) ⇒ Object 



33
34
35
36
37
 
# File 'lib/VMwareWebService/MiqVimCoreUpdater.rb', line 33

def addProperty(key, property)
  return if (pm = @propMap[key]).nil?
  property.split('.').each { |p| return if pm.include?(p) }
  @propMap[key][:props] << property
end

#currentSession ⇒ Object 



197
198
199
 
# File 'lib/VMwareWebService/MiqVimCoreUpdater.rb', line 197

def currentSession
  getMoProp(@sic.sessionManager, "currentSession")
end

#doUpdate(version, max_wait, &block) ⇒ Object

def monitorUpdates



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

def doUpdate(version, max_wait, &block)
  log_prefix = "#{self.class.name}.doUpdate"
  begin
    $vim_log.info "#{log_prefix}: call to waitForUpdates...Starting" if $vim_log
    updateSet = waitForUpdatesEx(@umPropCol, version, :max_wait => max_wait)
    $vim_log.info "#{log_prefix}: call to waitForUpdates...Complete" if $vim_log
    return version if updateSet.nil?

    version = updateSet.version

    return if updateSet.filterSet.nil? || updateSet.filterSet.empty?

    updateSet.filterSet.each do |fu|
      next if fu.filter != @filterSpecRef
      fu.objectSet.each do |objUpdate|
        updateObject(objUpdate, &block)
      end
    end # updateSet.filterSet.each
    # Help out the Ruby Garbage Collector by resetting variables pointing to large objects back to nil
    updateSet = nil
    return version
  rescue HTTPClient::ReceiveTimeoutError => terr
    $vim_log.info "#{log_prefix}: call to waitForUpdates...Timeout" if $vim_log
    retry if isAlive?
    $vim_log.warn "#{log_prefix}: connection lost"
    raise terr
  end
end

#getMoProp(mo, path = nil) ⇒ Object 



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/VMwareWebService/MiqVimCoreUpdater.rb', line 201

def getMoProp(mo, path = nil)
  pfSpec = VimHash.new("PropertyFilterSpec") do |pfs|
    pfs.propSet = VimArray.new("ArrayOfPropertySpec") do |psa|
      psa << VimHash.new("PropertySpec") do |ps|
        ps.type = mo.vimType
        if !path
          ps.all = "true"
        else
          ps.all = "false"
          ps.pathSet = path
        end
      end
    end
    pfs.objectSet = VimArray.new("ArrayOfObjectSpec") do |osa|
      osa << VimHash.new("ObjectSpec") do |os|
        os.obj = mo
      end
    end
  end

  oca = retrievePropertiesCompat(@propCol, pfSpec)

  return nil if !oca || !oca[0] || !oca[0].propSet

  oc = oca[0]
  oc.delete('obj')

  oc.propSet = [oc.propSet] unless oc.propSet.kind_of?(Array)
  oc.propSet.each do |ps|
    #
    # Here, ps.name can be a property path in the form: a.b.c
    # If that's the case, we should set the target to: propHash['a']['b']['c']
    # creating intermediate nodes as needed.
    #
    h, k = hashTarget(oc, ps.name)
    if !h[k]
      h[k] = ps.val
    elsif h[k].kind_of? Array
      h[k] << ps.val
    else
      h[k] = VimArray.new do |arr|
        arr << h[k]
        arr << ps.val
      end
    end
  end # oc.propSet.each
  oc.delete('propSet')

  (oc)
end

#isAlive? ⇒ Boolean

Returns:

  • (Boolean) 


182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/VMwareWebService/MiqVimCoreUpdater.rb', line 182

def isAlive?
  return false unless @alive
  log_prefix = "#{self.class.name}.isAlive?"
  begin
      unless currentSession
        $vim_log.info "#{log_prefix}: Current session no longer exists."
        @alive = false
      end
    rescue Exception => err
      $vim_log.info "#{log_prefix}: Could not access connection - #{err}"
      @alive = false
    end
  @alive
end

#monitorUpdates(&block) ⇒ Object 



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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/VMwareWebService/MiqVimCoreUpdater.rb', line 54

def monitorUpdates(&block)
  log_prefix = "#{self.class.name}.monitorUpdates"
  @umPropCol      = nil
  @filterSpecRef  = nil
  @monitor        = true
  @debugUpdates   = false if @debugUpdates.nil?
  @dumpToLog      = true  if @debugUpdates

  $vim_log.debug "#{log_prefix}: debugUpdates = #{@debugUpdates}"

  trap(:TERM) { $vim_log.info "#{log_prefix}: ignoring SIGTERM" }

  begin
    @umPropCol     = @sic.propertyCollector
    @filterSpecRef = createFilter(@umPropCol, @updateSpec, "true")

    version = nil

    while @monitor
      updates_version = doUpdate(version, @maxWait, &block)
      next if updates_version.nil?
      version = updates_version
      sleep @updateDelay if @updateDelay
    end # while @monitor
  rescue SignalException => err
    # Ignore signals, except TERM
  rescue => herr
    if herr.respond_to?(:reason) && herr.reason == 'The task was canceled by a user.'
      $vim_log.info "#{log_prefix}: waitForUpdates canceled"
    else
      $vim_log.error "******* #{herr.class}"
      $vim_log.error herr.to_s
      $vim_log.error herr.backtrace.join("\n") unless herr.kind_of?(HTTPClient::ReceiveTimeoutError) # already logged in monitorUpdatesInitial or monitorUpdatesSince
      raise herr
    end
  ensure
    if isAlive?
      if @filterSpecRef
        $vim_log.info "#{log_prefix}: calling destroyPropertyFilter...Starting"
        destroyPropertyFilter(@filterSpecRef)
        $vim_log.info "#{log_prefix}: calling destroyPropertyFilter...Complete"
      end
      $vim_log.info "#{log_prefix}: disconnecting..."
      disconnect
      $vim_log.info "#{log_prefix}: disconnected"
    end
    @filterSpecRef = nil
    # @umPropCol     = nil
  end
end

#propUpdate(changeSet) ⇒ Object 



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/VMwareWebService/MiqVimCoreUpdater.rb', line 149

def propUpdate(changeSet)
  changedProps = {}
  changeSet.each do |propChange|
    if @debugUpdates
      $vim_log.debug "\tpropChange name (path): #{propChange.name}"
      $vim_log.debug "\tpropChange op: #{propChange.op}"
      $vim_log.debug "\tpropChange val (type): #{propChange.val.class}"

      $vim_log.debug "\t*** propChange val START:"
      oGi = @globalIndent
      @globalIndent = "\t\t"
      dumpObj(propChange.val)
      @globalIndent = oGi
      $vim_log.debug "\t*** propChange val END"
      $vim_log.debug "\t***"
    end

    changedProps[propChange.name] = propChange.val
  end unless changeSet.nil?
  changedProps
end

#stop ⇒ Object 



171
172
173
174
175
176
177
178
179
180
 
# File 'lib/VMwareWebService/MiqVimCoreUpdater.rb', line 171

def stop
  log_prefix = "#{self.class.name}.stop"
  $vim_log.info "#{log_prefix}: stopping..."
  @monitor = false
  if @propCol
    $vim_log.info "#{log_prefix}: calling cancelWaitForUpdates"
    cancelWaitForUpdates(@propCol)
    $vim_log.info "#{log_prefix}: returned from cancelWaitForUpdates"
  end
end

#updateObject(objUpdate) ⇒ Object 



134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/VMwareWebService/MiqVimCoreUpdater.rb', line 134

def updateObject(objUpdate)
  log_prefix = "#{self.class.name}.updateObject"

  case objUpdate.kind
  when 'enter'
    yield(objUpdate.obj, propUpdate(objUpdate.changeSet))
  when 'leave'
    yield(objUpdate.obj, nil)
  when 'modify'
    yield(objUpdate.obj, propUpdate(objUpdate.changeSet))
  else
    $vim_log.warn "#{log_prefix}: unrecognized operation: #{objUpdate.kind}"
  end
end

#updateSpec ⇒ Object 



39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/VMwareWebService/MiqVimCoreUpdater.rb', line 39

def updateSpec
  VimHash.new("PropertyFilterSpec") do |pfs|
    pfs.propSet = VimArray.new("ArrayOfPropertySpec") do |psa|
      @propMap.each do |type, h|
        psa << VimHash.new("PropertySpec") do |ps|
          ps.type   = type
          ps.all    = h[:props].nil?.to_s
          ps.pathSet  = h[:props] if h[:props]
        end
      end
    end
    pfs.objectSet = @objectSet
  end
end