Class: IntersightClient::EquipmentIdentitySummary

Inherits:
ViewsView show all
Defined in:
lib/intersight_client/models/equipment_identity_summary.rb

Overview

Consolidated view of all equipment identities.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/intersight_client/models/equipment_identity_summary.rb', line 183

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#adapter_serial ⇒ Object

Serial Identifier of an adapter participating in SWM.



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

def adapter_serial
  @adapter_serial
end

#admin_action ⇒ Object

Updated by UI/API to trigger specific chassis action type. * None - No operation value for maintenance actions on an equipment. * Decommission - Decommission the equipment and temporarily remove it from being managed by Intersight. * Recommission - Recommission the equipment. * Reack - Reacknowledge the equipment and discover it again. * Remove - Remove the equipment permanently from Intersight management. * Replace - Replace the equipment with the other one.



29
30
31
 
# File 'lib/intersight_client/models/equipment_identity_summary.rb', line 29

def admin_action
  @admin_action
end

#admin_action_state ⇒ Object

The state of Maintenance Action performed. This will have three states. Applying - Action is in progress. Applied - Action is completed and applied. Failed - Action has failed. * None - Nil value when no action has been triggered by the user. * Applied - User configured settings are in applied state. * Applying - User settings are being applied on the target server. * Failed - User configured settings could not be applied.



32
33
34
 
# File 'lib/intersight_client/models/equipment_identity_summary.rb', line 32

def admin_action_state
  @admin_action_state
end

#chassis_id ⇒ Object

Chassis Identifier of a blade server.



35
36
37
 
# File 'lib/intersight_client/models/equipment_identity_summary.rb', line 35

def chassis_id
  @chassis_id
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.



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

def class_id
  @class_id
end

#current_chassis_id ⇒ Object

The id of the chassis that the blade is currently located in.



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

def current_chassis_id
  @current_chassis_id
end

#current_slot_id ⇒ Object

The slot number in the chassis that the blade is currently located in.



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

def current_slot_id
  @current_slot_id
end

#firmware_supportability ⇒ Object

Describes whether the running CIMC version supports Intersight managed mode. * Unknown - The running firmware version is unknown. * Supported - The running firmware version is known and supports IMM mode. * NotSupported - The running firmware version is known and does not support IMM mode.



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

def firmware_supportability
  @firmware_supportability
end

#identifier ⇒ Object

Numeric Identifier assigned by the management system to the equipment.



47
48
49
 
# File 'lib/intersight_client/models/equipment_identity_summary.rb', line 47

def identifier
  @identifier
end

#io_card_identity_list ⇒ Object

Returns the value of attribute io_card_identity_list.



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

def io_card_identity_list
  @io_card_identity_list
end

#lifecycle ⇒ Object

The equipment’s lifecycle status. * None - Default state of an equipment. This should be an initial state when no state is defined for an equipment. * Active - Default Lifecycle State for a physical entity. * Decommissioned - Decommission Lifecycle state. * DecommissionInProgress - Decommission Inprogress Lifecycle state. * RecommissionInProgress - Recommission Inprogress Lifecycle state. * OperationFailed - Failed Operation Lifecycle state. * ReackInProgress - ReackInProgress Lifecycle state. * RemoveInProgress - RemoveInProgress Lifecycle state. * Discovered - Discovered Lifecycle state. * DiscoveryInProgress - DiscoveryInProgress Lifecycle state. * DiscoveryFailed - DiscoveryFailed Lifecycle state. * FirmwareUpgradeInProgress - Firmware upgrade is in progress on given physical entity. * BladeMigrationInProgress - Server slot migration is in progress on given physical entity. * Inactive - Inactive Lifecycle state. * ReplaceInProgress - ReplaceInProgress Lifecycle state. * SlotMismatch - The blade server is detected in a different chassis/slot than it was previously.



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

def lifecycle
  @lifecycle
end

#model ⇒ Object

The vendor provided model name for the equipment.



55
56
57
 
# File 'lib/intersight_client/models/equipment_identity_summary.rb', line 55

