Consul v3.12.1 published on Friday, Aug 23, 2024 by Pulumi
consul.getCatalogNodes
Explore with Pulumi AI
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>
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]
func GetCatalogNodes(ctx *Context, args *GetCatalogNodesArgs, opts ...InvokeOption) (*GetCatalogNodesResult, error)
func GetCatalogNodesOutput(ctx *Context, args *GetCatalogNodesOutputArgs, opts ...InvokeOption) GetCatalogNodesResultOutput
> 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)
}
public static CompletableFuture<GetCatalogNodesResult> getCatalogNodes(GetCatalogNodesArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: consul:index/getCatalogNodes:getCatalogNodes
arguments:
# arguments dictionary
The following arguments are supported:
- Query
Options List<GetCatalog Nodes Query Option> - See below.
- Query
Options []GetCatalog Nodes Query Option - See below.
- query
Options List<GetCatalog Nodes Query Option> - See below.
- query
Options GetCatalog Nodes Query Option[] - See below.
- query
Options List<Property Map> - See below.
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.
- Node
Ids List<string> - A list of the Consul node IDs.
- Node
Names List<string> - A list of the Consul node names.
- Nodes
List<Get
Catalog Nodes Node> - A list of nodes and details about each Consul agent. The list of per-node attributes is detailed below.
- Query
Options List<GetCatalog Nodes Query Option>
- Datacenter string
- The datacenter the keys are being read from to.
- Id string
- The provider-assigned unique ID for this managed resource.
- Node
Ids []string - A list of the Consul node IDs.
- Node
Names []string - A list of the Consul node names.
- Nodes
[]Get
Catalog Nodes Node - A list of nodes and details about each Consul agent. The list of per-node attributes is detailed below.
- Query
Options []GetCatalog Nodes Query Option
- datacenter String
- The datacenter the keys are being read from to.
- id String
- The provider-assigned unique ID for this managed resource.
- node
Ids List<String> - A list of the Consul node IDs.
- node
Names List<String> - A list of the Consul node names.
- nodes
List<Get
Catalog Nodes Node> - A list of nodes and details about each Consul agent. The list of per-node attributes is detailed below.
- query
Options List<GetCatalog Nodes Query Option>
- datacenter string
- The datacenter the keys are being read from to.
- id string
- The provider-assigned unique ID for this managed resource.
- node
Ids string[] - A list of the Consul node IDs.
- node
Names string[] - A list of the Consul node names.
- nodes
Get
Catalog Nodes Node[] - A list of nodes and details about each Consul agent. The list of per-node attributes is detailed below.
- query
Options GetCatalog Nodes Query Option[]
- 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[Get
Catalog Nodes Node] - A list of nodes and details about each Consul agent. The list of per-node attributes is detailed below.
- query_
options Sequence[GetCatalog Nodes Query Option]
- datacenter String
- The datacenter the keys are being read from to.
- id String
- The provider-assigned unique ID for this managed resource.
- node
Ids List<String> - A list of the Consul node IDs.
- node
Names 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.
- query
Options List<Property Map>
Supporting Types
GetCatalogNodesNode
- 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
- Tagged
Addresses 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
- Tagged
Addresses 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
- tagged
Addresses 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
- tagged
Addresses {[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
- tagged
Addresses Map<String>
GetCatalogNodesQueryOption
- Allow
Stale 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, thedatacenter
value found in the Consul agent that this provider is configured to talk to then the datacenter in the provider setup. - Near string
- Node
Meta Dictionary<string, string> - Partition string
- 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 tofalse
. - 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. - Wait
Index int - Index number used to enable blocking queries.
- Wait
Time 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 string
- The Consul datacenter to query. Defaults to the
same value found in
query_options
parameter specified below, or if that is empty, thedatacenter
value found in the Consul agent that this provider is configured to talk to then the datacenter in the provider setup. - Near string
- Node
Meta map[string]string - Partition string
- 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 tofalse
. - 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. - Wait
Index int - Index number used to enable blocking queries.
- Wait
Time string - Max time the client should wait for a blocking query to return.
- allow
Stale 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, thedatacenter
value found in the Consul agent that this provider is configured to talk to then the datacenter in the provider setup. - near String
- node
Meta Map<String,String> - partition String
- require
Consistent Boolean - When
true
force the client to perform a read on at least quorum servers and verify the result is the same. Defaults tofalse
. - 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. - wait
Index Integer - Index number used to enable blocking queries.
- wait
Time String - Max time the client should wait for a blocking query to return.
- allow
Stale 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, thedatacenter
value found in the Consul agent that this provider is configured to talk to then the datacenter in the provider setup. - near string
- node
Meta {[key: string]: string} - partition string
- require
Consistent boolean - When
true
force the client to perform a read on at least quorum servers and verify the result is the same. Defaults tofalse
. - 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. - wait
Index number - Index number used to enable blocking queries.
- wait
Time 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, thedatacenter
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 tofalse
. - 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.
- allow
Stale 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, thedatacenter
value found in the Consul agent that this provider is configured to talk to then the datacenter in the provider setup. - near String
- node
Meta Map<String> - partition String
- require
Consistent Boolean - When
true
force the client to perform a read on at least quorum servers and verify the result is the same. Defaults tofalse
. - 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. - wait
Index Number - Index number used to enable blocking queries.
- wait
Time 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.