Class: OCI::Core::Models::PrivateIp

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

Overview

A private IP is a conceptual term that refers to an IPv4 private IP address and related properties. The privateIp object is the API representation of a private IP.

Note: For information about IPv6 addresses, see Ipv6.

Each instance has a primary private IP that is automatically created and assigned to the primary VNIC during instance launch. If you add a secondary VNIC to the instance, it also automatically gets a primary private IP. You can't remove a primary private IP from its VNIC. The primary private IP is automatically deleted when the VNIC is terminated.

You can add secondary private IPs to a VNIC after it's created. For more information, see the privateIp operations and also IP Addresses.

Note: Only list_private_ips and get_private_ip work with primary private IPs. To create and update primary private IPs, you instead work with instance and VNIC operations. For example, a primary private IP's properties come from the values you specify in CreateVnicDetails when calling either launch_instance or attach_vnic. To update the hostname for a primary private IP, you use update_vnic.

PrivateIp objects that are created for use with the Oracle Cloud VMware Solution are assigned to a VLAN and not a VNIC in a subnet. See the descriptions of the relevant attributes in the PrivateIp object. Also see Vlan.

To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

Constant Summary collapse

IP_STATE_ENUM = 
[
  IP_STATE_ASSIGNED = 'ASSIGNED'.freeze,
  IP_STATE_AVAILABLE = 'AVAILABLE'.freeze,
  IP_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFETIME_ENUM = 
[
  LIFETIME_EPHEMERAL = 'EPHEMERAL'.freeze,
  LIFETIME_RESERVED = 'RESERVED'.freeze,
  LIFETIME_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PrivateIp

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :availability_domain (String) —

    The value to assign to the #availability_domain property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :hostname_label (String) —

    The value to assign to the #hostname_label property

  • :id (String) —

    The value to assign to the #id property

  • :ip_address (String) —

    The value to assign to the #ip_address property

  • :cidr_prefix_length (Integer) —

    The value to assign to the #cidr_prefix_length property

  • :is_primary (BOOLEAN) —

    The value to assign to the #is_primary property

  • :vlan_id (String) —

    The value to assign to the #vlan_id property

  • :subnet_id (String) —

    The value to assign to the #subnet_id property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :vnic_id (String) —

    The value to assign to the #vnic_id property

  • :ip_state (String) —

    The value to assign to the #ip_state property

  • :lifetime (String) —

    The value to assign to the #lifetime property

  • :route_table_id (String) —

    The value to assign to the #route_table_id property

  • :ipv4_subnet_cidr_at_creation (String) —

    The value to assign to the #ipv4_subnet_cidr_at_creation property



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
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
 
# File 'lib/oci/core/models/private_ip.rb', line 265

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.availability_domain = attributes[:'availabilityDomain'] if attributes[:'availabilityDomain']

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

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

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

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

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

  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.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.id = attributes[:'id'] if attributes[:'id']

  self.ip_address = attributes[:'ipAddress'] if attributes[:'ipAddress']

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

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

  self.cidr_prefix_length = attributes[:'cidrPrefixLength'] if attributes[:'cidrPrefixLength']

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

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

  self.is_primary = attributes[:'isPrimary'] unless attributes[:'isPrimary'].nil?

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

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

  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']

  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.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

  self.vnic_id = attributes[:'vnicId'] if attributes[:'vnicId']

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

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

  self.ip_state = attributes[:'ipState'] if attributes[:'ipState']

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

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

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

  self.route_table_id = attributes[:'routeTableId'] if attributes[:'routeTableId']

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

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

  self.ipv4_subnet_cidr_at_creation = attributes[:'ipv4SubnetCidrAtCreation'] if attributes[:'ipv4SubnetCidrAtCreation']

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

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

Instance Attribute Details

#availability_domain ⇒ String

The private IP's availability domain. This attribute will be null if this is a secondary private IP assigned to a VNIC that is in a regional subnet.

Example: Uocm:PHX-AD-1

Returns:

  • (String) 


64
65
66
 
# File 'lib/oci/core/models/private_ip.rb', line 64

def availability_domain
  @availability_domain
end

#cidr_prefix_length ⇒ Integer

The secondary IPv4 CIDR prefix length.

Returns:

  • (Integer) 


125
126
127
 
# File 'lib/oci/core/models/private_ip.rb', line 125

def cidr_prefix_length
  @cidr_prefix_length
end

#compartment_id ⇒ String

The OCID of the compartment containing the private IP.

Returns:

  • (String) 


68
69
70
 
# File 'lib/oci/core/models/private_ip.rb', line 68

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


76
77
78
 
# File 'lib/oci/core/models/private_ip.rb', line 76

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) 


82
83
84
 
# File 'lib/oci/core/models/private_ip.rb', line 82

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>) 


