Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace 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 and VCNs and Subnets.

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

Properties

Optional availabilityDomain

availabilityDomain: undefined | string

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`

cidrBlock

cidrBlock: string

The subnet's CIDR block.

Example: `10.0.1.0/24`

compartmentId

compartmentId: string

The OCID of the compartment containing the subnet.

Optional definedTags

definedTags: undefined | 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\"}}`

Optional dhcpOptionsId

dhcpOptionsId: undefined | string

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

Optional displayName

displayName: undefined | string

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

Optional dnsLabel

dnsLabel: undefined | string

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](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/dns.htm).

Example: `subnet123`

Optional freeformTags

freeformTags: undefined | object

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\"}`

id

id: string

The subnet's Oracle ID (OCID).

Optional ipv6CidrBlock

ipv6CidrBlock: undefined | string

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.

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

Optional ipv6VirtualRouterIp

ipv6VirtualRouterIp: undefined | string

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

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

lifecycleState

lifecycleState: LifecycleState

The subnet's current state.

Optional prohibitInternetIngress

prohibitInternetIngress: undefined | false | true

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`

Optional prohibitPublicIpOnVnic

prohibitPublicIpOnVnic: undefined | false | true

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`

routeTableId

routeTableId: string

The OCID of the route table that the subnet uses.

Optional securityListIds

securityListIds: Array<string>

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.

Optional subnetDomainName

subnetDomainName: undefined | string

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](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/dns.htm).

Example: `subnet123.vcn1.oraclevcn.com`

Optional timeCreated

timeCreated: Date

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

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

vcnId

vcnId: string

The OCID of the VCN the subnet is in.

virtualRouterIp

virtualRouterIp: string

The IP address of the virtual router.

Example: `10.0.14.1`

virtualRouterMac

virtualRouterMac: string

The MAC address of the virtual router.

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

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: Subnet): object

getJsonObj

  • getJsonObj(obj: Subnet): object