Class: IntersightClient::VnicFcAdapterPolicy

Inherits:
PolicyAbstractPolicy show all
Defined in:
lib/intersight_client/models/vnic_fc_adapter_policy.rb

Overview

A Fibre Channel Adapter policy governs the host-side behavior of the adapter, including how the adapter handles traffic. You can enable FCP Error Recovery, change the default settings of Queues and Interrupt handling for performance enhancement.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from PolicyAbstractPolicy

#description, #name

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



158
159
160
161
162
163
164
165
166
167
168
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
 
# File 'lib/intersight_client/models/vnic_fc_adapter_policy.rb', line 158

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

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

  if attributes.key?(:'error_detection_timeout')
    self.error_detection_timeout = attributes[:'error_detection_timeout']
  else
    self.error_detection_timeout = 2000
  end

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

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

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

  if attributes.key?(:'io_throttle_count')
    self.io_throttle_count = attributes[:'io_throttle_count']
  else
    self.io_throttle_count = 512
  end

  if attributes.key?(:'lun_count')
    self.lun_count = attributes[:'lun_count']
  else
    self.lun_count = 1024
  end

  if attributes.key?(:'lun_queue_depth')
    self.lun_queue_depth = attributes[:'lun_queue_depth']
  else
    self.lun_queue_depth = 20
  end

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

  if attributes.key?(:'resource_allocation_timeout')
    self.resource_allocation_timeout = attributes[:'resource_allocation_timeout']
  else
    self.resource_allocation_timeout = 10000
  end

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

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

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

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



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

def class_id
  @class_id
end

#error_detection_timeout ⇒ Object

Error Detection Timeout, also referred to as EDTOV, is the number of milliseconds to wait before the system assumes that an error has occurred.



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

def error_detection_timeout
  @error_detection_timeout
end

#error_recovery_settings ⇒ Object

Returns the value of attribute error_recovery_settings.



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

def error_recovery_settings
  @error_recovery_settings
end

#flogi_settings ⇒ Object

Returns the value of attribute flogi_settings.



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

def flogi_settings
  @flogi_settings
end

#interrupt_settings ⇒ Object

Returns the value of attribute interrupt_settings.



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

def interrupt_settings
  @interrupt_settings
end

#io_throttle_count ⇒ Object

The maximum number of data or control I/O operations that can be pending for the virtual interface at one time. If this value is exceeded, the additional I/O operations wait in the queue until the number of pending I/O operations decreases and the additional operations can be processed.



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

def io_throttle_count
  @io_throttle_count
end

#lun_count ⇒ Object

The maximum number of LUNs that the Fibre Channel driver will export or show. The maximum number of LUNs is usually controlled by the operating system running on the server.



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

def lun_count
  @lun_count
end

#lun_queue_depth ⇒ Object

The number of commands that the HBA can send and receive in a single transmission per LUN.



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

def lun_queue_depth
  @lun_queue_depth
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/vnic_fc_adapter_policy.rb', line 23

def object_type
  @object_type
end

#organization ⇒ Object

Returns the value of attribute organization.



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

def organization
  @organization
end

#plogi_settings ⇒ Object

Returns the value of attribute plogi_settings.



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

def plogi_settings
  @plogi_settings
end

#resource_allocation_timeout ⇒ Object

Resource Allocation Timeout, also referred to as RATOV, is the number of milliseconds to wait before the system assumes that a resource cannot be properly allocated.



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

def resource_allocation_timeout
  @resource_allocation_timeout
end

#rx_queue_settings ⇒ Object

Returns the value of attribute rx_queue_settings.



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

def rx_queue_settings
  @rx_queue_settings
end

#scsi_queue_settings ⇒ Object

Returns the value of attribute scsi_queue_settings.



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

def scsi_queue_settings
  @scsi_queue_settings
end

#tx_queue_settings ⇒ Object

Returns the value of attribute tx_queue_settings.



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

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



105
106
107
 
