News HashiCorp to join IBM to accelerate multi-cloud automation. Read the blog →
Consul
Consul Home

You are viewing documentation for version v1.16.x. View latest version.

Consul ACL Policy Read

Command: consul acl policy read

Corresponding HTTP API Endpoints: [GET] /v1/acl/policy/:id, [GET] /v1/acl/policy/name/:name

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

The table below shows this command's required ACLs. Configuration of blocking queries and agent caching are not supported from commands, but may be from the corresponding HTTP endpoint.

ACL Required
acl:read

Usage

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

Command Options

  • -id=<string> - The ID of the policy to read. It may be specified as a unique ID prefix but will error if the prefix matches multiple policy IDs.

  • -meta - Indicates that policy metadata such as the content hash and raft indices should be shown for each entry.

  • -name=<string> - The name of the policy to read.

  • -format={pretty|json} - Command output format. The default value is pretty.

Enterprise Options

  • -partition=<string> - Specifies the partition to query. If not provided, the partition will be inferred from the request's ACL token, or will default to the default partition. Partitions are a Consul Enterprise feature added in v1.11.0.
  • -namespace=<string> - Specifies the namespace to query. If not provided, the namespace will be inferred from the request's ACL token, or will default to the default namespace. Namespaces are a Consul Enterprise feature added in v1.7.0.

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 policy details:

$ consul acl policy read -id 00000000-0000-0000-0000-000000000001ID:           00000000-0000-0000-0000-000000000001Name:         global-managementDescription:  Builtin Policy that grants unlimited accessDatacenters:Rules: acl = "write"agent_prefix "" {   policy = "write"}event_prefix "" {   policy = "write"}key_prefix "" {   policy = "write"}keyring = "write"node_prefix "" {   policy = "write"}operator = "write"query_prefix "" {   policy = "write"}service_prefix "" {   policy = "write"   intentions = "write"}session_prefix "" {   policy = "write"}

Get policy details by name:

$ consul acl policy read -name "acl-replication"ID:           35b8ecb0-707c-ee18-2002-81b238b54b38Name:         acl-replicationDescription:  Token capable of replicating ACL policiesDatacenters:Rules:acl = "read"

Get policy details (Builtin Policies):

Builtin policies can be accessed by specifying their original name as the value to the -id parameter.

$ consul acl policy read -id global-managementID:           00000000-0000-0000-0000-000000000001Name:         global-managementDescription:  Builtin Policy that grants unlimited accessDatacenters:Hash:         b30210b7aba9facd1c57891e3df27669174a08b690cb2905e0797535f75eba69Create Index: 4Modify Index: 4Rules: acl = "write"agent_prefix "" {   policy = "write"}event_prefix "" {   policy = "write"}key_prefix "" {   policy = "write"}keyring = "write"node_prefix "" {   policy = "write"}operator = "write"query_prefix "" {   policy = "write"}service_prefix "" {   policy = "write"   intentions = "write"}session_prefix "" {   policy = "write"}