open-consul/website/content/commands/acl/translate-rules.mdx

81 lines
2.2 KiB
Plaintext
Raw Normal View History

---
layout: commands
2020-04-07 18:55:19 +00:00
page_title: 'Commands: ACL Translate Rules'
---
-> **Deprecated:** This command exists only as a convenience to make legacy ACL migration easier.
It will be removed in a future major release when support for the legacy ACL system is removed.
# Consul ACL Translate Rules
Command: `consul acl translate-rules`
2022-01-11 13:26:58 +00:00
Corresponding HTTP API Endpoint: [\[GET\] /v1/acl/rules/translate/:accessor_id](/api-docs/acl#translate-a-legacy-token-s-rules)
This command translates the legacy ACL rule syntax into the new syntax.
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:read` |
### Usage
Usage: `consul acl translate-rules [options] TRANSLATE`
#### Command Options
2020-04-07 18:55:19 +00:00
- `TRANSLATE` - The rules to translate. If `-` is used, then
the rules will be read from stdin. If `@` is prefixed to
the value then the value is considered to be a file and
the rules will be read from that file.
2020-04-07 18:55:19 +00:00
- `-token-secret` - Specifies that what the `TRANSLATE` argument
holds is not a rule set but rather the token secret ID of a
legacy ACL token that holds the rule set.
2020-04-07 18:55:19 +00:00
- `-token-accessor` - Specifies that what the `TRANSLATE` argument
holds is not a rule set but rather the token accessor ID of a
legacy ACL token that holds the rule set.
#### API Options
@include 'http_api_options_client.mdx'
@include 'http_api_options_server.mdx'
### Examples
2020-04-07 18:55:19 +00:00
Translate rules within a file:
2020-05-19 18:32:38 +00:00
```shell-session
$ consul acl translate-rules @rules.hcl
```
Translate rules from stdin:
2020-05-19 18:32:38 +00:00
```shell-session
$ consul acl translate-rules -
```
Translate rules from a string argument:
2020-05-19 18:32:38 +00:00
```shell-session
$ consul acl translate-rules 'key "" { policy = "write"}'
```
Translate rules for a legacy ACL token using its SecretID passed from stdin:
2020-05-19 18:32:38 +00:00
```shell-session
$ consul acl translate-rules --token-secret -
```
Translate rules for a legacy ACL token using its AccessorID:
2020-05-19 18:32:38 +00:00
```shell-session
$ consul acl translate-rules 429cd746-03d5-4bbb-a83a-18b164171c89
```