Class: IntersightClient::ComputeServerSetting

Inherits:
InventoryBase show all
Defined in:
lib/intersight_client/models/compute_server_setting.rb

Overview

Models the configurable properties of a server in Intersight.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from InventoryBase

#device_mo_id, #dn, #rn

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
272
273
274
275
276
277
278
279
280
 
# File 'lib/intersight_client/models/compute_server_setting.rb', line 175

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

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

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

  if attributes.key?(:'admin_power_state')
    self.admin_power_state = attributes[:'admin_power_state']
  else
    self.admin_power_state = 'Policy'
  end

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

  if attributes.key?(:'cmos_reset')
    self.cmos_reset = attributes[:'cmos_reset']
  else
    self.cmos_reset = 'Ready'
  end

  if attributes.key?(:'config_state')
    self.config_state = attributes[:'config_state']
  else
    self.config_state = 'Applied'
  end

  if attributes.key?(:'front_panel_lock_state')
    self.front_panel_lock_state = attributes[:'front_panel_lock_state']
  else
    self.front_panel_lock_state = 'Unlock'
  end

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#admin_locator_led_state ⇒ Object

User configured state of the locator LED for the server. * None - No operation property for locator led. * On - The Locator Led is turned on. * Off - The Locator Led is turned off.



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

def admin_locator_led_state
  @admin_locator_led_state
end

#admin_power_state ⇒ Object

User configured power state of the server. * Policy - Power state is set to the default value in the policy. * PowerOn - Power state of the server is set to On. * PowerOff - Power state is the server set to Off. * PowerCycle - Power state the server is reset. * HardReset - Power state the server is hard reset. * Shutdown - Operating system on the server is shut down. * Reboot - Power state of IMC is rebooted.



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

def admin_power_state
  @admin_power_state
end

#certificates_action ⇒ Object

Returns the value of attribute certificates_action.



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

def certificates_action
  @certificates_action
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/compute_server_setting.rb', line 20

def class_id
  @class_id
end

#cmos_reset ⇒ Object

The allowed actions on the CMOS Reset. * Ready - CMOS Reset operation is allowed to be done on the server in this state. * Pending - This indicates that the previous CMOS Reset operation on this server has not completed due to a pending power cycle. CMOS Reset operation cannot be done on the server when in this state. * Reset - The value that the UI/API needs to provide to trigger a CMOS Reset operation on a server.



34
35
36
 
# File 'lib/intersight_client/models/compute_server_setting.rb', line 34

def cmos_reset
  @cmos_reset
end

#config_state ⇒ Object

The configured state of these settings in the target server. The value is any one of Applied, Applying, Failed. Applied - This state denotes that the settings are applied successfully in the target server. Applying - This state denotes that the settings are being applied in the target server. Failed - This state denotes that the settings could not be applied in the target server. * 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.



37
38
39
 
# File 'lib/intersight_client/models/compute_server_setting.rb', line 37

def config_state
  @config_state
end

#front_panel_lock_state ⇒ Object

The allowed actions on the Front Panel Lock. * Unlock - Front Panel of the server is set to Unlocked state. * Lock - Front Panel of the server is set to Locked state.



40
41
42
 
# File 'lib/intersight_client/models/compute_server_setting.rb', line 40

def front_panel_lock_state
  @front_panel_lock_state
end

#locator_led ⇒ Object

Returns the value of attribute locator_led.



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

def locator_led
  @locator_led
end

#name ⇒ Object

The property used to identify the name of the server it is associated with.



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

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.



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

def object_type
  @object_type
end

#one_time_boot_device ⇒ Object

The name of the device chosen by user for configuring One-Time Boot device.



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

def one_time_boot_device
  @one_time_boot_device
end

#persistent_memory_operation ⇒ Object

Returns the value of attribute persistent_memory_operation.



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

def persistent_memory_operation
  @persistent_memory_operation
end

#registered_device ⇒ Object

Returns the value of attribute registered_device.



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

def registered_device
  @registered_device
end

#running_workflow ⇒ Object

Returns the value of attribute running_workflow.



62
63
64
 
# File 'lib/intersight_client/models/compute_server_setting.rb', line 62

def running_workflow
  @running_workflow
end

#server ⇒ Object

Returns the value of attribute server.



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

def server
  @server
end

#server_config ⇒ Object

Returns the value of attribute server_config.



50
51
52
 
# File 'lib/intersight_client/models/compute_server_setting.rb', line 50

def server_config
  @server_config
end

#storage_controller_operation ⇒ Object

Returns the value of attribute storage_controller_operation.



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

def storage_controller_operation
  @storage_controller_operation
end

#storage_physical_drive_operation ⇒ Object

Returns the value of attribute storage_physical_drive_operation.



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

def storage_physical_drive_operation
  @storage_physical_drive_operation
end

#storage_virtual_drive_operation ⇒ Object

Returns the value of attribute storage_virtual_drive_operation.



56
57
58
 
# File 'lib/intersight_client/models/compute_server_setting.rb', line 56

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



119
120
121
 
# File 'lib/intersight_client/models/compute_server_setting.rb', line 119

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)



114
115
116
 
