HashiConf 2024 Now streaming live from Boston! Attend for free
Consul
Consul Home

Consul ACL Templated Policy Read

Command: consul acl templated-policy read

Corresponding HTTP API Endpoint: [GET] /v1/acl/templated-policy/name/:name

The acl templated-policy read command reads and displays a templated policies details.

You must provide an ACL token with acl:read permissions to use the consul all templated-policy read command. The command does not support blocking queries and agent caching.

Usage

Usage: consul acl templated-policy read [options] [args]

Command options

  • -name: String value that specifies the name of the templated policy to read.

  • -format: String value that specifies the output format. You can specify pretty or json. The default value is pretty.

API options

  • -ca-file=<value> - Path to a CA file to use for TLS when communicating with Consul. This can also be specified via the CONSUL_CACERT environment variable.

  • -ca-path=<value> - Path to a directory of CA certificates to use for TLS when communicating with Consul. This can also be specified via the CONSUL_CAPATH environment variable.

  • -client-cert=<value> - Path to a client cert file to use for TLS when verify_incoming is enabled. This can also be specified via the CONSUL_CLIENT_CERT environment variable.

  • -client-key=<value> - Path to a client key file to use for TLS when verify_incoming is enabled. This can also be specified via the CONSUL_CLIENT_KEY environment variable.

  • -http-addr=<addr> - Address of the Consul agent with the port. This can be an IP address or DNS address, but it must include the port. This can also be specified via the CONSUL_HTTP_ADDR environment variable. In Consul 0.8 and later, the default value is http://127.0.0.1:8500, and https can optionally be used instead. The scheme can also be set to HTTPS by setting the environment variable CONSUL_HTTP_SSL=true. This may be a unix domain socket using unix:///path/to/socket if the agent is configured to listen that way.

  • -tls-server-name=<value> - The server name to use as the SNI host when connecting via TLS. This can also be specified via the CONSUL_TLS_SERVER_NAME environment variable.

  • -token=<value> - ACL token to use in the request. This can also be specified via the CONSUL_HTTP_TOKEN environment variable. If unspecified, the query will default to the token of the Consul agent at the HTTP address.

  • -token-file=<value> - File containing the ACL token to use in the request instead of one specified via the -token argument or CONSUL_HTTP_TOKEN environment variable. This can also be specified via the CONSUL_HTTP_TOKEN_FILE environment variable.

  • -datacenter=<name> - Name of the datacenter to query. If unspecified, the query will default to the datacenter of the Consul agent at the HTTP address.

  • -stale - Permit any Consul server (non-leader) to respond to this request. This allows for lower latency and higher throughput, but can result in stale data. This option has no effect on non-read operations. The default value is false.

Examples

Get templated policy details by name:

$ consul acl templated-policy read -name "builtin/service"
Name:            builtin/service
Input variables:
    Name: String - Required - The name of the service.
Example usage:
    consul acl token create -templated-policy builtin/service -var name:api
Edit this page on GitHub