Ready to level-up your engineering skills? Join a Pulumi Workshop. Register Now

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

function getNodes(args: GetNodesArgs, opts?: InvokeOptions): Promise<GetNodesResult>
def get_nodes(query_options: Optional[Sequence[GetNodesQueryOptionArgs]] = None, opts: Optional[InvokeOptions] = None) -> GetNodesResult
func GetNodes(ctx *Context, args *GetNodesArgs, opts ...InvokeOption) (*GetNodesResult, error)

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

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

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 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]

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 {[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]

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>
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 overriden if necessary.

WaitIndex int

Index number used to enable blocking quereis.

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
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 overriden if necessary.

WaitIndex int

Index number used to enable blocking quereis.

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}
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 overriden if necessary.

waitIndex number

Index number used to enable blocking quereis.

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]
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 overriden if necessary.

wait_index int

Index number used to enable blocking quereis.

wait_time str

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.