open-consul/website/content/commands/acl/set-agent-token.mdx

62 lines
2.1 KiB
Plaintext
Raw Normal View History

2020-04-07 18:55:19 +00:00
---
layout: commands
2020-04-07 18:55:19 +00:00
page_title: 'Commands: ACL Set Agent Token'
---
# Consul ACL Set Agent Token
Command: `consul acl set-agent-token`
2022-01-11 13:26:58 +00:00
Corresponding HTTP API Endpoint: [\[PUT\] /v1/agent/token/:type](/api-docs/agent#update-acl-tokens)
2020-04-07 18:55:19 +00:00
This command updates the ACL tokens currently in use by the agent. It can be used to introduce
ACL tokens to the agent for the first time, or to update tokens that were initially loaded from
the agent's configuration. Tokens are not persisted unless
2022-01-11 01:30:50 +00:00
[`acl.enable_token_persistence`](/docs/agent/config/config-files#acl_enable_token_persistence)
is `true`, so tokens will need to be updated again if that option is `false` and
the agent is restarted.
2020-04-07 18:55:19 +00:00
2022-10-18 19:49:07 +00:00
The table below shows this command's [required ACLs](/api-docs/api-structure#authentication). Configuration of
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
are not supported from commands, but may be from the corresponding HTTP endpoint.
| ACL Required |
| ------------ |
| `acl:write` |
2020-04-07 18:55:19 +00:00
## Usage
Usage: `consul acl set-agent-token [options] token_type token_secret_id`
2020-04-07 18:55:19 +00:00
The token types are:
2020-04-07 18:55:19 +00:00
- `default` - The default token is the token that the agent will use for
both internal agent operations and operations initiated by the HTTP
and DNS interfaces when no specific token is provided. If not set the
agent will use the anonymous token.
- `agent` - The token that the agent will use for internal agent operations.
If not given then the default token is used for these operations.
- `recovery` - This sets the token that can be used to access the Agent APIs
in the event that the ACL datacenter cannot be reached. In Consul versions
prior to 1.11, this token type was called `agent_master`.
2020-04-07 18:55:19 +00:00
- `replication` - This is the token that the agent will use for replication
operations. This token will need to be configured with read access to
whatever data is being replicated.
### API Options
@include 'http_api_options_client.mdx'
2020-04-07 23:56:08 +00:00
2020-04-07 18:55:19 +00:00
@include 'http_api_options_server.mdx'
## Examples
Set the `default` token:
2020-05-19 18:32:38 +00:00
```shell-session
2020-04-07 18:55:19 +00:00
$ consul acl set-agent-token default c4d0f8df-3aba-4ab6-a7a0-35b760dc29a1
```