getNodes

Consul v3.13.3, Nov 19 25

Consul v3.13.3 published on Wednesday, Nov 19, 2025 by Pulumi

Schema (JSON)

pulumi/pulumi-consul

Consul v3.13.3 published on Wednesday, Nov 19, 2025 by Pulumi

Schema (JSON)

pulumi/pulumi-consul

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as consul from "@pulumi/consul";
import * as example from "@pulumi/example";
import * as std from "@pulumi/std";

const read_dc1_nodes = consul.getNodes({
    queryOptions: [{
        datacenter: "dc1",
    }],
});
// Set the description to a whitespace delimited list of the node names
const app = new example.index.Resource("app", {description: std.join({
    separator: " ",
    input: std.formatlist({
        input: "%s",
        args: [nodeNames],
    }).result,
}).result});

import pulumi
import pulumi_consul as consul
import pulumi_example as example
import pulumi_std as std

read_dc1_nodes = consul.get_nodes(query_options=[{
    "datacenter": "dc1",
}])
# Set the description to a whitespace delimited list of the node names
app = example.index.Resource("app", description=std.join(separator= ,
    input=std.formatlist(input=%s,
        args=[node_names]).result).result)

package main

import (
	"github.com/pulumi/pulumi-consul/sdk/v3/go/consul"
	"github.com/pulumi/pulumi-example/sdk/go/example"
	"github.com/pulumi/pulumi-std/sdk/go/std"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := consul.GetNodes(ctx, &consul.GetNodesArgs{
			QueryOptions: []consul.GetNodesQueryOption{
				{
					Datacenter: pulumi.StringRef("dc1"),
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		// Set the description to a whitespace delimited list of the node names
		_, err = example.NewResource(ctx, "app", &example.ResourceArgs{
			Description: std.Join(ctx, &std.JoinArgs{
				Separator: " ",
				Input: std.Formatlist(ctx, &std.FormatlistArgs{
					Input: "%s",
					Args: []interface{}{
						nodeNames,
					},
				}, nil).Result,
			}, nil).Result,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Consul = Pulumi.Consul;
using Example = Pulumi.Example;
using Std = Pulumi.Std;

return await Deployment.RunAsync(() => 
{
    var read_dc1_nodes = Consul.GetNodes.Invoke(new()
    {
        QueryOptions = new[]
        {
            new Consul.Inputs.GetNodesQueryOptionInputArgs
            {
                Datacenter = "dc1",
            },
        },
    });

    // Set the description to a whitespace delimited list of the node names
    var app = new Example.Index.Resource("app", new()
    {
        Description = Std.Join.Invoke(new()
        {
            Separator = " ",
            Input = Std.Formatlist.Invoke(new()
            {
                Input = "%s",
                Args = new[]
                {
                    nodeNames,
                },
            }).Result,
        }).Result,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.consul.ConsulFunctions;
import com.pulumi.consul.inputs.GetNodesArgs;
import com.pulumi.example.Resource;
import com.pulumi.example.ResourceArgs;
import com.pulumi.std.StdFunctions;
import com.pulumi.std.inputs.FormatlistArgs;
import com.pulumi.std.inputs.JoinArgs;
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 read-dc1-nodes = ConsulFunctions.getNodes(GetNodesArgs.builder()
            .queryOptions(GetNodesQueryOptionArgs.builder()
                .datacenter("dc1")
                .build())
            .build());

        // Set the description to a whitespace delimited list of the node names
        var app = new Resource("app", ResourceArgs.builder()
            .description(StdFunctions.join(JoinArgs.builder()
                .separator(" ")
                .input(StdFunctions.formatlist(FormatlistArgs.builder()
                    .input("%s")
                    .args(nodeNames)
                    .build()).result())
                .build()).result())
            .build());

    }
}

resources:
  # Set the description to a whitespace delimited list of the node names
  app:
    type: example:Resource
    properties:
      description:
        fn::invoke:
          function: std:join
          arguments:
            separator: ' '
            input:
              fn::invoke:
                function: std:formatlist
                arguments:
                  input: '%s'
                  args:
                    - ${nodeNames}
                return: result
          return: result
variables:
  read-dc1-nodes:
    fn::invoke:
      function: consul:getNodes
      arguments:
        queryOptions:
          - datacenter: dc1

Using getNodes

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 getNodes(args: GetNodesArgs, opts?: InvokeOptions): Promise<GetNodesResult>
function getNodesOutput(args: GetNodesOutputArgs, opts?: InvokeOptions): Output<GetNodesResult>

def get_nodes(query_options: Optional[Sequence[GetNodesQueryOption]] = None,
              opts: Optional[InvokeOptions] = None) -> GetNodesResult
def get_nodes_output(query_options: Optional[pulumi.Input[Sequence[pulumi.Input[GetNodesQueryOptionArgs]]]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetNodesResult]

func GetNodes(ctx *Context, args *GetNodesArgs, opts ...InvokeOption) (*GetNodesResult, error)
func GetNodesOutput(ctx *Context, args *GetNodesOutputArgs, opts ...InvokeOption) GetNodesResultOutput

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

public static class GetNodes 
{
    public static Task<GetNodesResult> InvokeAsync(GetNodesArgs args, InvokeOptions? opts = null)
    public static Output<GetNodesResult> Invoke(GetNodesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetNodesResult> getNodes(GetNodesArgs args, InvokeOptions options)
public static Output<GetNodesResult> getNodes(GetNodesArgs args, InvokeOptions options)

fn::invoke:
  function: consul:index/getNodes:getNodes
  arguments:
    # arguments dictionary

The following arguments are supported:

QueryOptions List<GetNodesQueryOption>: See below.

QueryOptions []GetNodesQueryOption: See below.

queryOptions List<GetNodesQueryOption>: See below.

queryOptions GetNodesQueryOption[]: See below.

query_options Sequence[GetNodesQueryOption]: See below.

queryOptions List<Property Map>: See below.

getNodes Result

The following output properties are available:

Datacenter string: The datacenter the keys are being read from to.
Id string: The provider-assigned unique ID for this managed resource.
NodeIds List<string>: A list of the Consul node IDs.
NodeNames List<string>: A list of the Consul node names.
Nodes List<GetNodesNode>: A list of nodes and details about each Consul agent. The list of per-node attributes is detailed below.
QueryOptions List<GetNodesQueryOption>

Datacenter string: The datacenter the keys are being read from to.
Id string: The provider-assigned unique ID for this managed resource.
NodeIds []string: A list of the Consul node IDs.
NodeNames []string: A list of the Consul node names.
Nodes []GetNodesNode: A list of nodes and details about each Consul agent. The list of per-node attributes is detailed below.
QueryOptions []GetNodesQueryOption

datacenter String: The datacenter the keys are being read from to.
id String: The provider-assigned unique ID for this managed resource.
nodeIds List<String>: A list of the Consul node IDs.
nodeNames List<String>: A list of the Consul node names.
nodes List<GetNodesNode>: A list of nodes and details about each Consul agent. The list of per-node attributes is detailed below.
queryOptions List<GetNodesQueryOption>

datacenter string: The datacenter the keys are being read from to.
id string: The provider-assigned unique ID for this managed resource.
nodeIds string[]: A list of the Consul node IDs.
nodeNames string[]: A list of the Consul node names.
nodes GetNodesNode[]: A list of nodes and details about each Consul agent. The list of per-node attributes is detailed below.
queryOptions GetNodesQueryOption[]

datacenter str: The datacenter the keys are being read from to.
id str: The provider-assigned unique ID for this managed resource.
node_ids Sequence[str]: A list of the Consul node IDs.
node_names Sequence[str]: A list of the Consul node names.
nodes Sequence[GetNodesNode]: A list of nodes and details about each Consul agent. The list of per-node attributes is detailed below.
query_options Sequence[GetNodesQueryOption]

datacenter String: The datacenter the keys are being read from to.
id String: The provider-assigned unique ID for this managed resource.
nodeIds List<String>: A list of the Consul node IDs.
nodeNames List<String>: A list of the Consul node names.
nodes List<Property Map>: A list of nodes and details about each Consul agent. The list of per-node attributes is detailed below.
queryOptions List<Property Map>

Supporting Types

GetNodesNode

Address string

Id string

The Node ID of the Consul agent.

meta - Node meta data tag information, if any.
name - The name of the Consul node.
address - The IP address the node is advertising to the Consul cluster.
tagged_addresses - List of explicit LAN and WAN IP addresses for the agent.

Meta Dictionary<string, string>

Name string

TaggedAddresses Dictionary<string, string>

Address string

Id string

The Node ID of the Consul agent.

meta - Node meta data tag information, if any.
name - The name of the Consul node.
address - The IP address the node is advertising to the Consul cluster.
tagged_addresses - List of explicit LAN and WAN IP addresses for the agent.

Meta map[string]string

Name string

TaggedAddresses map[string]string

address String

id String

The Node ID of the Consul agent.

meta - Node meta data tag information, if any.
name - The name of the Consul node.
address - The IP address the node is advertising to the Consul cluster.
tagged_addresses - List of explicit LAN and WAN IP addresses for the agent.

meta Map<String,String>

name String

taggedAddresses Map<String,String>

address string

id string

The Node ID of the Consul agent.

meta - Node meta data tag information, if any.
name - The name of the Consul node.
address - The IP address the node is advertising to the Consul cluster.
tagged_addresses - List of explicit LAN and WAN IP addresses for the agent.

meta {[key: string]: string}

name string

taggedAddresses {[key: string]: string}

address str

id str

The Node ID of the Consul agent.

meta - Node meta data tag information, if any.
name - The name of the Consul node.
address - The IP address the node is advertising to the Consul cluster.
tagged_addresses - List of explicit LAN and WAN IP addresses for the agent.

meta Mapping[str, str]

name str

tagged_addresses Mapping[str, str]

address String

id String

The Node ID of the Consul agent.

meta - Node meta data tag information, if any.
name - The name of the Consul node.
address - The IP address the node is advertising to the Consul cluster.
tagged_addresses - List of explicit LAN and WAN IP addresses for the agent.

meta Map<String>

name String

taggedAddresses Map<String>

GetNodesQueryOption

AllowStale bool: When true, the default, allow responses from Consul servers that are followers.
Datacenter string: The Consul datacenter to query. Defaults to the same value found in query_options parameter specified below, or if that is empty, the datacenter value found in the Consul agent that this provider is configured to talk to then the datacenter in the provider setup.
Near string
NodeMeta Dictionary<string, string>
Partition string
RequireConsistent bool: When true force the client to perform a read on at least quorum servers and verify the result is the same. Defaults to false.
Token string: Specify the Consul ACL token to use when performing the request. This defaults to the same API token configured by the consul provider but may be overridden if necessary.
WaitIndex int: Index number used to enable blocking queries.
WaitTime string: Max time the client should wait for a blocking query to return.

AllowStale bool: When true, the default, allow responses from Consul servers that are followers.
Datacenter string: The Consul datacenter to query. Defaults to the same value found in query_options parameter specified below, or if that is empty, the datacenter value found in the Consul agent that this provider is configured to talk to then the datacenter in the provider setup.
Near string
NodeMeta map[string]string
Partition string
RequireConsistent bool: When true force the client to perform a read on at least quorum servers and verify the result is the same. Defaults to false.
Token string: Specify the Consul ACL token to use when performing the request. This defaults to the same API token configured by the consul provider but may be overridden if necessary.
WaitIndex int: Index number used to enable blocking queries.
WaitTime string: Max time the client should wait for a blocking query to return.

allowStale Boolean: When true, the default, allow responses from Consul servers that are followers.
datacenter String: The Consul datacenter to query. Defaults to the same value found in query_options parameter specified below, or if that is empty, the datacenter value found in the Consul agent that this provider is configured to talk to then the datacenter in the provider setup.
near String
nodeMeta Map<String,String>
partition String
requireConsistent Boolean: When true force the client to perform a read on at least quorum servers and verify the result is the same. Defaults to false.
token String: Specify the Consul ACL token to use when performing the request. This defaults to the same API token configured by the consul provider but may be overridden if necessary.
waitIndex Integer: Index number used to enable blocking queries.
waitTime String: Max time the client should wait for a blocking query to return.

allowStale boolean: When true, the default, allow responses from Consul servers that are followers.
datacenter string: The Consul datacenter to query. Defaults to the same value found in query_options parameter specified below, or if that is empty, the datacenter value found in the Consul agent that this provider is configured to talk to then the datacenter in the provider setup.
near string
nodeMeta {[key: string]: string}
partition string
requireConsistent boolean: When true force the client to perform a read on at least quorum servers and verify the result is the same. Defaults to false.
token string: Specify the Consul ACL token to use when performing the request. This defaults to the same API token configured by the consul provider but may be overridden if necessary.
waitIndex number: Index number used to enable blocking queries.
waitTime string: Max time the client should wait for a blocking query to return.

allow_stale bool: When true, the default, allow responses from Consul servers that are followers.
datacenter str: The Consul datacenter to query. Defaults to the same value found in query_options parameter specified below, or if that is empty, the datacenter value found in the Consul agent that this provider is configured to talk to then the datacenter in the provider setup.
near str
node_meta Mapping[str, str]
partition str
require_consistent bool: When true force the client to perform a read on at least quorum servers and verify the result is the same. Defaults to false.
token str: Specify the Consul ACL token to use when performing the request. This defaults to the same API token configured by the consul provider but may be overridden if necessary.
wait_index int: Index number used to enable blocking queries.
wait_time str: Max time the client should wait for a blocking query to return.

allowStale Boolean: When true, the default, allow responses from Consul servers that are followers.
datacenter String: The Consul datacenter to query. Defaults to the same value found in query_options parameter specified below, or if that is empty, the datacenter value found in the Consul agent that this provider is configured to talk to then the datacenter in the provider setup.
near String
nodeMeta Map<String>
partition String
requireConsistent Boolean: When true force the client to perform a read on at least quorum servers and verify the result is the same. Defaults to false.
token String: Specify the Consul ACL token to use when performing the request. This defaults to the same API token configured by the consul provider but may be overridden if necessary.
waitIndex Number: Index number used to enable blocking queries.
waitTime String: Max time the client should wait for a blocking query to return.

Package Details

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

Consul v3.13.3 published on Wednesday, Nov 19, 2025 by Pulumi

Schema (JSON)

pulumi/pulumi-consul

consul.getNodes

On this page

On this page

Example Usage

Using getNodes

getNodes Result

Supporting Types

GetNodesNode

GetNodesQueryOption

Package Details

On this page

On this page