@Generated(value="OracleSDKGenerator",
comments="API Version: 20160918")
public final class Vnic
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
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 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).
Note: Objects should always be created or deserialized using the Vnic.Builder. This model
distinguishes fields that are null because they are unset from fields that are explicitly
set to null. This is done in the setter methods of the Vnic.Builder, which maintain a
set of all explicitly set fields called Vnic.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set
fields into account. The constructor, on the other hand, does not take the explicitly set fields
into account (since the constructor cannot distinguish explicit null from unset null).
| Modifier and Type | Class and Description |
|---|---|
static class |
Vnic.Builder |
static class |
Vnic.LifecycleState
The current state of the VNIC.
|
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
Vnic(String availabilityDomain,
String compartmentId,
Map<String,Map<String,Object>> definedTags,
String displayName,
Map<String,String> freeformTags,
String hostnameLabel,
String id,
Boolean isPrimary,
Vnic.LifecycleState lifecycleState,
String macAddress,
List<String> nsgIds,
String vlanId,
String privateIp,
String publicIp,
Boolean skipSourceDestCheck,
String subnetId,
Date timeCreated)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static Vnic.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
String |
getAvailabilityDomain()
The VNIC’s availability domain.
|
String |
getCompartmentId()
The OCID of
the compartment containing the VNIC.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
String |
getDisplayName()
A user-friendly name.
|
Map<String,String> |
getFreeformTags()
Simple key-value pair that is applied without any predefined name, type or scope.
|
String |
getHostnameLabel()
The hostname for the VNIC’s primary private IP.
|
String |
getId()
The OCID of
the VNIC.
|
Boolean |
getIsPrimary()
Whether the VNIC is the primary VNIC (the VNIC that is automatically created and attached
during instance launch).
|
Vnic.LifecycleState |
getLifecycleState()
The current state of the VNIC.
|
String |
getMacAddress()
The MAC address of the VNIC.
|
List<String> |
getNsgIds()
A list of the OCIDs of the network security groups that the VNIC belongs to.
|
String |
getPrivateIp()
The private IP address of the primary
privateIp object on the VNIC. |
String |
getPublicIp()
The public IP address of the VNIC, if one is assigned.
|
Boolean |
getSkipSourceDestCheck()
Whether the source/destination check is disabled on the VNIC.
|
String |
getSubnetId()
The OCID of
the subnet the VNIC is in.
|
Date |
getTimeCreated()
The date and time the VNIC was created, in the format defined by
RFC3339.
|
String |
getVlanId()
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. |
int |
hashCode() |
Vnic.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"availabilityDomain","compartmentId","definedTags","displayName","freeformTags","hostnameLabel","id","isPrimary","lifecycleState","macAddress","nsgIds","vlanId","privateIp","publicIp","skipSourceDestCheck","subnetId","timeCreated"}) public Vnic(String availabilityDomain, String compartmentId, Map<String,Map<String,Object>> definedTags, String displayName, Map<String,String> freeformTags, String hostnameLabel, String id, Boolean isPrimary, Vnic.LifecycleState lifecycleState, String macAddress, List<String> nsgIds, String vlanId, String privateIp, String publicIp, Boolean skipSourceDestCheck, String subnetId, Date timeCreated)
public static Vnic.Builder builder()
Create a new builder.
public Vnic.Builder toBuilder()
public String getAvailabilityDomain()
The VNIC’s availability domain.
Example: Uocm:PHX-AD-1
public String getCompartmentId()
The OCID of the compartment containing the VNIC.
public Map<String,Map<String,Object>> getDefinedTags()
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace": {"bar-key": "value"}}
public String getDisplayName()
A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
public Map<String,String> getFreeformTags()
Simple key-value pair that is applied without any predefined name, type or scope. Exists for
cross-compatibility only. Example: {"bar-key": "value"}
public String getHostnameLabel()
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, bminstance1 in FQDN bminstance1.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: bminstance1
public Boolean getIsPrimary()
Whether the VNIC is the primary VNIC (the VNIC that is automatically created and attached during instance launch).
public Vnic.LifecycleState getLifecycleState()
The current state of the VNIC.
public String getMacAddress()
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
public List<String> getNsgIds()
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.
public String getVlanId()
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.
public String getPrivateIp()
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
public String getPublicIp()
The public IP address of the VNIC, if one is assigned.
public Boolean getSkipSourceDestCheck()
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
public Date getTimeCreated()
The date and time the VNIC was created, in the format defined by RFC3339.
Example: 2016-08-25T21:10:29.600Z
public String toString()
toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic int hashCode()
hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelCopyright © 2016–2024. All rights reserved.