Oracle Cloud Infrastructure v2.31.0, Apr 17 25

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

oci.NetworkLoadBalancer.getNetworkLoadBalancer

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testNetworkLoadBalancer = oci.NetworkLoadBalancer.getNetworkLoadBalancer({
    networkLoadBalancerId: testNetworkLoadBalancerOciNetworkLoadBalancerNetworkLoadBalancer.id,
});

import pulumi
import pulumi_oci as oci

test_network_load_balancer = oci.NetworkLoadBalancer.get_network_load_balancer(network_load_balancer_id=test_network_load_balancer_oci_network_load_balancer_network_load_balancer["id"])

package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/networkloadbalancer"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := networkloadbalancer.GetNetworkLoadBalancer(ctx, &networkloadbalancer.GetNetworkLoadBalancerArgs{
			NetworkLoadBalancerId: testNetworkLoadBalancerOciNetworkLoadBalancerNetworkLoadBalancer.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testNetworkLoadBalancer = Oci.NetworkLoadBalancer.GetNetworkLoadBalancer.Invoke(new()
    {
        NetworkLoadBalancerId = testNetworkLoadBalancerOciNetworkLoadBalancerNetworkLoadBalancer.Id,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.NetworkLoadBalancer.NetworkLoadBalancerFunctions;
import com.pulumi.oci.NetworkLoadBalancer.inputs.GetNetworkLoadBalancerArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var testNetworkLoadBalancer = NetworkLoadBalancerFunctions.getNetworkLoadBalancer(GetNetworkLoadBalancerArgs.builder()
            .networkLoadBalancerId(testNetworkLoadBalancerOciNetworkLoadBalancerNetworkLoadBalancer.id())
            .build());

    }
}

variables:
  testNetworkLoadBalancer:
    fn::invoke:
      function: oci:NetworkLoadBalancer:getNetworkLoadBalancer
      arguments:
        networkLoadBalancerId: ${testNetworkLoadBalancerOciNetworkLoadBalancerNetworkLoadBalancer.id}

Using getNetworkLoadBalancer

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getNetworkLoadBalancer(args: GetNetworkLoadBalancerArgs, opts?: InvokeOptions): Promise<GetNetworkLoadBalancerResult>
function getNetworkLoadBalancerOutput(args: GetNetworkLoadBalancerOutputArgs, opts?: InvokeOptions): Output<GetNetworkLoadBalancerResult>

