class OCI::Core::Models::Subnet

A logical subdivision of a VCN. Each subnet consists of a contiguous range of IP addresses that do not overlap with other subnets in the VCN. Example: 172.16.1.0/24. For more information, see [Overview of the Networking Service](docs.cloud.oracle.com/iaas/Content/Network/Concepts/overview.htm) and [VCNs and Subnets](docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingVCNs.htm).

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](docs.cloud.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).

Constants

LIFECYCLE_STATE_ENUM

Attributes

availability_domain[RW]

The subnet's availability domain. This attribute will be null if this is a regional subnet instead of an AD-specific subnet. Oracle recommends creating regional subnets.

Example: `Uocm:PHX-AD-1`

@return [String]

cidr_block[RW]

[Required] The subnet's CIDR block.

Example: `10.0.1.0/24`

@return [String]

compartment_id[RW]

[Required] The OCID of the compartment containing the subnet. @return [String]

defined_tags[RW]

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).

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

@return [Hash<String, Hash<String, Object>>]

dhcp_options_id[RW]

The OCID of the set of DHCP options that the subnet uses.

@return [String]

display_name[RW]

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

@return [String]

dns_label[RW]

A DNS label for the subnet, used in conjunction with the VNIC's hostname and VCN's DNS label to form a fully qualified domain name (FQDN) for each VNIC within this subnet (for example, `bminstance-1.subnet123.vcn1.oraclevcn.com`). Must be an alphanumeric string that begins with a letter and is unique within the VCN. The value cannot be changed.

The absence of this parameter means the Internet and VCN Resolver will not resolve hostnames of instances in this subnet.

For more information, see [DNS in Your Virtual Cloud Network](docs.cloud.oracle.com/iaas/Content/Network/Concepts/dns.htm).

Example: `subnet123`

@return [String]

freeform_tags[RW]

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](docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).

Example: `{"Department": "Finance"}`

@return [Hash<String, String>]

id[RW]

[Required] The subnet's Oracle ID (OCID). @return [String]

ipv6_cidr_block[RW]

For an IPv6-enabled subnet, this is the IPv6 CIDR block for the subnet's IP address space. The subnet size is always /64. See [IPv6 Addresses](docs.cloud.oracle.com/iaas/Content/Network/Concepts/ipv6.htm).

Example: `2001:0db8:0123:1111::/64`

@return [String]

ipv6_virtual_router_ip[RW]

For an IPv6-enabled subnet, this is the IPv6 address of the virtual router.

Example: `2001:0db8:0123:1111:89ab:cdef:1234:5678`

@return [String]

lifecycle_state[R]

[Required] The subnet's current state. @return [String]

prohibit_internet_ingress[RW]

Whether to disallow ingress internet traffic to VNICs within this subnet. Defaults to false.

