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

Methods:

__init__(**kwargs)

Initializes a new CreateVnicDetails object with values from keyword arguments.

Attributes:

`assign_ipv6_ip`	Gets the assign_ipv6_ip of this CreateVnicDetails.
`assign_private_dns_record`	Gets the assign_private_dns_record of this CreateVnicDetails.
`assign_public_ip`	Gets the assign_public_ip of this CreateVnicDetails.
`defined_tags`	Gets the defined_tags of this CreateVnicDetails.
`display_name`	Gets the display_name of this CreateVnicDetails.
`freeform_tags`	Gets the freeform_tags of this CreateVnicDetails.
`hostname_label`	Gets the hostname_label of this CreateVnicDetails.
`ipv6_address_ipv6_subnet_cidr_pair_details`	Gets the ipv6_address_ipv6_subnet_cidr_pair_details of this CreateVnicDetails.
`nsg_ids`	Gets the nsg_ids of this CreateVnicDetails.
`private_ip`	Gets the private_ip of this CreateVnicDetails.
`private_ip_id`	Gets the private_ip_id of this CreateVnicDetails.
`security_attributes`	Gets the security_attributes of this CreateVnicDetails.
`skip_source_dest_check`	Gets the skip_source_dest_check of this CreateVnicDetails.
`subnet_cidr`	Gets the subnet_cidr of this CreateVnicDetails.
`subnet_id`	Gets the subnet_id of this CreateVnicDetails.
`vlan_id`	Gets the vlan_id of this CreateVnicDetails.

__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_ipv6_ip (bool) – The value to assign to the assign_ipv6_ip property of this CreateVnicDetails.
assign_public_ip (bool) – The value to assign to the assign_public_ip property of this CreateVnicDetails.
assign_private_dns_record (bool) – The value to assign to the assign_private_dns_record 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.
security_attributes (dict(str, dict(str, object))) – The value to assign to the security_attributes property of this CreateVnicDetails.
hostname_label (str) – The value to assign to the hostname_label property of this CreateVnicDetails.
ipv6_address_ipv6_subnet_cidr_pair_details (list[oci.core.models.Ipv6AddressIpv6SubnetCidrPairDetails]) – The value to assign to the ipv6_address_ipv6_subnet_cidr_pair_details property of this CreateVnicDetails.
subnet_cidr (str) – The value to assign to the subnet_cidr 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.
private_ip_id (str) – The value to assign to the private_ip_id 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.
vlan_id (str) – The value to assign to the vlan_id property of this CreateVnicDetails.

property assign_ipv6_ip¶

Gets the assign_ipv6_ip of this CreateVnicDetails. 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 (ipv6SubnetCidr) of your choice to assign the IPv6 address from. If ipv6SubnetCidr is not provided then an IPv6 prefix is chosen for you.

Returns: The assign_ipv6_ip of this CreateVnicDetails.
Return type: bool

property assign_private_dns_record¶

Gets the assign_private_dns_record of this CreateVnicDetails. 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 hostnameLabel, then assignPrivateDnsRecord must be set to true.

Returns: The assign_private_dns_record of this CreateVnicDetails.
Return type: bool

property 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

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

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

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

property display_name¶

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

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

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

property 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, 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. 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: bminstance1

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

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

property ipv6_address_ipv6_subnet_cidr_pair_details¶

Gets the ipv6_address_ipv6_subnet_cidr_pair_details of this CreateVnicDetails. 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.

Returns: The ipv6_address_ipv6_subnet_cidr_pair_details of this CreateVnicDetails.
Return type: list[oci.core.models.Ipv6AddressIpv6SubnetCidrPairDetails]

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

If a vlanId is specified, the nsgIds cannot be specified. The 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.

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

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

If you specify a vlanId, the privateIp cannot be specified. See Vlan.

If you specify a ‘privateIpId’, the ‘privateIp’ cannot be specified.

Example: 10.0.3.3

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

property private_ip_id¶

Gets the private_ip_id of this CreateVnicDetails. An OCID that specifies a previously-reserved IP address to use for this VNIC.

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

property security_attributes¶

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

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

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

Example: true

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

property subnet_cidr¶

Gets the subnet_cidr of this CreateVnicDetails. One of the IPv4 CIDR blocks allocated to the subnet. Represents the IP range from which the VNIC’s private IP address will be assigned if privateIp or privateIpId is not specified. Either this field or the privateIp (or privateIpId, if applicable) field must be provided, but not both simultaneously. Example: 192.168.1.0/28

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

property subnet_id¶

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.

If you are an Oracle Cloud VMware Solution customer and creating a secondary VNIC in a VLAN instead of a subnet, provide a vlanId instead of a subnetId. If you provide both a vlanId and subnetId, the request fails.

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

property vlan_id¶

Gets the vlan_id of this CreateVnicDetails. 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 vlanId instead of a subnetId. If you provide both a vlanId and subnetId, the request fails.

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