CreateVnicDetails

class oci.core.models.CreateVnicDetails(**kwargs)

Bases: object

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

__init__(**kwargs)

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

Parameters:
  • assign_public_ip (bool) -- The value to assign to the assign_public_ip property of this CreateVnicDetails.
  • defined_tags (dict(str, dict(str, object))) -- The value to assign to the defined_tags property of this CreateVnicDetails.
  • display_name (str) -- The value to assign to the display_name property of this CreateVnicDetails.
  • freeform_tags (dict(str, str)) -- The value to assign to the freeform_tags property of this CreateVnicDetails.
  • hostname_label (str) -- The value to assign to the hostname_label property of this CreateVnicDetails.
  • nsg_ids (list[str]) -- The value to assign to the nsg_ids property of this CreateVnicDetails.
  • private_ip (str) -- The value to assign to the private_ip property of this CreateVnicDetails.
  • skip_source_dest_check (bool) -- The value to assign to the skip_source_dest_check property of this CreateVnicDetails.
  • subnet_id (str) -- The value to assign to the subnet_id property of this CreateVnicDetails.
assign_public_ip

Gets the assign_public_ip of this CreateVnicDetails. 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 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 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: false

Returns:The assign_public_ip of this CreateVnicDetails.
Return type:bool
defined_tags

Gets the defined_tags of this CreateVnicDetails. 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 CreateVnicDetails.
Return type:dict(str, dict(str, object))
display_name

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

Returns:The display_name of this CreateVnicDetails.
Return type:str
freeform_tags

Gets the freeform_tags of this CreateVnicDetails. 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 CreateVnicDetails.
Return type:dict(str, str)
hostname_label

Gets the hostname_label of this CreateVnicDetails. 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. The value appears in the Vnic object and also the PrivateIp object returned by list_private_ips() and get_private_ip().

For more information, see DNS in Your Virtual Cloud Network.

When launching an instance, use this hostnameLabel instead of the deprecated hostnameLabel in launch_instance_details(). If you provide both, the values must match.

Example: bminstance-1

Returns:The hostname_label of this CreateVnicDetails.
Return type:str
nsg_ids

Gets the nsg_ids of this CreateVnicDetails. A list of the OCIDs of the network security groups (NSGs) to add the VNIC to. For more information about NSGs, see NetworkSecurityGroup.

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

Gets the private_ip of this CreateVnicDetails. 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 Vnic object and also the PrivateIp object returned by list_private_ips() and get_private_ip().

Example: 10.0.3.3

Returns:The private_ip of this CreateVnicDetails.
Return type:str
skip_source_dest_check

Gets the skip_source_dest_check of this CreateVnicDetails. 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 CreateVnicDetails.
Return type:bool
subnet_id

[Required] Gets the subnet_id of this CreateVnicDetails. The OCID of the subnet to create the VNIC in. When launching an instance, use this subnetId instead of the deprecated subnetId in launch_instance_details(). At least one of them is required; if you provide both, the values must match.

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