Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Vnic

A virtual network interface card. Each VNIC resides in a subnet in a VCN. An instance attaches to a VNIC to obtain a network connection into the VCN through that subnet. Each instance has a primary VNIC that is automatically created and attached during launch. You can add secondary VNICs to an instance after it's launched. For more information, see Virtual Network Interface Cards (VNICs).

Each VNIC has a *primary private IP* that is automatically assigned during launch. You can add *secondary private IPs* to a VNIC after it's created. For more information, see {@link #createPrivateIp(CreatePrivateIpRequest) createPrivateIp} and [IP Addresses](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingIPaddresses.htm).

If you are an Oracle Cloud VMware Solution customer, you will have secondary VNICs that reside in a VLAN instead of a subnet. These VNICs have other differences, which are called out in the descriptions of the relevant attributes in the Vnic 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](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).

If you are an Oracle Cloud VMware Solution customer, you will have secondary VNICs that reside in a VLAN instead of a subnet. These VNICs have other differences, which are called out in the descriptions of the relevant attributes in the Vnic 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](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).

Properties

availabilityDomain

availabilityDomain: string

The VNIC's availability domain.

Example: `Uocm:PHX-AD-1`

compartmentId

compartmentId: string

The OCID of the compartment containing the VNIC.

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 displayName

displayName: undefined | string

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

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

Optional hostnameLabel

hostnameLabel: undefined | 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, bminstance-1 in FQDN bminstance-1.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](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/dns.htm).

Example: `bminstance-1`

id

id: string

The OCID of the VNIC.

Optional isPrimary

isPrimary: undefined | false | true

Whether the VNIC is the primary VNIC (the VNIC that is automatically created and attached during instance launch).

lifecycleState

lifecycleState: LifecycleState

The current state of the VNIC.

Optional macAddress

macAddress: undefined | string

The MAC address of the VNIC.

If the VNIC belongs to a VLAN as part of the Oracle Cloud VMware Solution, the MAC address is learned. If the VNIC belongs to a subnet, the MAC address is a static, Oracle-provided value.

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

Optional nsgIds

nsgIds: Array<string>

A list of the OCIDs of the network security groups that the VNIC belongs to.

If the VNIC belongs to a VLAN as part of the Oracle Cloud VMware Solution (instead of belonging to a subnet), the value of the `nsgIds` attribute is ignored. Instead, the VNIC belongs to the NSGs that are associated with the VLAN itself. See Vlan.

For more information about NSGs, see NetworkSecurityGroup.

Optional privateIp

privateIp: undefined | string

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

Example: `10.0.3.3`

Optional publicIp

publicIp: undefined | string

The public IP address of the VNIC, if one is assigned.

Optional skipSourceDestCheck

skipSourceDestCheck: undefined | false | true

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 the VNIC belongs to a VLAN as part of the Oracle Cloud VMware Solution (instead of belonging to a subnet), the skipSourceDestCheck attribute is true. This is because the source/destination check is always disabled for VNICs in a VLAN.

Example: `true`

If the VNIC belongs to a VLAN as part of the Oracle Cloud VMware Solution (instead of belonging to a subnet), the skipSourceDestCheck attribute is true. This is because the source/destination check is always disabled for VNICs in a VLAN.

Example: `true`

Optional subnetId

subnetId: undefined | string

The OCID of the subnet the VNIC is in.

timeCreated

timeCreated: Date

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

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

Optional vlanId

vlanId: undefined | string

If the VNIC belongs to a VLAN as part of the Oracle Cloud VMware Solution (instead of belonging to a subnet), the vlanId is the OCID of the VLAN the VNIC is in. See Vlan. If the VNIC is instead in a subnet, subnetId has a value.

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: Vnic): object

getJsonObj

  • getJsonObj(obj: Vnic): object