Class CreateVnicDetails

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).

Inheritance

object

CreateVnicDetails

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.CoreService.Models

Assembly: OCI.DotNetSDK.Core.dll

Syntax

public class CreateVnicDetails

Properties

AssignIpv6Ip

Declaration

[JsonProperty(PropertyName = "assignIpv6Ip")]
public bool? AssignIpv6Ip { get; set; }

Property Value

Type	Description
bool?	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.

AssignPrivateDnsRecord

Declaration

[JsonProperty(PropertyName = "assignPrivateDnsRecord")]
public bool? AssignPrivateDnsRecord { get; set; }

Property Value

Type	Description
bool?	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.

AssignPublicIp

Declaration

[JsonProperty(PropertyName = "assignPublicIp")]
public bool? AssignPublicIp { get; set; }

Property Value

Type Description

Type	Description
bool?	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 {@link 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. Note: There's a limit to the number of {@link 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. Example: falseIf you specify a vlanId, then assignPublicIp must be set to false. See{@link Vlan}.

bool?

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 {@link 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.
Note: There's a limit to the number of {@link 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.
Example: falseIf you specify a vlanId, then assignPublicIp must be set to false. See{@link Vlan}.

DefinedTags

Declaration

[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, 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"}}

DisplayName

Declaration

[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

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

FreeformTags

Declaration

[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }

Property Value

Type	Description
Dictionary<string, string>	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"}

HostnameLabel

Declaration

[JsonProperty(PropertyName = "hostnameLabel")]
public string HostnameLabel { get; set; }

Property Value

Type Description

Type	Description
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, `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. 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: bminstance1If you specify a vlanId, the hostnameLabel cannot be specified. VNICs on a VLANcan not be assigned a hostname. See {@link Vlan}.

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, 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.
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: bminstance1If you specify a vlanId, the hostnameLabel cannot be specified. VNICs on a VLANcan not be assigned a hostname. See {@link Vlan}.

Ipv6AddressIpv6SubnetCidrPairDetails

Declaration

[JsonProperty(PropertyName = "ipv6AddressIpv6SubnetCidrPairDetails")]
public List<Ipv6AddressIpv6SubnetCidrPairDetails> Ipv6AddressIpv6SubnetCidrPairDetails { get; set; }

Property Value

Type	Description
List<Ipv6AddressIpv6SubnetCidrPairDetails>	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.

NsgIds

Declaration

[JsonProperty(PropertyName = "nsgIds")]
public List<string> NsgIds { get; set; }

Property Value

Type	Description
List<string>	A list of the OCIDs of the network security groups (NSGs) to add the VNIC to. For more information about NSGs, see {@link 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 {@link Vlan}.

PrivateIp

Declaration

[JsonProperty(PropertyName = "privateIp")]
public string PrivateIp { get; set; }

Property Value

Type Description

Type	Description
string	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 {@link Vlan}. Example: 10.0.3.3

string

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 {@link Vlan}.
Example: 10.0.3.3

SecurityAttributes

Declaration

[JsonProperty(PropertyName = "securityAttributes")]
public Dictionary<string, Dictionary<string, object>> SecurityAttributes { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Security attributes are labels for a resource that can be referenced in a Zero Trust Packet Routing (ZPR) policy to control access to ZPR-supported resources. Example: {"Oracle-DataSecurity-ZPR": {"MaxEgressCount": {"value":"42","mode":"audit"}}}

SkipSourceDestCheck

Declaration

[JsonProperty(PropertyName = "skipSourceDestCheck")]
public bool? SkipSourceDestCheck { get; set; }

Property Value

Type Description

Type	Description
bool?	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 {@link Vlan}. Example: true

bool?

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 {@link Vlan}.
Example: true

SubnetId

Declaration

[JsonProperty(PropertyName = "subnetId")]
public string SubnetId { get; set; }

Property Value

Type Description

Type	Description
string	The OCID of the subnet to create the VNIC in. When launching an instance, use this `subnetId` instead of the deprecated `subnetId` in {@link #launchInstanceDetails(LaunchInstanceDetailsRequest) 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.

string

The OCID of the subnet to create the VNIC in. When launching an instance, use this subnetId instead of the deprecated subnetId in {@link #launchInstanceDetails(LaunchInstanceDetailsRequest) 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.

VlanId

Declaration

[JsonProperty(PropertyName = "vlanId")]
public string VlanId { get; set; }

Property Value

Type	Description
string	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 {@link Vlan}. Provide a `vlanId` instead of a `subnetId`. If you provide both a `vlanId` and `subnetId`, the request fails.