90
91
92
 
# File 'lib/oci/core/models/private_ip.rb', line 90

def freeform_tags
  @freeform_tags
end

#hostname_label ⇒ String

The hostname for the private IP. Used for DNS. The value is the hostname portion of the 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.

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

Example: bminstance1

Returns:

  • (String) 


105
106
107
 
# File 'lib/oci/core/models/private_ip.rb', line 105

def hostname_label
  @hostname_label
end

#id ⇒ String

The private IP's Oracle ID (OCID).

Returns:

  • (String) 


109
110
111
 
# File 'lib/oci/core/models/private_ip.rb', line 109

def id
  @id
end

#ip_address ⇒ String

The private IP address of the privateIp object. The address is within the CIDR of the VNIC's subnet.

However, if the PrivateIp object is being used with a VLAN as part of the Oracle Cloud VMware Solution, the address is from the range specified by the cidrBlock attribute for the VLAN. See Vlan.

Example: 10.0.3.3

Returns:

  • (String) 


121
122
123
 
# File 'lib/oci/core/models/private_ip.rb', line 121

def ip_address
  @ip_address
end

#ip_state ⇒ String

State of the IP address. If an IP address is assigned to a VNIC it is ASSIGNED, otherwise it is AVAILABLE.

Returns:

  • (String) 


168
169
170
 
# File 'lib/oci/core/models/private_ip.rb', line 168

def ip_state
  @ip_state
end

#ipv4_subnet_cidr_at_creation ⇒ String

Ipv4 Subnet CIDR specified whn creating the PrivateIP.

Returns:

  • (String) 


187
188
189
 
# File 'lib/oci/core/models/private_ip.rb', line 187

def ipv4_subnet_cidr_at_creation
  @ipv4_subnet_cidr_at_creation
end

#is_primary ⇒ BOOLEAN

Whether this private IP is the primary one on the VNIC. Primary private IPs are unassigned and deleted automatically when the VNIC is terminated.

Example: true

Returns:

  • (BOOLEAN) 


133
134
135
 
# File 'lib/oci/core/models/private_ip.rb', line 133

def is_primary
  @is_primary
end

#lifetime ⇒ String

Lifetime of the IP address. There are two types of IPs: - Ephemeral - Reserved

Returns:

  • (String) 


176
177
178
 
# File 'lib/oci/core/models/private_ip.rb', line 176

def lifetime
  @lifetime
end

#route_table_id ⇒ String

The OCID of the route table the IP address or VNIC will use. For more information, see Per-resource Routing.

Returns:

  • (String) 


182
183
184
 
# File 'lib/oci/core/models/private_ip.rb', line 182

def route_table_id
  @route_table_id
end

#subnet_id ⇒ String

The OCID of the subnet the VNIC is in.

However, if the PrivateIp object is being used with a VLAN as part of the Oracle Cloud VMware Solution, the subnetId is null.

Returns:

  • (String) 


148
149
150
 
# File 'lib/oci/core/models/private_ip.rb', line 148

def subnet_id
  @subnet_id
end

#time_created ⇒ DateTime

The date and time the private IP was created, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


155
156
157
 
# File 'lib/oci/core/models/private_ip.rb', line 155

def time_created
  @time_created
end

#vlan_id ⇒ String

