Class: IntersightClient::VirtualizationVmwareTeamingAndFailover

Inherits:
MoBaseComplexType show all
Defined in:
lib/intersight_client/models/virtualization_vmware_teaming_and_failover.rb

Overview

The teams can then either share the load of traffic between physical and virtual networks among some or all of its members, or provide passive failover in the event of a hardware failure or a network outage.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ VirtualizationVmwareTeamingAndFailover

Initializes the object

Parameters:

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

    Model attributes in the form of hash



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
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
 
# File 'lib/intersight_client/models/virtualization_vmware_teaming_and_failover.rb', line 129

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

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

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

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

  if attributes.key?(:'load_balancing')
    self.load_balancing = attributes[:'load_balancing']
  else
    self.load_balancing = 'loadbalanceIP'
  end

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

  if attributes.key?(:'network_failure_detection')
    self.network_failure_detection = attributes[:'network_failure_detection']
  else
    self.network_failure_detection = 'linkStatus'
  end

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

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

Instance Attribute Details

#active_adapters ⇒ Object

Returns the value of attribute active_adapters.



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

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

def class_id
  @class_id
end

#failback ⇒ Object

By default, a failback policy is enabled on a NIC team. If a failed physical NIC returns online, the network component sets the NIC back to active by replacing the standby NIC that took over its slot.



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

def failback
  @failback
end

#load_balancing ⇒ Object

Determines how network traffic is distributed between the network adapters in a NIC team. * ‘loadbalanceIP` - Load balance based on IP hash. * `loadbalanceSrcmac` - Route based on source MAC hash. * `loadbalanceSrcid` - Route based on originating virtual port. * `failoverExplicit` - Use explicit failover order. * `loadbalanceSrcnic` - Route based on physical NIC load.



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

def load_balancing
  @load_balancing
end

#name ⇒ Object

Name of the network component, example dvswitch, dvnetwork, vswitch or standard network.



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

def name
  @name
end

#network_failure_detection ⇒ Object

Methods used by network component for failover detection. * ‘linkStatus` - This option detects failures such as removed cables and physical switch power failures. * `beaconProbing` - Sends out and listens for beacon probes on all NICs in the team, and uses this information, in addition to link status, to determine link failure. ESXi sends beacon packets every second.



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

def network_failure_detection
  @network_failure_detection
end

#notify_switches ⇒ Object

Determines how network traffic is distributed between the network adapters in a NIC team.



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

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

def object_type
  @object_type
end

#standby_adapters ⇒ Object

Returns the value of attribute standby_adapters.



42
43
44
 
# File 'lib/intersight_client/models/virtualization_vmware_teaming_and_failover.rb', line 42

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



87
88
89
 
# File 'lib/intersight_client/models/virtualization_vmware_teaming_and_failover.rb', line 87

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)



82
83
84
 
# File 'lib/intersight_client/models/virtualization_vmware_teaming_and_failover.rb', line 82

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.



67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/intersight_client/models/virtualization_vmware_teaming_and_failover.rb', line 67

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'active_adapters' => :'ActiveAdapters',
    :'failback' => :'Failback',
    :'load_balancing' => :'LoadBalancing',
    :'name' => :'Name',
    :'network_failure_detection' => :'NetworkFailureDetection',
    :'notify_switches' => :'NotifySwitches',
    :'standby_adapters' => :'StandbyAdapters'
  }
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



296
297
298
 
# File 'lib/intersight_client/models/virtualization_vmware_teaming_and_failover.rb', line 296

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



115
116
117
118
119
120
 
# File 'lib/intersight_client/models/virtualization_vmware_teaming_and_failover.rb', line 115

def self.openapi_all_of
  [
  :'MoBaseComplexType',
  :'VirtualizationVmwareTeamingAndFailoverAllOf'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



123
124
125
 
# File 'lib/intersight_client/models/virtualization_vmware_teaming_and_failover.rb', line 123

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



107
108
109
110
111
112
 
# File 'lib/intersight_client/models/virtualization_vmware_teaming_and_failover.rb', line 107

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

.openapi_types ⇒ Object

Attribute type mapping.



92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/intersight_client/models/virtualization_vmware_teaming_and_failover.rb', line 92

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'active_adapters' => :'Array<String>',
    :'failback' => :'Boolean',
    :'load_balancing' => :'String',
    :'name' => :'String',
    :'network_failure_detection' => :'String',
    :'notify_switches' => :'Boolean',
    :'standby_adapters' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/intersight_client/models/virtualization_vmware_teaming_and_failover.rb', line 267

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      active_adapters == o.active_adapters &&
      failback == o.failback &&
      load_balancing == o.load_balancing &&
      name == o.name &&
      network_failure_detection == o.network_failure_detection &&
      notify_switches == o.notify_switches &&
      standby_adapters == o.standby_adapters && 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



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/intersight_client/models/virtualization_vmware_teaming_and_failover.rb', line 327

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



398
399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'lib/intersight_client/models/virtualization_vmware_teaming_and_failover.rb', line 398

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



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/intersight_client/models/virtualization_vmware_teaming_and_failover.rb', line 303

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


283
284
285
 
# File 'lib/intersight_client/models/virtualization_vmware_teaming_and_failover.rb', line 283

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



289
290
291
 
# File 'lib/intersight_client/models/virtualization_vmware_teaming_and_failover.rb', line 289

def hash
  [class_id, object_type, active_adapters, failback, load_balancing, name, network_failure_detection, notify_switches, standby_adapters].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



196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/intersight_client/models/virtualization_vmware_teaming_and_failover.rb', line 196

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



374
375
376
 
# File 'lib/intersight_client/models/virtualization_vmware_teaming_and_failover.rb', line 374

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



380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/intersight_client/models/virtualization_vmware_teaming_and_failover.rb', line 380

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



368
369
370
 
# File 'lib/intersight_client/models/virtualization_vmware_teaming_and_failover.rb', line 368

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



211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/intersight_client/models/virtualization_vmware_teaming_and_failover.rb', line 211

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["virtualization.VmwareTeamingAndFailover"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["virtualization.VmwareTeamingAndFailover"])
  return false unless object_type_validator.valid?(@object_type)
  load_balancing_validator = EnumAttributeValidator.new('String', ["loadbalanceIP", "loadbalanceSrcmac", "loadbalanceSrcid", "failoverExplicit", "loadbalanceSrcnic"])
  return false unless load_balancing_validator.valid?(@load_balancing)
  network_failure_detection_validator = EnumAttributeValidator.new('String', ["linkStatus", "beaconProbing"])
  return false unless network_failure_detection_validator.valid?(@network_failure_detection)
  true && super
end