CreatePrivateIpDetails¶
- class oci.core.models.CreatePrivateIpDetails(**kwargs)¶
Bases:
objectCreatePrivateIpDetails model.
Attributes:
A constant which can be used with the lifetime property of a CreatePrivateIpDetails.
A constant which can be used with the lifetime property of a CreatePrivateIpDetails.
Gets the cidr_prefix_length of this CreatePrivateIpDetails.
Gets the defined_tags of this CreatePrivateIpDetails.
Gets the display_name of this CreatePrivateIpDetails.
Gets the freeform_tags of this CreatePrivateIpDetails.
Gets the hostname_label of this CreatePrivateIpDetails.
Gets the ip_address of this CreatePrivateIpDetails.
Gets the ipv4_subnet_cidr_at_creation of this CreatePrivateIpDetails.
Gets the lifetime of this CreatePrivateIpDetails. Lifetime of the IP address. There are two types of IPs: - Ephemeral - Reserved.
Gets the route_table_id of this CreatePrivateIpDetails.
Gets the subnet_id of this CreatePrivateIpDetails.
Gets the vlan_id of this CreatePrivateIpDetails.
Gets the vnic_id of this CreatePrivateIpDetails.
Methods:
__init__(**kwargs)Initializes a new CreatePrivateIpDetails object with values from keyword arguments.
- LIFETIME_EPHEMERAL = 'EPHEMERAL'¶
A constant which can be used with the lifetime property of a CreatePrivateIpDetails. This constant has a value of “EPHEMERAL”
- LIFETIME_RESERVED = 'RESERVED'¶
A constant which can be used with the lifetime property of a CreatePrivateIpDetails. This constant has a value of “RESERVED”
- __init__(**kwargs)¶
Initializes a new CreatePrivateIpDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreatePrivateIpDetails.
display_name (str) – The value to assign to the display_name property of this CreatePrivateIpDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreatePrivateIpDetails.
hostname_label (str) – The value to assign to the hostname_label property of this CreatePrivateIpDetails.
ip_address (str) – The value to assign to the ip_address property of this CreatePrivateIpDetails.
cidr_prefix_length (int) – The value to assign to the cidr_prefix_length property of this CreatePrivateIpDetails.
vnic_id (str) – The value to assign to the vnic_id property of this CreatePrivateIpDetails.
vlan_id (str) – The value to assign to the vlan_id property of this CreatePrivateIpDetails.
subnet_id (str) – The value to assign to the subnet_id property of this CreatePrivateIpDetails.
ipv4_subnet_cidr_at_creation (str) – The value to assign to the ipv4_subnet_cidr_at_creation property of this CreatePrivateIpDetails.
lifetime (str) – The value to assign to the lifetime property of this CreatePrivateIpDetails. Allowed values for this property are: “EPHEMERAL”, “RESERVED”
route_table_id (str) – The value to assign to the route_table_id property of this CreatePrivateIpDetails.
- property cidr_prefix_length¶
Gets the cidr_prefix_length of this CreatePrivateIpDetails. An optional field that when combined with the ipAddress field, will be used to allocate secondary IPv4 CIDRs. The CIDR range created by this combination must be within the subnet’s CIDR and the CIDR range should not collide with any existing IPv4 address allocation. The VNIC ID specified in the request object should not already been assigned more than the max IPv4 addresses. If you don’t specify a value, this option will be ignored.
Example: 18
- Returns
The cidr_prefix_length of this CreatePrivateIpDetails.
- Return type
int
- property defined_tags¶
Gets the defined_tags of this CreatePrivateIpDetails. 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 CreatePrivateIpDetails.
- Return type
dict(str, dict(str, object))
- property display_name¶
Gets the display_name of this CreatePrivateIpDetails. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
- Returns
The display_name of this CreatePrivateIpDetails.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this CreatePrivateIpDetails. 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 CreatePrivateIpDetails.
- Return type
dict(str, str)
- property hostname_label¶
Gets the hostname_label of this CreatePrivateIpDetails. The hostname for the private IP. Used for DNS. The value is the hostname portion of the 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 CreatePrivateIpDetails.
- Return type
str
- property ip_address¶
Gets the ip_address of this CreatePrivateIpDetails. A private IP address of your choice. 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.
Example: 10.0.3.3
- Returns
The ip_address of this CreatePrivateIpDetails.
- Return type
str
- property ipv4_subnet_cidr_at_creation¶
Gets the ipv4_subnet_cidr_at_creation of this CreatePrivateIpDetails. Any one of the IPv4 CIDRs allocated to the subnet.
- Returns
The ipv4_subnet_cidr_at_creation of this CreatePrivateIpDetails.
- Return type
str
- property lifetime¶
Gets the lifetime of this CreatePrivateIpDetails. Lifetime of the IP address. There are two types of IPs:
Ephemeral
Reserved
Allowed values for this property are: “EPHEMERAL”, “RESERVED”
- Returns
The lifetime of this CreatePrivateIpDetails.
- Return type
str
- property route_table_id¶
Gets the route_table_id of this CreatePrivateIpDetails. 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 CreatePrivateIpDetails.
- Return type
str
- property subnet_id¶
Gets the subnet_id of this CreatePrivateIpDetails. The OCID of the subnet from which the private IP is to be drawn. The IP address, if supplied, must be valid for the given subnet.
- Returns
The subnet_id of this CreatePrivateIpDetails.
- Return type
str
- property vlan_id¶
Gets the vlan_id of this CreatePrivateIpDetails. Use this attribute only with the Oracle Cloud VMware Solution.
The OCID of the VLAN from which the private IP is to be drawn. The IP address, if supplied, must be valid for the given VLAN. See
Vlan.- Returns
The vlan_id of this CreatePrivateIpDetails.
- Return type
str