Applicable only if the PrivateIp object is being used with a VLAN as part of the Oracle Cloud VMware Solution. The vlanId is the OCID of the VLAN. See Vlan.

Returns:

  • (String) 


140
141
142
 
# File 'lib/oci/core/models/private_ip.rb', line 140

def vlan_id
  @vlan_id
end

#vnic_id ⇒ String

The OCID of the VNIC the private IP is assigned to. The VNIC and private IP must be in the same subnet. However, if the PrivateIp object is being used with a VLAN as part of the Oracle Cloud VMware Solution, the vnicId is null.

Returns:

  • (String) 


163
164
165
 
# File 'lib/oci/core/models/private_ip.rb', line 163

def vnic_id
  @vnic_id
end

Class Method Details

.attribute_map ⇒ Object

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



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/oci/core/models/private_ip.rb', line 190

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'availability_domain': :'availabilityDomain',
    'compartment_id': :'compartmentId',
    'defined_tags': :'definedTags',
    'display_name': :'displayName',
    'freeform_tags': :'freeformTags',
    'hostname_label': :'hostnameLabel',
    'id': :'id',
    'ip_address': :'ipAddress',
    'cidr_prefix_length': :'cidrPrefixLength',
    'is_primary': :'isPrimary',
    'vlan_id': :'vlanId',
    'subnet_id': :'subnetId',
    'time_created': :'timeCreated',
    'vnic_id': :'vnicId',
    'ip_state': :'ipState',
    'lifetime': :'lifetime',
    'route_table_id': :'routeTableId',
    'ipv4_subnet_cidr_at_creation': :'ipv4SubnetCidrAtCreation'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/oci/core/models/private_ip.rb', line 216

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'availability_domain': :'String',
    'compartment_id': :'String',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'display_name': :'String',
    'freeform_tags': :'Hash<String, String>',
    'hostname_label': :'String',
    'id': :'String',
    'ip_address': :'String',
    'cidr_prefix_length': :'Integer',
    'is_primary': :'BOOLEAN',
    'vlan_id': :'String',
    'subnet_id': :'String',
    'time_created': :'DateTime',
    'vnic_id': :'String',
    'ip_state': :'String',
    'lifetime': :'String',
    'route_table_id': :'String',
    'ipv4_subnet_cidr_at_creation': :'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



405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
 
# File 'lib/oci/core/models/private_ip.rb', line 405

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

  self.class == other.class &&
    availability_domain == other.availability_domain &&
    compartment_id == other.compartment_id &&
    defined_tags == other.defined_tags &&
    display_name == other.display_name &&
    freeform_tags == other.freeform_tags &&
    hostname_label == other.hostname_label &&
    id == other.id &&
    ip_address == other.ip_address &&
    cidr_prefix_length == other.cidr_prefix_length &&
    is_primary == other.is_primary &&
    vlan_id == other.vlan_id &&
    subnet_id == other.subnet_id &&
    time_created == other.time_created &&
    vnic_id == other.vnic_id &&
    ip_state == other.ip_state &&
    lifetime == other.lifetime &&
    route_table_id == other.route_table_id &&
    ipv4_subnet_cidr_at_creation == other.ipv4_subnet_cidr_at_creation
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



452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'lib/oci/core/models/private_ip.rb', line 452

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


432
433
434
 
# File 'lib/oci/core/models/private_ip.rb', line 432

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



441
442
443
 
# File 'lib/oci/core/models/private_ip.rb', line 441

def hash
  [availability_domain, compartment_id, defined_tags, display_name, freeform_tags, hostname_label, id, ip_address, cidr_prefix_length, is_primary, vlan_id, subnet_id, time_created, vnic_id, ip_state, lifetime, route_table_id, ipv4_subnet_cidr_at_creation].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



485
486
487
488
489
490
491
492
493
494
 
# File 'lib/oci/core/models/private_ip.rb', line 485

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



479
480
481
 
# File 'lib/oci/core/models/private_ip.rb', line 479

def to_s
  to_hash.to_s
end