@Generated(value="OracleSDKGenerator", comments="API Version: 20160918") public final class CreateVnicDetails extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
Contains properties for a VNIC. You use this object when creating the primary VNIC during
instance launch or when creating a secondary VNIC. For more information about VNICs, see Virtual
Network Interface Cards
(VNICs).
Note: Objects should always be created or deserialized using the CreateVnicDetails.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 CreateVnicDetails.Builder
, which maintain a
set of all explicitly set fields called CreateVnicDetails.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 |
CreateVnicDetails.Builder |
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME
Constructor and Description |
---|
CreateVnicDetails(Boolean assignIpv6Ip,
Boolean assignPublicIp,
Boolean assignPrivateDnsRecord,
Map<String,Map<String,Object>> definedTags,
String displayName,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> securityAttributes,
String hostnameLabel,
List<Ipv6AddressIpv6SubnetCidrPairDetails> ipv6AddressIpv6SubnetCidrPairDetails,
List<String> nsgIds,
String privateIp,
Boolean skipSourceDestCheck,
String subnetId,
String vlanId)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
static CreateVnicDetails.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
Boolean |
getAssignIpv6Ip()
Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled
subnet.
|
Boolean |
getAssignPrivateDnsRecord()
Whether the VNIC should be assigned a DNS record.
|
Boolean |
getAssignPublicIp()
Whether the VNIC should be assigned a public IP address.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
String |
getDisplayName()
A user-friendly name.
|
Map<String,String> |
getFreeformTags()
Free-form tags for this resource.
|
String |
getHostnameLabel()
The hostname for the VNIC’s primary private IP.
|
List<Ipv6AddressIpv6SubnetCidrPairDetails> |
getIpv6AddressIpv6SubnetCidrPairDetails()
A list of IPv6 prefix ranges from which the VNIC is assigned an IPv6 address.
|
List<String> |
getNsgIds()
A list of the OCIDs of the network security groups (NSGs) to add the VNIC to.
|
String |
getPrivateIp()
A private IP address of your choice to assign to the VNIC.
|
Map<String,Map<String,Object>> |
getSecurityAttributes()
Security Attributes for this resource.
|
Boolean |
getSkipSourceDestCheck()
Whether the source/destination check is disabled on the VNIC.
|
String |
getSubnetId()
The OCID of
the subnet to create the VNIC in.
|
String |
getVlanId()
Provide this attribute only if you are an Oracle Cloud VMware Solution customer and creating
a secondary VNIC in a VLAN.
|
int |
hashCode() |
CreateVnicDetails.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet
@Deprecated @ConstructorProperties(value={"assignIpv6Ip","assignPublicIp","assignPrivateDnsRecord","definedTags","displayName","freeformTags","securityAttributes","hostnameLabel","ipv6AddressIpv6SubnetCidrPairDetails","nsgIds","privateIp","skipSourceDestCheck","subnetId","vlanId"}) public CreateVnicDetails(Boolean assignIpv6Ip, Boolean assignPublicIp, Boolean assignPrivateDnsRecord, Map<String,Map<String,Object>> definedTags, String displayName, Map<String,String> freeformTags, Map<String,Map<String,Object>> securityAttributes, String hostnameLabel, List<Ipv6AddressIpv6SubnetCidrPairDetails> ipv6AddressIpv6SubnetCidrPairDetails, List<String> nsgIds, String privateIp, Boolean skipSourceDestCheck, String subnetId, String vlanId)
public static CreateVnicDetails.Builder builder()
Create a new builder.
public CreateVnicDetails.Builder toBuilder()
public Boolean getAssignIpv6Ip()
Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled
subnet. Default: False. When provided you may optionally provide an IPv6 prefix (ipv6SubnetCidr
) of your choice to assign the IPv6 address from. If ipv6SubnetCidr
is
not provided then an IPv6 prefix is chosen for you.
public Boolean getAssignPublicIp()
Whether the VNIC should be assigned a public IP address. Defaults to whether the subnet is
public or private. If not set and the VNIC is being created in a private subnet (that is,
where prohibitPublicIpOnVnic
= true in the Subnet
), then no public IP address
is assigned. If not set and the subnet is public (prohibitPublicIpOnVnic
= false),
then a public IP address is assigned. If set to true and prohibitPublicIpOnVnic
=
true, an error is returned.
*Note:** This public IP address is associated with the primary private IP on the VNIC. For more information, see [IP Addresses](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingIPaddresses.htm).
*Note:** There's a limit to the number of PublicIp
a VNIC or instance can have. If
you try to create a secondary VNIC with an assigned public IP for an instance that has
already reached its public IP limit, an error is returned. For information about the public
IP limits, see [Public IP
Addresses](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingpublicIPs.htm).
Example: false
If you specify a vlanId
, then assignPublicIp
must be set to false. See
Vlan
.
public Boolean getAssignPrivateDnsRecord()
Whether the VNIC should be assigned a DNS record. If set to false, there will be no DNS record registration for the VNIC. If set to true, the DNS record will be registered. The default value is true.
If you specify a hostnameLabel
, then assignPrivateDnsRecord
must be set to
true.
public Map<String,Map<String,Object>> getDefinedTags()
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: {"Operations": {"CostCenter": "42"}}
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()
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"}
public Map<String,Map<String,Object>> getSecurityAttributes()
Security Attributes for this resource. This is unique to ZPR, and helps identify which resources are allowed to be accessed by what permission controls.
Example: {"Oracle-DataSecurity-ZPR": {"MaxEgressCount":
{"value":"42","mode":"audit"}}}
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. The value appears in the {@link
Vnic}
object and also the {@link PrivateIp}
object returned by {@link
#listPrivateIps(ListPrivateIpsRequest) listPrivateIps}
and {@link
#getPrivateIp(GetPrivateIpRequest) getPrivateIp}
.
For more information, see [DNS in Your Virtual Cloud Network](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/dns.htm).
When launching an instance, use this hostnameLabel
instead of the deprecated
hostnameLabel
in {@link #launchInstanceDetails(LaunchInstanceDetailsRequest)
launchInstanceDetails}
. If you provide both, the values must match.
Example: bminstance1
If you specify a vlanId
, the hostnameLabel
cannot be specified. VNICs on a
VLAN can not be assigned a hostname. See Vlan
.
public List<Ipv6AddressIpv6SubnetCidrPairDetails> getIpv6AddressIpv6SubnetCidrPairDetails()
A list of IPv6 prefix ranges from which the VNIC is assigned an IPv6 address. You can provide only the prefix ranges from which OCI selects an available address from the range. You can optionally choose to leave the prefix range empty and instead provide the specific IPv6 address within that range to use.
public List<String> getNsgIds()
A list of the OCIDs of the network security groups (NSGs) to add the VNIC to. For more
information about NSGs, see NetworkSecurityGroup
.
If a vlanId
is specified, the nsgIds
cannot be specified. The vlanId
indicates that the VNIC will belong to a VLAN instead of a subnet. With VLANs, all
VNICs in the VLAN belong to the NSGs that are associated with the VLAN. See Vlan
.
public String getPrivateIp()
A private IP address of your choice to assign to the VNIC. Must be an available IP address
within the subnet’s CIDR. If you don’t specify a value, Oracle automatically assigns a
private IP address from the subnet. This is the VNIC’s primary private IP address. The
value appears in the {@link Vnic}
object and also the {@link PrivateIp}
object returned by {@link #listPrivateIps(ListPrivateIpsRequest) listPrivateIps}
and
{@link #getPrivateIp(GetPrivateIpRequest) getPrivateIp}
.
If you specify a vlanId
, the privateIp
cannot be specified. See Vlan
.
Example: 10.0.3.3
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 you specify a vlanId
, the skipSourceDestCheck
cannot be specified
because the source/destination check is always disabled for VNICs in a VLAN. See Vlan
.
Example: true
public String getSubnetId()
The OCID of
the subnet to create the VNIC in. When launching an instance, use this subnetId
instead of the deprecated subnetId
in launchInstanceDetails
. At least one of
them is required; if you provide both, the values must match.
If you are an Oracle Cloud VMware Solution customer and creating a secondary VNIC in a
VLAN instead of a subnet, provide a vlanId
instead of a subnetId
. If you
provide both a vlanId
and subnetId
, the request fails.
public String getVlanId()
Provide this attribute only if you are an Oracle Cloud VMware Solution customer and creating
a secondary VNIC in a VLAN. The value is the
OCID of the
VLAN. See Vlan
.
Provide a vlanId
instead of a subnetId
. If you provide both a vlanId
and subnetId
, the request fails.
public String toString()
toString
in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
public 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.ExplicitlySetBmcModel
public int hashCode()
hashCode
in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
Copyright © 2016–2024. All rights reserved.