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:
- AclDatacenter string
- AclDefault stringPolicy 
- AclDisabled stringTtl 
- AclDown stringPolicy 
- AclEnforce08Semantics bool
- AclTtl string
- Addresses Dictionary<string, string>
- AdvertiseAddr string
- AdvertiseAddr stringWan 
- AdvertiseAddrs Dictionary<string, string>
- AtlasJoin bool
- BindAddr string
- BootstrapExpect int
- BootstrapMode bool
- CheckDeregister stringInterval Min 
- CheckReap stringInterval 
- CheckUpdate stringInterval 
- ClientAddr string
- DataDir string
- Datacenter string
- DevMode 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_dir
- datacenter
- dev_mode
- domain
- enable_anonymous_signature
 
- DnsRecursors List<string>
- Domain string
- EnableAnonymous boolSignature 
- EnableCoordinates bool
- enable_debug
- enable_remote_exec
- enable_syslog
- enable_ui
- enable_update_check
- id
- leave_on_int
- leave_on_term
- log_level
- name
- performance
- pid_file
- ports
- protocol_version
- reconnect_timeout_lan
- reconnect_timeout_wan
- rejoin_after_leave
- retry_join
- retry_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_wan
- retry_max_attempts
- retry_max_attempts_wan
- serf_lan_bind_addr
- serf_wan_bind_addr
- server_mode
- server_name
- session_ttl_min
- start_join
- start_join_wan
- syslog_facility
- tls_ca_file
- tls_cert_file
- tls_key_file
- tls_min_version
- tls_verify_incoming
- tls_verify_outgoing
- tls_verify_server_hostname
- tagged_addresses
- telemetry- A map of telemetry configuration.
- translate_wan_addrs
- ui_dir
- unix_sockets
 
- EnableDebug bool
- EnableRemote boolExec 
- EnableSyslog bool
- EnableUi bool
- EnableUpdate boolCheck 
- Id string
- LeaveOn boolInt 
- LeaveOn boolTerm 
- LogLevel string
- Name string
- Performance Dictionary<string, string>
- PidFile string
- Ports Dictionary<string, int>
- ProtocolVersion int
- ReconnectTimeout stringLan 
- ReconnectTimeout stringWan 
- RejoinAfter boolLeave 
- RetryJoin Dictionary<string, string>Ec2 
- RetryJoin Dictionary<string, string>Gce 
- RetryJoin List<string>Wans 
- RetryJoins List<string>
- RetryMax intAttempts 
- RetryMax intAttempts Wan 
- SerfLan stringBind Addr 
- SerfWan stringBind Addr 
- ServerMode bool
- ServerName string
- SessionTtl stringMin 
- StartJoin List<string>Wans 
- StartJoins List<string>
- SyslogFacility string
- TaggedAddresses Dictionary<string, string>
- Telemetry Dictionary<string, string>
- TlsCa stringFile 
- TlsCert stringFile 
- TlsKey stringFile 
- TlsMin stringVersion 
- TlsVerify boolIncoming 
- TlsVerify boolOutgoing 
- TlsVerify boolServer Hostname 
- TranslateWan boolAddrs 
- UiDir string
- UnixSockets Dictionary<string, string>
- Version string
- The version of the Consul agent.
- VersionPrerelease string
- VersionRevision string
- AclDatacenter string
- AclDefault stringPolicy 
- AclDisabled stringTtl 
- AclDown stringPolicy 
- AclEnforce08Semantics bool
- AclTtl string
- Addresses map[string]string
- AdvertiseAddr string
- AdvertiseAddr stringWan 
- AdvertiseAddrs map[string]string
- AtlasJoin bool
- BindAddr string
- BootstrapExpect int
- BootstrapMode bool
- CheckDeregister stringInterval Min 
- CheckReap stringInterval 
- CheckUpdate stringInterval 
- ClientAddr string
- DataDir string
- Datacenter string
- DevMode 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_dir
- datacenter
- dev_mode
- domain
- enable_anonymous_signature
 
