Oracle Cloud Infrastructure

Pulumi Official
Package maintained by Pulumi
v0.1.1 published on Tuesday, May 3, 2022 by Pulumi

getNetworkLoadBalancerHealth

This data source provides details about a specific Network Load Balancer Health resource in Oracle Cloud Infrastructure Network Load Balancer service.

Retrieves the health status for the specified network load balancer.

Example Usage

using Pulumi;
using Oci = Pulumi.Oci;

class MyStack : Stack
{
    public MyStack()
    {
        var testNetworkLoadBalancerHealth = Output.Create(Oci.NetworkLoadBalancer.GetNetworkLoadBalancerHealth.InvokeAsync(new Oci.NetworkLoadBalancer.GetNetworkLoadBalancerHealthArgs
        {
            NetworkLoadBalancerId = oci_network_load_balancer_network_load_balancer.Test_network_load_balancer.Id,
        }));
    }

}
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := NetworkLoadBalancer.GetNetworkLoadBalancerHealth(ctx, &networkloadbalancer.GetNetworkLoadBalancerHealthArgs{
			NetworkLoadBalancerId: oci_network_load_balancer_network_load_balancer.Test_network_load_balancer.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_oci as oci

test_network_load_balancer_health = oci.NetworkLoadBalancer.get_network_load_balancer_health(network_load_balancer_id=oci_network_load_balancer_network_load_balancer["test_network_load_balancer"]["id"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testNetworkLoadBalancerHealth = oci.NetworkLoadBalancer.getNetworkLoadBalancerHealth({
    networkLoadBalancerId: oci_network_load_balancer_network_load_balancer.test_network_load_balancer.id,
});

Coming soon!

Using getNetworkLoadBalancerHealth

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 getNetworkLoadBalancerHealth(args: GetNetworkLoadBalancerHealthArgs, opts?: InvokeOptions): Promise<GetNetworkLoadBalancerHealthResult>
function getNetworkLoadBalancerHealthOutput(args: GetNetworkLoadBalancerHealthOutputArgs, opts?: InvokeOptions): Output<GetNetworkLoadBalancerHealthResult>
def get_network_load_balancer_health(network_load_balancer_id: Optional[str] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetNetworkLoadBalancerHealthResult
def get_network_load_balancer_health_output(network_load_balancer_id: Optional[pulumi.Input[str]] = None,
                                     opts: Optional[InvokeOptions] = None) -> Output[GetNetworkLoadBalancerHealthResult]
func GetNetworkLoadBalancerHealth(ctx *Context, args *GetNetworkLoadBalancerHealthArgs, opts ...InvokeOption) (*GetNetworkLoadBalancerHealthResult, error)
func GetNetworkLoadBalancerHealthOutput(ctx *Context, args *GetNetworkLoadBalancerHealthOutputArgs, opts ...InvokeOption) GetNetworkLoadBalancerHealthResultOutput

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

public static class GetNetworkLoadBalancerHealth 
{
    public static Task<GetNetworkLoadBalancerHealthResult> InvokeAsync(GetNetworkLoadBalancerHealthArgs args, InvokeOptions? opts = null)
    public static Output<GetNetworkLoadBalancerHealthResult> Invoke(GetNetworkLoadBalancerHealthInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetNetworkLoadBalancerHealthResult> getNetworkLoadBalancerHealth(GetNetworkLoadBalancerHealthArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: oci:NetworkLoadBalancer/getNetworkLoadBalancerHealth:getNetworkLoadBalancerHealth
  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.

getNetworkLoadBalancerHealth Result

The following output properties are available:

CriticalStateBackendSetNames List<string>

A list of backend sets that are currently in the CRITICAL health state. The list identifies each backend set by the user-friendly name you assigned when you created the backend set. Example: example_backend_set

Id string

The provider-assigned unique ID for this managed resource.

NetworkLoadBalancerId string
Status string

The overall health status of the network load balancer.

  • OK: All backend sets associated with the network load balancer return a status of OK.
  • WARNING: At least one of the backend sets associated with the network load balancer returns a status of WARNING, no backend sets return a status of CRITICAL, and the network load balancer life cycle state is ACTIVE.
  • CRITICAL: One or more of the backend sets associated with the network load balancer return a status of CRITICAL.
  • UNKNOWN: If any one of the following conditions is true:
  • The network load balancer life cycle state is not ACTIVE.
  • No backend sets are defined for the network load balancer.
  • More than half of the backend sets associated with the network load balancer return a status of UNKNOWN, none of the backend sets return a status of WARNING or CRITICAL, and the network load balancer life cycle state is ACTIVE.
  • The system could not retrieve metrics for any reason.
TotalBackendSetCount int

The total number of backend sets associated with this network load balancer. Example: 4

UnknownStateBackendSetNames List<string>

A list of backend sets that are currently in the UNKNOWN health state. The list identifies each backend set by the user-friendly name you assigned when you created the backend set. Example: example_backend_set2

WarningStateBackendSetNames List<string>

A list of backend sets that are currently in the WARNING health state. The list identifies each backend set by the user-friendly name you assigned when you created the backend set. Example: example_backend_set3

CriticalStateBackendSetNames []string

A list of backend sets that are currently in the CRITICAL health state. The list identifies each backend set by the user-friendly name you assigned when you created the backend set. Example: example_backend_set

Id string

The provider-assigned unique ID for this managed resource.

NetworkLoadBalancerId string
Status string

The overall health status of the network load balancer.

  • OK: All backend sets associated with the network load balancer return a status of OK.
  • WARNING: At least one of the backend sets associated with the network load balancer returns a status of WARNING, no backend sets return a status of CRITICAL, and the network load balancer life cycle state is ACTIVE.
  • CRITICAL: One or more of the backend sets associated with the network load balancer return a status of CRITICAL.
  • UNKNOWN: If any one of the following conditions is true:
  • The network load balancer life cycle state is not ACTIVE.
  • No backend sets are defined for the network load balancer.
  • More than half of the backend sets associated with the network load balancer return a status of UNKNOWN, none of the backend sets return a status of WARNING or CRITICAL, and the network load balancer life cycle state is ACTIVE.
  • The system could not retrieve metrics for any reason.
TotalBackendSetCount int

The total number of backend sets associated with this network load balancer. Example: 4

UnknownStateBackendSetNames []string

A list of backend sets that are currently in the UNKNOWN health state. The list identifies each backend set by the user-friendly name you assigned when you created the backend set. Example: example_backend_set2

WarningStateBackendSetNames []string

A list of backend sets that are currently in the WARNING health state. The list identifies each backend set by the user-friendly name you assigned when you created the backend set. Example: example_backend_set3

criticalStateBackendSetNames List<String>

A list of backend sets that are currently in the CRITICAL health state. The list identifies each backend set by the user-friendly name you assigned when you created the backend set. Example: example_backend_set

id String

The provider-assigned unique ID for this managed resource.

networkLoadBalancerId String
status String

The overall health status of the network load balancer.

  • OK: All backend sets associated with the network load balancer return a status of OK.
  • WARNING: At least one of the backend sets associated with the network load balancer returns a status of WARNING, no backend sets return a status of CRITICAL, and the network load balancer life cycle state is ACTIVE.
  • CRITICAL: One or more of the backend sets associated with the network load balancer return a status of CRITICAL.
  • UNKNOWN: If any one of the following conditions is true:
  • The network load balancer life cycle state is not ACTIVE.
  • No backend sets are defined for the network load balancer.
  • More than half of the backend sets associated with the network load balancer return a status of UNKNOWN, none of the backend sets return a status of WARNING or CRITICAL, and the network load balancer life cycle state is ACTIVE.
  • The system could not retrieve metrics for any reason.
totalBackendSetCount Integer

The total number of backend sets associated with this network load balancer. Example: 4

unknownStateBackendSetNames List<String>

A list of backend sets that are currently in the UNKNOWN health state. The list identifies each backend set by the user-friendly name you assigned when you created the backend set. Example: example_backend_set2

warningStateBackendSetNames List<String>

A list of backend sets that are currently in the WARNING health state. The list identifies each backend set by the user-friendly name you assigned when you created the backend set. Example: example_backend_set3

criticalStateBackendSetNames string[]

A list of backend sets that are currently in the CRITICAL health state. The list identifies each backend set by the user-friendly name you assigned when you created the backend set. Example: example_backend_set

id string

The provider-assigned unique ID for this managed resource.

networkLoadBalancerId string
status string

The overall health status of the network load balancer.

  • OK: All backend sets associated with the network load balancer return a status of OK.
  • WARNING: At least one of the backend sets associated with the network load balancer returns a status of WARNING, no backend sets return a status of CRITICAL, and the network load balancer life cycle state is ACTIVE.
  • CRITICAL: One or more of the backend sets associated with the network load balancer return a status of CRITICAL.
  • UNKNOWN: If any one of the following conditions is true:
  • The network load balancer life cycle state is not ACTIVE.
  • No backend sets are defined for the network load balancer.
  • More than half of the backend sets associated with the network load balancer return a status of UNKNOWN, none of the backend sets return a status of WARNING or CRITICAL, and the network load balancer life cycle state is ACTIVE.
  • The system could not retrieve metrics for any reason.
totalBackendSetCount number

The total number of backend sets associated with this network load balancer. Example: 4

unknownStateBackendSetNames string[]

A list of backend sets that are currently in the UNKNOWN health state. The list identifies each backend set by the user-friendly name you assigned when you created the backend set. Example: example_backend_set2

warningStateBackendSetNames string[]

A list of backend sets that are currently in the WARNING health state. The list identifies each backend set by the user-friendly name you assigned when you created the backend set. Example: example_backend_set3

critical_state_backend_set_names Sequence[str]

A list of backend sets that are currently in the CRITICAL health state. The list identifies each backend set by the user-friendly name you assigned when you created the backend set. Example: example_backend_set

id str

The provider-assigned unique ID for this managed resource.

network_load_balancer_id str
status str

The overall health status of the network load balancer.

  • OK: All backend sets associated with the network load balancer return a status of OK.
  • WARNING: At least one of the backend sets associated with the network load balancer returns a status of WARNING, no backend sets return a status of CRITICAL, and the network load balancer life cycle state is ACTIVE.
  • CRITICAL: One or more of the backend sets associated with the network load balancer return a status of CRITICAL.
  • UNKNOWN: If any one of the following conditions is true:
  • The network load balancer life cycle state is not ACTIVE.
  • No backend sets are defined for the network load balancer.
  • More than half of the backend sets associated with the network load balancer return a status of UNKNOWN, none of the backend sets return a status of WARNING or CRITICAL, and the network load balancer life cycle state is ACTIVE.
  • The system could not retrieve metrics for any reason.
total_backend_set_count int

The total number of backend sets associated with this network load balancer. Example: 4

unknown_state_backend_set_names Sequence[str]

A list of backend sets that are currently in the UNKNOWN health state. The list identifies each backend set by the user-friendly name you assigned when you created the backend set. Example: example_backend_set2

warning_state_backend_set_names Sequence[str]

A list of backend sets that are currently in the WARNING health state. The list identifies each backend set by the user-friendly name you assigned when you created the backend set. Example: example_backend_set3

criticalStateBackendSetNames List<String>

A list of backend sets that are currently in the CRITICAL health state. The list identifies each backend set by the user-friendly name you assigned when you created the backend set. Example: example_backend_set

id String

The provider-assigned unique ID for this managed resource.

networkLoadBalancerId String
status String

The overall health status of the network load balancer.

  • OK: All backend sets associated with the network load balancer return a status of OK.
  • WARNING: At least one of the backend sets associated with the network load balancer returns a status of WARNING, no backend sets return a status of CRITICAL, and the network load balancer life cycle state is ACTIVE.
  • CRITICAL: One or more of the backend sets associated with the network load balancer return a status of CRITICAL.
  • UNKNOWN: If any one of the following conditions is true:
  • The network load balancer life cycle state is not ACTIVE.
  • No backend sets are defined for the network load balancer.
  • More than half of the backend sets associated with the network load balancer return a status of UNKNOWN, none of the backend sets return a status of WARNING or CRITICAL, and the network load balancer life cycle state is ACTIVE.
  • The system could not retrieve metrics for any reason.
totalBackendSetCount Number

The total number of backend sets associated with this network load balancer. Example: 4

unknownStateBackendSetNames List<String>

A list of backend sets that are currently in the UNKNOWN health state. The list identifies each backend set by the user-friendly name you assigned when you created the backend set. Example: example_backend_set2

warningStateBackendSetNames List<String>

A list of backend sets that are currently in the WARNING health state. The list identifies each backend set by the user-friendly name you assigned when you created the backend set. Example: example_backend_set3

Package Details

Repository
https://github.com/pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.