HashiCorp Consul operations

Install

emisar pack install fetches this pack, re-validates it, and verifies its content hash against the --hash below — the exact bytes this page was rendered against, so a tampered copy is rejected — before copying it into the runner's packs dir. The command reloads a running daemon itself; no manual restart.

sudo emisar pack install consul --hash sha256:67e58e3d585892717a2005a8c08954dd27f49891f90852d7df1a11bb4b95dc58

• consul.acl_token_self exec low

  GET /v1/acl/token/self

  Show metadata on the runner's own token — accessor, policies, roles, expiration. The SecretID the API returns is redacted from the output.

  View source on GitHub
• consul.agent_checks exec low

  GET /v1/agent/checks

  List checks registered with the local agent + their current status.

  View source on GitHub
• consul.agent_host_info exec low

  GET /v1/agent/host

  Show host info: OS, CPU, memory, filesystem, network from the agent's view.

  View source on GitHub
• consul.agent_metrics exec low

  GET /v1/agent/metrics

  Show current runtime metrics gauges + counters.

  View source on GitHub
• consul.agent_self exec low

  GET /v1/agent/self

  Show this agent's effective config, runtime, member, and ACL state.

  View source on GitHub
• consul.agent_services exec low

  GET /v1/agent/services

  List the services registered with the local agent.

  View source on GitHub
• consul.autopilot_state exec low

  GET /v1/operator/autopilot/state

  Show the Autopilot view of cluster health: server stabilization, leader, failure tolerance.

  View source on GitHub
• consul.catalog_datacenters exec low

  GET /v1/catalog/datacenters

  List all WAN-federated datacenters known to this server.

  View source on GitHub
• consul.catalog_service exec low

  GET /v1/catalog/service/<name>

  List all instances of one service across the cluster.

  View source on GitHub
• consul.connect_ca_configuration exec low

  GET /v1/connect/ca/configuration

  Show CA provider configuration (which CA, intermediate cert TTL, etc). Provider secrets the config map may carry — the Vault provider's Token and the built-in provider's PrivateKey — are redacted from the output.

  View source on GitHub
• consul.connect_ca_roots exec low

  GET /v1/connect/ca/roots

  List currently-trusted root CAs for Connect mesh TLS.

  View source on GitHub
• consul.deregister_service exec high

  consul services deregister

  Removes one service registration from this agent.

  View source on GitHub
• consul.destroy_session exec high

  PUT /v1/session/destroy/<id>

  Destroys one session. Any locks held are released; KV entries with release behavior are unlocked.

  View source on GitHub
• consul.force_check_fail exec high

  PUT /v1/agent/check/fail/<check_id>

  Forces one check into CRITICAL state. Service discovery stops returning it.

  View source on GitHub
• consul.force_check_pass exec high

  PUT /v1/agent/check/pass/<check_id>

  Forces one TTL check into the PASSING state. The check stays passing until the next TTL expires.

  View source on GitHub
• consul.force_check_warn exec high

  PUT /v1/agent/check/warn/<check_id>

  Forces one check into WARNING state.

  View source on GitHub
• consul.intentions_list exec low

  GET /v1/connect/intentions

  List all Connect mesh intentions (allow/deny rules between services).

  View source on GitHub
• consul.intentions_match exec low

  GET /v1/connect/intentions/match (by destination)

  List all intentions whose destination is the named service. Use to answer "what can talk to X?".

  View source on GitHub
• consul.kv_get exec low

  consul kv get <key>

  Get the value at one KV key.

  View source on GitHub
• consul.kv_get_recursive exec low

  consul kv get -recurse <prefix>

  Get all keys + values under a prefix.

  View source on GitHub
• consul.kv_list exec low

  consul kv get -keys <prefix>

  List all KV keys under one prefix.

  View source on GitHub
• consul.leader exec low

  GET /v1/status/leader

  Show the current Raft leader address for this datacenter. Reads the status endpoint, which is not ACL-gated, so it answers "is there a leader?" even when no CONSUL_HTTP_TOKEN is set.

  View source on GitHub
• consul.list_acl_policies exec low

  consul acl policy list

  List all ACL policies.

  View source on GitHub
• consul.list_acl_roles exec low

  consul acl role list

  List all ACL roles (groups of policies).

  View source on GitHub
• consul.list_acl_tokens exec low

  consul acl token list

  List ACL tokens (descriptions + accessor IDs only, not secrets).

  View source on GitHub
• consul.list_checks_critical exec low

  GET /v1/health/state/critical

  List every check currently in CRITICAL state across the catalog.

  View source on GitHub
• consul.list_checks_warning exec low

  GET /v1/health/state/warning

  List every check currently in WARNING state.

  View source on GitHub
• consul.list_nodes exec low

  consul catalog nodes

  List all registered nodes.

  View source on GitHub
• consul.list_services exec low

  consul catalog services

  List all registered service names.

  View source on GitHub
• consul.list_sessions exec low

  GET /v1/session/list

  List active sessions cluster-wide: ID, node, TTL, behavior.

  View source on GitHub
• consul.members exec low

  consul members

  List all agents in the gossip pool with status, role, version.

  View source on GitHub
• consul.node_health exec low

  GET /v1/health/node/<node>

  List all checks for one node + their status.

  View source on GitHub
• consul.node_maintenance exec high

  consul maint -enable

  Enables maintenance mode on this agent's node. Health checks fail until disabled.

  View source on GitHub
• consul.node_services exec low

  GET /v1/catalog/node-services/<node>

  List all services registered against one node.

  View source on GitHub
• consul.prepared_queries_list exec low

  GET /v1/query

  List all defined prepared queries (named service-discovery templates with failover).

  View source on GitHub
• consul.raft_peers exec low

  consul operator raft list-peers

  List the server peers with voter status, suffix, address.

  View source on GitHub
• consul.raft_remove_peer exec critical

  consul operator raft remove-peer

  Forcibly removes a server from Raft. Use ONLY when a server is permanently gone and autopilot hasn't cleaned it up.

  View source on GitHub
• consul.reload exec high

  consul reload

  Reloads the local agent's config (re-reads HCL files). Some settings can't be reloaded — see consul docs.

  View source on GitHub
• consul.service_health exec low

  Health of a service's instances

  Show per-node health for one service.

  View source on GitHub
• consul.service_maintenance exec high

  consul maint -enable -service <svc>

  Puts one local-agent service into maintenance mode. Its checks report critical until disabled.

  View source on GitHub
• consul.service_passing_only exec low

  GET /v1/health/service/<name>?passing

  List only healthy (all-passing) instances of one service. What service discovery would return.

  View source on GitHub
• consul.snapshot_inspect exec low

  consul snapshot inspect <path>

  Show a summary of one snapshot file — size, index, KV count, ACL count.

  View source on GitHub
• consul.snapshot_restore exec critical

  consul snapshot restore <path>

  Restores cluster state from a snapshot. ALL existing state (KV, services, sessions, intentions, ACL) is REPLACED. Cluster briefly unavailable during restore.

  View source on GitHub
• consul.snapshot_save exec medium

  consul snapshot save <path>

  Writes a Raft snapshot to a local file. Use before risky operations + as a backup.

  View source on GitHub