Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace CreateNetworkLoadBalancerDetails

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, then contact an administrator. If you are an administrator who writes policies to give users access, then see [Getting Started with Policies](https://docs.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm).

For information about endpoints and signing API requests, see [About the API](https://docs.cloud.oracle.com/Content/API/Concepts/usingapi.htm). For information about available SDKs and tools, see [SDKS and Other Tools](https://docs.cloud.oracle.com/Content/API/Concepts/sdks.htm).

Properties

Optional assignedIpv6

assignedIpv6: undefined | string

IPv6 address to be assigned to the network load balancer being created. This IP address has to be part of one of the prefixes supported by the subnet. Example: "2607:9b80:9a0a:9a7e:abcd:ef01:2345:6789"

Optional assignedPrivateIpv4

assignedPrivateIpv4: undefined | string

Private IP address to be assigned to the network load balancer being created. This IP address has to be in the CIDR range of the subnet where network load balancer is being created Example: "10.0.0.1"

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. Example: {@code {"foo-namespace": {"bar-key": "value"}}}

displayName

displayName: string

Network load balancer identifier, which can be renamed.

Optional freeformTags

freeformTags: undefined | object

Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {@code {"bar-key": "value"}}

Optional isPreserveSourceDestination

isPreserveSourceDestination: undefined | false | true

This parameter can be enabled only if backends are compute OCIDs. When enabled, the skipSourceDestinationCheck parameter is automatically enabled on the load balancer VNIC, and packets are sent to the backend with the entire IP header intact.

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 on the [security list rules](https://docs.cloud.oracle.com/Content/network/Concepts/securitylists.htm) for your virtual cloud 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 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.

Optional reservedIps

reservedIps: Array<ReservedIP>

An array of reserved Ips.

subnetId

subnetId: string

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

Optional subnetIpv6Cidr

subnetIpv6Cidr: undefined | string

IPv6 subnet prefix selection. If Ipv6 subnet prefix is passed, Nlb Ipv6 Address would be assign within the cidr block. NLB has to be dual or single stack ipv6 to support this.

Functions

getDeserializedJsonObj

getJsonObj