For IPV4, `prohibitInternetIngress` behaves similarly to `prohibitPublicIpOnVnic`. If it is set to false, VNICs created in this subnet will automatically be assigned public IP addresses unless specified otherwise during instance launch or VNIC creation (with the `assignPublicIp` flag in {CreateVnicDetails}). If `prohibitInternetIngress` is set to true, VNICs created in this subnet cannot have public IP addresses (that is, it's a privatesubnet).

For IPv6, if `prohibitInternetIngress` is set to `true`, internet access is not allowed for any IPv6s assigned to VNICs in the subnet. Otherwise, ingress internet traffic is allowed by default.

Example: `true`

@return [BOOLEAN]

prohibit_public_ip_on_vnic[RW]

Whether VNICs within this subnet can have public IP addresses. Defaults to false, which means VNICs created in this subnet will automatically be assigned public IP addresses unless specified otherwise during instance launch or VNIC creation (with the `assignPublicIp` flag in {CreateVnicDetails}). If `prohibitPublicIpOnVnic` is set to true, VNICs created in this subnet cannot have public IP addresses (that is, it's a private subnet).

Example: `true`

@return [BOOLEAN]

route_table_id[RW]

[Required] The OCID of the route table that the subnet uses. @return [String]

security_list_ids[RW]

The OCIDs of the security list or lists that the subnet uses. Remember that security lists are associated *with the subnet*, but the rules are applied to the individual VNICs in the subnet.

@return [Array<String>]

subnet_domain_name[RW]

The subnet's domain name, which consists of the subnet's DNS label, the VCN's DNS label, and the `oraclevcn.com` domain.

For more information, see [DNS in Your Virtual Cloud Network](docs.cloud.oracle.com/iaas/Content/Network/Concepts/dns.htm).

Example: `subnet123.vcn1.oraclevcn.com`

@return [String]

time_created[RW]

The date and time the subnet was created, in the format defined by [RFC3339](tools.ietf.org/html/rfc3339).

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

@return [DateTime]

vcn_id[RW]

[Required] The OCID of the VCN the subnet is in. @return [String]

virtual_router_ip[RW]

[Required] The IP address of the virtual router.

Example: `10.0.14.1`

@return [String]

virtual_router_mac[RW]

[Required] The MAC address of the virtual router.

Example: `00:00:00:00:00:01`

@return [String]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/core/models/subnet.rb, line 195
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'availability_domain': :'availabilityDomain',
    'cidr_block': :'cidrBlock',
    'compartment_id': :'compartmentId',
    'defined_tags': :'definedTags',
    'dhcp_options_id': :'dhcpOptionsId',
    'display_name': :'displayName',
    'dns_label': :'dnsLabel',
    'freeform_tags': :'freeformTags',
    'id': :'id',
    'ipv6_cidr_block': :'ipv6CidrBlock',
    'ipv6_virtual_router_ip': :'ipv6VirtualRouterIp',
    'lifecycle_state': :'lifecycleState',
    'prohibit_internet_ingress': :'prohibitInternetIngress',
    'prohibit_public_ip_on_vnic': :'prohibitPublicIpOnVnic',
    'route_table_id': :'routeTableId',
    'security_list_ids': :'securityListIds',
    'subnet_domain_name': :'subnetDomainName',
    'time_created': :'timeCreated',
    'vcn_id': :'vcnId',
    'virtual_router_ip': :'virtualRouterIp',
    'virtual_router_mac': :'virtualRouterMac'
    # rubocop:enable Style/SymbolLiteral
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :availability_domain The value to assign to the {#availability_domain} property @option attributes [String] :cidr_block The value to assign to the {#cidr_block} property @option attributes [String] :compartment_id The value to assign to the {#compartment_id} property @option attributes [Hash<String, Hash<String, Object>>] :defined_tags The value to assign to the {#defined_tags} property @option attributes [String] :dhcp_options_id The value to assign to the {#dhcp_options_id} property @option attributes [String] :display_name The value to assign to the {#display_name} property @option attributes [String] :dns_label The value to assign to the {#dns_label} property @option attributes [Hash<String, String>] :freeform_tags The value to assign to the {#freeform_tags} property @option attributes [String] :id The value to assign to the {#id} property @option attributes [String] :ipv6_cidr_block The value to assign to the {#ipv6_cidr_block} property @option attributes [String] :ipv6_virtual_router_ip The value to assign to the {#ipv6_virtual_router_ip} property @option attributes [String] :lifecycle_state The value to assign to the {#lifecycle_state} property @option attributes [BOOLEAN] :prohibit_internet_ingress The value to assign to the {#prohibit_internet_ingress} property @option attributes [BOOLEAN] :prohibit_public_ip_on_vnic The value to assign to the {#prohibit_public_ip_on_vnic} property @option attributes [String] :route_table_id The value to assign to the {#route_table_id} property @option attributes [Array<String>] :security_list_ids The value to assign to the {#security_list_ids} property @option attributes [String] :subnet_domain_name The value to assign to the {#subnet_domain_name} property @option attributes [DateTime] :time_created The value to assign to the {#time_created} property @option attributes [String] :vcn_id The value to assign to the {#vcn_id} property @option attributes [String] :virtual_router_ip The value to assign to the {#virtual_router_ip} property @option attributes [String] :virtual_router_mac The value to assign to the {#virtual_router_mac} property

# File lib/oci/core/models/subnet.rb, line 279
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.cidr_block = attributes[:'cidrBlock'] if attributes[:'cidrBlock']

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

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

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

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

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

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

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

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

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

  self.ipv6_cidr_block = attributes[:'ipv6CidrBlock'] if attributes[:'ipv6CidrBlock']

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

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

  self.ipv6_virtual_router_ip = attributes[:'ipv6VirtualRouterIp'] if attributes[:'ipv6VirtualRouterIp']

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

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

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

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

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

  self.prohibit_internet_ingress = attributes[:'prohibitInternetIngress'] unless attributes[:'prohibitInternetIngress'].nil?

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

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

  self.prohibit_public_ip_on_vnic = attributes[:'prohibitPublicIpOnVnic'] unless attributes[:'prohibitPublicIpOnVnic'].nil?

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

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

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

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

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

  self.subnet_domain_name = attributes[:'subnetDomainName'] if attributes[:'subnetDomainName']

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

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

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

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

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

  self.virtual_router_ip = attributes[:'virtualRouterIp'] if attributes[:'virtualRouterIp']

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

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

  self.virtual_router_mac = attributes[:'virtualRouterMac'] if attributes[:'virtualRouterMac']

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

  self.virtual_router_mac = attributes[:'virtual_router_mac'] if attributes[:'virtual_router_mac']
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/core/models/subnet.rb, line 224
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'availability_domain': :'String',
    'cidr_block': :'String',
    'compartment_id': :'String',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'dhcp_options_id': :'String',
    'display_name': :'String',
    'dns_label': :'String',
    'freeform_tags': :'Hash<String, String>',
    'id': :'String',
    'ipv6_cidr_block': :'String',
    'ipv6_virtual_router_ip': :'String',
    'lifecycle_state': :'String',
    'prohibit_internet_ingress': :'BOOLEAN',
    'prohibit_public_ip_on_vnic': :'BOOLEAN',
    'route_table_id': :'String',
    'security_list_ids': :'Array<String>',
    'subnet_domain_name': :'String',
    'time_created': :'DateTime',
    'vcn_id': :'String',
    'virtual_router_ip': :'String',
    'virtual_router_mac': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Public Instance Methods

==(other) click to toggle source

Checks equality by comparing each attribute. @param [Object] other the other object to be compared

# File lib/oci/core/models/subnet.rb, line 428
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    availability_domain == other.availability_domain &&
    cidr_block == other.cidr_block &&
    compartment_id == other.compartment_id &&
    defined_tags == other.defined_tags &&
    dhcp_options_id == other.dhcp_options_id &&
    display_name == other.display_name &&
    dns_label == other.dns_label &&
    freeform_tags == other.freeform_tags &&
    id == other.id &&
    ipv6_cidr_block == other.ipv6_cidr_block &&
    ipv6_virtual_router_ip == other.ipv6_virtual_router_ip &&
    lifecycle_state == other.lifecycle_state &&
    prohibit_internet_ingress == other.prohibit_internet_ingress &&
    prohibit_public_ip_on_vnic == other.prohibit_public_ip_on_vnic &&
    route_table_id == other.route_table_id &&
    security_list_ids == other.security_list_ids &&
    subnet_domain_name == other.subnet_domain_name &&
    time_created == other.time_created &&
    vcn_id == other.vcn_id &&
    virtual_router_ip == other.virtual_router_ip &&
    virtual_router_mac == other.virtual_router_mac
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/oci/core/models/subnet.rb, line 478
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) click to toggle source

@see the `==` method @param [Object] other the other object to be compared

# File lib/oci/core/models/subnet.rb, line 458
def eql?(other)
  self == other
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/oci/core/models/subnet.rb, line 467
def hash
  [availability_domain, cidr_block, compartment_id, defined_tags, dhcp_options_id, display_name, dns_label, freeform_tags, id, ipv6_cidr_block, ipv6_virtual_router_ip, lifecycle_state, prohibit_internet_ingress, prohibit_public_ip_on_vnic, route_table_id, security_list_ids, subnet_domain_name, time_created, vcn_id, virtual_router_ip, virtual_router_mac].hash
end
lifecycle_state=(lifecycle_state) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] lifecycle_state Object to be assigned

# File lib/oci/core/models/subnet.rb, line 412
def lifecycle_state=(lifecycle_state)
  # rubocop:disable Style/ConditionalAssignment
  if lifecycle_state && !LIFECYCLE_STATE_ENUM.include?(lifecycle_state)
    OCI.logger.debug("Unknown value for 'lifecycle_state' [" + lifecycle_state + "]. Mapping to 'LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE'") if OCI.logger
    @lifecycle_state = LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE
  else
    @lifecycle_state = lifecycle_state
  end
  # rubocop:enable Style/ConditionalAssignment
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/oci/core/models/subnet.rb, line 511
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/oci/core/models/subnet.rb, line 505
def to_s
  to_hash.to_s
end

Private Instance Methods

_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/oci/core/models/subnet.rb, line 528
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