Oracle Cloud Infrastructure v2.16.0 published on Wednesday, Nov 13, 2024 by Pulumi
oci.NetworkLoadBalancer.getNetworkLoadBalancer
Explore with Pulumi AI
Oracle Cloud Infrastructure v2.16.0 published on Wednesday, Nov 13, 2024 by Pulumi
This data source provides details about a specific Network Load Balancer resource in Oracle Cloud Infrastructure Network Load Balancer service.
Retrieves network load balancer configuration information by identifier.
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)
// Output-based functions aren't available in Java yet
fn::invoke:
function: oci:NetworkLoadBalancer/getNetworkLoadBalancer:getNetworkLoadBalancer
arguments:
# arguments dictionary
The following arguments are supported:
- Network
Load stringBalancer Id - The OCID of the network load balancer to update.
- Network
Load stringBalancer Id - The OCID of the network load balancer to update.
- network
Load StringBalancer Id - The OCID of the network load balancer to update.
- network
Load stringBalancer Id - The OCID of the network load balancer to update.
- network_
load_ strbalancer_ id - The OCID of the network load balancer to update.
- network
Load StringBalancer Id - The OCID of the network load balancer to update.
getNetworkLoadBalancer Result
The following output properties are available:
- Assigned
Ipv6 string - Assigned
Private stringIpv4 - Compartment
Id string - The OCID of the compartment containing the network load balancer.
- 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"}
- Display
Name string - A user-friendly name, which does not have to be unique, and can be changed. Example:
example_load_balancer
- 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.
- Ip
Addresses List<GetNetwork Load Balancer Ip Address> - An array of IP addresses.
- Is
Preserve boolSource Destination - 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 boolHash Enabled - 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 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.
- Network
Load stringBalancer Id - Network
Security List<string>Group Ids - An array of network security groups OCIDs associated with the network load balancer.
- Nlb
Ip stringVersion - IP version associated with the NLB.
- Reserved
Ips List<GetNetwork Load Balancer Reserved Ip> - Security
Attributes 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.
- Subnet
Id string - The subnet in which the network load balancer is spawned OCIDs."
- Subnet
Ipv6cidr string - Dictionary<string, string>
- Key-value pair representing system tags' keys and values scoped to a namespace. Example:
{"bar-key": "value"}
- Time
Created string - 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 string - The time the network load balancer was updated. An RFC3339 formatted date-time string. Example:
2020-05-01T22:10:29.600Z
- Assigned
Ipv6 string - Assigned
Private stringIpv4 - Compartment
Id string - The OCID of the compartment containing the network load balancer.
- 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"}
- Display
Name string - A user-friendly name, which does not have to be unique, and can be changed. Example:
example_load_balancer
- 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.
- Ip
Addresses []GetNetwork Load Balancer Ip Address - An array of IP addresses.
- Is
Preserve boolSource Destination - 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 boolHash Enabled - 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 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.
- Network
Load stringBalancer Id - Network
Security []stringGroup Ids - An array of network security groups OCIDs associated with the network load balancer.
- Nlb
Ip stringVersion - IP version associated with the NLB.
- Reserved
Ips []GetNetwork Load Balancer Reserved Ip - Security
Attributes 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.
- Subnet
Id string - The subnet in which the network load balancer is spawned OCIDs."
- Subnet
Ipv6cidr string - map[string]string
- Key-value pair representing system tags' keys and values scoped to a namespace. Example:
{"bar-key": "value"}
- Time
Created string - 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 string - The time the network load balancer was updated. An RFC3339 formatted date-time string. Example:
2020-05-01T22:10:29.600Z
- assigned
Ipv6 String - assigned
Private StringIpv4 - compartment
Id String - The OCID of the compartment containing the network load balancer.
- 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"}
- display
Name String - A user-friendly name, which does not have to be unique, and can be changed. Example:
example_load_balancer
- 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.
- ip
Addresses List<GetIp Address> - An array of IP addresses.
- is
Preserve BooleanSource Destination - 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 Boolean - Whether the network load balancer has a virtual cloud network-local (private) IP address.
- is
Symmetric BooleanHash Enabled - 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 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.
- network
Load StringBalancer Id - network
Security List<String>Group Ids - An array of network security groups OCIDs associated with the network load balancer.
- nlb
Ip StringVersion - IP version associated with the NLB.
- reserved
Ips List<GetReserved Ip> - security
Attributes 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.
- subnet
Id String - The subnet in which the network load balancer is spawned OCIDs."
- subnet
Ipv6cidr String - Map<String,String>
- Key-value pair representing system tags' keys and values scoped to a namespace. Example:
{"bar-key": "value"}
- time
Created String - 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 String - The time the network load balancer was updated. An RFC3339 formatted date-time string. Example:
2020-05-01T22:10:29.600Z
- assigned
Ipv6 string - assigned
Private stringIpv4 - compartment
Id string - The OCID of the compartment containing the network load balancer.
- {[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"}
- display
Name string - A user-friendly name, which does not have to be unique, and can be changed. Example:
example_load_balancer
- {[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.
- ip
Addresses GetNetwork Load Balancer Ip Address[] - An array of IP addresses.
- is
Preserve booleanSource Destination - 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 boolean - Whether the network load balancer has a virtual cloud network-local (private) IP address.
- is
Symmetric booleanHash Enabled - 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 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.
- network
Load stringBalancer Id - network
Security string[]Group Ids - An array of network security groups OCIDs associated with the network load balancer.
- nlb
Ip stringVersion - IP version associated with the NLB.
- reserved
Ips GetNetwork Load Balancer Reserved Ip[] - security
Attributes {[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.
- subnet
Id string - The subnet in which the network load balancer is spawned OCIDs."
- subnet
Ipv6cidr string - {[key: string]: string}
- Key-value pair representing system tags' keys and values scoped to a namespace. Example:
{"bar-key": "value"}
- time
Created string - 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 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_ stripv4 - compartment_
id str - The OCID of the compartment containing the network load balancer.
- 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
- 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.Get Network Load Balancer Ip Address] - An array of IP addresses.
- is_
preserve_ boolsource_ destination - 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_ boolhash_ enabled - 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_ strbalancer_ id - network_
security_ Sequence[str]group_ ids - An array of network security groups OCIDs associated with the network load balancer.
- nlb_
ip_ strversion - IP version associated with the NLB.
- reserved_
ips Sequence[networkloadbalancer.Get Network Load Balancer Reserved Ip] - 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 - 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
- assigned
Ipv6 String - assigned
Private StringIpv4 - compartment
Id String - The OCID of the compartment containing the network load balancer.
- 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"}
- display
Name String - A user-friendly name, which does not have to be unique, and can be changed. Example:
example_load_balancer
- 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.
- ip
Addresses List<Property Map> - An array of IP addresses.
- is
Preserve BooleanSource Destination - 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 Boolean - Whether the network load balancer has a virtual cloud network-local (private) IP address.
- is
Symmetric BooleanHash Enabled - 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 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.
- network
Load StringBalancer Id - network
Security List<String>Group Ids - An array of network security groups OCIDs associated with the network load balancer.
- nlb
Ip StringVersion - IP version associated with the NLB.
- reserved
Ips List<Property Map> - security
Attributes 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.
- subnet
Id String - The subnet in which the network load balancer is spawned OCIDs."
- subnet
Ipv6cidr String - Map<String>
- Key-value pair representing system tags' keys and values scoped to a namespace. Example:
{"bar-key": "value"}
- time
Created String - 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 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
- Ip
Address string - An IP address. Example:
192.168.0.3
- Ip
Version string - IP version associated with the listener.
- Is
Public bool - Whether the IP address is public or private.
- Reserved
Ips List<GetNetwork Load Balancer Ip Address Reserved Ip> - An object representing a reserved IP address to be attached or that is already attached to a network load balancer.
- Ip
Address string - An IP address. Example:
192.168.0.3
- Ip
Version string - IP version associated with the listener.
- Is
Public bool - Whether the IP address is public or private.
- Reserved
Ips []GetNetwork Load Balancer Ip Address Reserved Ip - An object representing a reserved IP address to be attached or that is already attached to a network load balancer.
- ip
Address String - An IP address. Example:
192.168.0.3
- ip
Version String - IP version associated with the listener.
- is
Public Boolean - Whether the IP address is public or private.
- reserved
Ips List<GetIp Address Reserved Ip> - An object representing a reserved IP address to be attached or that is already attached to a network load balancer.
- ip
Address string - An IP address. Example:
192.168.0.3
- ip
Version string - IP version associated with the listener.
- is
Public boolean - Whether the IP address is public or private.
- reserved
Ips GetNetwork Load Balancer Ip Address Reserved Ip[] - 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.Get Network Load Balancer Ip Address Reserved Ip] - An object representing a reserved IP address to be attached or that is already attached to a network load balancer.
- ip
Address String - An IP address. Example:
192.168.0.3
- ip
Version String - IP version associated with the listener.
- is
Public Boolean - Whether the IP address is public or private.
- reserved
Ips 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.16.0 published on Wednesday, Nov 13, 2024 by Pulumi