Vnic¶

class oci.core.models.Vnic(**kwargs)¶

Bases: object

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 create_private_ip() and IP Addresses.

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.

Attributes:

`LIFECYCLE_STATE_AVAILABLE`	A constant which can be used with the lifecycle_state property of a Vnic.
`LIFECYCLE_STATE_PROVISIONING`	A constant which can be used with the lifecycle_state property of a Vnic.
`LIFECYCLE_STATE_TERMINATED`	A constant which can be used with the lifecycle_state property of a Vnic.
`LIFECYCLE_STATE_TERMINATING`	A constant which can be used with the lifecycle_state property of a Vnic.
`availability_domain`	[Required] Gets the availability_domain of this Vnic.
`compartment_id`	[Required] Gets the compartment_id of this Vnic.
`defined_tags`	Gets the defined_tags of this Vnic.
`display_name`	Gets the display_name of this Vnic.
`freeform_tags`	Gets the freeform_tags of this Vnic.
`hostname_label`	Gets the hostname_label of this Vnic.
`id`	[Required] Gets the id of this Vnic.
`ipv6_addresses`	Gets the ipv6_addresses of this Vnic.
`is_primary`	Gets the is_primary of this Vnic.
`lifecycle_state`	[Required] Gets the lifecycle_state of this Vnic.
`mac_address`	Gets the mac_address of this Vnic.
`nsg_ids`	Gets the nsg_ids of this Vnic.
`private_ip`	Gets the private_ip of this Vnic.
`public_ip`	Gets the public_ip of this Vnic.
`route_table_id`	Gets the route_table_id of this Vnic.
`security_attributes`	Gets the security_attributes of this Vnic.
`skip_source_dest_check`	Gets the skip_source_dest_check of this Vnic.
`subnet_id`	Gets the subnet_id of this Vnic.
`system_tags`	Gets the system_tags of this Vnic.
`time_created`	[Required] Gets the time_created of this Vnic.
`vlan_id`	Gets the vlan_id of this Vnic.

Methods:

__init__(**kwargs)

Initializes a new Vnic object with values from keyword arguments.

LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE'¶: A constant which can be used with the lifecycle_state property of a Vnic. This constant has a value of “AVAILABLE”

LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING'¶: A constant which can be used with the lifecycle_state property of a Vnic. This constant has a value of “PROVISIONING”

LIFECYCLE_STATE_TERMINATED = 'TERMINATED'¶: A constant which can be used with the lifecycle_state property of a Vnic. This constant has a value of “TERMINATED”

LIFECYCLE_STATE_TERMINATING = 'TERMINATING'¶: A constant which can be used with the lifecycle_state property of a Vnic. This constant has a value of “TERMINATING”

__init__(**kwargs)¶

Initializes a new Vnic object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters

availability_domain (str) – The value to assign to the availability_domain property of this Vnic.
compartment_id (str) – The value to assign to the compartment_id property of this Vnic.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Vnic.
display_name (str) – The value to assign to the display_name property of this Vnic.
security_attributes (dict(str, dict(str, object))) – The value to assign to the security_attributes property of this Vnic.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Vnic.
hostname_label (str) – The value to assign to the hostname_label property of this Vnic.
id (str) – The value to assign to the id property of this Vnic.
is_primary (bool) – The value to assign to the is_primary property of this Vnic.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this Vnic. Allowed values for this property are: “PROVISIONING”, “AVAILABLE”, “TERMINATING”, “TERMINATED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
mac_address (str) – The value to assign to the mac_address property of this Vnic.
nsg_ids (list[str]) – The value to assign to the nsg_ids property of this Vnic.
vlan_id (str) – The value to assign to the vlan_id property of this Vnic.
private_ip (str) – The value to assign to the private_ip property of this Vnic.
public_ip (str) – The value to assign to the public_ip property of this Vnic.
skip_source_dest_check (bool) – The value to assign to the skip_source_dest_check property of this Vnic.
subnet_id (str) – The value to assign to the subnet_id property of this Vnic.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this Vnic.
time_created (datetime) – The value to assign to the time_created property of this Vnic.
ipv6_addresses (list[str]) – The value to assign to the ipv6_addresses property of this Vnic.
route_table_id (str) – The value to assign to the route_table_id property of this Vnic.

