HashiCorp Consul

Pulumi Official
Package maintained by Pulumi
v3.6.0 published on Tuesday, Apr 12, 2022 by Pulumi

getNodes

The consul.getNodes data source returns a list of Consul nodes that have been registered with the Consul cluster in a given datacenter. By specifying a different datacenter in the query_options it is possible to retrieve a list of nodes from a different WAN-attached Consul datacenter.

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)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: consul:index/getNodes:getNodes
  Arguments:
    # Arguments dictionary

The following arguments are supported:

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
https://github.com/pulumi/pulumi-consul
License
Apache-2.0
Notes

This Pulumi package is based on the consul Terraform Provider.