Class: OCI::Core::Models::CreateVnicDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/core/models/create_vnic_details.rb

Overview

Contains properties for a VNIC. You use this object when creating the primary VNIC during instance launch or when creating a secondary VNIC. For more information about VNICs, see Virtual Network Interface Cards (VNICs).

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateVnicDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
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
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/oci/core/models/create_vnic_details.rb', line 280

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.assign_ipv6_ip = attributes[:'assignIpv6Ip'] unless attributes[:'assignIpv6Ip'].nil?
  self.assign_ipv6_ip = false if assign_ipv6_ip.nil? && !attributes.key?(:'assignIpv6Ip') # rubocop:disable Style/StringLiterals

  raise 'You cannot provide both :assignIpv6Ip and :assign_ipv6_ip' if attributes.key?(:'assignIpv6Ip') && attributes.key?(:'assign_ipv6_ip')

  self.assign_ipv6_ip = attributes[:'assign_ipv6_ip'] unless attributes[:'assign_ipv6_ip'].nil?
  self.assign_ipv6_ip = false if assign_ipv6_ip.nil? && !attributes.key?(:'assignIpv6Ip') && !attributes.key?(:'assign_ipv6_ip') # rubocop:disable Style/StringLiterals

  self.assign_public_ip = attributes[:'assignPublicIp'] unless attributes[:'assignPublicIp'].nil?

  raise 'You cannot provide both :assignPublicIp and :assign_public_ip' if attributes.key?(:'assignPublicIp') && attributes.key?(:'assign_public_ip')

  self.assign_public_ip = attributes[:'assign_public_ip'] unless attributes[:'assign_public_ip'].nil?

  self.assign_private_dns_record = attributes[:'assignPrivateDnsRecord'] unless attributes[:'assignPrivateDnsRecord'].nil?

  raise 'You cannot provide both :assignPrivateDnsRecord and :assign_private_dns_record' if attributes.key?(:'assignPrivateDnsRecord') && attributes.key?(:'assign_private_dns_record')

  self.assign_private_dns_record = attributes[:'assign_private_dns_record'] unless attributes[:'assign_private_dns_record'].nil?

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

  raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags')

  self.defined_tags = attributes[:'defined_tags'] if attributes[:'defined_tags']

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

  raise 'You cannot provide both :displayName and :display_name' if attributes.key?(:'displayName') && attributes.key?(:'display_name')

  self.display_name = attributes[:'display_name'] if attributes[:'display_name']

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

  raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags')

  self.freeform_tags = attributes[:'freeform_tags'] if attributes[:'freeform_tags']

  self.security_attributes = attributes[:'securityAttributes'] if attributes[:'securityAttributes']

  raise 'You cannot provide both :securityAttributes and :security_attributes' if attributes.key?(:'securityAttributes') && attributes.key?(:'security_attributes')

  self.security_attributes = attributes[:'security_attributes'] if attributes[:'security_attributes']

  self.hostname_label = attributes[:'hostnameLabel'] if attributes[:'hostnameLabel']

  raise 'You cannot provide both :hostnameLabel and :hostname_label' if attributes.key?(:'hostnameLabel') && attributes.key?(:'hostname_label')

  self.hostname_label = attributes[:'hostname_label'] if attributes[:'hostname_label']

  self.ipv6_address_ipv6_subnet_cidr_pair_details = attributes[:'ipv6AddressIpv6SubnetCidrPairDetails'] if attributes[:'ipv6AddressIpv6SubnetCidrPairDetails']

  raise 'You cannot provide both :ipv6AddressIpv6SubnetCidrPairDetails and :ipv6_address_ipv6_subnet_cidr_pair_details' if attributes.key?(:'ipv6AddressIpv6SubnetCidrPairDetails') && attributes.key?(:'ipv6_address_ipv6_subnet_cidr_pair_details')

  self.ipv6_address_ipv6_subnet_cidr_pair_details = attributes[:'ipv6_address_ipv6_subnet_cidr_pair_details'] if attributes[:'ipv6_address_ipv6_subnet_cidr_pair_details']

  self.subnet_cidr = attributes[:'subnetCidr'] if attributes[:'subnetCidr']

  raise 'You cannot provide both :subnetCidr and :subnet_cidr' if attributes.key?(:'subnetCidr') && attributes.key?(:'subnet_cidr')

  self.subnet_cidr = attributes[:'subnet_cidr'] if attributes[:'subnet_cidr']

  self.nsg_ids = attributes[:'nsgIds'] if attributes[:'nsgIds']

  raise 'You cannot provide both :nsgIds and :nsg_ids' if attributes.key?(:'nsgIds') && attributes.key?(:'nsg_ids')

  self.nsg_ids = attributes[:'nsg_ids'] if attributes[:'nsg_ids']

  self.private_ip = attributes[:'privateIp'] if attributes[:'privateIp']

  raise 'You cannot provide both :privateIp and :private_ip' if attributes.key?(:'privateIp') && attributes.key?(:'private_ip')

  self.private_ip = attributes[:'private_ip'] if attributes[:'private_ip']

  self.private_ip_id = attributes[:'privateIpId'] if attributes[:'privateIpId']

  raise 'You cannot provide both :privateIpId and :private_ip_id' if attributes.key?(:'privateIpId') && attributes.key?(:'private_ip_id')

  self.private_ip_id = attributes[:'private_ip_id'] if attributes[:'private_ip_id']

  self.skip_source_dest_check = attributes[:'skipSourceDestCheck'] unless attributes[:'skipSourceDestCheck'].nil?

  raise 'You cannot provide both :skipSourceDestCheck and :skip_source_dest_check' if attributes.key?(:'skipSourceDestCheck') && attributes.key?(:'skip_source_dest_check')

  self.skip_source_dest_check = attributes[:'skip_source_dest_check'] unless attributes[:'skip_source_dest_check'].nil?

  self.subnet_id = attributes[:'subnetId'] if attributes[:'subnetId']

  raise 'You cannot provide both :subnetId and :subnet_id' if attributes.key?(:'subnetId') && attributes.key?(:'subnet_id')

  self.subnet_id = attributes[:'subnet_id'] if attributes[:'subnet_id']

  self.vlan_id = attributes[:'vlanId'] if attributes[:'vlanId']

  raise 'You cannot provide both :vlanId and :vlan_id' if attributes.key?(:'vlanId') && attributes.key?(:'vlan_id')

  self.vlan_id = attributes[:'vlan_id'] if attributes[:'vlan_id']