- DnsRecursors []string
- Domain string
- EnableAnonymous boolSignature 
- EnableCoordinates bool
- enable_debug
- enable_remote_exec
- enable_syslog
- enable_ui
- enable_update_check
- id
- leave_on_int
- leave_on_term
- log_level
- name
- performance
- pid_file
- ports
- protocol_version
- reconnect_timeout_lan
- reconnect_timeout_wan
- rejoin_after_leave
- retry_join
- retry_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_wan
- retry_max_attempts
- retry_max_attempts_wan
- serf_lan_bind_addr
- serf_wan_bind_addr
- server_mode
- server_name
- session_ttl_min
- start_join
- start_join_wan
- syslog_facility
- tls_ca_file
- tls_cert_file
- tls_key_file
- tls_min_version
- tls_verify_incoming
- tls_verify_outgoing
- tls_verify_server_hostname
- tagged_addresses
- telemetry- A map of telemetry configuration.
- translate_wan_addrs
- ui_dir
- unix_sockets
 
- EnableDebug bool
- EnableRemote boolExec 
- EnableSyslog bool
- EnableUi bool
- EnableUpdate boolCheck 
- Id string
- LeaveOn boolInt 
- LeaveOn boolTerm 
- LogLevel string
- Name string
- Performance map[string]string
- PidFile string
- Ports map[string]int
- ProtocolVersion int
- ReconnectTimeout stringLan 
- ReconnectTimeout stringWan 
- RejoinAfter boolLeave 
- RetryJoin map[string]stringEc2 
- RetryJoin map[string]stringGce 
- RetryJoin []stringWans 
- RetryJoins []string
- RetryMax intAttempts 
- RetryMax intAttempts Wan 
- SerfLan stringBind Addr 
- SerfWan stringBind Addr 
- ServerMode bool
- ServerName string
- SessionTtl stringMin 
- StartJoin []stringWans 
- StartJoins []string
- SyslogFacility string
- TaggedAddresses map[string]string
- Telemetry map[string]string
- TlsCa stringFile 
- TlsCert stringFile 
- TlsKey stringFile 
- TlsMin stringVersion 
- TlsVerify boolIncoming 
- TlsVerify boolOutgoing 
- TlsVerify boolServer Hostname 
- TranslateWan boolAddrs 
- UiDir string
- UnixSockets map[string]string
- Version string
- The version of the Consul agent.
- VersionPrerelease string
- VersionRevision string
- aclDatacenter String
- aclDefault StringPolicy 
- aclDisabled StringTtl 
- aclDown StringPolicy 
- aclEnforce08Semantics Boolean
- aclTtl String
- addresses Map<String,String>
- advertiseAddr String
- advertiseAddr StringWan 
- advertiseAddrs Map<String,String>
- atlasJoin Boolean
- bindAddr String
- bootstrapExpect Integer
- bootstrapMode Boolean
- checkDeregister StringInterval Min 
- checkReap StringInterval 
- checkUpdate StringInterval 
- clientAddr String
- dataDir String
- datacenter String
- devMode 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_dir
- datacenter
- dev_mode
- domain
- enable_anonymous_signature
 
- dnsRecursors List<String>
- domain String
- enableAnonymous BooleanSignature 
- enableCoordinates Boolean
- enable_debug
- enable_remote_exec
- enable_syslog
- enable_ui
- enable_update_check
- id
- leave_on_int
- leave_on_term
- log_level
- name
- performance
- pid_file
- ports
- protocol_version
- reconnect_timeout_lan
- reconnect_timeout_wan
- rejoin_after_leave
- retry_join
- retry_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_wan
- retry_max_attempts
- retry_max_attempts_wan
- serf_lan_bind_addr
- serf_wan_bind_addr
- server_mode
- server_name
- session_ttl_min
- start_join
- start_join_wan
- syslog_facility
- tls_ca_file
- tls_cert_file
- tls_key_file
- tls_min_version
- tls_verify_incoming
- tls_verify_outgoing
- tls_verify_server_hostname
- tagged_addresses
- telemetry- A map of telemetry configuration.
- translate_wan_addrs
- ui_dir
- unix_sockets
 
