»Consul ACL Policies
Command: consul acl policy
The acl policy command is used to manage Consul's ACL policies.
It exposes commands for creating, updating, reading, deleting, and listing policies.
This command is available in Consul 1.4.0 and newer.
ACL policies may also be managed via the HTTP API.
Note: All of the example subcommands in this document will require a valid
Consul token with the appropriate permissions. Either set the
CONSUL_HTTP_TOKEN environment variable to the token's secret ID or pass the
secret ID as the value of the -token parameter.
»Usage
Usage: consul acl policy <subcommand>
For the exact documentation for your Consul version, run consul acl policy -h to view the complete list of subcommands.
For more information, examples, and usage about a subcommand, click on the name of the subcommand in the sidebar.
»Identifying Policies
Several of the subcommands need to operate on a specific policy. Those
subcommands support specifying the policy by its ID using the -id parameter
or by name using the -name parameter.
When specifying the policy by its ID a unique policy ID prefix may be specified
instead of the entire UUID. As long as it is unique it will be resolved to the
full UUID and used. Additionally builtin policy names will be accepted as the
value to the -id parameter. Even if the builtin policies are renamed their
original name can be used to operate on them.
Builtin policies:
| Policy UUID | Policy Name |
|---|---|
| 00000000-0000-0000-0000-000000000001 | global-management |
»Basic Examples
Create a new ACL policy:
List all policies:
Update a policy:
Read a policy:
Delete a policy
