Class: IntersightClient::VirtualizationBaseVirtualMachine

Inherits:
VirtualizationBaseSourceDevice show all
Defined in:
lib/intersight_client/models/virtualization_base_virtual_machine.rb

Overview

Common attributes of a virtual machine managed by a hypervisor. Serves as a base class for all concrete virtual machine types. A virtual machine (VM) is what a user and applications interact with. A VM usually runs a guest OS and applications run on the guest OS.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from VirtualizationBaseSourceDevice

#registered_device

Attributes inherited from MoBaseMo

#account_moid, #ancestors, #create_time, #display_names, #domain_group_moid, #mod_time, #moid, #owners, #parent, #permission_resources, #shared_scope, #tags, #version_context

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ VirtualizationBaseVirtualMachine

Initializes the object

Parameters:

  • (defaults to: {})

    Model attributes in the form of hash



174
175
176
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
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
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/intersight_client/models/virtualization_base_virtual_machine.rb', line 174

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `IntersightClient::VirtualizationBaseVirtualMachine` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `#{self.class.name}`. Please check the name to make sure it's valid. List of attributes: " + self.class.acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  # call parent's initialize
  super(attributes)

  if attributes.key?(:'class_id')
    self.class_id = attributes[:'class_id']
  end

  if attributes.key?(:'object_type')
    self.object_type = attributes[:'object_type']
  end

  if attributes.key?(:'boot_time')
    self.boot_time = attributes[:'boot_time']
  end

  if attributes.key?(:'capacity')
    self.capacity = attributes[:'capacity']
  end

  if attributes.key?(:'cpu_utilization')
    self.cpu_utilization = attributes[:'cpu_utilization']
  end

  if attributes.key?(:'guest_info')
    self.guest_info = attributes[:'guest_info']
  end

  if attributes.key?(:'hypervisor_type')
    self.hypervisor_type = attributes[:'hypervisor_type']
  else
    self.hypervisor_type = 'ESXi'
  end

  if attributes.key?(:'identity')
    self.identity = attributes[:'identity']
  end

  if attributes.key?(:'ip_address')
    if (value = attributes[:'ip_address']).is_a?(Array)
      self.ip_address = value
    end
  end

  if attributes.key?(:'memory_capacity')
    self.memory_capacity = attributes[:'memory_capacity']
  end

  if attributes.key?(:'memory_utilization')
    self.memory_utilization = attributes[:'memory_utilization']
  end

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.key?(:'power_state')
    self.power_state = attributes[:'power_state']
  else
    self.power_state = 'Unknown'
  end

  if attributes.key?(:'processor_capacity')
    self.processor_capacity = attributes[:'processor_capacity']
  end

  if attributes.key?(:'provider')
    self.provider = attributes[:'provider']
  else
    self.provider = 'Unknown'
  end

  if attributes.key?(:'state')
    self.state = attributes[:'state']
  else
    self.state = 'None'
  end

  if attributes.key?(:'uuid')
    self.uuid = attributes[:'uuid']
  end

  if attributes.key?(:'vm_creation_time')
    self.vm_creation_time = attributes[:'vm_creation_time']
  end
end

Instance Attribute Details

#boot_time ⇒ Object

Time when this VM booted up.



26
27
28
 
# File 'lib/intersight_client/models/virtualization_base_virtual_machine.rb', line 26

def boot_time
  @boot_time
end

#capacity ⇒ Object

Returns the value of attribute capacity.



28
29
30
 
# File 'lib/intersight_client/models/virtualization_base_virtual_machine.rb', line 28

def capacity
  @capacity
end

#class_id ⇒ Object

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data. The enum values provides the list of concrete types that can be instantiated from this abstract type.



20
21
22
 
# File 'lib/intersight_client/models/virtualization_base_virtual_machine.rb', line 20

def class_id
  @class_id
end

#cpu_utilization ⇒ Object

Average CPU utilization percentage derived as a ratio of CPU used to CPU allocated. The value is calculated whenever inventory is performed.



31
32
33
 
# File 'lib/intersight_client/models/virtualization_base_virtual_machine.rb', line 31

def cpu_utilization
  @cpu_utilization
end

#guest_info ⇒ Object

Returns the value of attribute guest_info.



33
34
35
 
# File 'lib/intersight_client/models/virtualization_base_virtual_machine.rb', line 33

def guest_info
  @guest_info
end

#hypervisor_type ⇒ Object

