Class: IntersightClient::VirtualizationNetworkInterface

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

Overview

Virtual machine network interface configuration data.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ VirtualizationNetworkInterface

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

  if attributes.key?(:'adaptor_type')
    self.adaptor_type = attributes[:'adaptor_type']
  else
    self.adaptor_type = 'Unknown'
  end

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'private_ip_allocation_mode')
    self.private_ip_allocation_mode = attributes[:'private_ip_allocation_mode']
  else
    self.private_ip_allocation_mode = 'DHCP'
  end

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

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

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

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

Instance Attribute Details

#adaptor_type ⇒ Object

Virtual machine network adaptor type. * ‘Unknown` - The type of the network adaptor type is unknown. * `E1000` - Emulated version of the Intel 82545EM Gigabit Ethernet NIC. * `SRIOV` - Representation of a virtual function (VF) on a physical NIC with SR-IOV support. * `VMXNET2` - VMXNET 2 (Enhanced) is available only for some guest operating systems on ESX/ESXi 3.5 and later. * `VMXNET3` - VMXNET 3 offers all the features available in VMXNET 2 and adds several new features. * `E1000E` - E1000E – emulates a newer real network adapter, the 1 Gbit Intel 82574, and is available for Windows 2012 and later. The E1000E needs virtual machine hardware version 8 or later. * `NE2K_PCI` - The Ne2000 network card uses two ring buffers for packet handling. These are circular buffers made of 256-byte pages that the chip’s DMA logic will use to store received packets or to get received packets. * ‘PCnet` - The PCnet-PCI II is a PCI network adapter. It has built-in support for CRC checks and can automatically pad short packets to the minimum Ethernet length. * `RTL8139` - The RTL8139 is a fast Ethernet card that operates at 10/100 Mbps. It is compliant with PCI version 2.0/2.1 and it is known for reliability and superior performance. * `VirtIO` - VirtIO is a standardized interface which allows virtual machines access to simplified "virtual" devices, such as block devices, network adapters and consoles. Accessing devices through VirtIO on a guest VM improves performance over more traditional "emulated" devices, as VirtIO devices require only the bare minimum setup and configuration needed to send and receive data, while the host machine handles the majority of the setup and maintenance of the actual physical hardware. * “ - Default network adaptor type supported by the hypervisor.



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

def adaptor_type
  @adaptor_type
end

#bridge ⇒ Object

Virtual machine network bridge name.



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

def bridge
  @bridge
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_network_interface.rb', line 20

def class_id
  @class_id
end

#connect_at_power_on ⇒ Object

Connect the adaptor at virtual machine power on.



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

def connect_at_power_on
  @connect_at_power_on
end

#direct_path_io ⇒ Object

Enable the direct path I/O.



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

def direct_path_io
  @direct_path_io
end

#ip_forwarding_enabled ⇒ Object

Set to true, if IP forwarding is enabled on the NIC.



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

def ip_forwarding_enabled
  @ip_forwarding_enabled
end

#ipv6_address ⇒ Object

Set to true, if IPv6 address should be allocated for the NIC.



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

def ipv6_address
  @ipv6_address
end

#mac_address ⇒ Object

Virtual machine network mac address.



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

def mac_address
  @mac_address
end

#name ⇒ Object

Name of the network interface. This may be different from guest operating system assigned.



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

def name
  @name
end

#network_id ⇒ Object

Identity of the network to which this network interface belongs.



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

def network_id
  @network_id
end

#nic_id ⇒ Object

Identity of the network interface.



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

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

def object_type
  @object_type
end

#order ⇒ Object

Order of the NIC attachment to the VM.



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

def order
  @order
end

#private_ip_allocation_mode ⇒ Object

