NetworkLoadBalancer¶

class oci.network_load_balancer.models.NetworkLoadBalancer(**kwargs)¶

Bases: object

The properties that define a network load balancer. For more information, see Managing a network load balancer.

To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, contact an administrator. If you are an administrator who writes policies to give users access, then see Getting Started with Policies.

For information about endpoints and signing API requests, see About the API. For information about available SDKs and tools, see SDKS and Other Tools.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a NetworkLoadBalancer.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a NetworkLoadBalancer.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a NetworkLoadBalancer.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a NetworkLoadBalancer.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a NetworkLoadBalancer.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a NetworkLoadBalancer.
`NLB_IP_VERSION_IPV4`	A constant which can be used with the nlb_ip_version property of a NetworkLoadBalancer.
`NLB_IP_VERSION_IPV4_AND_IPV6`	A constant which can be used with the nlb_ip_version property of a NetworkLoadBalancer.
`NLB_IP_VERSION_IPV6`	A constant which can be used with the nlb_ip_version property of a NetworkLoadBalancer.
`backend_sets`	Gets the backend_sets of this NetworkLoadBalancer.
`compartment_id`	[Required] Gets the compartment_id of this NetworkLoadBalancer.
`defined_tags`	Gets the defined_tags of this NetworkLoadBalancer.
`display_name`	[Required] Gets the display_name of this NetworkLoadBalancer.
`freeform_tags`	Gets the freeform_tags of this NetworkLoadBalancer.
`id`	[Required] Gets the id of this NetworkLoadBalancer.
`ip_addresses`	[Required] Gets the ip_addresses of this NetworkLoadBalancer.
`is_preserve_source_destination`	Gets the is_preserve_source_destination of this NetworkLoadBalancer.
`is_private`	Gets the is_private of this NetworkLoadBalancer.
`is_symmetric_hash_enabled`	Gets the is_symmetric_hash_enabled of this NetworkLoadBalancer.
`lifecycle_details`	Gets the lifecycle_details of this NetworkLoadBalancer.
`lifecycle_state`	[Required] Gets the lifecycle_state of this NetworkLoadBalancer.
`listeners`	Gets the listeners of this NetworkLoadBalancer.
`network_security_group_ids`	Gets the network_security_group_ids of this NetworkLoadBalancer.
`nlb_ip_version`	Gets the nlb_ip_version of this NetworkLoadBalancer.
`security_attributes`	Gets the security_attributes of this NetworkLoadBalancer.
`subnet_id`	[Required] Gets the subnet_id of this NetworkLoadBalancer.
`system_tags`	Gets the system_tags of this NetworkLoadBalancer.
`time_created`	[Required] Gets the time_created of this NetworkLoadBalancer.
`time_updated`	Gets the time_updated of this NetworkLoadBalancer.

Methods

__init__(**kwargs) Initializes a new NetworkLoadBalancer object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a NetworkLoadBalancer. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a NetworkLoadBalancer. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a NetworkLoadBalancer. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a NetworkLoadBalancer. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a NetworkLoadBalancer. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a NetworkLoadBalancer. This constant has a value of “UPDATING”

NLB_IP_VERSION_IPV4 = 'IPV4'¶: A constant which can be used with the nlb_ip_version property of a NetworkLoadBalancer. This constant has a value of “IPV4”

NLB_IP_VERSION_IPV4_AND_IPV6 = 'IPV4_AND_IPV6'¶: A constant which can be used with the nlb_ip_version property of a NetworkLoadBalancer. This constant has a value of “IPV4_AND_IPV6”

NLB_IP_VERSION_IPV6 = 'IPV6'¶: A constant which can be used with the nlb_ip_version property of a NetworkLoadBalancer. This constant has a value of “IPV6”

__init__(**kwargs)¶

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

Parameters:

id (str) – The value to assign to the id property of this NetworkLoadBalancer.
compartment_id (str) – The value to assign to the compartment_id property of this NetworkLoadBalancer.
display_name (str) – The value to assign to the display_name property of this NetworkLoadBalancer.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this NetworkLoadBalancer. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this NetworkLoadBalancer.
nlb_ip_version (str) – The value to assign to the nlb_ip_version property of this NetworkLoadBalancer. Allowed values for this property are: “IPV4”, “IPV4_AND_IPV6”, “IPV6”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_created (datetime) – The value to assign to the time_created property of this NetworkLoadBalancer.
time_updated (datetime) – The value to assign to the time_updated property of this NetworkLoadBalancer.
ip_addresses (list[oci.network_load_balancer.models.IpAddress]) – The value to assign to the ip_addresses property of this NetworkLoadBalancer.
is_private (bool) – The value to assign to the is_private property of this NetworkLoadBalancer.
is_preserve_source_destination (bool) – The value to assign to the is_preserve_source_destination property of this NetworkLoadBalancer.
is_symmetric_hash_enabled (bool) – The value to assign to the is_symmetric_hash_enabled property of this NetworkLoadBalancer.
subnet_id (str) – The value to assign to the subnet_id property of this NetworkLoadBalancer.
network_security_group_ids (list[str]) – The value to assign to the network_security_group_ids property of this NetworkLoadBalancer.
listeners (dict(str, Listener)) – The value to assign to the listeners property of this NetworkLoadBalancer.
backend_sets (dict(str, BackendSet)) – The value to assign to the backend_sets property of this NetworkLoadBalancer.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this NetworkLoadBalancer.
security_attributes (dict(str, dict(str, object))) – The value to assign to the security_attributes property of this NetworkLoadBalancer.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this NetworkLoadBalancer.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this NetworkLoadBalancer.

