Class: IntersightClient::VirtualizationVmwareDistributedNetwork

Inherits:
VirtualizationBaseDistributedNetwork show all
Defined in:
lib/intersight_client/models/virtualization_vmware_distributed_network.rb

Overview

The VMware Distributed Virtual PortGroup object is represented here.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from VirtualizationBaseNetwork

#identity, #name

Attributes inherited from VirtualizationBaseSourceDevice

#registered_device

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

  if attributes.key?(:'forged_transmits')
    self.forged_transmits = attributes[:'forged_transmits']
  else
    self.forged_transmits = 'Reject'
  end

  if attributes.key?(:'mac_address_changes')
    self.mac_address_changes = attributes[:'mac_address_changes']
  else
    self.mac_address_changes = 'Reject'
  end

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

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

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

  if attributes.key?(:'promiscuous_mode')
    self.promiscuous_mode = attributes[:'promiscuous_mode']
  else
    self.promiscuous_mode = 'Reject'
  end

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

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

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

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

  if attributes.key?(:'hosts')
    if (value = attributes[:'hosts']).is_a?(Array)
      self.hosts = value
    end
  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/virtualization_vmware_distributed_network.rb', line 20

def class_id
  @class_id
end

#distributed_switch ⇒ Object

Returns the value of attribute distributed_switch.



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

def distributed_switch
  @distributed_switch
end

#forged_transmits ⇒ Object

If forgedTransmits property value is set to reject, outbound frames with a source MAC address different from the one set on the adapter are dropped. If property value is set to accept, no filtering is performed and all outbound frames are passed. * ‘Reject` - Indicates that the security policy is rejected. * `Accept` - Indicates that the security policy is accepted.



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

def forged_transmits
  @forged_transmits
end

#hosts ⇒ Object

An array of relationships to virtualizationVmwareHost resources.



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

def hosts
  @hosts
end

#mac_address_changes ⇒ Object

If macAddressChanges property value is set to reject and the MAC address of the adapter is changed to a value other than the one specified in .vmx configuration file, all inbound frames are dropped. If property value is set to accept and the MAC address is changed, inbound frames to the new MAC address are received. * ‘Reject` - Indicates that the security policy is rejected. * `Accept` - Indicates that the security policy is accepted.



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

def mac_address_changes
  @mac_address_changes
end

#nic_teaming_and_failover ⇒ Object

Returns the value of attribute nic_teaming_and_failover.



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

def nic_teaming_and_failover
  @nic_teaming_and_failover
end

#num_hosts ⇒ Object

The total number of hosts connected to this distributed virtual network.



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

def num_hosts
  @num_hosts
end

#num_ports ⇒ Object

The total number of ports in the distributed virtual network.



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

def num_ports
  @num_ports
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_distributed_network.rb', line 23

def object_type
  @object_type
end

#promiscuous_mode ⇒ Object

If promiscuousMode property value is set to reject, incoming traffic only targeted to that network will be visible. If property value is set to accept, objects defined within the network can see all incoming traffic on the virtual switch based on the VLAN policy. * ‘Reject` - Indicates that the security policy is rejected. * `Accept` - Indicates that the security policy is accepted.



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

def promiscuous_mode
  @promiscuous_mode
end

#up_link ⇒ Object

Indicates if the distributed virtual network is a uplink.



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

def up_link
  @up_link
end

#vlan_range ⇒ Object

Returns the value of attribute vlan_range.



45
46
47
 
# File 'lib/intersight_client/models/virtualization_vmware_distributed_network.rb', line 45

def vlan_range
  @vlan_range
end

#vlan_type ⇒ Object

VLAN type of the distributed virtual network. It can be None, VLAN, VLAN Trunking or Private VLAN. * ‘None` - Do not tag traffic with any VLAN Id. * `VLAN` - Tag traffic with the Id from the VLAN Id field. * `VLAN trunking` - Pass VLAN traffic with Id within the VLAN trunk range to guest operating system. * `Private VLAN` - Associate the traffic with a private VLAN created on the distributed switch.



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

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



102
103
104
 
# File 'lib/intersight_client/models/virtualization_vmware_distributed_network.rb', line 102

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)



97
98
99
 
# File 'lib/intersight_client/models/virtualization_vmware_distributed_network.rb', line 97

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.



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

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'forged_transmits' => :'ForgedTransmits',
    :'mac_address_changes' => :'MacAddressChanges',
    :'nic_teaming_and_failover' => :'NicTeamingAndFailover',
    :'num_hosts' => :'NumHosts',
    :'num_ports' => :'NumPorts',
    :'promiscuous_mode' => :'PromiscuousMode',
    :'up_link' => :'UpLink',
    :'vlan_range' => :'VlanRange',
    :'vlan_type' => :'VlanType',
    :'distributed_switch' => :'DistributedSwitch',
    :'hosts' => :'Hosts'
  }
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



