/** * Core Services API * Use the Core Services API to manage resources such as virtual cloud networks (VCNs), compute instances, and block storage volumes. For more information, see the console documentation for the [Networking](https://docs.oracle.com/iaas/Content/Network/Concepts/overview.htm), [Compute](https://docs.oracle.com/iaas/Content/Compute/Concepts/computeoverview.htm), and [Block Volume](https://docs.oracle.com/iaas/Content/Block/Concepts/overview.htm) services. The required permissions are documented in the [Details for the Core Services](https://docs.oracle.com/iaas/Content/Identity/Reference/corepolicyreference.htm) article. * OpenAPI spec version: 20160918 * * * NOTE: This class is auto generated by OracleSDKGenerator. * Do not edit the class manually. * * Copyright (c) 2020, 2026, Oracle and/or its affiliates. All rights reserved. * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. */ /** * 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)](https://docs.oracle.com/iaas/Content/Network/Tasks/managingVNICs.htm). *
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.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 {@code Vnic} object. * Also see {@link 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.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm). * */ export interface Vnic { /** * The VNIC's availability domain. *
Example: {@code Uocm:PHX-AD-1} * */ "availabilityDomain": string; /** * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the VNIC. */ "compartmentId": string; /** * Defined tags for this resource. Each key is predefined and scoped to a * namespace. For more information, see [Resource Tags](https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). *
Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}} * */ "definedTags"?: { [key: string]: { [key: string]: any; }; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. * Avoid entering confidential information. * */ "displayName"?: string; /** * [Security attributes](https://docs.oracle.com/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels * for a resource that can be referenced in a [Zero Trust Packet Routing](https://docs.oracle.com/iaas/Content/zero-trust-packet-routing/overview.htm) * (ZPR) policy to control access to ZPR-supported resources. *
Example: {@code {\"Oracle-DataSecurity-ZPR\": {\"MaxEgressCount\": {\"value\":\"42\",\"mode\":\"audit\"}}}} * */ "securityAttributes"?: { [key: string]: { [key: string]: any; }; }; /** * 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](https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). *
Example: {@code {\"Department\": \"Finance\"}} * */ "freeformTags"?: { [key: string]: 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, {@code bminstance1} in FQDN {@code bminstance1.subnet123.vcn1.oraclevcn.com}). * Must be unique across all VNICs in the subnet and comply with * [RFC 952](https://tools.ietf.org/html/rfc952) and * [RFC 1123](https://tools.ietf.org/html/rfc1123). *
For more information, see * [DNS in Your Virtual Cloud Network](https://docs.oracle.com/iaas/Content/Network/Concepts/dns.htm). *
Example: {@code bminstance1} * */ "hostnameLabel"?: string; /** * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VNIC. */ "id": string; /** * Whether the VNIC is the primary VNIC (the VNIC that is automatically created * and attached during instance launch). * */ "isPrimary"?: boolean; /** * The current state of the VNIC. */ "lifecycleState": Vnic.LifecycleState; /** * 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: {@code 00:00:00:00:00:01} * */ "macAddress"?: 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 {@code nsgIds} attribute is ignored. Instead, the * VNIC belongs to the NSGs that are associated with the VLAN itself. See {@link Vlan}. *
For more information about NSGs, see
* {@link NetworkSecurityGroup}.
*
*/
"nsgIds"?: Array
Example: {@code 10.0.3.3}
*
*/
"privateIp"?: string;
/**
* The public IP address of the VNIC, if one is assigned.
*
*/
"publicIp"?: string;
/**
* Whether the source/destination check is disabled on the VNIC.
* Defaults to {@code 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](https://docs.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm#privateip).
*
If the VNIC belongs to a VLAN as part of the Oracle Cloud VMware Solution (instead of
* belonging to a subnet), the {@code skipSourceDestCheck} attribute is {@code true}.
* This is because the source/destination check is always disabled for VNICs in a VLAN.
*
Example: {@code true}
*
*/
"skipSourceDestCheck"?: boolean;
/**
* The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet the VNIC is in.
*/
"subnetId"?: string;
/**
* Usage of system tag keys. These predefined keys are scoped to namespaces.
* Example: {@code { \"orcl-cloud\": { \"free-tier-retained\": \"true\" } }}
*
*/
"systemTags"?: {
[key: string]: {
[key: string]: any;
};
};
/**
* The date and time the VNIC was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
*
Example: {@code 2016-08-25T21:10:29.600Z}
*
*/
"timeCreated": Date;
/**
* List of IPv6 addresses assigned to the VNIC.
*
Example: {@code 2001:DB8::}
*
*/
"ipv6Addresses"?: Array