Class: IntersightClient::VirtualizationBaseHost

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

Overview

Common attributes of any host associated to a hypervisor manager. Serves as a base class for all concrete host types A Host belongs to a datacenter and optionally to a cluster, and runs virtual machines on it. A host is basically a hardware platform that runs the VMs. Depending on the capacity of the host, it can support 100s of virtual machines.

Direct Known Subclasses

HyperflexHxapHost, VirtualizationVmwareHost

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 = {}) ⇒ VirtualizationBaseHost

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



169
170
171
172
173
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
 
# File 'lib/intersight_client/models/virtualization_base_host.rb', line 169

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `IntersightClient::VirtualizationBaseHost` 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?(:'cpu_info')
    self.cpu_info = attributes[:'cpu_info']
  end

  if attributes.key?(:'hardware_info')
    self.hardware_info = attributes[:'hardware_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?(:'maintenance_mode')
    self.maintenance_mode = attributes[:'maintenance_mode']
  end

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#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_host.rb', line 20

def class_id
  @class_id
end

#cpu_info ⇒ Object

Returns the value of attribute cpu_info.



25
26
27
 
# File 'lib/intersight_client/models/virtualization_base_host.rb', line 25

def cpu_info
  @cpu_info
end

#hardware_info ⇒ Object

Returns the value of attribute hardware_info.



27
28
29
 
# File 'lib/intersight_client/models/virtualization_base_host.rb', line 27

def hardware_info
  @hardware_info
end

#hypervisor_type ⇒ Object

Identifies the broad type of the underlying hypervisor. * ‘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.



30
31
32
 
# File 'lib/intersight_client/models/virtualization_base_host.rb', line 30

def hypervisor_type
  @hypervisor_type
end

#identity ⇒ Object

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



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

def identity
  @identity
end

#maintenance_mode ⇒ Object

Is this host in maintenance mode. Set to true or false.



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

def maintenance_mode
  @maintenance_mode
end

#memory_capacity ⇒ Object

Returns the value of attribute memory_capacity.



38
39
40
 
# File 'lib/intersight_client/models/virtualization_base_host.rb', line 38

def memory_capacity
  @memory_capacity
end

#model ⇒ Object

Commercial model information about this hardware.



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

def model
  @model
end

#name ⇒ Object

Name of this host supplied by user. It is not the identity of the host. The name is subject to user manipulations.



44
45
46
 
# File 'lib/intersight_client/models/virtualization_base_host.rb', line 44

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_host.rb', line 23

def object_type
  @object_type
end

#processor_capacity ⇒ Object

Returns the value of attribute processor_capacity.



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

def processor_capacity
  @processor_capacity
end

#product_info ⇒ Object

Returns the value of attribute product_info.



48
49
50
 
# File 'lib/intersight_client/models/virtualization_base_host.rb', line 48

def product_info
  @product_info
end

#serial ⇒ Object

Serial number of this host (internally generated).



51
52
53
 
# File 'lib/intersight_client/models/virtualization_base_host.rb', line 51

def serial
  @serial
end

#status ⇒ Object

Host health status, as reported by the hypervisor platform. * ‘Unknown` - Entity status is unknown. * `Degraded` - State is degraded, and might impact normal operation of the entity. * `Critical` - Entity is in a critical state, impacting operations. * `Ok` - Entity status is in a stable state, operating normally.



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

def status
  @status
end

#up_time ⇒ Object

The uptime of the host, stored as Duration (from w3c).



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

def up_time
  @up_time
end

#uuid ⇒ Object

Universally unique identity of this host (example b3d4483b-5560-9342-8309-b486c9236610). Internally generated.



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

def uuid
  @uuid
end

#vendor ⇒ Object

Commercial vendor details of this hardware.



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

def vendor
  @vendor
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)



116
117
118
 
# File 'lib/intersight_client/models/virtualization_base_host.rb', line 116

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)



111
112
113
 
# File 'lib/intersight_client/models/virtualization_base_host.rb', line 111

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.



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/intersight_client/models/virtualization_base_host.rb', line 88

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'cpu_info' => :'CpuInfo',
    :'hardware_info' => :'HardwareInfo',
    :'hypervisor_type' => :'HypervisorType',
    :'identity' => :'Identity',
    :'maintenance_mode' => :'MaintenanceMode',
    :'memory_capacity' => :'MemoryCapacity',
    :'model' => :'Model',
    :'name' => :'Name',
    :'processor_capacity' => :'ProcessorCapacity',
    :'product_info' => :'ProductInfo',
    :'serial' => :'Serial',
    :'status' => :'Status',
    :'up_time' => :'UpTime',
    :'uuid' => :'Uuid',
    :'vendor' => :'Vendor'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



385
386
387
 
# File 'lib/intersight_client/models/virtualization_base_host.rb', line 385

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



155
156
157
158
159
160
 
# File 'lib/intersight_client/models/virtualization_base_host.rb', line 155

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

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



163
164
165
 
# File 'lib/intersight_client/models/virtualization_base_host.rb', line 163

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



144
145
146
147
148
149
150
151
152
 
# File 'lib/intersight_client/models/virtualization_base_host.rb', line 144

def self.openapi_nullable
  Set.new([
    :'cpu_info',
    :'hardware_info',
    :'memory_capacity',
    :'processor_capacity',
    :'product_info',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/intersight_client/models/virtualization_base_host.rb', line 121

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'cpu_info' => :'VirtualizationCpuInfo',
    :'hardware_info' => :'InfraHardwareInfo',
    :'hypervisor_type' => :'String',
    :'identity' => :'String',
    :'maintenance_mode' => :'Boolean',
    :'memory_capacity' => :'VirtualizationMemoryCapacity',
    :'model' => :'String',
    :'name' => :'String',
    :'processor_capacity' => :'VirtualizationComputeCapacity',
    :'product_info' => :'VirtualizationProductInfo',
    :'serial' => :'String',
    :'status' => :'String',
    :'up_time' => :'String',
    :'uuid' => :'String',
    :'vendor' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/intersight_client/models/virtualization_base_host.rb', line 348

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      cpu_info == o.cpu_info &&
      hardware_info == o.hardware_info &&
      hypervisor_type == o.hypervisor_type &&
      identity == o.identity &&
      maintenance_mode == o.maintenance_mode &&
      memory_capacity == o.memory_capacity &&
      model == o.model &&
      name == o.name &&
      processor_capacity == o.processor_capacity &&
      product_info == o.product_info &&
      serial == o.serial &&
      status == o.status &&
      up_time == o.up_time &&
      uuid == o.uuid &&
      vendor == o.vendor && super(o)
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'lib/intersight_client/models/virtualization_base_host.rb', line 416

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:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



487
488
489
490
491
492
493
494
495
496
497
498
499
 
# File 'lib/intersight_client/models/virtualization_base_host.rb', line 487

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:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'lib/intersight_client/models/virtualization_base_host.rb', line 392

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  super(attributes)
  VirtualizationBaseHost.openapi_types.each_pair do |key, type|
    if attributes[VirtualizationBaseHost.attribute_map[key]].nil? && VirtualizationBaseHost.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[VirtualizationBaseHost.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[VirtualizationBaseHost.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[VirtualizationBaseHost.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[VirtualizationBaseHost.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


372
373
374
 
# File 'lib/intersight_client/models/virtualization_base_host.rb', line 372

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



378
379
380
 
# File 'lib/intersight_client/models/virtualization_base_host.rb', line 378

def hash
  [class_id, object_type, cpu_info, hardware_info, hypervisor_type, identity, maintenance_mode, memory_capacity, model, name, processor_capacity, product_info, serial, status, up_time, uuid, vendor].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



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/intersight_client/models/virtualization_base_host.rb', line 260

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:

  • (Hash) —

    Returns the object in the form of hash



463
464
465
 
# File 'lib/intersight_client/models/virtualization_base_host.rb', line 463

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



469
470
471
472
473
474
475
476
477
478
479
480
481
 
# File 'lib/intersight_client/models/virtualization_base_host.rb', line 469

def to_hash
  hash = super
  VirtualizationBaseHost.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = VirtualizationBaseHost.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) —

    String presentation of the object



457
458
459
 
# File 'lib/intersight_client/models/virtualization_base_host.rb', line 457

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/intersight_client/models/virtualization_base_host.rb', line 280

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["hyperflex.HxapHost", "virtualization.VmwareHost"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["hyperflex.HxapHost", "virtualization.VmwareHost"])
  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)
  status_validator = EnumAttributeValidator.new('String', ["Unknown", "Degraded", "Critical", "Ok"])
  return false unless status_validator.valid?(@status)
  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