property availability_domain¶

[Required] Gets the availability_domain of this Vnic. The VNIC’s availability domain.

Example: Uocm:PHX-AD-1

Returns: The availability_domain of this Vnic.
Return type: str

property compartment_id¶

[Required] Gets the compartment_id of this Vnic. The OCID of the compartment containing the VNIC.

Returns: The compartment_id of this Vnic.
Return type: str

property defined_tags¶

Gets the defined_tags of this Vnic. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {“Operations”: {“CostCenter”: “42”}}

Returns: The defined_tags of this Vnic.
Return type: dict(str, dict(str, object))

property display_name¶

Gets the display_name of this Vnic. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Returns: The display_name of this Vnic.
Return type: str

property freeform_tags¶

Gets the freeform_tags of this Vnic. 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”}

Returns: The freeform_tags of this Vnic.
Return type: dict(str, str)

property hostname_label¶

Gets the hostname_label of this Vnic. 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.

Example: bminstance1

Returns: The hostname_label of this Vnic.
Return type: str

property id¶

[Required] Gets the id of this Vnic. The OCID of the VNIC.

Returns: The id of this Vnic.
Return type: str

property ipv6_addresses¶

Gets the ipv6_addresses of this Vnic. List of IPv6 addresses assigned to the VNIC.

Example: 2001:DB8::

Returns: The ipv6_addresses of this Vnic.
Return type: list[str]

property is_primary¶

Gets the is_primary of this Vnic. Whether the VNIC is the primary VNIC (the VNIC that is automatically created and attached during instance launch).

Returns: The is_primary of this Vnic.
Return type: bool

property lifecycle_state¶

[Required] Gets the lifecycle_state of this Vnic. The current state of the VNIC.

Allowed values for this property are: “PROVISIONING”, “AVAILABLE”, “TERMINATING”, “TERMINATED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns: The lifecycle_state of this Vnic.
Return type: str

property mac_address¶

Gets the mac_address of this Vnic. 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

Returns: The mac_address of this Vnic.
Return type: str

property nsg_ids¶

Gets the nsg_ids of this Vnic. 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.

Returns: The nsg_ids of this Vnic.
Return type: list[str]

property private_ip¶

Gets the private_ip of this Vnic. 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

Returns: The private_ip of this Vnic.
Return type: str

property public_ip¶

Gets the public_ip of this Vnic. The public IP address of the VNIC, if one is assigned.

Returns: The public_ip of this Vnic.
Return type: str

property route_table_id¶

Gets the route_table_id of this Vnic. The OCID of the route table the IP address or VNIC will use. For more information, see Per-resource Routing.

Returns: The route_table_id of this Vnic.
Return type: str

property security_attributes¶

Gets the security_attributes of this Vnic. 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”}}}

Returns: The security_attributes of this Vnic.
Return type: dict(str, dict(str, object))

property skip_source_dest_check¶

Gets the skip_source_dest_check of this Vnic. 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

Returns: The skip_source_dest_check of this Vnic.
Return type: bool

property subnet_id¶

Gets the subnet_id of this Vnic. The OCID of the subnet the VNIC is in.

Returns: The subnet_id of this Vnic.
Return type: str

property system_tags¶

Gets the system_tags of this Vnic. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: { “orcl-cloud”: { “free-tier-retained”: “true” } }

Returns: The system_tags of this Vnic.
Return type: dict(str, dict(str, object))

property time_created¶

[Required] Gets the time_created of this Vnic. The date and time the VNIC was created, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

Returns: The time_created of this Vnic.
Return type: datetime

property vlan_id¶

Gets the vlan_id of this Vnic. 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.

Returns: The vlan_id of this Vnic.
Return type: str