# File 'lib/intersight_client/models/compute_server_setting.rb', line 114

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.



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

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'admin_locator_led_state' => :'AdminLocatorLedState',
    :'admin_power_state' => :'AdminPowerState',
    :'certificates_action' => :'CertificatesAction',
    :'cmos_reset' => :'CmosReset',
    :'config_state' => :'ConfigState',
    :'front_panel_lock_state' => :'FrontPanelLockState',
    :'name' => :'Name',
    :'one_time_boot_device' => :'OneTimeBootDevice',
    :'persistent_memory_operation' => :'PersistentMemoryOperation',
    :'server_config' => :'ServerConfig',
    :'storage_controller_operation' => :'StorageControllerOperation',
    :'storage_physical_drive_operation' => :'StoragePhysicalDriveOperation',
    :'storage_virtual_drive_operation' => :'StorageVirtualDriveOperation',
    :'locator_led' => :'LocatorLed',
    :'registered_device' => :'RegisteredDevice',
    :'running_workflow' => :'RunningWorkflow',
    :'server' => :'Server'
  }
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



430
431
432
 
# File 'lib/intersight_client/models/compute_server_setting.rb', line 430

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



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

def self.openapi_all_of
  [
  :'ComputeServerSettingAllOf',
  :'InventoryBase'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



169
170
171
 
# File 'lib/intersight_client/models/compute_server_setting.rb', line 169

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
158
 
# File 'lib/intersight_client/models/compute_server_setting.rb', line 149

def self.openapi_nullable
  Set.new([
    :'certificates_action',
    :'persistent_memory_operation',
    :'server_config',
    :'storage_controller_operation',
    :'storage_physical_drive_operation',
    :'storage_virtual_drive_operation',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



124
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/compute_server_setting.rb', line 124

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'admin_locator_led_state' => :'String',
    :'admin_power_state' => :'String',
    :'certificates_action' => :'CertificatemanagementCertificateBase',
    :'cmos_reset' => :'String',
    :'config_state' => :'String',
    :'front_panel_lock_state' => :'String',
    :'name' => :'String',
    :'one_time_boot_device' => :'String',
    :'persistent_memory_operation' => :'ComputePersistentMemoryOperation',
    :'server_config' => :'ComputeServerConfig',
    :'storage_controller_operation' => :'ComputeStorageControllerOperation',
    :'storage_physical_drive_operation' => :'ComputeStoragePhysicalDriveOperation',
    :'storage_virtual_drive_operation' => :'ComputeStorageVirtualDriveOperation',
    :'locator_led' => :'EquipmentLocatorLedRelationship',
    :'registered_device' => :'AssetDeviceRegistrationRelationship',
    :'running_workflow' => :'WorkflowWorkflowInfoRelationship',
    :'server' => :'ComputePhysicalRelationship'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      admin_locator_led_state == o.admin_locator_led_state &&
      admin_power_state == o.admin_power_state &&
      certificates_action == o.certificates_action &&
      cmos_reset == o.cmos_reset &&
      config_state == o.config_state &&
      front_panel_lock_state == o.front_panel_lock_state &&
      name == o.name &&
      one_time_boot_device == o.one_time_boot_device &&
      persistent_memory_operation == o.persistent_memory_operation &&
      server_config == o.server_config &&
      storage_controller_operation == o.storage_controller_operation &&
      storage_physical_drive_operation == o.storage_physical_drive_operation &&
      storage_virtual_drive_operation == o.storage_virtual_drive_operation &&
      locator_led == o.locator_led &&
      registered_device == o.registered_device &&
      running_workflow == o.running_workflow &&
      server == o.server && 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



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
494
495
496
497
498
 
# File 'lib/intersight_client/models/compute_server_setting.rb', line 461

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



532
533
534
535
536
537
538
539
540
541
542
543
544
 
# File 'lib/intersight_client/models/compute_server_setting.rb', line 532

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



437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
 
# File 'lib/intersight_client/models/compute_server_setting.rb', line 437

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


417
418
419
 
# File 'lib/intersight_client/models/compute_server_setting.rb', line 417

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



423
424
425
 
# File 'lib/intersight_client/models/compute_server_setting.rb', line 423

def hash
  [class_id, object_type, admin_locator_led_state, admin_power_state, certificates_action, cmos_reset, config_state, front_panel_lock_state, name, one_time_boot_device, persistent_memory_operation, server_config, storage_controller_operation, storage_physical_drive_operation, storage_virtual_drive_operation, locator_led, registered_device, running_workflow, server].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



284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/intersight_client/models/compute_server_setting.rb', line 284

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



508
509
510
 
# File 'lib/intersight_client/models/compute_server_setting.rb', line 508

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



514
515
516
517
518
519
520
521
522
523
524
525
526
 
# File 'lib/intersight_client/models/compute_server_setting.rb', line 514

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



502
503
504
 
# File 'lib/intersight_client/models/compute_server_setting.rb', line 502

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



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/intersight_client/models/compute_server_setting.rb', line 299

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["compute.ServerSetting"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["compute.ServerSetting"])
  return false unless object_type_validator.valid?(@object_type)
  admin_locator_led_state_validator = EnumAttributeValidator.new('String', ["None", "On", "Off"])
  return false unless admin_locator_led_state_validator.valid?(@admin_locator_led_state)
  admin_power_state_validator = EnumAttributeValidator.new('String', ["Policy", "PowerOn", "PowerOff", "PowerCycle", "HardReset", "Shutdown", "Reboot"])
  return false unless admin_power_state_validator.valid?(@admin_power_state)
  cmos_reset_validator = EnumAttributeValidator.new('String', ["Ready", "Pending", "Reset"])
  return false unless cmos_reset_validator.valid?(@cmos_reset)
  config_state_validator = EnumAttributeValidator.new('String', ["Applied", "Applying", "Failed"])
  return false unless config_state_validator.valid?(@config_state)
  front_panel_lock_state_validator = EnumAttributeValidator.new('String', ["Unlock", "Lock"])
  return false unless front_panel_lock_state_validator.valid?(@front_panel_lock_state)
  true && super
end