# File 'lib/intersight_client/models/vnic_fc_adapter_policy.rb', line 105

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)



100
101
102
 
# File 'lib/intersight_client/models/vnic_fc_adapter_policy.rb', line 100

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.



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/intersight_client/models/vnic_fc_adapter_policy.rb', line 79

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'error_detection_timeout' => :'ErrorDetectionTimeout',
    :'error_recovery_settings' => :'ErrorRecoverySettings',
    :'flogi_settings' => :'FlogiSettings',
    :'interrupt_settings' => :'InterruptSettings',
    :'io_throttle_count' => :'IoThrottleCount',
    :'lun_count' => :'LunCount',
    :'lun_queue_depth' => :'LunQueueDepth',
    :'plogi_settings' => :'PlogiSettings',
    :'resource_allocation_timeout' => :'ResourceAllocationTimeout',
    :'rx_queue_settings' => :'RxQueueSettings',
    :'scsi_queue_settings' => :'ScsiQueueSettings',
    :'tx_queue_settings' => :'TxQueueSettings',
    :'organization' => :'Organization'
  }
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



453
454
455
 
# File 'lib/intersight_client/models/vnic_fc_adapter_policy.rb', line 453

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



144
145
146
147
148
149
 
# File 'lib/intersight_client/models/vnic_fc_adapter_policy.rb', line 144