Allocation mode for NIC addresses e.g. DHCP or static. * ‘DHCP` - Dynamic IP address allocation using DHCP protocol. * `STATIC_IP` - Assign fixed / static IPs to resources for use. * `IPAM_CALLOUT` - Use callout scripts to query cloud IP allocation tools to assign network parameters. * `PREALLOCATE_IP` - Allows the cloud infrastructure IP allocation to be dynamically provided before the server boots up.



59
60
61
 
# File 'lib/intersight_client/models/virtualization_network_interface.rb', line 59

def private_ip_allocation_mode
  @private_ip_allocation_mode
end

#public_ip_allocate ⇒ Object

Set to true, if public IP should be allocated for the NIC.



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

def public_ip_allocate
  @public_ip_allocate
end

#security_groups ⇒ Object

Returns the value of attribute security_groups.



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

def security_groups
  @security_groups
end

#static_ip_address ⇒ Object

Returns the value of attribute static_ip_address.



66
67
68
 
# File 'lib/intersight_client/models/virtualization_network_interface.rb', line 66

def static_ip_address
  @static_ip_address
end

#subnet_id ⇒ Object

Subnet identifier for the NIC.



69
70
71
 
# File 'lib/intersight_client/models/virtualization_network_interface.rb', line 69

def subnet_id
  @subnet_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)



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

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)



118
119
120
 
# File 'lib/intersight_client/models/virtualization_network_interface.rb', line 118

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.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/intersight_client/models/virtualization_network_interface.rb', line 94

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'adaptor_type' => :'AdaptorType',
    :'bridge' => :'Bridge',
    :'connect_at_power_on' => :'ConnectAtPowerOn',
    :'direct_path_io' => :'DirectPathIo',
    :'ip_forwarding_enabled' => :'IpForwardingEnabled',
    :'ipv6_address' => :'Ipv6Address',
    :'mac_address' => :'MacAddress',
    :'name' => :'Name',
    :'network_id' => :'NetworkId',
    :'nic_id' => :'NicId',
    :'order' => :'Order',
    :'private_ip_allocation_mode' => :'PrivateIpAllocationMode',
    :'public_ip_allocate' => :'PublicIpAllocate',
    :'security_groups' => :'SecurityGroups',
    :'static_ip_address' => :'StaticIpAddress',
    :'subnet_id' => :'SubnetId'
  }
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



403
404
405
 
# File 'lib/intersight_client/models/virtualization_network_interface.rb', line 403

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



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

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

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



168
169
170
 
# File 'lib/intersight_client/models/virtualization_network_interface.rb', line 168

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



152
153
154
155
156
157
 
# File 'lib/intersight_client/models/virtualization_network_interface.rb', line 152

def self.openapi_nullable
  Set.new([
    :'security_groups',
    :'static_ip_address',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/intersight_client/models/virtualization_network_interface.rb', line 128

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'adaptor_type' => :'String',
    :'bridge' => :'String',
    :'connect_at_power_on' => :'Boolean',
    :'direct_path_io' => :'Boolean',
    :'ip_forwarding_enabled' => :'Boolean',
    :'ipv6_address' => :'Boolean',
    :'mac_address' => :'String',
    :'name' => :'String',
    :'network_id' => :'String',
    :'nic_id' => :'String',
    :'order' => :'Integer',
    :'private_ip_allocation_mode' => :'String',
    :'public_ip_allocate' => :'Boolean',
    :'security_groups' => :'Array<String>',
    :'static_ip_address' => :'Array<VirtualizationIpAddressInfo>',
    :'subnet_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
 
# File 'lib/intersight_client/models/virtualization_network_interface.rb', line 365

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      adaptor_type == o.adaptor_type &&
      bridge == o.bridge &&
      connect_at_power_on == o.connect_at_power_on &&
      direct_path_io == o.direct_path_io &&
      ip_forwarding_enabled == o.ip_forwarding_enabled &&
      ipv6_address == o.ipv6_address &&
      mac_address == o.mac_address &&
      name == o.name &&
      network_id == o.network_id &&
      nic_id == o.nic_id &&
      order == o.order &&
      private_ip_allocation_mode == o.private_ip_allocation_mode &&
      public_ip_allocate == o.public_ip_allocate &&
      security_groups == o.security_groups &&
      static_ip_address == o.static_ip_address &&
      subnet_id == o.subnet_id && 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



434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'lib/intersight_client/models/virtualization_network_interface.rb', line 434

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



505
506
507
508
509
510
511
512
513
514
515
516
517
 
# File 'lib/intersight_client/models/virtualization_network_interface.rb', line 505

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



410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'lib/intersight_client/models/virtualization_network_interface.rb', line 410

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


390
391
392
 
# File 'lib/intersight_client/models/virtualization_network_interface.rb', line 390

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



396
397
398
 
# File 'lib/intersight_client/models/virtualization_network_interface.rb', line 396

def hash
  [class_id, object_type, adaptor_type, bridge, connect_at_power_on, direct_path_io, ip_forwarding_enabled, ipv6_address, mac_address, name, network_id, nic_id, order, private_ip_allocation_mode, public_ip_allocate, security_groups, static_ip_address, subnet_id].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



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/intersight_client/models/virtualization_network_interface.rb', line 277

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

  pattern = Regexp.new(/^$|^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$/)
  if !@mac_address.nil? && @mac_address !~ pattern
    invalid_properties.push("invalid value for \"mac_address\", must conform to the pattern #{pattern}.")
  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



481
482
483
 
# File 'lib/intersight_client/models/virtualization_network_interface.rb', line 481

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



487
488
489
490
491
492
493
494
495
496
497
498
499
 
# File 'lib/intersight_client/models/virtualization_network_interface.rb', line 487

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



475
476
477
 
# File 'lib/intersight_client/models/virtualization_network_interface.rb', line 475

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



297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/intersight_client/models/virtualization_network_interface.rb', line 297

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["virtualization.NetworkInterface"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["virtualization.NetworkInterface"])
  return false unless object_type_validator.valid?(@object_type)
  adaptor_type_validator = EnumAttributeValidator.new('String', ["Unknown", "E1000", "SRIOV", "VMXNET2", "VMXNET3", "E1000E", "NE2K_PCI", "PCnet", "RTL8139", "VirtIO", ""])
  return false unless adaptor_type_validator.valid?(@adaptor_type)
  return false if !@mac_address.nil? && @mac_address !~ Regexp.new(/^$|^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$/)
  private_ip_allocation_mode_validator = EnumAttributeValidator.new('String', ["DHCP", "STATIC_IP", "IPAM_CALLOUT", "PREALLOCATE_IP"])
  return false unless private_ip_allocation_mode_validator.valid?(@private_ip_allocation_mode)
  true && super
end