1. Packages
  2. Linode Provider
  3. API Docs
  4. getNodeBalancer
Linode v4.37.0 published on Thursday, Apr 10, 2025 by Pulumi

linode.getNodeBalancer

Explore with Pulumi AI

Linode v4.37.0 published on Thursday, Apr 10, 2025 by Pulumi

Provides details about a Linode NodeBalancer. For more information, see the Linode APIv4 docs.

Example Usage

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

const my_nodebalancer = linode.getNodeBalancer({
    id: 123,
});
Copy
import pulumi
import pulumi_linode as linode

my_nodebalancer = linode.get_node_balancer(id=123)
Copy
package main

import (
	"github.com/pulumi/pulumi-linode/sdk/v4/go/linode"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := linode.LookupNodeBalancer(ctx, &linode.LookupNodeBalancerArgs{
			Id: 123,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Linode = Pulumi.Linode;

return await Deployment.RunAsync(() => 
{
    var my_nodebalancer = Linode.GetNodeBalancer.Invoke(new()
    {
        Id = 123,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.linode.LinodeFunctions;
import com.pulumi.linode.inputs.GetNodeBalancerArgs;
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 my-nodebalancer = LinodeFunctions.getNodeBalancer(GetNodeBalancerArgs.builder()
            .id(123)
            .build());

    }
}
Copy
variables:
  my-nodebalancer:
    fn::invoke:
      function: linode:getNodeBalancer
      arguments:
        id: 123
Copy

Using getNodeBalancer

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 getNodeBalancer(args: GetNodeBalancerArgs, opts?: InvokeOptions): Promise<GetNodeBalancerResult>
function getNodeBalancerOutput(args: GetNodeBalancerOutputArgs, opts?: InvokeOptions): Output<GetNodeBalancerResult>
Copy
def get_node_balancer(firewalls: Optional[Sequence[GetNodeBalancerFirewall]] = None,
                      id: Optional[int] = None,
                      opts: Optional[InvokeOptions] = None) -> GetNodeBalancerResult
def get_node_balancer_output(firewalls: Optional[pulumi.Input[Sequence[pulumi.Input[GetNodeBalancerFirewallArgs]]]] = None,
                      id: Optional[pulumi.Input[int]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetNodeBalancerResult]
Copy
func LookupNodeBalancer(ctx *Context, args *LookupNodeBalancerArgs, opts ...InvokeOption) (*LookupNodeBalancerResult, error)
func LookupNodeBalancerOutput(ctx *Context, args *LookupNodeBalancerOutputArgs, opts ...InvokeOption) LookupNodeBalancerResultOutput
Copy

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

public static class GetNodeBalancer 
{
    public static Task<GetNodeBalancerResult> InvokeAsync(GetNodeBalancerArgs args, InvokeOptions? opts = null)
    public static Output<GetNodeBalancerResult> Invoke(GetNodeBalancerInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetNodeBalancerResult> getNodeBalancer(GetNodeBalancerArgs args, InvokeOptions options)
public static Output<GetNodeBalancerResult> getNodeBalancer(GetNodeBalancerArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: linode:index/getNodeBalancer:getNodeBalancer
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Id This property is required. int
The NodeBalancer's ID.
Firewalls List<GetNodeBalancerFirewall>
Id This property is required. int
The NodeBalancer's ID.
Firewalls []GetNodeBalancerFirewall
id This property is required. Integer
The NodeBalancer's ID.
firewalls List<GetNodeBalancerFirewall>
id This property is required. number
The NodeBalancer's ID.
firewalls GetNodeBalancerFirewall[]
id This property is required. int
The NodeBalancer's ID.
firewalls Sequence[GetNodeBalancerFirewall]
id This property is required. Number
The NodeBalancer's ID.
firewalls List<Property Map>

getNodeBalancer Result

The following output properties are available:

ClientConnThrottle int
Throttle connections per second (0-20).
Created string
When this firewall was created.
Hostname string
This NodeBalancer's hostname, ending with .ip.linodeusercontent.com
Id int
The Firewall's ID.
Ipv4 string
A list of IPv4 addresses or networks. Must be in IP/mask format.
Ipv6 string
A list of IPv6 addresses or networks. Must be in IP/mask format.
Label string
Used to identify this rule. For display purposes only.
Region string
The Region where this Linode NodeBalancer is located. NodeBalancers only support backends in the same Region.
Tags List<string>
The tags applied to the firewall. Tags are case-insensitive and are for organizational purposes only.
Transfers List<GetNodeBalancerTransfer>
Updated string
When this firewall was last updated.
Firewalls List<GetNodeBalancerFirewall>
ClientConnThrottle int
Throttle connections per second (0-20).
Created string
When this firewall was created.
Hostname string
This NodeBalancer's hostname, ending with .ip.linodeusercontent.com
Id int
The Firewall's ID.
Ipv4 string
A list of IPv4 addresses or networks. Must be in IP/mask format.
Ipv6 string
A list of IPv6 addresses or networks. Must be in IP/mask format.
Label string
Used to identify this rule. For display purposes only.
Region string
The Region where this Linode NodeBalancer is located. NodeBalancers only support backends in the same Region.
Tags []string
The tags applied to the firewall. Tags are case-insensitive and are for organizational purposes only.
Transfers []GetNodeBalancerTransfer
Updated string
When this firewall was last updated.
Firewalls []GetNodeBalancerFirewall
clientConnThrottle Integer
Throttle connections per second (0-20).
created String
When this firewall was created.
hostname String
This NodeBalancer's hostname, ending with .ip.linodeusercontent.com
id Integer
The Firewall's ID.
ipv4 String
A list of IPv4 addresses or networks. Must be in IP/mask format.
ipv6 String
A list of IPv6 addresses or networks. Must be in IP/mask format.
label String
Used to identify this rule. For display purposes only.
region String
The Region where this Linode NodeBalancer is located. NodeBalancers only support backends in the same Region.
tags List<String>
The tags applied to the firewall. Tags are case-insensitive and are for organizational purposes only.
transfers List<GetNodeBalancerTransfer>
updated String
When this firewall was last updated.
firewalls List<GetNodeBalancerFirewall>
clientConnThrottle number
Throttle connections per second (0-20).
created string
When this firewall was created.
hostname string
This NodeBalancer's hostname, ending with .ip.linodeusercontent.com
id number
The Firewall's ID.
ipv4 string
A list of IPv4 addresses or networks. Must be in IP/mask format.
ipv6 string
A list of IPv6 addresses or networks. Must be in IP/mask format.
label string
Used to identify this rule. For display purposes only.
region string
The Region where this Linode NodeBalancer is located. NodeBalancers only support backends in the same Region.
tags string[]
The tags applied to the firewall. Tags are case-insensitive and are for organizational purposes only.
transfers GetNodeBalancerTransfer[]
updated string
When this firewall was last updated.
firewalls GetNodeBalancerFirewall[]
client_conn_throttle int
Throttle connections per second (0-20).
created str
When this firewall was created.
hostname str
This NodeBalancer's hostname, ending with .ip.linodeusercontent.com
id int
The Firewall's ID.
ipv4 str
A list of IPv4 addresses or networks. Must be in IP/mask format.
ipv6 str
A list of IPv6 addresses or networks. Must be in IP/mask format.
label str
Used to identify this rule. For display purposes only.
region str
The Region where this Linode NodeBalancer is located. NodeBalancers only support backends in the same Region.
tags Sequence[str]
The tags applied to the firewall. Tags are case-insensitive and are for organizational purposes only.
transfers Sequence[GetNodeBalancerTransfer]
updated str
When this firewall was last updated.
firewalls Sequence[GetNodeBalancerFirewall]
clientConnThrottle Number
Throttle connections per second (0-20).
created String
When this firewall was created.
hostname String
This NodeBalancer's hostname, ending with .ip.linodeusercontent.com
id Number
The Firewall's ID.
ipv4 String
A list of IPv4 addresses or networks. Must be in IP/mask format.
ipv6 String
A list of IPv6 addresses or networks. Must be in IP/mask format.
label String
Used to identify this rule. For display purposes only.
region String
The Region where this Linode NodeBalancer is located. NodeBalancers only support backends in the same Region.
tags List<String>
The tags applied to the firewall. Tags are case-insensitive and are for organizational purposes only.
transfers List<Property Map>
updated String
When this firewall was last updated.
firewalls List<Property Map>

Supporting Types

GetNodeBalancerFirewall

Created This property is required. string
When this firewall was created.
Id This property is required. int
The NodeBalancer's ID.
InboundPolicy This property is required. string
The default behavior for inbound traffic. (ACCEPT, DROP)
Label This property is required. string
Used to identify this rule. For display purposes only.
OutboundPolicy This property is required. string
The default behavior for outbound traffic. (ACCEPT, DROP)
Status This property is required. string
The status of the firewall. (enabled, disabled, deleted)
Tags This property is required. List<string>
The tags applied to the firewall. Tags are case-insensitive and are for organizational purposes only.
Updated This property is required. string
When this firewall was last updated.
Inbounds List<GetNodeBalancerFirewallInbound>
A set of firewall rules that specify what inbound network traffic is allowed.
Outbounds List<GetNodeBalancerFirewallOutbound>
A set of firewall rules that specify what outbound network traffic is allowed.
Created This property is required. string
When this firewall was created.
Id This property is required. int
The NodeBalancer's ID.
InboundPolicy This property is required. string
The default behavior for inbound traffic. (ACCEPT, DROP)
Label This property is required. string
Used to identify this rule. For display purposes only.
OutboundPolicy This property is required. string
The default behavior for outbound traffic. (ACCEPT, DROP)
Status This property is required. string
The status of the firewall. (enabled, disabled, deleted)
Tags This property is required. []string
The tags applied to the firewall. Tags are case-insensitive and are for organizational purposes only.
Updated This property is required. string
When this firewall was last updated.
Inbounds []GetNodeBalancerFirewallInbound
A set of firewall rules that specify what inbound network traffic is allowed.
Outbounds []GetNodeBalancerFirewallOutbound
A set of firewall rules that specify what outbound network traffic is allowed.
created This property is required. String
When this firewall was created.
id This property is required. Integer
The NodeBalancer's ID.
inboundPolicy This property is required. String
The default behavior for inbound traffic. (ACCEPT, DROP)
label This property is required. String
Used to identify this rule. For display purposes only.
outboundPolicy This property is required. String
The default behavior for outbound traffic. (ACCEPT, DROP)
status This property is required. String
The status of the firewall. (enabled, disabled, deleted)
tags This property is required. List<String>
The tags applied to the firewall. Tags are case-insensitive and are for organizational purposes only.
updated This property is required. String
When this firewall was last updated.
inbounds List<GetNodeBalancerFirewallInbound>
A set of firewall rules that specify what inbound network traffic is allowed.
outbounds List<GetNodeBalancerFirewallOutbound>
A set of firewall rules that specify what outbound network traffic is allowed.
created This property is required. string
When this firewall was created.
id This property is required. number
The NodeBalancer's ID.
inboundPolicy This property is required. string
The default behavior for inbound traffic. (ACCEPT, DROP)
label This property is required. string
Used to identify this rule. For display purposes only.
outboundPolicy This property is required. string
The default behavior for outbound traffic. (ACCEPT, DROP)
status This property is required. string
The status of the firewall. (enabled, disabled, deleted)
tags This property is required. string[]
The tags applied to the firewall. Tags are case-insensitive and are for organizational purposes only.
updated This property is required. string
When this firewall was last updated.
inbounds GetNodeBalancerFirewallInbound[]
A set of firewall rules that specify what inbound network traffic is allowed.
outbounds GetNodeBalancerFirewallOutbound[]
A set of firewall rules that specify what outbound network traffic is allowed.
created This property is required. str
When this firewall was created.
id This property is required. int
The NodeBalancer's ID.
inbound_policy This property is required. str
The default behavior for inbound traffic. (ACCEPT, DROP)
label This property is required. str
Used to identify this rule. For display purposes only.
outbound_policy This property is required. str
The default behavior for outbound traffic. (ACCEPT, DROP)
status This property is required. str
The status of the firewall. (enabled, disabled, deleted)
tags This property is required. Sequence[str]
The tags applied to the firewall. Tags are case-insensitive and are for organizational purposes only.
updated This property is required. str
When this firewall was last updated.
inbounds Sequence[GetNodeBalancerFirewallInbound]
A set of firewall rules that specify what inbound network traffic is allowed.
outbounds Sequence[GetNodeBalancerFirewallOutbound]
A set of firewall rules that specify what outbound network traffic is allowed.
created This property is required. String
When this firewall was created.
id This property is required. Number
The NodeBalancer's ID.
inboundPolicy This property is required. String
The default behavior for inbound traffic. (ACCEPT, DROP)
label This property is required. String
Used to identify this rule. For display purposes only.
outboundPolicy This property is required. String
The default behavior for outbound traffic. (ACCEPT, DROP)
status This property is required. String
The status of the firewall. (enabled, disabled, deleted)
tags This property is required. List<String>
The tags applied to the firewall. Tags are case-insensitive and are for organizational purposes only.
updated This property is required. String
When this firewall was last updated.
inbounds List<Property Map>
A set of firewall rules that specify what inbound network traffic is allowed.
outbounds List<Property Map>
A set of firewall rules that specify what outbound network traffic is allowed.

GetNodeBalancerFirewallInbound

Action This property is required. string
Controls whether traffic is accepted or dropped by this rule. Overrides the Firewall’s inbound_policy if this is an inbound rule, or the outbound_policy if this is an outbound rule.
Ipv4s This property is required. List<string>
A list of IPv4 addresses or networks. Must be in IP/mask format.
Ipv6s This property is required. List<string>
A list of IPv6 addresses or networks. Must be in IP/mask format.
Label This property is required. string
Used to identify this rule. For display purposes only.
Ports This property is required. string
A string representation of ports and/or port ranges (i.e. "443" or "80-90, 91").
Protocol This property is required. string
The network protocol this rule controls. (TCP, UDP, ICMP)
Action This property is required. string
Controls whether traffic is accepted or dropped by this rule. Overrides the Firewall’s inbound_policy if this is an inbound rule, or the outbound_policy if this is an outbound rule.
Ipv4s This property is required. []string
A list of IPv4 addresses or networks. Must be in IP/mask format.
Ipv6s This property is required. []string
A list of IPv6 addresses or networks. Must be in IP/mask format.
Label This property is required. string
Used to identify this rule. For display purposes only.
Ports This property is required. string
A string representation of ports and/or port ranges (i.e. "443" or "80-90, 91").
Protocol This property is required. string
The network protocol this rule controls. (TCP, UDP, ICMP)
action This property is required. String
Controls whether traffic is accepted or dropped by this rule. Overrides the Firewall’s inbound_policy if this is an inbound rule, or the outbound_policy if this is an outbound rule.
ipv4s This property is required. List<String>
A list of IPv4 addresses or networks. Must be in IP/mask format.
ipv6s This property is required. List<String>
A list of IPv6 addresses or networks. Must be in IP/mask format.
label This property is required. String
Used to identify this rule. For display purposes only.
ports This property is required. String
A string representation of ports and/or port ranges (i.e. "443" or "80-90, 91").
protocol This property is required. String
The network protocol this rule controls. (TCP, UDP, ICMP)
action This property is required. string
Controls whether traffic is accepted or dropped by this rule. Overrides the Firewall’s inbound_policy if this is an inbound rule, or the outbound_policy if this is an outbound rule.
ipv4s This property is required. string[]
A list of IPv4 addresses or networks. Must be in IP/mask format.
ipv6s This property is required. string[]
A list of IPv6 addresses or networks. Must be in IP/mask format.
label This property is required. string
Used to identify this rule. For display purposes only.
ports This property is required. string
A string representation of ports and/or port ranges (i.e. "443" or "80-90, 91").
protocol This property is required. string
The network protocol this rule controls. (TCP, UDP, ICMP)
action This property is required. str
Controls whether traffic is accepted or dropped by this rule. Overrides the Firewall’s inbound_policy if this is an inbound rule, or the outbound_policy if this is an outbound rule.
ipv4s This property is required. Sequence[str]
A list of IPv4 addresses or networks. Must be in IP/mask format.
ipv6s This property is required. Sequence[str]
A list of IPv6 addresses or networks. Must be in IP/mask format.
label This property is required. str
Used to identify this rule. For display purposes only.
ports This property is required. str
A string representation of ports and/or port ranges (i.e. "443" or "80-90, 91").
protocol This property is required. str
The network protocol this rule controls. (TCP, UDP, ICMP)
action This property is required. String
Controls whether traffic is accepted or dropped by this rule. Overrides the Firewall’s inbound_policy if this is an inbound rule, or the outbound_policy if this is an outbound rule.
ipv4s This property is required. List<String>
A list of IPv4 addresses or networks. Must be in IP/mask format.
ipv6s This property is required. List<String>
A list of IPv6 addresses or networks. Must be in IP/mask format.
label This property is required. String
Used to identify this rule. For display purposes only.
ports This property is required. String
A string representation of ports and/or port ranges (i.e. "443" or "80-90, 91").
protocol This property is required. String
The network protocol this rule controls. (TCP, UDP, ICMP)

GetNodeBalancerFirewallOutbound

Action This property is required. string
Controls whether traffic is accepted or dropped by this rule. Overrides the Firewall’s inbound_policy if this is an inbound rule, or the outbound_policy if this is an outbound rule.
Ipv4s This property is required. List<string>
A list of IPv4 addresses or networks. Must be in IP/mask format.
Ipv6s This property is required. List<string>
A list of IPv6 addresses or networks. Must be in IP/mask format.
Label This property is required. string
Used to identify this rule. For display purposes only.
Ports This property is required. string
A string representation of ports and/or port ranges (i.e. "443" or "80-90, 91").
Protocol This property is required. string
The network protocol this rule controls. (TCP, UDP, ICMP)
Action This property is required. string
Controls whether traffic is accepted or dropped by this rule. Overrides the Firewall’s inbound_policy if this is an inbound rule, or the outbound_policy if this is an outbound rule.
Ipv4s This property is required. []string
A list of IPv4 addresses or networks. Must be in IP/mask format.
Ipv6s This property is required. []string
A list of IPv6 addresses or networks. Must be in IP/mask format.
Label This property is required. string
Used to identify this rule. For display purposes only.
Ports This property is required. string
A string representation of ports and/or port ranges (i.e. "443" or "80-90, 91").
Protocol This property is required. string
The network protocol this rule controls. (TCP, UDP, ICMP)
action This property is required. String
Controls whether traffic is accepted or dropped by this rule. Overrides the Firewall’s inbound_policy if this is an inbound rule, or the outbound_policy if this is an outbound rule.
ipv4s This property is required. List<String>
A list of IPv4 addresses or networks. Must be in IP/mask format.
ipv6s This property is required. List<String>
A list of IPv6 addresses or networks. Must be in IP/mask format.
label This property is required. String
Used to identify this rule. For display purposes only.
ports This property is required. String
A string representation of ports and/or port ranges (i.e. "443" or "80-90, 91").
protocol This property is required. String
The network protocol this rule controls. (TCP, UDP, ICMP)
action This property is required. string
Controls whether traffic is accepted or dropped by this rule. Overrides the Firewall’s inbound_policy if this is an inbound rule, or the outbound_policy if this is an outbound rule.
ipv4s This property is required. string[]
A list of IPv4 addresses or networks. Must be in IP/mask format.
ipv6s This property is required. string[]
A list of IPv6 addresses or networks. Must be in IP/mask format.
label This property is required. string
Used to identify this rule. For display purposes only.
ports This property is required. string
A string representation of ports and/or port ranges (i.e. "443" or "80-90, 91").
protocol This property is required. string
The network protocol this rule controls. (TCP, UDP, ICMP)
action This property is required. str
Controls whether traffic is accepted or dropped by this rule. Overrides the Firewall’s inbound_policy if this is an inbound rule, or the outbound_policy if this is an outbound rule.
ipv4s This property is required. Sequence[str]
A list of IPv4 addresses or networks. Must be in IP/mask format.
ipv6s This property is required. Sequence[str]
A list of IPv6 addresses or networks. Must be in IP/mask format.
label This property is required. str
Used to identify this rule. For display purposes only.
ports This property is required. str
A string representation of ports and/or port ranges (i.e. "443" or "80-90, 91").
protocol This property is required. str
The network protocol this rule controls. (TCP, UDP, ICMP)
action This property is required. String
Controls whether traffic is accepted or dropped by this rule. Overrides the Firewall’s inbound_policy if this is an inbound rule, or the outbound_policy if this is an outbound rule.
ipv4s This property is required. List<String>
A list of IPv4 addresses or networks. Must be in IP/mask format.
ipv6s This property is required. List<String>
A list of IPv6 addresses or networks. Must be in IP/mask format.
label This property is required. String
Used to identify this rule. For display purposes only.
ports This property is required. String
A string representation of ports and/or port ranges (i.e. "443" or "80-90, 91").
protocol This property is required. String
The network protocol this rule controls. (TCP, UDP, ICMP)

GetNodeBalancerTransfer

In This property is required. double
The total transfer, in MB, used by this NodeBalancer for the current month
Out This property is required. double
The total inbound transfer, in MB, used for this NodeBalancer for the current month
Total This property is required. double
The total outbound transfer, in MB, used for this NodeBalancer for the current month
In This property is required. float64
The total transfer, in MB, used by this NodeBalancer for the current month
Out This property is required. float64
The total inbound transfer, in MB, used for this NodeBalancer for the current month
Total This property is required. float64
The total outbound transfer, in MB, used for this NodeBalancer for the current month
in This property is required. Double
The total transfer, in MB, used by this NodeBalancer for the current month
out This property is required. Double
The total inbound transfer, in MB, used for this NodeBalancer for the current month
total This property is required. Double
The total outbound transfer, in MB, used for this NodeBalancer for the current month
in This property is required. number
The total transfer, in MB, used by this NodeBalancer for the current month
out This property is required. number
The total inbound transfer, in MB, used for this NodeBalancer for the current month
total This property is required. number
The total outbound transfer, in MB, used for this NodeBalancer for the current month
in_ This property is required. float
The total transfer, in MB, used by this NodeBalancer for the current month
out This property is required. float
The total inbound transfer, in MB, used for this NodeBalancer for the current month
total This property is required. float
The total outbound transfer, in MB, used for this NodeBalancer for the current month
in This property is required. Number
The total transfer, in MB, used by this NodeBalancer for the current month
out This property is required. Number
The total inbound transfer, in MB, used for this NodeBalancer for the current month
total This property is required. Number
The total outbound transfer, in MB, used for this NodeBalancer for the current month

Package Details

Repository
Linode pulumi/pulumi-linode
License
Apache-2.0
Notes
This Pulumi package is based on the linode Terraform Provider.
Linode v4.37.0 published on Thursday, Apr 10, 2025 by Pulumi