364
365
366
 
# File 'lib/intersight_client/models/virtualization_vmware_distributed_network.rb', line 364

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



135
136
137
138
139
140
 
# File 'lib/intersight_client/models/virtualization_vmware_distributed_network.rb', line 135

def self.openapi_all_of
  [
  :'VirtualizationBaseDistributedNetwork',
  :'VirtualizationVmwareDistributedNetworkAllOf'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



143
144
145
 
# File 'lib/intersight_client/models/virtualization_vmware_distributed_network.rb', line 143

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



126
127
128
129
130
131
132
 
# File 'lib/intersight_client/models/virtualization_vmware_distributed_network.rb', line 126

def self.openapi_nullable
  Set.new([
    :'nic_teaming_and_failover',
    :'vlan_range',
    :'hosts'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/intersight_client/models/virtualization_vmware_distributed_network.rb', line 107

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'forged_transmits' => :'String',
    :'mac_address_changes' => :'String',
    :'nic_teaming_and_failover' => :'VirtualizationVmwareTeamingAndFailover',
    :'num_hosts' => :'Integer',
    :'num_ports' => :'Integer',
    :'promiscuous_mode' => :'String',
    :'up_link' => :'Boolean',
    :'vlan_range' => :'Array<VirtualizationVmwareVlanRange>',
    :'vlan_type' => :'String',
    :'distributed_switch' => :'VirtualizationVmwareDistributedSwitchRelationship',
    :'hosts' => :'Array<VirtualizationVmwareHostRelationship>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      forged_transmits == o.forged_transmits &&
      mac_address_changes == o.mac_address_changes &&
      nic_teaming_and_failover == o.nic_teaming_and_failover &&
      num_hosts == o.num_hosts &&
      num_ports == o.num_ports &&
      promiscuous_mode == o.promiscuous_mode &&
      up_link == o.up_link &&
      vlan_range == o.vlan_range &&
      vlan_type == o.vlan_type &&
      distributed_switch == o.distributed_switch &&
      hosts == o.hosts && 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



395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
 
# File 'lib/intersight_client/models/virtualization_vmware_distributed_network.rb', line 395

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



466
467
468
469
470
471
472
473
474
475
476
477
478
 
# File 'lib/intersight_client/models/virtualization_vmware_distributed_network.rb', line 466

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



371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/intersight_client/models/virtualization_vmware_distributed_network.rb', line 371

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


351
352
353
 
# File 'lib/intersight_client/models/virtualization_vmware_distributed_network.rb', line 351

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



357
358
359
 
# File 'lib/intersight_client/models/virtualization_vmware_distributed_network.rb', line 357

def hash
  [class_id, object_type, forged_transmits, mac_address_changes, nic_teaming_and_failover, num_hosts, num_ports, promiscuous_mode, up_link, vlan_range, vlan_type, distributed_switch, hosts].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



236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/intersight_client/models/virtualization_vmware_distributed_network.rb', line 236

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



442
443
444
 
# File 'lib/intersight_client/models/virtualization_vmware_distributed_network.rb', line 442

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



448
449
450
451
452
453
454
455
456
457
458
459
460
 
# File 'lib/intersight_client/models/virtualization_vmware_distributed_network.rb', line 448

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



436
437
438
 
# File 'lib/intersight_client/models/virtualization_vmware_distributed_network.rb', line 436

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



251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/intersight_client/models/virtualization_vmware_distributed_network.rb', line 251

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["virtualization.VmwareDistributedNetwork"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["virtualization.VmwareDistributedNetwork"])
  return false unless object_type_validator.valid?(@object_type)
  forged_transmits_validator = EnumAttributeValidator.new('String', ["Reject", "Accept"])
  return false unless forged_transmits_validator.valid?(@forged_transmits)
  mac_address_changes_validator = EnumAttributeValidator.new('String', ["Reject", "Accept"])
  return false unless mac_address_changes_validator.valid?(@mac_address_changes)
  promiscuous_mode_validator = EnumAttributeValidator.new('String', ["Reject", "Accept"])
  return false unless promiscuous_mode_validator.valid?(@promiscuous_mode)
  vlan_type_validator = EnumAttributeValidator.new('String', ["None", "VLAN", "VLAN trunking", "Private VLAN"])
  return false unless vlan_type_validator.valid?(@vlan_type)
  true && super
end