Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace NetworkLoadBalancerSummary

Network load balancer object to be used for list operations.

Properties

Optional backendSets

backendSets: undefined | object

Backend sets associated with the network load balancer.

compartmentId

compartmentId: string

The OCID of the compartment containing the network load balancer.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}

displayName

displayName: string

A user-friendly name, which does not have to be unique, and can be changed.

Example: {@code example_load_balancer}

Optional freeformTags

freeformTags: undefined | object

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: {@code {\"Department\": \"Finance\"}}

id

id: string

The OCID of the network load balancer.

ipAddresses

ipAddresses: Array<IpAddress>

An array of IP addresses.

Optional isPreserveSourceDestination

isPreserveSourceDestination: undefined | false | true

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.

Optional isPrivate

isPrivate: undefined | false | true

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](https://docs.cloud.oracle.com/Content/network/Concepts/securitylists.htm) for your virtual cloudn network. For more information about public and private network load balancers, see [How Network Load Balancing Works](https://docs.cloud.oracle.com/Content/NetworkLoadBalancer/overview.htm). This value is true by default.

Example: {@code true}

Optional isSymmetricHashEnabled

isSymmetricHashEnabled: undefined | false | true

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.

Optional lifecycleDetails

lifecycleDetails: undefined | string

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

lifecycleState

lifecycleState: LifecycleState

The current state of the network load balancer.

Optional listeners

listeners: undefined | object

Listeners associated with the network load balancer.

Optional networkSecurityGroupIds

networkSecurityGroupIds: Array<string>

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\"]

Optional nlbIpVersion

nlbIpVersion: model.NlbIpVersion

IP version associated with the NLB.

subnetId

subnetId: string

The subnet in which the network load balancer is spawned OCIDs."

Optional systemTags

systemTags: undefined | object

Key-value pair representing system tags' keys and values scoped to a namespace. Example: {@code {"bar-key": "value"}}

timeCreated

timeCreated: Date

The date and time the network load balancer was created, in the format defined by RFC3339.

Example: {@code 2020-05-01T21:10:29.600Z}

Optional timeUpdated

timeUpdated: Date

The time the network load balancer was updated. An RFC3339 formatted date-time string.

Example: {@code 2020-05-01T22:10:29.600Z}

Functions

getDeserializedJsonObj

getJsonObj