def model
  @model
end

#object_type ⇒ Object

The fully-qualified name of the instantiated, concrete type. The value should be the same as the ‘ClassId’ property.



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

def object_type
  @object_type
end

#presence ⇒ Object

The presence state of the blade server. * Unknown - The default presence state. * Equipped - The server is equipped in the slot. * EquippedMismatch - The slot is equipped, but there is another server currently inventoried in the slot. * Missing - The server is not present in the given slot.



58
59
60
 
# File 'lib/intersight_client/models/equipment_identity_summary.rb', line 58

def presence
  @presence
end

#registered_device ⇒ Object

Returns the value of attribute registered_device.



75
76
77
 
# File 'lib/intersight_client/models/equipment_identity_summary.rb', line 75

def registered_device
  @registered_device
end

#serial ⇒ Object

The serial number of the equipment.



61
62
63
 
# File 'lib/intersight_client/models/equipment_identity_summary.rb', line 61

def serial
  @serial
end

#slot_id ⇒ Object

Chassis slot number of a blade server.



64
65
66
 
# File 'lib/intersight_client/models/equipment_identity_summary.rb', line 64

def slot_id
  @slot_id
end

#source_object_type ⇒ Object

The source object type of this view MO.



67
68
69
 
# File 'lib/intersight_client/models/equipment_identity_summary.rb', line 67

def source_object_type
  @source_object_type
end

#switch_id ⇒ Object

Switch ID to which Fabric Extender is connected, ID can be either 1 or 2, equalent to A or B.



70
71
72
 
# File 'lib/intersight_client/models/equipment_identity_summary.rb', line 70

def switch_id
  @switch_id
end

#vendor ⇒ Object

The manufacturer of the equipment.



73
74
75
 
# File 'lib/intersight_client/models/equipment_identity_summary.rb', line 73

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)



131
132
133
 
# File 'lib/intersight_client/models/equipment_identity_summary.rb', line 131

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)



126
127
128
 
# File 'lib/intersight_client/models/equipment_identity_summary.rb', line 126

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.



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/intersight_client/models/equipment_identity_summary.rb', line 100

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'adapter_serial' => :'AdapterSerial',
    :'admin_action' => :'AdminAction',
    :'admin_action_state' => :'AdminActionState',
    :'chassis_id' => :'ChassisId',
    :'current_chassis_id' => :'CurrentChassisId',
    :'current_slot_id' => :'CurrentSlotId',
    :'firmware_supportability' => :'FirmwareSupportability',
    :'identifier' => :'Identifier',
    :'io_card_identity_list' => :'IoCardIdentityList',
    :'lifecycle' => :'Lifecycle',
    :'model' => :'Model',
    :'presence' => :'Presence',
    :'serial' => :'Serial',
    :'slot_id' => :'SlotId',
    :'source_object_type' => :'SourceObjectType',
    :'switch_id' => :'SwitchId',
    :'vendor' => :'Vendor',
    :'registered_device' => :'RegisteredDevice'
  }
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



445
446
447
 
# File 'lib/intersight_client/models/equipment_identity_summary.rb', line 445

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



169
170
171
172
173
174
 
# File 'lib/intersight_client/models/equipment_identity_summary.rb', line 169

