Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Consul Provider
  3. API Docs
  4. getCatalogNodes
Consul v3.12.4 published on Wednesday, Feb 12, 2025 by Pulumi
pulumi/pulumi-consul

consul.getCatalogNodes

Explore with Pulumi AI

Consul v3.12.4 published on Wednesday, Feb 12, 2025 by Pulumi
pulumi/pulumi-consul
Deprecated: getCatalogNodes has been deprecated in favor of 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 getCatalogNodes

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 getCatalogNodes(args: GetCatalogNodesArgs, opts?: InvokeOptions): Promise<GetCatalogNodesResult>
function getCatalogNodesOutput(args: GetCatalogNodesOutputArgs, opts?: InvokeOptions): Output<GetCatalogNodesResult>
Copy
def get_catalog_nodes(query_options: Optional[Sequence[GetCatalogNodesQueryOption]] = None,
                      opts: Optional[InvokeOptions] = None) -> GetCatalogNodesResult
def get_catalog_nodes_output(query_options: Optional[pulumi.Input[Sequence[pulumi.Input[GetCatalogNodesQueryOptionArgs]]]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetCatalogNodesResult]
Copy
func GetCatalogNodes(ctx *Context, args *GetCatalogNodesArgs, opts ...InvokeOption) (*GetCatalogNodesResult, error)
func GetCatalogNodesOutput(ctx *Context, args *GetCatalogNodesOutputArgs, opts ...InvokeOption) GetCatalogNodesResultOutput
Copy

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

public static class GetCatalogNodes 
{
    public static Task<GetCatalogNodesResult> InvokeAsync(GetCatalogNodesArgs args, InvokeOptions? opts = null)
    public static Output<GetCatalogNodesResult> Invoke(GetCatalogNodesInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetCatalogNodesResult> getCatalogNodes(GetCatalogNodesArgs args, InvokeOptions options)
public static Output<GetCatalogNodesResult> getCatalogNodes(GetCatalogNodesArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: consul:index/getCatalogNodes:getCatalogNodes
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

getCatalogNodes 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<GetCatalogNodesNode>
A list of nodes and details about each Consul agent. The list of per-node attributes is detailed below.
QueryOptions List<GetCatalogNodesQueryOption>
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 []GetCatalogNodesNode
A list of nodes and details about each Consul agent. The list of per-node attributes is detailed below.
QueryOptions []GetCatalogNodesQueryOption
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<GetCatalogNodesNode>
A list of nodes and details about each Consul agent. The list of per-node attributes is detailed below.
queryOptions List<GetCatalogNodesQueryOption>
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 GetCatalogNodesNode[]
A list of nodes and details about each Consul agent. The list of per-node attributes is detailed below.
queryOptions GetCatalogNodesQueryOption[]
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[GetCatalogNodesNode]
A list of nodes and details about each Consul agent. The list of per-node attributes is detailed below.
query_options Sequence[GetCatalogNodesQueryOption]
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

GetCatalogNodesNode

Address This property is required. string
Id This property is required. 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 This property is required. Dictionary<string, string>
Name This property is required. string
TaggedAddresses This property is required. Dictionary<string, string>
Address This property is required. string
Id This property is required. 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 This property is required. map[string]string
Name This property is required. string
TaggedAddresses This property is required. map[string]string
address This property is required. String
id This property is required. 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 This property is required. Map<String,String>
name This property is required. String
taggedAddresses This property is required. Map<String,String>
address This property is required. string
id This property is required. 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 This property is required. {[key: string]: string}
name This property is required. string
taggedAddresses This property is required. {[key: string]: string}
address This property is required. str
id This property is required. 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 This property is required. Mapping[str, str]
name This property is required. str
tagged_addresses This property is required. Mapping[str, str]
address This property is required. String
id This property is required. 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 This property is required. Map<String>
name This property is required. String
taggedAddresses This property is required. Map<String>

GetCatalogNodesQueryOption

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.12.4 published on Wednesday, Feb 12, 2025 by Pulumi
pulumi/pulumi-consul