Type of hypervisor where the virtual machine is hosted for example ESXi. * ‘ESXi` - The hypervisor running on the HyperFlex cluster is a Vmware ESXi hypervisor of any version. * `HyperFlexAp` - The hypervisor of the virtualization platform is Cisco HyperFlex Application Platform. * `IWE` - The hypervisor of the virtualization platform is Cisco Intersight Workload Engine. * `Hyper-V` - The hypervisor running on the HyperFlex cluster is Microsoft Hyper-V. * `Unknown` - The hypervisor running on the HyperFlex cluster is not known.



36
37
38
 
# File 'lib/intersight_client/models/virtualization_base_virtual_machine.rb', line 36

def hypervisor_type
  @hypervisor_type
end

#identity ⇒ Object

The internally generated identity of this VM. This entity is not manipulated by users. It aids in uniquely identifying the virtual machine object. For VMware, this is MOR (managed object reference).



39
40
41
 
# File 'lib/intersight_client/models/virtualization_base_virtual_machine.rb', line 39

def identity
  @identity
end

#ip_address ⇒ Object

Returns the value of attribute ip_address.



41
42
43
 
# File 'lib/intersight_client/models/virtualization_base_virtual_machine.rb', line 41

def ip_address
  @ip_address
end

#memory_capacity ⇒ Object

Returns the value of attribute memory_capacity.



43
44
45
 
# File 'lib/intersight_client/models/virtualization_base_virtual_machine.rb', line 43

def memory_capacity
  @memory_capacity
end

#memory_utilization ⇒ Object

Average memory utilization percentage derived as a ratio of memory used to available memory. The value is calculated whenever inventory is performed.



46
47
48
 
# File 'lib/intersight_client/models/virtualization_base_virtual_machine.rb', line 46

def memory_utilization
  @memory_utilization
end

#name ⇒ Object

User-provided name to identify the virtual machine.



49
50
51
 
# File 'lib/intersight_client/models/virtualization_base_virtual_machine.rb', line 49

def name
  @name
end

#object_type ⇒ Object

The fully-qualified name of the instantiated, concrete type. The value should be the same as the ‘ClassId’ property. The enum values provides the list of concrete types that can be instantiated from this abstract type.



23
24
25
 
# File 'lib/intersight_client/models/virtualization_base_virtual_machine.rb', line 23

def object_type
  @object_type
end

#power_state ⇒ Object

Power state of the virtual machine. * ‘Unknown` - The entity’s power state is unknown. * ‘PoweringOn` - The entity is powering on. * `PoweredOn` - The entity is powered on. * `PoweringOff` - The entity is powering off. * `PoweredOff` - The entity is powered down. * `StandBy` - The entity is in standby mode. * `Paused` - The entity is in pause state. * `Rebooting` - The entity reboot is in progress. * “ - The entity’s power state is not available.



52
53
54
 
# File 'lib/intersight_client/models/virtualization_base_virtual_machine.rb', line 52

def power_state
  @power_state
end

#processor_capacity ⇒ Object

Returns the value of attribute processor_capacity.



54
55
56
 
# File 'lib/intersight_client/models/virtualization_base_virtual_machine.rb', line 54

def processor_capacity
  @processor_capacity
end

#provider ⇒ Object

Cloud platform, where the virtual machine is launched. * ‘Unknown` - Cloud provider is not known. * `VMwarevSphere` - Cloud provider named VMware vSphere. * `AmazonWebServices` - Cloud provider named Amazon Web Services. * `MicrosoftAzure` - Cloud provider named Microsoft Azure. * `GoogleCloudPlatform` - Cloud provider named Google Cloud Platform.



57
58
59
 
# File 'lib/intersight_client/models/virtualization_base_virtual_machine.rb', line 57

def provider
  @provider
end

#state ⇒ Object