def get_network_load_balancer(network_load_balancer_id: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetNetworkLoadBalancerResult
def get_network_load_balancer_output(network_load_balancer_id: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetNetworkLoadBalancerResult]

func GetNetworkLoadBalancer(ctx *Context, args *GetNetworkLoadBalancerArgs, opts ...InvokeOption) (*GetNetworkLoadBalancerResult, error)
func GetNetworkLoadBalancerOutput(ctx *Context, args *GetNetworkLoadBalancerOutputArgs, opts ...InvokeOption) GetNetworkLoadBalancerResultOutput

> Note: This function is named GetNetworkLoadBalancer in the Go SDK.

public static class GetNetworkLoadBalancer 
{
    public static Task<GetNetworkLoadBalancerResult> InvokeAsync(GetNetworkLoadBalancerArgs args, InvokeOptions? opts = null)
    public static Output<GetNetworkLoadBalancerResult> Invoke(GetNetworkLoadBalancerInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetNetworkLoadBalancerResult> getNetworkLoadBalancer(GetNetworkLoadBalancerArgs args, InvokeOptions options)
public static Output<GetNetworkLoadBalancerResult> getNetworkLoadBalancer(GetNetworkLoadBalancerArgs args, InvokeOptions options)

fn::invoke:
  function: oci:NetworkLoadBalancer/getNetworkLoadBalancer:getNetworkLoadBalancer
  arguments:
    # arguments dictionary

The following arguments are supported:

NetworkLoadBalancerId string: The OCID of the network load balancer to update.

NetworkLoadBalancerId string: The OCID of the network load balancer to update.

networkLoadBalancerId String: The OCID of the network load balancer to update.

networkLoadBalancerId string: The OCID of the network load balancer to update.

network_load_balancer_id str: The OCID of the network load balancer to update.

networkLoadBalancerId String: The OCID of the network load balancer to update.

getNetworkLoadBalancer Result

The following output properties are available:

AssignedIpv6 string
AssignedPrivateIpv4 string
CompartmentId string: The OCID of the compartment containing the network load balancer.
DefinedTags Dictionary<string, string>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
DisplayName string: A user-friendly name, which does not have to be unique, and can be changed. Example: example_load_balancer
FreeformTags Dictionary<string, string>: 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"}
Id string: OCID of the reserved public IP address created with the virtual cloud network.
IpAddresses List<GetNetworkLoadBalancerIpAddress>: An array of IP addresses.
IsPreserveSourceDestination bool: 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.
IsPrivate bool: Whether the network load balancer has a virtual cloud network-local (private) IP address.
IsSymmetricHashEnabled bool: 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.
LifecycleDetails 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.
NetworkLoadBalancerId string
NetworkSecurityGroupIds List<string>: An array of network security groups OCIDs associated with the network load balancer.
NlbIpVersion string: IP version associated with the NLB.
ReservedIps List<GetNetworkLoadBalancerReservedIp>
SecurityAttributes Dictionary<string, string>: 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" } } }
State string: The current state of the network load balancer.
SubnetId string: The subnet in which the network load balancer is spawned OCIDs."
SubnetIpv6cidr string
SystemTags Dictionary<string, string>: Key-value pair representing system tags' keys and values scoped to a namespace. Example: {"bar-key": "value"}
TimeCreated string: The date and time the network load balancer was created, in the format defined by RFC3339. Example: 2020-05-01T21:10:29.600Z
TimeUpdated string: The time the network load balancer was updated. An RFC3339 formatted date-time string. Example: 2020-05-01T22:10:29.600Z

AssignedIpv6 string
AssignedPrivateIpv4 string
CompartmentId string: The OCID of the compartment containing the network load balancer.
DefinedTags map[string]string: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
DisplayName string: A user-friendly name, which does not have to be unique, and can be changed. Example: example_load_balancer
FreeformTags map[string]string: 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"}
Id string: OCID of the reserved public IP address created with the virtual cloud network.
IpAddresses []GetNetworkLoadBalancerIpAddress: An array of IP addresses.
IsPreserveSourceDestination bool: 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.
IsPrivate bool: Whether the network load balancer has a virtual cloud network-local (private) IP address.
IsSymmetricHashEnabled bool: 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.
LifecycleDetails 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.
NetworkLoadBalancerId string
NetworkSecurityGroupIds []string: An array of network security groups OCIDs associated with the network load balancer.
NlbIpVersion string: IP version associated with the NLB.
ReservedIps []GetNetworkLoadBalancerReservedIp
SecurityAttributes map[string]string: 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" } } }
State string: The current state of the network load balancer.
SubnetId string: The subnet in which the network load balancer is spawned OCIDs."
SubnetIpv6cidr string
SystemTags map[string]string: Key-value pair representing system tags' keys and values scoped to a namespace. Example: {"bar-key": "value"}
TimeCreated string: The date and time the network load balancer was created, in the format defined by RFC3339. Example: 2020-05-01T21:10:29.600Z
TimeUpdated string: The time the network load balancer was updated. An RFC3339 formatted date-time string. Example: 2020-05-01T22:10:29.600Z

assignedIpv6 String
assignedPrivateIpv4 String
compartmentId String: The OCID of the compartment containing the network load balancer.
definedTags Map<String,String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
displayName String: A user-friendly name, which does not have to be unique, and can be changed. Example: example_load_balancer
freeformTags Map<String,String>: 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"}
id String: OCID of the reserved public IP address created with the virtual cloud network.
ipAddresses List<GetIpAddress>: An array of IP addresses.
isPreserveSourceDestination Boolean: 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.
isPrivate Boolean: Whether the network load balancer has a virtual cloud network-local (private) IP address.
isSymmetricHashEnabled Boolean: 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.
lifecycleDetails 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.
networkLoadBalancerId String
networkSecurityGroupIds List<String>: An array of network security groups OCIDs associated with the network load balancer.
nlbIpVersion String: IP version associated with the NLB.
reservedIps List<GetReservedIp>
securityAttributes Map<String,String>: 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" } } }
state String: The current state of the network load balancer.
subnetId String: The subnet in which the network load balancer is spawned OCIDs."
subnetIpv6cidr String
systemTags Map<String,String>: Key-value pair representing system tags' keys and values scoped to a namespace. Example: {"bar-key": "value"}
timeCreated String: The date and time the network load balancer was created, in the format defined by RFC3339. Example: 2020-05-01T21:10:29.600Z
timeUpdated String: The time the network load balancer was updated. An RFC3339 formatted date-time string. Example: 2020-05-01T22:10:29.600Z

assignedIpv6 string
assignedPrivateIpv4 string
compartmentId string: The OCID of the compartment containing the network load balancer.
definedTags {[key: string]: string}: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
displayName string: A user-friendly name, which does not have to be unique, and can be changed. Example: example_load_balancer
freeformTags {[key: string]: string}: 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"}
id string: OCID of the reserved public IP address created with the virtual cloud network.
ipAddresses GetNetworkLoadBalancerIpAddress[]: An array of IP addresses.
isPreserveSourceDestination boolean: 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.
isPrivate boolean: Whether the network load balancer has a virtual cloud network-local (private) IP address.
isSymmetricHashEnabled boolean: 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.
lifecycleDetails 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.
networkLoadBalancerId string
networkSecurityGroupIds string[]: An array of network security groups OCIDs associated with the network load balancer.
nlbIpVersion string: IP version associated with the NLB.
reservedIps GetNetworkLoadBalancerReservedIp[]
securityAttributes {[key: string]: string}: 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" } } }
state string: The current state of the network load balancer.
subnetId string: The subnet in which the network load balancer is spawned OCIDs."
subnetIpv6cidr string
systemTags {[key: string]: string}: Key-value pair representing system tags' keys and values scoped to a namespace. Example: {"bar-key": "value"}
timeCreated string: The date and time the network load balancer was created, in the format defined by RFC3339. Example: 2020-05-01T21:10:29.600Z
timeUpdated string: The time the network load balancer was updated. An RFC3339 formatted date-time string. Example: 2020-05-01T22:10:29.600Z

assigned_ipv6 str
assigned_private_ipv4 str
compartment_id str: The OCID of the compartment containing the network load balancer.
defined_tags Mapping[str, str]: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
display_name str: A user-friendly name, which does not have to be unique, and can be changed. Example: example_load_balancer
freeform_tags Mapping[str, str]: 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"}
id str: OCID of the reserved public IP address created with the virtual cloud network.
ip_addresses Sequence[networkloadbalancer.GetNetworkLoadBalancerIpAddress]: An array of IP addresses.
is_preserve_source_destination bool: 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.
is_private bool: Whether the network load balancer has a virtual cloud network-local (private) IP address.
is_symmetric_hash_enabled bool: 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.
lifecycle_details str: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
network_load_balancer_id str
network_security_group_ids Sequence[str]: An array of network security groups OCIDs associated with the network load balancer.
nlb_ip_version str: IP version associated with the NLB.
reserved_ips Sequence[networkloadbalancer.GetNetworkLoadBalancerReservedIp]
security_attributes Mapping[str, str]: 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" } } }
state str: The current state of the network load balancer.
subnet_id str: The subnet in which the network load balancer is spawned OCIDs."
subnet_ipv6cidr str
system_tags Mapping[str, str]: Key-value pair representing system tags' keys and values scoped to a namespace. Example: {"bar-key": "value"}
time_created str: The date and time the network load balancer was created, in the format defined by RFC3339. Example: 2020-05-01T21:10:29.600Z
time_updated str: The time the network load balancer was updated. An RFC3339 formatted date-time string. Example: 2020-05-01T22:10:29.600Z

assignedIpv6 String
assignedPrivateIpv4 String
compartmentId String: The OCID of the compartment containing the network load balancer.
definedTags Map<String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
displayName String: A user-friendly name, which does not have to be unique, and can be changed. Example: example_load_balancer
freeformTags Map<String>: 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"}
id String: OCID of the reserved public IP address created with the virtual cloud network.
ipAddresses List<Property Map>: An array of IP addresses.
isPreserveSourceDestination Boolean: 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.
isPrivate Boolean: Whether the network load balancer has a virtual cloud network-local (private) IP address.
isSymmetricHashEnabled Boolean: 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.
lifecycleDetails 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.
networkLoadBalancerId String
networkSecurityGroupIds List<String>: An array of network security groups OCIDs associated with the network load balancer.
nlbIpVersion String: IP version associated with the NLB.
reservedIps List<Property Map>
securityAttributes Map<String>: 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" } } }
state String: The current state of the network load balancer.
subnetId String: The subnet in which the network load balancer is spawned OCIDs."
subnetIpv6cidr String
systemTags Map<String>: Key-value pair representing system tags' keys and values scoped to a namespace. Example: {"bar-key": "value"}
timeCreated String: The date and time the network load balancer was created, in the format defined by RFC3339. Example: 2020-05-01T21:10:29.600Z
timeUpdated String: The time the network load balancer was updated. An RFC3339 formatted date-time string. Example: 2020-05-01T22:10:29.600Z

Supporting Types

GetNetworkLoadBalancerIpAddress

IpAddress string: An IP address. Example: 192.168.0.3
IpVersion string: IP version associated with the listener.
IsPublic bool: Whether the IP address is public or private.
ReservedIps List<GetNetworkLoadBalancerIpAddressReservedIp>: An object representing a reserved IP address to be attached or that is already attached to a network load balancer.

IpAddress string: An IP address. Example: 192.168.0.3
IpVersion string: IP version associated with the listener.
IsPublic bool: Whether the IP address is public or private.
ReservedIps []GetNetworkLoadBalancerIpAddressReservedIp: An object representing a reserved IP address to be attached or that is already attached to a network load balancer.

ipAddress String: An IP address. Example: 192.168.0.3
ipVersion String: IP version associated with the listener.
isPublic Boolean: Whether the IP address is public or private.
reservedIps List<GetIpAddressReservedIp>: An object representing a reserved IP address to be attached or that is already attached to a network load balancer.

ipAddress string: An IP address. Example: 192.168.0.3
ipVersion string: IP version associated with the listener.
isPublic boolean: Whether the IP address is public or private.
reservedIps GetNetworkLoadBalancerIpAddressReservedIp[]: An object representing a reserved IP address to be attached or that is already attached to a network load balancer.

ip_address str: An IP address. Example: 192.168.0.3
ip_version str: IP version associated with the listener.
is_public bool: Whether the IP address is public or private.
reserved_ips Sequence[networkloadbalancer.GetNetworkLoadBalancerIpAddressReservedIp]: An object representing a reserved IP address to be attached or that is already attached to a network load balancer.

ipAddress String: An IP address. Example: 192.168.0.3
ipVersion String: IP version associated with the listener.
isPublic Boolean: Whether the IP address is public or private.
reservedIps List<Property Map>: An object representing a reserved IP address to be attached or that is already attached to a network load balancer.

GetNetworkLoadBalancerIpAddressReservedIp

Id string: OCID of the reserved public IP address created with the virtual cloud network.

Id string: OCID of the reserved public IP address created with the virtual cloud network.

id String: OCID of the reserved public IP address created with the virtual cloud network.

id string: OCID of the reserved public IP address created with the virtual cloud network.

id str: OCID of the reserved public IP address created with the virtual cloud network.

id String: OCID of the reserved public IP address created with the virtual cloud network.

GetNetworkLoadBalancerReservedIp

Id string: OCID of the reserved public IP address created with the virtual cloud network.

Id string: OCID of the reserved public IP address created with the virtual cloud network.

id String: OCID of the reserved public IP address created with the virtual cloud network.

id string: OCID of the reserved public IP address created with the virtual cloud network.

id str: OCID of the reserved public IP address created with the virtual cloud network.

id String: OCID of the reserved public IP address created with the virtual cloud network.

Package Details

Repository: oci pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

pulumi/pulumi-oci

oci.NetworkLoadBalancer.getNetworkLoadBalancer

On this page

On this page

Example Usage

Using getNetworkLoadBalancer

getNetworkLoadBalancer Result

Supporting Types

GetNetworkLoadBalancerIpAddress

GetNetworkLoadBalancerIpAddressReservedIp

GetNetworkLoadBalancerReservedIp

Package Details

On this page

On this page