- enableDebug Boolean
- enableRemote BooleanExec 
- enableSyslog Boolean
- enableUi Boolean
- enableUpdate BooleanCheck 
- id String
- leaveOn BooleanInt 
- leaveOn BooleanTerm 
- logLevel String
- name String
- performance Map<String,String>
- pidFile String
- ports Map<String,Integer>
- protocolVersion Integer
- reconnectTimeout StringLan 
- reconnectTimeout StringWan 
- rejoinAfter BooleanLeave 
- retryJoin Map<String,String>Ec2 
- retryJoin Map<String,String>Gce 
- retryJoin List<String>Wans 
- retryJoins List<String>
- retryMax IntegerAttempts 
- retryMax IntegerAttempts Wan 
- serfLan StringBind Addr 
- serfWan StringBind Addr 
- serverMode Boolean
- serverName String
- sessionTtl StringMin 
- startJoin List<String>Wans 
- startJoins List<String>
- syslogFacility String
- taggedAddresses Map<String,String>
- telemetry Map<String,String>
- tlsCa StringFile 
- tlsCert StringFile 
- tlsKey StringFile 
- tlsMin StringVersion 
- tlsVerify BooleanIncoming 
- tlsVerify BooleanOutgoing 
- tlsVerify BooleanServer Hostname 
- translateWan BooleanAddrs 
- uiDir String
- unixSockets Map<String,String>
- version String
- The version of the Consul agent.
- versionPrerelease String
- versionRevision String
- aclDatacenter string
- aclDefault stringPolicy 
- aclDisabled stringTtl 
- aclDown stringPolicy 
- aclEnforce08Semantics boolean
- aclTtl string
- addresses {[key: string]: string}
- advertiseAddr string
- advertiseAddr stringWan 
- advertiseAddrs {[key: string]: string}
- atlasJoin boolean
- bindAddr string
- bootstrapExpect number
- bootstrapMode boolean
- checkDeregister stringInterval Min 
- checkReap stringInterval 
- checkUpdate stringInterval 
- clientAddr string
- dataDir string
- datacenter string
- devMode 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_dir
- datacenter
- dev_mode
- domain
- enable_anonymous_signature
 
- dnsRecursors string[]
- domain string
- enableAnonymous booleanSignature 
- enableCoordinates boolean
- enable_debug
- enable_remote_exec
- enable_syslog
- enable_ui
- enable_update_check
- id
- leave_on_int
- leave_on_term
- log_level
- name
- performance
- pid_file
- ports
- protocol_version
- reconnect_timeout_lan
- reconnect_timeout_wan
- rejoin_after_leave
- retry_join
- retry_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_wan
- retry_max_attempts
- retry_max_attempts_wan
- serf_lan_bind_addr
- serf_wan_bind_addr
- server_mode
- server_name
- session_ttl_min
- start_join
- start_join_wan
- syslog_facility
- tls_ca_file
- tls_cert_file
- tls_key_file
- tls_min_version
- tls_verify_incoming
- tls_verify_outgoing
- tls_verify_server_hostname
- tagged_addresses
- telemetry- A map of telemetry configuration.
- translate_wan_addrs
- ui_dir
- unix_sockets
 
- enableDebug boolean
- enableRemote booleanExec 
- enableSyslog boolean
- enableUi boolean
- enableUpdate booleanCheck 
- id string
- leaveOn booleanInt 
- leaveOn booleanTerm 
- logLevel string
- name string
- performance {[key: string]: string}
- pidFile string
- ports {[key: string]: number}
- protocolVersion number
- reconnectTimeout stringLan 
- reconnectTimeout stringWan 
- rejoinAfter booleanLeave 
- retryJoin {[key: string]: string}Ec2 
- retryJoin {[key: string]: string}Gce 
- retryJoin string[]Wans 
- retryJoins string[]
- retryMax numberAttempts 
- retryMax numberAttempts Wan 
- serfLan stringBind Addr 
- serfWan stringBind Addr 
- serverMode boolean
- serverName string
- sessionTtl stringMin 
- startJoin string[]Wans 
- startJoins string[]
- syslogFacility string
- taggedAddresses {[key: string]: string}
- telemetry {[key: string]: string}
- tlsCa stringFile 
- tlsCert stringFile 
- tlsKey stringFile 
- tlsMin stringVersion 
- tlsVerify booleanIncoming 
- tlsVerify booleanOutgoing 
- tlsVerify booleanServer Hostname 
- translateWan booleanAddrs 
- uiDir string
- unixSockets {[key: string]: string}
- version string
- The version of the Consul agent.
- versionPrerelease string
- versionRevision 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_dir
- datacenter
- dev_mode
- domain
- enable_anonymous_signature
 
