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.

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.

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

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.
  • 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.
  • 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.
  • time_created (datetime) -- The value to assign to the time_created property of this Vnic.
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
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
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))
display_name

Gets the display_name of this Vnic. A user-friendly name. Does not have to be unique. Avoid entering confidential information.

Returns:The display_name of this Vnic.
Return type:str
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)
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, bminstance-1 in FQDN bminstance-1.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: bminstance-1

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

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

Returns:The id of this Vnic.
Return type:str
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
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
mac_address

Gets the mac_address of this Vnic. The MAC address of the VNIC.

Example: 00:00:17:B6:4D:DD

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

Gets the nsg_ids of this Vnic. A list of the OCIDs of the network security groups that the VNIC belongs to. For more information about NSGs, see NetworkSecurityGroup.

Returns:The nsg_ids of this Vnic.
Return type:list[str]
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
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
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.

Example: true

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

[Required] 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
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