def self.openapi_all_of
  [
  :'EquipmentIdentitySummaryAllOf',
  :'ViewsView'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



177
178
179
 
# File 'lib/intersight_client/models/equipment_identity_summary.rb', line 177

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



162
163
164
165
166
 
# File 'lib/intersight_client/models/equipment_identity_summary.rb', line 162

def self.openapi_nullable
  Set.new([
    :'io_card_identity_list',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/intersight_client/models/equipment_identity_summary.rb', line 136

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'adapter_serial' => :'String',
    :'admin_action' => :'String',
    :'admin_action_state' => :'String',
    :'chassis_id' => :'Integer',
    :'current_chassis_id' => :'Integer',
    :'current_slot_id' => :'Integer',
    :'firmware_supportability' => :'String',
    :'identifier' => :'Integer',
    :'io_card_identity_list' => :'Array<EquipmentIoCardIdentity>',
    :'lifecycle' => :'String',
    :'model' => :'String',
    :'presence' => :'String',
    :'serial' => :'String',
    :'slot_id' => :'Integer',
    :'source_object_type' => :'String',
    :'switch_id' => :'Integer',
    :'vendor' => :'String',
    :'registered_device' => :'AssetDeviceRegistrationRelationship'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'lib/intersight_client/models/equipment_identity_summary.rb', line 405

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      adapter_serial == o.adapter_serial &&
      admin_action == o.admin_action &&
      admin_action_state == o.admin_action_state &&
      chassis_id == o.chassis_id &&
      current_chassis_id == o.current_chassis_id &&
      current_slot_id == o.current_slot_id &&
      firmware_supportability == o.firmware_supportability &&
      identifier == o.identifier &&
      io_card_identity_list == o.io_card_identity_list &&
      lifecycle == o.lifecycle &&
      model == o.model &&
      presence == o.presence &&
      serial == o.serial &&
      slot_id == o.slot_id &&
      source_object_type == o.source_object_type &&
      switch_id == o.switch_id &&
      vendor == o.vendor &&
      registered_device == o.registered_device && 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



476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
 
# File 'lib/intersight_client/models/equipment_identity_summary.rb', line 476

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



547
548
549
550
551
552
553
554
555
556
557
558
559
 
# File 'lib/intersight_client/models/equipment_identity_summary.rb', line 547

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



452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
 
# File 'lib/intersight_client/models/equipment_identity_summary.rb', line 452

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


432
433
434
 
# File 'lib/intersight_client/models/equipment_identity_summary.rb', line 432

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



438
439
440
 
# File 'lib/intersight_client/models/equipment_identity_summary.rb', line 438

def hash
  [class_id, object_type, adapter_serial, admin_action, admin_action_state, chassis_id, current_chassis_id, current_slot_id, firmware_supportability, identifier, io_card_identity_list, lifecycle, model, presence, serial, slot_id, source_object_type, switch_id, vendor, registered_device].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



298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/intersight_client/models/equipment_identity_summary.rb', line 298

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

  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



523
524
525
 
# File 'lib/intersight_client/models/equipment_identity_summary.rb', line 523

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



529
530
531
532
533
534
535
536
537
538
539
540
541
 
# File 'lib/intersight_client/models/equipment_identity_summary.rb', line 529

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



517
518
519
 
# File 'lib/intersight_client/models/equipment_identity_summary.rb', line 517

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



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/intersight_client/models/equipment_identity_summary.rb', line 313

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["equipment.IdentitySummary"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["equipment.IdentitySummary"])
  return false unless object_type_validator.valid?(@object_type)
  admin_action_validator = EnumAttributeValidator.new('String', ["None", "Decommission", "Recommission", "Reack", "Remove", "Replace"])
  return false unless admin_action_validator.valid?(@admin_action)
  admin_action_state_validator = EnumAttributeValidator.new('String', ["None", "Applied", "Applying", "Failed"])
  return false unless admin_action_state_validator.valid?(@admin_action_state)
  firmware_supportability_validator = EnumAttributeValidator.new('String', ["Unknown", "Supported", "NotSupported"])
  return false unless firmware_supportability_validator.valid?(@firmware_supportability)
  lifecycle_validator = EnumAttributeValidator.new('String', ["None", "Active", "Decommissioned", "DecommissionInProgress", "RecommissionInProgress", "OperationFailed", "ReackInProgress", "RemoveInProgress", "Discovered", "DiscoveryInProgress", "DiscoveryFailed", "FirmwareUpgradeInProgress", "BladeMigrationInProgress", "Inactive", "ReplaceInProgress", "SlotMismatch"])
  return false unless lifecycle_validator.valid?(@lifecycle)
  presence_validator = EnumAttributeValidator.new('String', ["Unknown", "Equipped", "EquippedMismatch", "Missing"])
  return false unless presence_validator.valid?(@presence)
  true && super
end