- dns_recursors Sequence[str]
- domain str
- enable_anonymous_ boolsignature 
- enable_coordinates bool
- enable_debug
- enable_remote_exec
- enable_syslog
- enable_ui
- enable_update_check
- id
- leave_on_int
- leave_on_term
- log_level
- name
- performance
- pid_file
- ports
- protocol_version
- reconnect_timeout_lan
- reconnect_timeout_wan
- rejoin_after_leave
- retry_join
- retry_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_wan
- retry_max_attempts
- retry_max_attempts_wan
- serf_lan_bind_addr
- serf_wan_bind_addr
- server_mode
- server_name
- session_ttl_min
- start_join
- start_join_wan
- syslog_facility
- tls_ca_file
- tls_cert_file
- tls_key_file
- tls_min_version
- tls_verify_incoming
- tls_verify_outgoing
- tls_verify_server_hostname
- tagged_addresses
- telemetry- A map of telemetry configuration.
- translate_wan_addrs
- ui_dir
- unix_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
- aclDatacenter String
- aclDefault StringPolicy 
- aclDisabled StringTtl 
- aclDown StringPolicy 
- aclEnforce08Semantics Boolean
- aclTtl String
- addresses Map<String>
- advertiseAddr String
- advertiseAddr StringWan 
- advertiseAddrs Map<String>
- atlasJoin Boolean
- bindAddr String
- bootstrapExpect Number
- bootstrapMode Boolean
- checkDeregister StringInterval Min 
- checkReap StringInterval 
- checkUpdate StringInterval 
- clientAddr String
- dataDir String
- datacenter String
- devMode 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_dir
- datacenter
- dev_mode
- domain
- enable_anonymous_signature
 
- dnsRecursors List<String>
- domain String
- enableAnonymous BooleanSignature 
- enableCoordinates Boolean
- enable_debug
- enable_remote_exec
- enable_syslog
- enable_ui
- enable_update_check
- id
- leave_on_int
- leave_on_term
- log_level
- name
- performance
- pid_file
- ports
- protocol_version
- reconnect_timeout_lan
- reconnect_timeout_wan
- rejoin_after_leave
- retry_join
- retry_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_wan
- retry_max_attempts
- retry_max_attempts_wan
- serf_lan_bind_addr
- serf_wan_bind_addr
- server_mode
- server_name
- session_ttl_min
- start_join
- start_join_wan
- syslog_facility
- tls_ca_file
- tls_cert_file
- tls_key_file
- tls_min_version
- tls_verify_incoming
- tls_verify_outgoing
- tls_verify_server_hostname
- tagged_addresses
- telemetry- A map of telemetry configuration.
- translate_wan_addrs
- ui_dir
- unix_sockets
 
- enableDebug Boolean
- enableRemote BooleanExec 
- enableSyslog Boolean
- enableUi Boolean
- enableUpdate BooleanCheck 
- id String
- leaveOn BooleanInt 
- leaveOn BooleanTerm 
- logLevel String
- name String
- performance Map<String>
- pidFile String
- ports Map<Number>
- protocolVersion Number
- reconnectTimeout StringLan 
- reconnectTimeout StringWan 
- rejoinAfter BooleanLeave 
- retryJoin Map<String>Ec2 
- retryJoin Map<String>Gce 
- retryJoin List<String>Wans 
- retryJoins List<String>
- retryMax NumberAttempts 
- retryMax NumberAttempts Wan 
- serfLan StringBind Addr 
- serfWan StringBind Addr 
- serverMode Boolean
- serverName String
- sessionTtl StringMin 
- startJoin List<String>Wans 
- startJoins List<String>
- syslogFacility String
- taggedAddresses Map<String>
- telemetry Map<String>
- tlsCa StringFile 
- tlsCert StringFile 
- tlsKey StringFile 
- tlsMin StringVersion 
- tlsVerify BooleanIncoming 
- tlsVerify BooleanOutgoing 
- tlsVerify BooleanServer Hostname 
- translateWan BooleanAddrs 
- uiDir String
- unixSockets Map<String>
- version String
- The version of the Consul agent.
- versionPrerelease String
- versionRevision String
Package Details
- Repository
- HashiCorp Consul pulumi/pulumi-consul
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the consulTerraform Provider.