Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace VnicAttachment

Represents an attachment between a VNIC and an instance. For more information, see Virtual Network Interface Cards (VNICs).

*Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Enumerations

Properties

Functions

Properties

availabilityDomain

availabilityDomain: string

The availability domain of the instance.

Example: {@code Uocm:PHX-AD-1}

compartmentId

compartmentId: string

The OCID of the compartment the VNIC attachment is in, which is the same compartment the instance is in.

Optional displayName

displayName: undefined | string

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

id

id: string

The OCID of the VNIC attachment.

instanceId

instanceId: string

The OCID of the instance.

lifecycleState

lifecycleState: LifecycleState

The current state of the VNIC attachment.

Optional nicIndex

nicIndex: undefined | number

Which physical network interface card (NIC) the VNIC uses. Certain bare metal instance shapes have two active physical NICs (0 and 1). If you add a secondary VNIC to one of these instances, you can specify which NIC the VNIC will use. For more information, see Virtual Network Interface Cards (VNICs). Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional subnetId

subnetId: undefined | string

The OCID of the subnet to create the VNIC in.

timeCreated

timeCreated: Date

The date and time the VNIC attachment was created, in the format defined by RFC3339.

Example: {@code 2016-08-25T21:10:29.600Z}

Optional vlanId

vlanId: undefined | string

The OCID of the VLAN to create the VNIC in. Creating the VNIC in a VLAN (instead of a subnet) is possible only if you are an Oracle Cloud VMware Solution customer. See Vlan.

An error is returned if the instance already has a VNIC attached to it from this VLAN.

Optional vlanTag

vlanTag: undefined | number

The Oracle-assigned VLAN tag of the attached VNIC. Available after the attachment process is complete.

However, if the VNIC belongs to a VLAN as part of the Oracle Cloud VMware Solution, the {@code vlanTag} value is instead the value of the {@code vlanTag} attribute for the VLAN. See Vlan.

Example: {@code 0} Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional vnicId

vnicId: undefined | string

The OCID of the VNIC. Available after the attachment process is complete.

Functions

getDeserializedJsonObj

getJsonObj