Class: MintPress::InfrastructureOci::PrivateIp

Inherits:

Object

• Object
• MintPress::InfrastructureOci::PrivateIp

Includes:

MintLogger, TagUtils, Mixins::Properties

Defined in:

src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_private_ip.rb

Properties (Read/Write)

• #name ⇒ String
  'The name of the Private IP'
  Property Attributes
  • alias ⇒ :display_name

  # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_private_ip.rb', line 23
  
  property :name, type: String, description: 'The name of the Private IP', alias: :display_name

• #host ⇒ MintPress::InfrastructureOci::OCIHost
  'Host object this vnic will be attached to.'
  Property Attributes

  # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_private_ip.rb', line 25
  
  property :host, type: MintPress::InfrastructureOci::OCIHost, description: 'Host object this vnic will be attached to.'

• #availability_domain ⇒ String (Default Value: Proc.new { self.platform.availability_domain })
  'The availability domain ID.'
  Property Attributes
  • default ⇒ Proc.new { self.platform.availability_domain }

  # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_private_ip.rb', line 27
  
  property :availability_domain, type: String, description: 'The availability domain ID.', default: Proc.new { self.platform.availability_domain }

• #compartment ⇒ String (Default Value: Proc.new { self.platform.compartment })
  'The compartment ID that will be used.'
  Property Attributes
  • default ⇒ Proc.new { self.platform.compartment }
  • alias ⇒ :compartment_id

  # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_private_ip.rb', line 29
  
  property :compartment, type: String, description: 'The compartment ID that will be used.', default: Proc.new { self.platform.compartment }, alias: :compartment_id

• #platform ⇒ MintPress::InfrastructureOci::OciPlatform (Default Value: Proc.new { if opts[:provider] MintPress::InfrastructureOci::OciPlatform.new(:provider => opts[:provider]) else MintPress::InfrastructureOci::OciPlatform.new end })
  'This incapsulates all properties required for the OCI provider.'
  Property Attributes
  • default ⇒ Proc.new { if opts[:provider] MintPress::InfrastructureOci::OciPlatform.new(:provider => opts[:provider]) else MintPress::InfrastructureOci::OciPlatform.new end }

  # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_private_ip.rb', line 32
  
  property :platform, type: MintPress::InfrastructureOci::OciPlatform, default: Proc.new {
    if opts[:provider]
      MintPress::InfrastructureOci::OciPlatform.new(:provider => opts[:provider])
    else
      MintPress::InfrastructureOci::OciPlatform.new
    end
  }, description: 'This incapsulates all properties required for the OCI provider.'

• #ip ⇒ String
  'IP that was created/reserved.'
  Property Attributes
  • alias ⇒ :ip_address

  # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_private_ip.rb', line 41
  
  property :ip, type: String, alias: :ip_address, description: 'IP that was created/reserved.'

• #hostname_label ⇒ String
  'The hostname for the private IP. Used for DNS. The value is the hostname portion of the private IP fully qualified domain name (FQDN)'
  Property Attributes

  # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_private_ip.rb', line 42
  
  property :hostname_label, type: String, description: 'The hostname for the private IP. Used for DNS. The value is the hostname portion of the private IP fully qualified domain name (FQDN)'

• #vlan_id ⇒ String
  'Use this attribute only with the Oracle Cloud VMware Solution. The OCID of the VLAN from which the private IP is to be drawn. The IP address, if supplied, must be valid for the given VLAN'
  Property Attributes

  # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_private_ip.rb', line 43
  
  property :vlan_id, type: String, description: 'Use this attribute only with the Oracle Cloud VMware Solution. The OCID of the VLAN from which the private IP is to be drawn. The IP address, if supplied, must be valid for the given VLAN'

• #vnic_id ⇒ String
  'The OCID of the VNIC to assign the private IP to. The VNIC and private IP must be in the same subnet.'
  Property Attributes

  # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_private_ip.rb', line 44
  
  property :vnic_id, type: String, description: 'The OCID of the VNIC to assign the private IP to. The VNIC and private IP must be in the same subnet.'