def self.openapi_all_of
  [
  :'PolicyAbstractPolicy',
  :'VnicFcAdapterPolicyAllOf'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



152
153
154
 
# File 'lib/intersight_client/models/vnic_fc_adapter_policy.rb', line 152

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/intersight_client/models/vnic_fc_adapter_policy.rb', line 131

def self.openapi_nullable
  Set.new([
    :'error_recovery_settings',
    :'flogi_settings',
    :'interrupt_settings',
    :'plogi_settings',
    :'rx_queue_settings',
    :'scsi_queue_settings',
    :'tx_queue_settings',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/intersight_client/models/vnic_fc_adapter_policy.rb', line 110

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'error_detection_timeout' => :'Integer',
    :'error_recovery_settings' => :'VnicFcErrorRecoverySettings',
    :'flogi_settings' => :'VnicFlogiSettings',
    :'interrupt_settings' => :'VnicFcInterruptSettings',
    :'io_throttle_count' => :'Integer',
    :'lun_count' => :'Integer',
    :'lun_queue_depth' => :'Integer',
    :'plogi_settings' => :'VnicPlogiSettings',
    :'resource_allocation_timeout' => :'Integer',
    :'rx_queue_settings' => :'VnicFcQueueSettings',
    :'scsi_queue_settings' => :'VnicScsiQueueSettings',
    :'tx_queue_settings' => :'VnicFcQueueSettings',
    :'organization' => :'OrganizationOrganizationRelationship'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
 
# File 'lib/intersight_client/models/vnic_fc_adapter_policy.rb', line 418

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      error_detection_timeout == o.error_detection_timeout &&
      error_recovery_settings == o.error_recovery_settings &&
      flogi_settings == o.flogi_settings &&
      interrupt_settings == o.interrupt_settings &&
      io_throttle_count == o.io_throttle_count &&
      lun_count == o.lun_count &&
      lun_queue_depth == o.lun_queue_depth &&
      plogi_settings == o.plogi_settings &&
      resource_allocation_timeout == o.resource_allocation_timeout &&
      rx_queue_settings == o.rx_queue_settings &&
      scsi_queue_settings == o.scsi_queue_settings &&
      tx_queue_settings == o.tx_queue_settings &&
      organization == o.organization && 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



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
514
515
516
517
518
519
520
521
 
# File 'lib/intersight_client/models/vnic_fc_adapter_policy.rb', line 484

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



555
556
557
558
559
560
561
562
563
564
565
566
567
 
# File 'lib/intersight_client/models/vnic_fc_adapter_policy.rb', line 555

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



460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
 
# File 'lib/intersight_client/models/vnic_fc_adapter_policy.rb', line 460

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


440
441
442
 
# File 'lib/intersight_client/models/vnic_fc_adapter_policy.rb', line 440

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



446
447
448
 
# File 'lib/intersight_client/models/vnic_fc_adapter_policy.rb', line 446

def hash
  [class_id, object_type, error_detection_timeout, error_recovery_settings, flogi_settings, interrupt_settings, io_throttle_count, lun_count, lun_queue_depth, plogi_settings, resource_allocation_timeout, rx_queue_settings, scsi_queue_settings, tx_queue_settings, organization].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



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
295
296
297
298
299
300
301
302
 
# File 'lib/intersight_client/models/vnic_fc_adapter_policy.rb', line 251

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

  if !@error_detection_timeout.nil? && @error_detection_timeout > 100000
    invalid_properties.push('invalid value for "error_detection_timeout", must be smaller than or equal to 100000.')
  end

  if !@error_detection_timeout.nil? && @error_detection_timeout < 1000
    invalid_properties.push('invalid value for "error_detection_timeout", must be greater than or equal to 1000.')
  end

  if !@io_throttle_count.nil? && @io_throttle_count > 1024
    invalid_properties.push('invalid value for "io_throttle_count", must be smaller than or equal to 1024.')
  end

  if !@io_throttle_count.nil? && @io_throttle_count < 1
    invalid_properties.push('invalid value for "io_throttle_count", must be greater than or equal to 1.')
  end

  if !@lun_count.nil? && @lun_count > 1024
    invalid_properties.push('invalid value for "lun_count", must be smaller than or equal to 1024.')
  end

  if !@lun_count.nil? && @lun_count < 1
    invalid_properties.push('invalid value for "lun_count", must be greater than or equal to 1.')
  end

  if !@lun_queue_depth.nil? && @lun_queue_depth > 254
    invalid_properties.push('invalid value for "lun_queue_depth", must be smaller than or equal to 254.')
  end

  if !@lun_queue_depth.nil? && @lun_queue_depth < 1
    invalid_properties.push('invalid value for "lun_queue_depth", must be greater than or equal to 1.')
  end

  if !@resource_allocation_timeout.nil? && @resource_allocation_timeout > 100000
    invalid_properties.push('invalid value for "resource_allocation_timeout", must be smaller than or equal to 100000.')
  end

  if !@resource_allocation_timeout.nil? && @resource_allocation_timeout < 5000
    invalid_properties.push('invalid value for "resource_allocation_timeout", must be greater than or equal to 5000.')
  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



531
532
533
 
# File 'lib/intersight_client/models/vnic_fc_adapter_policy.rb', line 531

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



537
538
539
540
541
542
543
544
545
546
547
548
549
 
# File 'lib/intersight_client/models/vnic_fc_adapter_policy.rb', line 537

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



525
526
527
 
# File 'lib/intersight_client/models/vnic_fc_adapter_policy.rb', line 525

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



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/intersight_client/models/vnic_fc_adapter_policy.rb', line 306

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["vnic.FcAdapterPolicy"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["vnic.FcAdapterPolicy"])
  return false unless object_type_validator.valid?(@object_type)
  return false if !@error_detection_timeout.nil? && @error_detection_timeout > 100000
  return false if !@error_detection_timeout.nil? && @error_detection_timeout < 1000
  return false if !@io_throttle_count.nil? && @io_throttle_count > 1024
  return false if !@io_throttle_count.nil? && @io_throttle_count < 1
  return false if !@lun_count.nil? && @lun_count > 1024
  return false if !@lun_count.nil? && @lun_count < 1
  return false if !@lun_queue_depth.nil? && @lun_queue_depth > 254
  return false if !@lun_queue_depth.nil? && @lun_queue_depth < 1
  return false if !@resource_allocation_timeout.nil? && @resource_allocation_timeout > 100000
  return false if !@resource_allocation_timeout.nil? && @resource_allocation_timeout < 5000
  true && super
end