Consul v3.12.5 published on Tuesday, Apr 29, 2025 by Pulumi
consul.getAgentSelf
Explore with Pulumi AI
Warning: The
consul.getAgentSelfresource has been deprecated and will be removed from a future release of the provider. Read the upgrade instructions for more information.
The consul.getAgentSelf data source returns
configuration and status data
from the agent specified in the provider.
Example Usage
Coming soon!
Coming soon!
Coming soon!
Coming soon!
Coming soon!
resources:
# Set the description to a whitespace delimited list of the services
app:
type: example:resource
properties:
description: Consul datacenter ${["read-dc1-agent"].datacenter}
variables:
read-dc1-agent:
fn::invoke:
function: consul:getAgentSelf
arguments:
queryOptions:
- datacenter: dc1
Using getAgentSelf
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 getAgentSelf(opts?: InvokeOptions): Promise<GetAgentSelfResult>
function getAgentSelfOutput(opts?: InvokeOptions): Output<GetAgentSelfResult>def get_agent_self(opts: Optional[InvokeOptions] = None) -> GetAgentSelfResult
def get_agent_self_output(opts: Optional[InvokeOptions] = None) -> Output[GetAgentSelfResult]func GetAgentSelf(ctx *Context, opts ...InvokeOption) (*GetAgentSelfResult, error)
func GetAgentSelfOutput(ctx *Context, opts ...InvokeOption) GetAgentSelfResultOutput> Note: This function is named GetAgentSelf in the Go SDK.
public static class GetAgentSelf
{
public static Task<GetAgentSelfResult> InvokeAsync(InvokeOptions? opts = null)
public static Output<GetAgentSelfResult> Invoke(InvokeOptions? opts = null)
}public static CompletableFuture<GetAgentSelfResult> getAgentSelf(InvokeOptions options)
public static Output<GetAgentSelfResult> getAgentSelf(InvokeOptions options)
fn::invoke:
function: consul:index/getAgentSelf:getAgentSelf
arguments:
# arguments dictionarygetAgentSelf Result
The following output properties are available:
- Acl
Datacenter string - Acl
Default stringPolicy - Acl
Disabled stringTtl - Acl
Down stringPolicy - Acl
Enforce08Semantics bool - Acl
Ttl string - Addresses Dictionary<string, string>
- Advertise
Addr string - Advertise
Addr stringWan - Advertise
Addrs Dictionary<string, string> - Atlas
Join bool - Bind
Addr string - Bootstrap
Expect int - Bootstrap
Mode bool - Check
Deregister stringInterval Min - Check
Reap stringInterval - Check
Update stringInterval - Client
Addr string - Data
Dir string - Datacenter string
- Dev
Mode bool - Dns Dictionary<string, string>
- A map of DNS configuration attributes. See below for details on the
contents of the
dnsattribute.dns_recursors- A list of all DNS recursors.data_dirdatacenterdev_modedomainenable_anonymous_signature
- Dns
Recursors List<string> - Domain string
- Enable
Anonymous boolSignature - Enable
Coordinates bool enable_debugenable_remote_execenable_syslogenable_uienable_update_checkidleave_on_intleave_on_termlog_levelnameperformancepid_fileportsprotocol_versionreconnect_timeout_lanreconnect_timeout_wanrejoin_after_leaveretry_joinretry_join_ec2- A map of EC2 retry attributes. See below for details on the available information.retry_join_gce- A map of GCE retry attributes. See below for details on the available information.retry_join_wanretry_max_attemptsretry_max_attempts_wanserf_lan_bind_addrserf_wan_bind_addrserver_modeserver_namesession_ttl_minstart_joinstart_join_wansyslog_facilitytls_ca_filetls_cert_filetls_key_filetls_min_versiontls_verify_incomingtls_verify_outgoingtls_verify_server_hostnametagged_addressestelemetry- A map of telemetry configuration.translate_wan_addrsui_dirunix_sockets
- Enable
Debug bool - Enable
Remote boolExec - Enable
Syslog bool - Enable
Ui bool - Enable
Update boolCheck - Id string
- Leave
On boolInt - Leave
On boolTerm - Log
Level string - Name string
- Performance Dictionary<string, string>
- Pid
File string - Ports Dictionary<string, int>
- Protocol
Version int - Reconnect
Timeout stringLan - Reconnect
Timeout stringWan - Rejoin
After boolLeave - Retry
Join Dictionary<string, string>Ec2 - Retry
Join Dictionary<string, string>Gce - Retry
Join List<string>Wans - Retry
Joins List<string> - Retry
Max intAttempts - Retry
Max intAttempts Wan - Serf
Lan stringBind Addr - Serf
Wan stringBind Addr - Server
Mode bool - Server
Name string - Session
Ttl stringMin - Start
Join List<string>Wans - Start
Joins List<string> - Syslog
Facility string - Tagged
Addresses Dictionary<string, string> - Telemetry Dictionary<string, string>
- Tls
Ca stringFile - Tls
Cert stringFile - Tls
Key stringFile - Tls
Min stringVersion - Tls
Verify boolIncoming - Tls
Verify boolOutgoing - Tls
Verify boolServer Hostname - Translate
Wan boolAddrs - Ui
Dir string - Unix
Sockets Dictionary<string, string> - Version string
- The version of the Consul agent.
- Version
Prerelease string - Version
Revision string
- Acl
Datacenter string - Acl
Default stringPolicy - Acl
Disabled stringTtl - Acl
Down stringPolicy - Acl
Enforce08Semantics bool - Acl
Ttl string - Addresses map[string]string
- Advertise
Addr string - Advertise
Addr stringWan - Advertise
Addrs map[string]string - Atlas
Join bool - Bind
Addr string - Bootstrap
Expect int - Bootstrap
Mode bool - Check
Deregister stringInterval Min - Check
Reap stringInterval - Check
Update stringInterval - Client
Addr string - Data
Dir string - Datacenter string
- Dev
Mode bool - Dns map[string]string
- A map of DNS configuration attributes. See below for details on the
contents of the
dnsattribute.dns_recursors- A list of all DNS recursors.data_dirdatacenterdev_modedomainenable_anonymous_signature
- Dns
Recursors []string - Domain string
- Enable
Anonymous boolSignature - Enable
Coordinates bool enable_debugenable_remote_execenable_syslogenable_uienable_update_checkidleave_on_intleave_on_termlog_levelnameperformancepid_fileportsprotocol_versionreconnect_timeout_lanreconnect_timeout_wanrejoin_after_leaveretry_joinretry_join_ec2- A map of EC2 retry attributes. See below for details on the available information.retry_join_gce- A map of GCE retry attributes. See below for details on the available information.retry_join_wanretry_max_attemptsretry_max_attempts_wanserf_lan_bind_addrserf_wan_bind_addrserver_modeserver_namesession_ttl_minstart_joinstart_join_wansyslog_facilitytls_ca_filetls_cert_filetls_key_filetls_min_versiontls_verify_incomingtls_verify_outgoingtls_verify_server_hostnametagged_addressestelemetry- A map of telemetry configuration.translate_wan_addrsui_dirunix_sockets
- Enable
Debug bool - Enable
Remote boolExec - Enable
Syslog bool - Enable
Ui bool - Enable
Update boolCheck - Id string
- Leave
On boolInt - Leave
On boolTerm - Log
Level string - Name string
- Performance map[string]string
- Pid
File string - Ports map[string]int
- Protocol
Version int - Reconnect
Timeout stringLan - Reconnect
Timeout stringWan - Rejoin
After boolLeave - Retry
Join map[string]stringEc2 - Retry
Join map[string]stringGce - Retry
Join []stringWans - Retry
Joins []string - Retry
Max intAttempts - Retry
Max intAttempts Wan - Serf
Lan stringBind Addr - Serf
Wan stringBind Addr - Server
Mode bool - Server
Name string - Session
Ttl stringMin - Start
Join []stringWans - Start
Joins []string - Syslog
Facility string - Tagged
Addresses map[string]string - Telemetry map[string]string
- Tls
Ca stringFile - Tls
Cert stringFile - Tls
Key stringFile - Tls
Min stringVersion - Tls
Verify boolIncoming - Tls
Verify boolOutgoing - Tls
Verify boolServer Hostname - Translate
Wan boolAddrs - Ui
Dir string - Unix
Sockets map[string]string - Version string
- The version of the Consul agent.
- Version
Prerelease string - Version
Revision string
- acl
Datacenter String - acl
Default StringPolicy - acl
Disabled StringTtl - acl
Down StringPolicy - acl
Enforce08Semantics Boolean - acl
Ttl String - addresses Map<String,String>
- advertise
Addr String - advertise
Addr StringWan - advertise
Addrs Map<String,String> - atlas
Join Boolean - bind
Addr String - bootstrap
Expect Integer - bootstrap
Mode Boolean - check
Deregister StringInterval Min - check
Reap StringInterval - check
Update StringInterval - client
Addr String - data
Dir String - datacenter String
- dev
Mode Boolean - dns Map<String,String>
- A map of DNS configuration attributes. See below for details on the
contents of the
dnsattribute.dns_recursors- A list of all DNS recursors.data_dirdatacenterdev_modedomainenable_anonymous_signature
- dns
Recursors List<String> - domain String
- enable
Anonymous BooleanSignature - enable
Coordinates Boolean enable_debugenable_remote_execenable_syslogenable_uienable_update_checkidleave_on_intleave_on_termlog_levelnameperformancepid_fileportsprotocol_versionreconnect_timeout_lanreconnect_timeout_wanrejoin_after_leaveretry_joinretry_join_ec2- A map of EC2 retry attributes. See below for details on the available information.retry_join_gce- A map of GCE retry attributes. See below for details on the available information.retry_join_wanretry_max_attemptsretry_max_attempts_wanserf_lan_bind_addrserf_wan_bind_addrserver_modeserver_namesession_ttl_minstart_joinstart_join_wansyslog_facilitytls_ca_filetls_cert_filetls_key_filetls_min_versiontls_verify_incomingtls_verify_outgoingtls_verify_server_hostnametagged_addressestelemetry- A map of telemetry configuration.translate_wan_addrsui_dirunix_sockets
- enable
Debug Boolean - enable
Remote BooleanExec - enable
Syslog Boolean - enable
Ui Boolean - enable
Update BooleanCheck - id String
- leave
On BooleanInt - leave
On BooleanTerm - log
Level String - name String
- performance Map<String,String>
- pid
File String - ports Map<String,Integer>
- protocol
Version Integer - reconnect
Timeout StringLan - reconnect
Timeout StringWan - rejoin
After BooleanLeave - retry
Join Map<String,String>Ec2 - retry
Join Map<String,String>Gce - retry
Join List<String>Wans - retry
Joins List<String> - retry
Max IntegerAttempts - retry
Max IntegerAttempts Wan - serf
Lan StringBind Addr - serf
Wan StringBind Addr - server
Mode Boolean - server
Name String - session
Ttl StringMin - start
Join List<String>Wans - start
Joins List<String> - syslog
Facility String - tagged
Addresses Map<String,String> - telemetry Map<String,String>
- tls
Ca StringFile - tls
Cert StringFile - tls
Key StringFile - tls
Min StringVersion - tls
Verify BooleanIncoming - tls
Verify BooleanOutgoing - tls
Verify BooleanServer Hostname - translate
Wan BooleanAddrs - ui
Dir String - unix
Sockets Map<String,String> - version String
- The version of the Consul agent.
- version
Prerelease String - version
Revision String
- acl
Datacenter string - acl
Default stringPolicy - acl
Disabled stringTtl - acl
Down stringPolicy - acl
Enforce08Semantics boolean - acl
Ttl string - addresses {[key: string]: string}
- advertise
Addr string - advertise
Addr stringWan - advertise
Addrs {[key: string]: string} - atlas
Join boolean - bind
Addr string - bootstrap
Expect number - bootstrap
Mode boolean - check
Deregister stringInterval Min - check
Reap stringInterval - check
Update stringInterval - client
Addr string - data
Dir string - datacenter string
- dev
Mode boolean - dns {[key: string]: string}
- A map of DNS configuration attributes. See below for details on the
contents of the
dnsattribute.dns_recursors- A list of all DNS recursors.data_dirdatacenterdev_modedomainenable_anonymous_signature
- dns
Recursors string[] - domain string
- enable
Anonymous booleanSignature - enable
Coordinates boolean enable_debugenable_remote_execenable_syslogenable_uienable_update_checkidleave_on_intleave_on_termlog_levelnameperformancepid_fileportsprotocol_versionreconnect_timeout_lanreconnect_timeout_wanrejoin_after_leaveretry_joinretry_join_ec2- A map of EC2 retry attributes. See below for details on the available information.retry_join_gce- A map of GCE retry attributes. See below for details on the available information.retry_join_wanretry_max_attemptsretry_max_attempts_wanserf_lan_bind_addrserf_wan_bind_addrserver_modeserver_namesession_ttl_minstart_joinstart_join_wansyslog_facilitytls_ca_filetls_cert_filetls_key_filetls_min_versiontls_verify_incomingtls_verify_outgoingtls_verify_server_hostnametagged_addressestelemetry- A map of telemetry configuration.translate_wan_addrsui_dirunix_sockets
- enable
Debug boolean - enable
Remote booleanExec - enable
Syslog boolean - enable
Ui boolean - enable
Update booleanCheck - id string
- leave
On booleanInt - leave
On booleanTerm - log
Level string - name string
- performance {[key: string]: string}
- pid
File string - ports {[key: string]: number}
- protocol
Version number - reconnect
Timeout stringLan - reconnect
Timeout stringWan - rejoin
After booleanLeave - retry
Join {[key: string]: string}Ec2 - retry
Join {[key: string]: string}Gce - retry
Join string[]Wans - retry
Joins string[] - retry
Max numberAttempts - retry
Max numberAttempts Wan - serf
Lan stringBind Addr - serf
Wan stringBind Addr - server
Mode boolean - server
Name string - session
Ttl stringMin - start
Join string[]Wans - start
Joins string[] - syslog
Facility string - tagged
Addresses {[key: string]: string} - telemetry {[key: string]: string}
- tls
Ca stringFile - tls
Cert stringFile - tls
Key stringFile - tls
Min stringVersion - tls
Verify booleanIncoming - tls
Verify booleanOutgoing - tls
Verify booleanServer Hostname - translate
Wan booleanAddrs - ui
Dir string - unix
Sockets {[key: string]: string} - version string
- The version of the Consul agent.
- version
Prerelease string - version
Revision string
- acl_
datacenter str - acl_
default_ strpolicy - acl_
disabled_ strttl - acl_
down_ strpolicy - acl_
enforce08_ boolsemantics - acl_
ttl str - addresses Mapping[str, str]
- advertise_
addr str - advertise_
addr_ strwan - advertise_
addrs Mapping[str, str] - atlas_
join bool - bind_
addr str - bootstrap_
expect int - bootstrap_
mode bool - check_
deregister_ strinterval_ min - check_
reap_ strinterval - check_
update_ strinterval - client_
addr str - data_
dir str - datacenter str
- dev_
mode bool - dns Mapping[str, str]
- A map of DNS configuration attributes. See below for details on the
contents of the
dnsattribute.dns_recursors- A list of all DNS recursors.data_dirdatacenterdev_modedomainenable_anonymous_signature
- dns_
recursors Sequence[str] - domain str
- enable_
anonymous_ boolsignature - enable_
coordinates bool enable_debugenable_remote_execenable_syslogenable_uienable_update_checkidleave_on_intleave_on_termlog_levelnameperformancepid_fileportsprotocol_versionreconnect_timeout_lanreconnect_timeout_wanrejoin_after_leaveretry_joinretry_join_ec2- A map of EC2 retry attributes. See below for details on the available information.retry_join_gce- A map of GCE retry attributes. See below for details on the available information.retry_join_wanretry_max_attemptsretry_max_attempts_wanserf_lan_bind_addrserf_wan_bind_addrserver_modeserver_namesession_ttl_minstart_joinstart_join_wansyslog_facilitytls_ca_filetls_cert_filetls_key_filetls_min_versiontls_verify_incomingtls_verify_outgoingtls_verify_server_hostnametagged_addressestelemetry- A map of telemetry configuration.translate_wan_addrsui_dirunix_sockets
- enable_
debug bool - enable_
remote_ boolexec - enable_
syslog bool - enable_
ui bool - enable_
update_ boolcheck - id str
- leave_
on_ boolint - leave_
on_ boolterm - log_
level str - name str
- performance Mapping[str, str]
- pid_
file str - ports Mapping[str, int]
- protocol_
version int - reconnect_
timeout_ strlan - reconnect_
timeout_ strwan - rejoin_
after_ boolleave - retry_
join_ Mapping[str, str]ec2 - retry_
join_ Mapping[str, str]gce - retry_
join_ Sequence[str]wans - retry_
joins Sequence[str] - retry_
max_ intattempts - retry_
max_ intattempts_ wan - serf_
lan_ strbind_ addr - serf_
wan_ strbind_ addr - server_
mode bool - server_
name str - session_
ttl_ strmin - start_
join_ Sequence[str]wans - start_
joins Sequence[str] - syslog_
facility str - tagged_
addresses Mapping[str, str] - telemetry Mapping[str, str]
- tls_
ca_ strfile - tls_
cert_ strfile - tls_
key_ strfile - tls_
min_ strversion - tls_
verify_ boolincoming - tls_
verify_ booloutgoing - tls_
verify_ boolserver_ hostname - translate_
wan_ booladdrs - ui_
dir str - unix_
sockets Mapping[str, str] - version str
- The version of the Consul agent.
- version_
prerelease str - version_
revision str
- acl
Datacenter String - acl
Default StringPolicy - acl
Disabled StringTtl - acl
Down StringPolicy - acl
Enforce08Semantics Boolean - acl
Ttl String - addresses Map<String>
- advertise
Addr String - advertise
Addr StringWan - advertise
Addrs Map<String> - atlas
Join Boolean - bind
Addr String - bootstrap
Expect Number - bootstrap
Mode Boolean - check
Deregister StringInterval Min - check
Reap StringInterval - check
Update StringInterval - client
Addr String - data
Dir String - datacenter String
- dev
Mode Boolean - dns Map<String>
- A map of DNS configuration attributes. See below for details on the
contents of the
dnsattribute.dns_recursors- A list of all DNS recursors.data_dirdatacenterdev_modedomainenable_anonymous_signature
- dns
Recursors List<String> - domain String
- enable
Anonymous BooleanSignature - enable
Coordinates Boolean enable_debugenable_remote_execenable_syslogenable_uienable_update_checkidleave_on_intleave_on_termlog_levelnameperformancepid_fileportsprotocol_versionreconnect_timeout_lanreconnect_timeout_wanrejoin_after_leaveretry_joinretry_join_ec2- A map of EC2 retry attributes. See below for details on the available information.retry_join_gce- A map of GCE retry attributes. See below for details on the available information.retry_join_wanretry_max_attemptsretry_max_attempts_wanserf_lan_bind_addrserf_wan_bind_addrserver_modeserver_namesession_ttl_minstart_joinstart_join_wansyslog_facilitytls_ca_filetls_cert_filetls_key_filetls_min_versiontls_verify_incomingtls_verify_outgoingtls_verify_server_hostnametagged_addressestelemetry- A map of telemetry configuration.translate_wan_addrsui_dirunix_sockets
- enable
Debug Boolean - enable
Remote BooleanExec - enable
Syslog Boolean - enable
Ui Boolean - enable
Update BooleanCheck - id String
- leave
On BooleanInt - leave
On BooleanTerm - log
Level String - name String
- performance Map<String>
- pid
File String - ports Map<Number>
- protocol
Version Number - reconnect
Timeout StringLan - reconnect
Timeout StringWan - rejoin
After BooleanLeave - retry
Join Map<String>Ec2 - retry
Join Map<String>Gce - retry
Join List<String>Wans - retry
Joins List<String> - retry
Max NumberAttempts - retry
Max NumberAttempts Wan - serf
Lan StringBind Addr - serf
Wan StringBind Addr - server
Mode Boolean - server
Name String - session
Ttl StringMin - start
Join List<String>Wans - start
Joins List<String> - syslog
Facility String - tagged
Addresses Map<String> - telemetry Map<String>
- tls
Ca StringFile - tls
Cert StringFile - tls
Key StringFile - tls
Min StringVersion - tls
Verify BooleanIncoming - tls
Verify BooleanOutgoing - tls
Verify BooleanServer Hostname - translate
Wan BooleanAddrs - ui
Dir String - unix
Sockets Map<String> - version String
- The version of the Consul agent.
- version
Prerelease String - version
Revision String
Package Details
- Repository
- HashiCorp Consul pulumi/pulumi-consul
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
consulTerraform Provider.