The current state of the virtual machine. For example, starting, stopped, etc. * ‘None` - A place holder for the default value. * `Creating` - Virtual machine creation is in progress. * `Pending` - The virtual machine is preparing to enter the started state. * `Starting` - The virtual machine is starting. * `Started` - The virtual machine is running and ready for use. * `Stopping` - The virtual machine is preparing to be stopped. * `Stopped` - The virtual machine is shut down and cannot be used. The virtual machine can be started again at any time. * `Pausing` - The virtual machine is preparing to be paused. * `Paused` - The virtual machine enters into paused state due to low free disk space. * `Suspending` - The virtual machine is preparing to be suspended. * `Suspended` - Virtual machine is in sleep mode.When a virtual machine is suspended, the current state of theoperating system, and applications is saved, and the virtual machine put into a suspended mode. * `Deleting` - The virtual machine is preparing to be terminated. * `Terminated` - The virtual machine has been permanently deleted and cannot be started. * `Rebooting` - The virtual machine reboot is in progress. * `Error` - The deployment of virtual machine is failed.



60
61
62
 
# File 'lib/intersight_client/models/virtualization_base_virtual_machine.rb', line 60

def state
  @state
end

#uuid ⇒ Object

The uuid of this virtual machine. The uuid is internally generated and not user specified.



63
64
65
 
# File 'lib/intersight_client/models/virtualization_base_virtual_machine.rb', line 63

def uuid
  @uuid
end

#vm_creation_time ⇒ Object

Time when this virtualmachine is created.



66
67
68
 
# File 'lib/intersight_client/models/virtualization_base_virtual_machine.rb', line 66

def vm_creation_time
  @vm_creation_time
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns the key-value map of all the JSON attributes this model knows about, including the ones defined in its parent(s)



120
121
122
 
# File 'lib/intersight_client/models/virtualization_base_virtual_machine.rb', line 120

def self.acceptable_attribute_map
  attribute_map.merge(superclass.acceptable_attribute_map)
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about, including the ones defined in its parent(s)



115
116
117
 
# File 'lib/intersight_client/models/virtualization_base_virtual_machine.rb', line 115

def self.acceptable_attributes
  attribute_map.values.concat(superclass.acceptable_attributes)
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/intersight_client/models/virtualization_base_virtual_machine.rb', line 91

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'boot_time' => :'BootTime',
    :'capacity' => :'Capacity',
    :'cpu_utilization' => :'CpuUtilization',
    :'guest_info' => :'GuestInfo',
    :'hypervisor_type' => :'HypervisorType',
    :'identity' => :'Identity',
    :'ip_address' => :'IpAddress',
    :'memory_capacity' => :'MemoryCapacity',
    :'memory_utilization' => :'MemoryUtilization',
    :'name' => :'Name',
    :'power_state' => :'PowerState',
    :'processor_capacity' => :'ProcessorCapacity',
    :'provider' => :'Provider',
    :'state' => :'State',
    :'uuid' => :'Uuid',
    :'vm_creation_time' => :'VmCreationTime'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • Model attributes in the form of hash

Returns:

  • Returns the model itself



425
426
427
 
# File 'lib/intersight_client/models/virtualization_base_virtual_machine.rb', line 425

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



160
161
162
163
164
165
 
# File 'lib/intersight_client/models/virtualization_base_virtual_machine.rb', line 160

def self.openapi_all_of
  [
  :'VirtualizationBaseSourceDevice',
  :'VirtualizationBaseVirtualMachineAllOf'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



168
169
170
 
# File 'lib/intersight_client/models/virtualization_base_virtual_machine.rb', line 168

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



149
150
151
152
153
154
155
156
157
 
# File 'lib/intersight_client/models/virtualization_base_virtual_machine.rb', line 149

def self.openapi_nullable
  Set.new([
    :'capacity',
    :'guest_info',
    :'ip_address',
    :'memory_capacity',
    :'processor_capacity',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/intersight_client/models/virtualization_base_virtual_machine.rb', line 125

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'boot_time' => :'Time',
    :'capacity' => :'InfraHardwareInfo',
    :'cpu_utilization' => :'Float',
    :'guest_info' => :'VirtualizationGuestInfo',
    :'hypervisor_type' => :'String',
    :'identity' => :'String',
    :'ip_address' => :'Array<String>',
    :'memory_capacity' => :'VirtualizationMemoryCapacity',
    :'memory_utilization' => :'Float',
    :'name' => :'String',
    :'power_state' => :'String',
    :'processor_capacity' => :'VirtualizationComputeCapacity',
    :'provider' => :'String',
    :'state' => :'String',
    :'uuid' => :'String',
    :'vm_creation_time' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • to be compared



387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
 
# File 'lib/intersight_client/models/virtualization_base_virtual_machine.rb', line 387

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      boot_time == o.boot_time &&
      capacity == o.capacity &&
      cpu_utilization == o.cpu_utilization &&
      guest_info == o.guest_info &&
      hypervisor_type == o.hypervisor_type &&
      identity == o.identity &&
      ip_address == o.ip_address &&
      memory_capacity == o.memory_capacity &&
      memory_utilization == o.memory_utilization &&
      name == o.name &&
      power_state == o.power_state &&
      processor_capacity == o.processor_capacity &&
      provider == o.provider &&
      state == o.state &&
      uuid == o.uuid &&
      vm_creation_time == o.vm_creation_time && super(o)
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • type Data type

  • value Value to be deserialized

Returns:

  • Deserialized data



456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
 
# File 'lib/intersight_client/models/virtualization_base_virtual_machine.rb', line 456

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = IntersightClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • Any valid value

Returns:

  • Returns the value in the form of hash



527
528
529
530
531
532
533
534
535
536
537
538
539
 
# File 'lib/intersight_client/models/virtualization_base_virtual_machine.rb', line 527

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • Model attributes in the form of hash

Returns:

  • Returns the model itself



432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'lib/intersight_client/models/virtualization_base_virtual_machine.rb', line 432

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  super(attributes)
  VirtualizationBaseVirtualMachine.openapi_types.each_pair do |key, type|
    if attributes[VirtualizationBaseVirtualMachine.attribute_map[key]].nil? && VirtualizationBaseVirtualMachine.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[VirtualizationBaseVirtualMachine.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[VirtualizationBaseVirtualMachine.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[VirtualizationBaseVirtualMachine.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[VirtualizationBaseVirtualMachine.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • to be compared

Returns:

See Also:

  • `==` method


412
413
414
 
# File 'lib/intersight_client/models/virtualization_base_virtual_machine.rb', line 412

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • Hash code



418
419
420
 
# File 'lib/intersight_client/models/virtualization_base_virtual_machine.rb', line 418

def hash
  [class_id, object_type, boot_time, capacity, cpu_utilization, guest_info, hypervisor_type, identity, ip_address, memory_capacity, memory_utilization, name, power_state, processor_capacity, provider, state, uuid, vm_creation_time].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/intersight_client/models/virtualization_base_virtual_machine.rb', line 275

def list_invalid_properties
  invalid_properties = super
  if @class_id.nil?
    invalid_properties.push('invalid value for "class_id", class_id cannot be nil.')
  end

  if @object_type.nil?
    invalid_properties.push('invalid value for "object_type", object_type cannot be nil.')
  end

  pattern = Regexp.new(/^$|^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/)
  if !@uuid.nil? && @uuid !~ pattern
    invalid_properties.push("invalid value for \"uuid\", must conform to the pattern #{pattern}.")
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • Returns the object in the form of hash



503
504
505
 
# File 'lib/intersight_client/models/virtualization_base_virtual_machine.rb', line 503

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • Returns the object in the form of hash



509
510
511
512
513
514
515
516
517
518
519
520
521
 
# File 'lib/intersight_client/models/virtualization_base_virtual_machine.rb', line 509

def to_hash
  hash = super
  VirtualizationBaseVirtualMachine.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = VirtualizationBaseVirtualMachine.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • String presentation of the object



497
498
499
 
# File 'lib/intersight_client/models/virtualization_base_virtual_machine.rb', line 497

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • true if the model is valid



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/intersight_client/models/virtualization_base_virtual_machine.rb', line 295

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["cloud.AwsVirtualMachine", "hyperflex.HxapVirtualMachine", "virtualization.VmwareVirtualMachine"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["cloud.AwsVirtualMachine", "hyperflex.HxapVirtualMachine", "virtualization.VmwareVirtualMachine"])
  return false unless object_type_validator.valid?(@object_type)
  hypervisor_type_validator = EnumAttributeValidator.new('String', ["ESXi", "HyperFlexAp", "IWE", "Hyper-V", "Unknown"])
  return false unless hypervisor_type_validator.valid?(@hypervisor_type)
  power_state_validator = EnumAttributeValidator.new('String', ["Unknown", "PoweringOn", "PoweredOn", "PoweringOff", "PoweredOff", "StandBy", "Paused", "Rebooting", ""])
  return false unless power_state_validator.valid?(@power_state)
  provider_validator = EnumAttributeValidator.new('String', ["Unknown", "VMwarevSphere", "AmazonWebServices", "MicrosoftAzure", "GoogleCloudPlatform"])
  return false unless provider_validator.valid?(@provider)
  state_validator = EnumAttributeValidator.new('String', ["None", "Creating", "Pending", "Starting", "Started", "Stopping", "Stopped", "Pausing", "Paused", "Suspending", "Suspended", "Deleting", "Terminated", "Rebooting", "Error"])
  return false unless state_validator.valid?(@state)
  return false if !@uuid.nil? && @uuid !~ Regexp.new(/^$|^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/)
  true && super
end