end

Instance Attribute Details

#assign_ipv6_ip ⇒ BOOLEAN

Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled subnet. Default: False. When provided you may optionally provide an IPv6 prefix (ipv6SubnetCidr) of your choice to assign the IPv6 address from. If ipv6SubnetCidr is not provided then an IPv6 prefix is chosen for you.

Returns:

  • (BOOLEAN) 


22
23
24
 
# File 'lib/oci/core/models/create_vnic_details.rb', line 22

def assign_ipv6_ip
  @assign_ipv6_ip
end

#assign_private_dns_record ⇒ BOOLEAN

Whether the VNIC should be assigned a DNS record. If set to false, there will be no DNS record registration for the VNIC. If set to true, the DNS record will be registered. The default value is true.

If you specify a hostnameLabel, then assignPrivateDnsRecord must be set to true.

Returns:

  • (BOOLEAN) 


58
59
60
 
# File 'lib/oci/core/models/create_vnic_details.rb', line 58

def assign_private_dns_record
  @assign_private_dns_record
end

#assign_public_ip ⇒ BOOLEAN

Whether the VNIC should be assigned a public IP address. Defaults to whether the subnet is public or private. If not set and the VNIC is being created in a private subnet (that is, where prohibitPublicIpOnVnic = true in the Subnet), then no public IP address is assigned. If not set and the subnet is public (prohibitPublicIpOnVnic = false), then a public IP address is assigned. If set to true and prohibitPublicIpOnVnic = true, an error is returned.

Note: This public IP address is associated with the primary private IP on the VNIC. For more information, see IP Addresses.

Note: There's a limit to the number of PublicIp} a VNIC or instance can have. If you try to create a secondary VNIC with an assigned public IP for an instance that has already reached its public IP limit, an error is returned. For information about the public IP limits, see IP Addresses.

Example: false