• #vnic ⇒ [MintPress::InfrastructureOci::Vnic, String]
  'The VNIC object or The OCID of the VNIC to assign the private IP to. The VNIC and private IP must be in the same subnet.'
  Property Attributes

  # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_private_ip.rb', line 45
  
  property :vnic, type: [MintPress::InfrastructureOci::Vnic, String], description: 'The VNIC object or The OCID of the VNIC to assign the private IP to. The VNIC and private IP must be in the same subnet.'

• #id ⇒ String
  'ID for the Private IP'
  Property Attributes

  # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_private_ip.rb', line 46
  
  property :id, type: String, description: 'ID for the Private IP'

• #subnet_id ⇒ String
  'Subnet ID for the Private IP'
  Property Attributes

  # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_private_ip.rb', line 47
  
  property :subnet_id, type: String, description: 'Subnet ID for the Private IP'

• #is_primary ⇒ [TrueClass, FalseClass] (Default Value: false)
  'Whether this private IP is the primary one on the VNIC. Primary private IPs are unassigned and deleted automatically when the VNIC is terminated.'
  Property Attributes
  • default ⇒ false

  # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_private_ip.rb', line 48
  
  property :is_primary, type: [TrueClass, FalseClass], default: false, description: 'Whether this private IP is the primary one on the VNIC. Primary private IPs are unassigned and deleted automatically when the VNIC is terminated.'

Properties (Read Only)

Constant Summary

Constants included from MintLogger

MintLogger::DEBUG, MintLogger::ERROR, MintLogger::FATAL, MintLogger::INFO, MintLogger::UNKNOWN, MintLogger::VERBOSE, MintLogger::WARN

Instance Attribute Summary

Attributes included from Mixins::Properties

#autopush_set_cache, #dynamic_create, #harvest_on_access, #harvest_undefined_only, #harvested, #tree_root

Instance Method Summary

• #create ⇒ Object
• #destroy ⇒ Object
• #exists? ⇒ Boolean
• #harvest ⇒ Object
• #initialize(opts = {}) ⇒ PrivateIp constructor
  A new instance of PrivateIp.
• #list ⇒ Object
• #update ⇒ Object

Methods included from TagUtils

#clear_tags, #fetch_resource_details, #import_tag_properties, #manage_tags, #merge_defined_tags, #remove_defined_tags, #remove_tags, #update_resource, #update_tags

Methods included from CommonUtils

#create_status_check_proc, #destroy_status_check_proc, #filter_nil_properties, #populate_properties

Methods included from MintLogger::Utils::Common

#boolean_val, #has_value?, #no_value?, #nvl, #path_as_symbol, #ruby_level_to_send

Methods included from Mixins::Properties

#[], #[]=, #add_validate_report_result, #armour_set_property, #array_contains?, #array_is_a?, #check_autopush, #check_stack_overflow, #clone_property_object, #cloner_handle_single_property, #coerce_single, #contains_as_string?, #display_validate_report_result, #double_initialize?, #dump_to_hash, #find_parent, #find_parent_by_identity, #generate_accessor_functions, #get_canonical_renamed, #get_from_opts, #get_my_name, #get_property, #get_property_item, #has?, included, #initialize_validate_report, #inspect, #is_cloned_object?, #is_mintpress_object?, #is_probably_canonical?, #is_set?, #local_debug, #local_info, #local_verbose, #mintpress_property_definitions, #place_object_by_identity, #process_properties, #prop_set?, #property, #property_definitions, #property_details, #property_is_simple_object?, #push_root!, #require_property, #require_update, #retrieve_docstring, #sanitize, #set_map_dirty, #set_property, #set_property_item, #show_short_array, #strip_defaults!, #synchronize, #uncloned_property_definitions, #update_map, #validate, #validate_generic, #validate_properties, #validate_property, #validate_required, #version_allowed?, #weakref

Constructor Details

#initialize(opts = {}) ⇒ PrivateIp

Returns a new instance of PrivateIp.

Instance Method Details

#create ⇒ Object

#destroy ⇒ Object

#exists? ⇒ Boolean

Returns:

• (Boolean)

#harvest ⇒ Object

#list ⇒ Object

#update ⇒ Object