backend_sets¶

Gets the backend_sets of this NetworkLoadBalancer. Backend sets associated with the network load balancer.

Returns:	The backend_sets of this NetworkLoadBalancer.
Return type:	dict(str, BackendSet)

compartment_id¶

[Required] Gets the compartment_id of this NetworkLoadBalancer. The OCID of the compartment containing the network load balancer.

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

defined_tags¶

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

display_name¶

[Required] Gets the display_name of this NetworkLoadBalancer. A user-friendly name, which does not have to be unique, and can be changed.

Example: example_load_balancer

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

freeform_tags¶

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

id¶

[Required] Gets the id of this NetworkLoadBalancer. The OCID of the network load balancer.

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

ip_addresses¶

[Required] Gets the ip_addresses of this NetworkLoadBalancer. An array of IP addresses.

Returns:	The ip_addresses of this NetworkLoadBalancer.
Return type:	list[oci.network_load_balancer.models.IpAddress]

is_preserve_source_destination¶

Gets the is_preserve_source_destination of this NetworkLoadBalancer. When enabled, the skipSourceDestinationCheck parameter is automatically enabled on the load balancer VNIC. Packets are sent to the backend set without any changes to the source and destination IP.

Returns:	The is_preserve_source_destination of this NetworkLoadBalancer.
Return type:	bool

is_private¶

Gets the is_private of this NetworkLoadBalancer. Whether the network load balancer has a virtual cloud network-local (private) IP address.

If “true”, then the service assigns a private IP address to the network load balancer.

If “false”, then the service assigns a public IP address to the network load balancer.

A public network load balancer is accessible from the internet, depending the security list rules for your virtual cloudn network. For more information about public and private network load balancers, see How Network Load Balancing Works. This value is true by default.

Example: true

Returns:	The is_private of this NetworkLoadBalancer.
Return type:	bool

is_symmetric_hash_enabled¶

Gets the is_symmetric_hash_enabled of this NetworkLoadBalancer. This can only be enabled when NLB is working in transparent mode with source destination header preservation enabled. This removes the additional dependency from NLB backends(like Firewalls) to perform SNAT.

Returns:	The is_symmetric_hash_enabled of this NetworkLoadBalancer.
Return type:	bool

lifecycle_details¶

Gets the lifecycle_details of this NetworkLoadBalancer. A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

Returns:	The lifecycle_details of this NetworkLoadBalancer.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this NetworkLoadBalancer. The current state of the network load balancer.

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

listeners¶

Gets the listeners of this NetworkLoadBalancer. Listeners associated with the network load balancer.

Returns:	The listeners of this NetworkLoadBalancer.
Return type:	dict(str, Listener)

network_security_group_ids¶

Gets the network_security_group_ids of this NetworkLoadBalancer. An array of network security groups OCIDs associated with the network load balancer.

During the creation of the network load balancer, the service adds the new load balancer to the specified network security groups.

The benefits of associating the network load balancer with network security groups include:

Network security groups define network security rules to govern ingress and egress traffic for the network load balancer.
The network security rules of other resources can reference the network security groups associated with the network load balancer to ensure access.

Example: [“ocid1.nsg.oc1.phx.unique_ID”]

Returns:	The network_security_group_ids of this NetworkLoadBalancer.
Return type:	list[str]

nlb_ip_version¶

Gets the nlb_ip_version of this NetworkLoadBalancer. IP version associated with the NLB.

Allowed values for this property are: “IPV4”, “IPV4_AND_IPV6”, “IPV6”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The nlb_ip_version of this NetworkLoadBalancer.
Return type:	str

security_attributes¶

Gets the security_attributes of this NetworkLoadBalancer. ZPR 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: { “oracle-zpr”: { “td”: { “value”: “42”, “mode”: “audit” } } }

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

subnet_id¶

[Required] Gets the subnet_id of this NetworkLoadBalancer. The subnet in which the network load balancer is spawned OCIDs.

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

system_tags¶

Gets the system_tags of this NetworkLoadBalancer. Key-value pair representing system tags’ keys and values scoped to a namespace. Example: {“bar-key”: “value”}

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

time_created¶

[Required] Gets the time_created of this NetworkLoadBalancer. The date and time the network load balancer was created, in the format defined by RFC3339.

Example: 2020-05-01T21:10:29.600Z

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

time_updated¶

Gets the time_updated of this NetworkLoadBalancer. The time the network load balancer was updated. An RFC3339 formatted date-time string.

Example: 2020-05-01T22:10:29.600Z

Returns:	The time_updated of this NetworkLoadBalancer.
Return type:	datetime