Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Properties

Optional assignIpv6Ip

assignIpv6Ip: undefined | false | true

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 ({@code ipv6SubnetCidr}) of your choice to assign the IPv6 address from. If {@code ipv6SubnetCidr} is not provided then an IPv6 prefix is chosen for you.

Optional assignPrivateDnsRecord

assignPrivateDnsRecord: undefined | false | true

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 {@code hostnameLabel}, then {@code assignPrivateDnsRecord} must be set to true.

Optional assignPublicIp

assignPublicIp: undefined | false | true

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 {@code prohibitPublicIpOnVnic} = true in the Subnet), then no public IP address is assigned. If not set and the subnet is public ({@code prohibitPublicIpOnVnic} = false), then a public IP address is assigned. If set to true and {@code 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: {@code false}

If you specify a {@code vlanId}, then {@code assignPublicIp} must be set to false. See Vlan.

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: {@code {\"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: {@code {\"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, {@code bminstance1} in FQDN {@code 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 {@code Vnic} object and also the {@code PrivateIp} object returned by {@code {@link #listPrivateIps(ListPrivateIpsRequest) listPrivateIps}} and {@code {@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 {@code hostnameLabel} instead of the deprecated {@code hostnameLabel} in {@code {@link #launchInstanceDetails(LaunchInstanceDetailsRequest) launchInstanceDetails}}. If you provide both, the values must match.

Example: {@code bminstance1}

If you specify a {@code vlanId}, the {@code hostnameLabel} cannot be specified. VNICs on a VLAN can not be assigned a hostname. See Vlan.

Optional ipv6AddressIpv6SubnetCidrPairDetails

ipv6AddressIpv6SubnetCidrPairDetails: Array<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.

Optional nsgIds

nsgIds: Array<string>

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 {@code vlanId} is specified, the {@code nsgIds} cannot be specified. The {@code 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.

Optional privateIp

privateIp: undefined | 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 {@code Vnic} object and also the {@code PrivateIp} object returned by {@code {@link #listPrivateIps(ListPrivateIpsRequest) listPrivateIps}} and {@code {@link #getPrivateIp(GetPrivateIpRequest) getPrivateIp}}.

If you specify a {@code vlanId}, the {@code privateIp} cannot be specified. See Vlan.

Example: {@code 10.0.3.3}

Optional skipSourceDestCheck

skipSourceDestCheck: undefined | false | true

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.

If you specify a {@code vlanId}, the {@code skipSourceDestCheck} cannot be specified because the source/destination check is always disabled for VNICs in a VLAN. See Vlan.

Example: {@code true}

Optional subnetId

subnetId: undefined | string

The OCID of the subnet to create the VNIC in. When launching an instance, use this {@code subnetId} instead of the deprecated {@code 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 {@code vlanId} instead of a {@code subnetId}. If you provide both a {@code vlanId} and {@code subnetId}, the request fails.

Optional vlanId

vlanId: undefined | 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 Vlan.

Provide a {@code vlanId} instead of a {@code subnetId}. If you provide both a {@code vlanId} and {@code subnetId}, the request fails.

Functions

getDeserializedJsonObj

getJsonObj