Class: IntersightClient::EtherPortChannel

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

Overview

Model contains the details of the ethernet port-channels configured on the FI.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/intersight_client/models/ether_port_channel.rb', line 157

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#access_vlan ⇒ Object

Access VLANs for this port-channel, on this FI.



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

def access_vlan
  @access_vlan
end

#admin_state ⇒ Object

Administratively configured state (enabled/disabled) for this port-channel.



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

def admin_state
  @admin_state
end

#allowed_vlans ⇒ Object

Allowed VLANs on this port-channel, on this FI.



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

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

def class_id
  @class_id
end

#equipment_switch_card ⇒ Object

Returns the value of attribute equipment_switch_card.



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

def equipment_switch_card
  @equipment_switch_card
end

#mode ⇒ Object

Operating mode of this port-channel.



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

def mode
  @mode
end

#native_vlan ⇒ Object

Native VLAN for this port-channel, on this FI.



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

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

def object_type
  @object_type
end

#oper_speed ⇒ Object

Operational speed of this port-channel.



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

def oper_speed
  @oper_speed
end

#oper_state ⇒ Object

Operational state of this port-channel.



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

def oper_state
  @oper_state
end

#oper_state_qual ⇒ Object

Reason for this port-channel’s Operational state.



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

def oper_state_qual
  @oper_state_qual
end

#port_channel_id ⇒ Object

Unique identifier for this port-channel on the FI.



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

def port_channel_id
  @port_channel_id
end

#registered_device ⇒ Object

Returns the value of attribute registered_device.



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

def registered_device
  @registered_device
end

#role ⇒ Object

This port-channel’s configured role (uplink, server, etc.).



53
54
55
 
# File 'lib/intersight_client/models/ether_port_channel.rb', line 53

def role
  @role
end

#switch_id ⇒ Object

Switch Identifier that is local to a cluster.



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

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



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

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)



106
107
108
 
# File 'lib/intersight_client/models/ether_port_channel.rb', line 106

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.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/intersight_client/models/ether_port_channel.rb', line 85

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'access_vlan' => :'AccessVlan',
    :'admin_state' => :'AdminState',
    :'allowed_vlans' => :'AllowedVlans',
    :'mode' => :'Mode',
    :'native_vlan' => :'NativeVlan',
    :'oper_speed' => :'OperSpeed',
    :'oper_state' => :'OperState',
    :'oper_state_qual' => :'OperStateQual',
    :'port_channel_id' => :'PortChannelId',
    :'role' => :'Role',
    :'switch_id' => :'SwitchId',
    :'equipment_switch_card' => :'EquipmentSwitchCard',
    :'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



322
323
324
 
# File 'lib/intersight_client/models/ether_port_channel.rb', line 322

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



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

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

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



151
152
153
 
# File 'lib/intersight_client/models/ether_port_channel.rb', line 151

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



137
138
139
140
 
# File 'lib/intersight_client/models/ether_port_channel.rb', line 137

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/intersight_client/models/ether_port_channel.rb', line 116

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'access_vlan' => :'String',
    :'admin_state' => :'String',
    :'allowed_vlans' => :'String',
    :'mode' => :'String',
    :'native_vlan' => :'String',
    :'oper_speed' => :'String',
    :'oper_state' => :'String',
    :'oper_state_qual' => :'String',
    :'port_channel_id' => :'Integer',
    :'role' => :'String',
    :'switch_id' => :'String',
    :'equipment_switch_card' => :'EquipmentSwitchCardRelationship',
    :'registered_device' => :'AssetDeviceRegistrationRelationship'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/intersight_client/models/ether_port_channel.rb', line 287

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      access_vlan == o.access_vlan &&
      admin_state == o.admin_state &&
      allowed_vlans == o.allowed_vlans &&
      mode == o.mode &&
      native_vlan == o.native_vlan &&
      oper_speed == o.oper_speed &&
      oper_state == o.oper_state &&
      oper_state_qual == o.oper_state_qual &&
      port_channel_id == o.port_channel_id &&
      role == o.role &&
      switch_id == o.switch_id &&
      equipment_switch_card == o.equipment_switch_card &&
      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



353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/intersight_client/models/ether_port_channel.rb', line 353

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



424
425
426
427
428
429
430
431
432
433
434
435
436
 
# File 'lib/intersight_client/models/ether_port_channel.rb', line 424

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



329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/intersight_client/models/ether_port_channel.rb', line 329

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


309
310
311
 
# File 'lib/intersight_client/models/ether_port_channel.rb', line 309

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



315
316
317
 
# File 'lib/intersight_client/models/ether_port_channel.rb', line 315

def hash
  [class_id, object_type, access_vlan, admin_state, allowed_vlans, mode, native_vlan, oper_speed, oper_state, oper_state_qual, port_channel_id, role, switch_id, equipment_switch_card, 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



240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/intersight_client/models/ether_port_channel.rb', line 240

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



400
401
402
 
# File 'lib/intersight_client/models/ether_port_channel.rb', line 400

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



406
407
408
409
410
411
412
413
414
415
416
417
418
 
# File 'lib/intersight_client/models/ether_port_channel.rb', line 406

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



394
395
396
 
# File 'lib/intersight_client/models/ether_port_channel.rb', line 394

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



255
256
257
258
259
260
261
262
263
 
# File 'lib/intersight_client/models/ether_port_channel.rb', line 255

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["ether.PortChannel"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["ether.PortChannel"])
  return false unless object_type_validator.valid?(@object_type)
  true && super
end