If you specify a vlanId, then assignPublicIp must be set to false. See {Vlan.

Returns:

  • (BOOLEAN) 


49
50
51
 
# File 'lib/oci/core/models/create_vnic_details.rb', line 49

def assign_public_ip
  @assign_public_ip
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


66
67
68
 
# File 'lib/oci/core/models/create_vnic_details.rb', line 66

def defined_tags
  @defined_tags
end

#display_name ⇒ String

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Returns:

  • (String) 


72
73
74
 
# File 'lib/oci/core/models/create_vnic_details.rb', line 72

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


80
81
82
 
# File 'lib/oci/core/models/create_vnic_details.rb', line 80

def freeform_tags
  @freeform_tags
end

#hostname_label ⇒ String

The hostname for the VNIC's primary private IP. Used for DNS. The value is the hostname portion of the primary private IP's fully qualified domain name (FQDN) (for example, bminstance1 in FQDN bminstance1.subnet123.vcn1.oraclevcn.com). Must be unique across all VNICs in the subnet and comply with RFC 952 and RFC 1123. The value appears in the Vnic object and also the PrivateIp object returned by list_private_ips and get_private_ip.

For more information, see DNS in Your Virtual Cloud Network.

When launching an instance, use this hostnameLabel instead of the deprecated hostnameLabel in launch_instance_details. If you provide both, the values must match.

Example: bminstance1

If you specify a vlanId, the hostnameLabel cannot be specified. VNICs on a VLAN can not be assigned a hostname. See Vlan.

Returns:

  • (String) 


116
117
118
 
# File 'lib/oci/core/models/create_vnic_details.rb', line 116

def hostname_label
  @hostname_label
end

#ipv6_address_ipv6_subnet_cidr_pair_details ⇒ Array<OCI::Core::Models::Ipv6AddressIpv6SubnetCidrPairDetails>

A list of IPv6 prefix ranges from which the VNIC is assigned an IPv6 address. You can provide only the prefix ranges from which OCI selects an available address from the range. You can optionally choose to leave the prefix range empty and instead provide the specific IPv6 address within that range to use.

Returns:



124
125
126
 
# File 'lib/oci/core/models/create_vnic_details.rb', line 124

def ipv6_address_ipv6_subnet_cidr_pair_details
  @ipv6_address_ipv6_subnet_cidr_pair_details
end

#nsg_ids ⇒ Array<String>

A list of the OCIDs of the network security groups (NSGs) to add the VNIC to. For more information about NSGs, see NetworkSecurityGroup.

If a vlanId is specified, the nsgIds cannot be specified. The vlanId indicates that the VNIC will belong to a VLAN instead of a subnet. With VLANs, all VNICs in the VLAN belong to the NSGs that are associated with the VLAN. See Vlan.

Returns:

  • (Array<String>) 


146
147
148
 
# File 'lib/oci/core/models/create_vnic_details.rb', line 146

def nsg_ids
  @nsg_ids
end

#private_ip ⇒ String

A private IP address of your choice to assign to the VNIC. Must be an available IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private IP address from the subnet. This is the VNIC's primary private IP address. The value appears in the Vnic object and also the PrivateIp object returned by list_private_ips and get_private_ip.

If you specify a vlanId, the privateIp cannot be specified. See Vlan.

If you specify a 'privateIpId', the 'privateIp' cannot be specified.

Example: 10.0.3.3

Returns:

  • (String) 


166
167
168
 
# File 'lib/oci/core/models/create_vnic_details.rb', line 166

def private_ip
  @private_ip
end

#private_ip_id ⇒ String

An OCID that specifies a previously-reserved IP address to use for this VNIC.

Returns:

  • (String) 


171
172
173
 
# File 'lib/oci/core/models/create_vnic_details.rb', line 171

def private_ip_id
  @private_ip_id
end

#security_attributes ⇒ Hash<String, Hash<String, Object>>

Security attributes are labels for a resource that can be referenced in a Zero Trust Packet Routing (ZPR) policy to control access to ZPR-supported resources.

Example: {\"Oracle-DataSecurity-ZPR\": {\"MaxEgressCount\": {\"value\":\"42\",\"mode\":\"audit\"}}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


89
90
91
 
# File 'lib/oci/core/models/create_vnic_details.rb', line 89

def security_attributes
  @security_attributes
end

#skip_source_dest_check ⇒ BOOLEAN

Whether the source/destination check is disabled on the VNIC. Defaults to false, which means the check is performed. For information about why you would skip the source/destination check, see Using a Private IP as a Route Target.

If you specify a vlanId, the skipSourceDestCheck cannot be specified because the source/destination check is always disabled for VNICs in a VLAN. See Vlan.

Example: true

Returns:

  • (BOOLEAN) 


186
187
188
 
# File 'lib/oci/core/models/create_vnic_details.rb', line 186

def skip_source_dest_check
  @skip_source_dest_check
end

#subnet_cidr ⇒ String

One of the IPv4 CIDR blocks allocated to the subnet. Represents the IP range from which the VNIC's private IP address will be assigned if privateIp or privateIpId is not specified. Either this field or the privateIp (or privateIpId, if applicable) field must be provided, but not both simultaneously. Example: 192.168.1.0/28

Returns:

  • (String) 


134
135
136
 
# File 'lib/oci/core/models/create_vnic_details.rb', line 134

def subnet_cidr
  @subnet_cidr
end

#subnet_id ⇒ String

The OCID of the subnet to create the VNIC in. When launching an instance, use this subnetId instead of the deprecated subnetId in launch_instance_details. At least one of them is required; if you provide both, the values must match.

If you are an Oracle Cloud VMware Solution customer and creating a secondary VNIC in a VLAN instead of a subnet, provide a vlanId instead of a subnetId. If you provide both a vlanId and subnetId, the request fails.

Returns:

  • (String) 


198
199
200
 
# File 'lib/oci/core/models/create_vnic_details.rb', line 198

def subnet_id
  @subnet_id
end

#vlan_id ⇒ String

Provide this attribute only if you are an Oracle Cloud VMware Solution customer and creating a secondary VNIC in a VLAN. The value is the OCID of the VLAN. See Vlan.

Provide a vlanId instead of a subnetId. If you provide both a vlanId and subnetId, the request fails.

Returns:

  • (String) 


208
209
210
 
# File 'lib/oci/core/models/create_vnic_details.rb', line 208

def vlan_id
  @vlan_id
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/oci/core/models/create_vnic_details.rb', line 211

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'assign_ipv6_ip': :'assignIpv6Ip',
    'assign_public_ip': :'assignPublicIp',
    'assign_private_dns_record': :'assignPrivateDnsRecord',
    'defined_tags': :'definedTags',
    'display_name': :'displayName',
    'freeform_tags': :'freeformTags',
    'security_attributes': :'securityAttributes',
    'hostname_label': :'hostnameLabel',
    'ipv6_address_ipv6_subnet_cidr_pair_details': :'ipv6AddressIpv6SubnetCidrPairDetails',
    'subnet_cidr': :'subnetCidr',
    'nsg_ids': :'nsgIds',
    'private_ip': :'privateIp',
    'private_ip_id': :'privateIpId',
    'skip_source_dest_check': :'skipSourceDestCheck',
    'subnet_id': :'subnetId',
    'vlan_id': :'vlanId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/oci/core/models/create_vnic_details.rb', line 235

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'assign_ipv6_ip': :'BOOLEAN',
    'assign_public_ip': :'BOOLEAN',
    'assign_private_dns_record': :'BOOLEAN',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'display_name': :'String',
    'freeform_tags': :'Hash<String, String>',
    'security_attributes': :'Hash<String, Hash<String, Object>>',
    'hostname_label': :'String',
    'ipv6_address_ipv6_subnet_cidr_pair_details': :'Array<OCI::Core::Models::Ipv6AddressIpv6SubnetCidrPairDetails>',
    'subnet_cidr': :'String',
    'nsg_ids': :'Array<String>',
    'private_ip': :'String',
    'private_ip_id': :'String',
    'skip_source_dest_check': :'BOOLEAN',
    'subnet_id': :'String',
    'vlan_id': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
 
# File 'lib/oci/core/models/create_vnic_details.rb', line 392

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    assign_ipv6_ip == other.assign_ipv6_ip &&
    assign_public_ip == other.assign_public_ip &&
    assign_private_dns_record == other.assign_private_dns_record &&
    defined_tags == other.defined_tags &&
    display_name == other.display_name &&
    freeform_tags == other.freeform_tags &&
    security_attributes == other.security_attributes &&
    hostname_label == other.hostname_label &&
    ipv6_address_ipv6_subnet_cidr_pair_details == other.ipv6_address_ipv6_subnet_cidr_pair_details &&
    subnet_cidr == other.subnet_cidr &&
    nsg_ids == other.nsg_ids &&
    private_ip == other.private_ip &&
    private_ip_id == other.private_ip_id &&
    skip_source_dest_check == other.skip_source_dest_check &&
    subnet_id == other.subnet_id &&
    vlan_id == other.vlan_id
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



437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
 
# File 'lib/oci/core/models/create_vnic_details.rb', line 437

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


417
418
419
 
# File 'lib/oci/core/models/create_vnic_details.rb', line 417

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



426
427
428
 
# File 'lib/oci/core/models/create_vnic_details.rb', line 426

def hash
  [assign_ipv6_ip, assign_public_ip, assign_private_dns_record, defined_tags, display_name, freeform_tags, security_attributes, hostname_label, ipv6_address_ipv6_subnet_cidr_pair_details, subnet_cidr, nsg_ids, private_ip, private_ip_id, skip_source_dest_check, subnet_id, vlan_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



470
471
472
473
474
475
476
477
478
479
 
# File 'lib/oci/core/models/create_vnic_details.rb', line 470

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    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



464
465
466
 
# File 'lib/oci/core/models/create_vnic_details.rb', line 464

def to_s
  to_hash.to_s
end