mirror of https://github.com/hashicorp/consul
82 lines
2.4 KiB
Plaintext
82 lines
2.4 KiB
Plaintext
|
---
|
||
|
|
layout: "docs"
|
||
|
|
page_title: "Commands: ACL Role Update"
|
||
|
|
sidebar_current: "docs-commands-acl-role-update"
|
||
|
|
---
|
||
|
|
|
||
|
|
# Consul ACL Role Update
|
||
|
|
|
||
|
|
Command: `consul acl role update`
|
||
|
|
|
||
|
|
The `acl role update` command is used to update a role. The default operations is to merge the
|
||
|
|
current role with those values provided to the command invocation. Therefore to
|
||
|
|
update just one field, only the `-id` or `-name` options and the option to
|
||
|
|
modify must be provided. Note that renaming roles requires both the `-id` and
|
||
|
|
`-name` as the new name cannot yet be used to lookup the role.
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
Usage: `consul acl role update [options] [args]`
|
||
|
|
|
||
|
|
#### API Options
|
||
|
|
|
||
|
|
<%= partial "docs/commands/http_api_options_client" %>
|
||
|
|
<%= partial "docs/commands/http_api_options_server" %>
|
||
|
|
|
||
|
|
#### Command Options
|
||
|
|
|
||
|
|
* `-description=<string>` - A description of the role.
|
||
|
|
|
||
|
|
* `-id=<string>` - The ID of the role to update. It may be specified as a
|
||
|
|
unique ID prefix but will error if the prefix matches multiple role IDs
|
||
|
|
|
||
|
|
* `-meta` - Indicates that role metadata such as the content hash and raft
|
||
|
|
indices should be shown for each entry
|
||
|
|
|
||
|
|
* `-name=<string>` - The role name.
|
||
|
|
|
||
|
|
* `-no-merge` - Do not merge the current role information with what is provided
|
||
|
|
to the command. Instead overwrite all fields with the exception of the role
|
||
|
|
ID which is immutable.
|
||
|
|
|
||
|
|
* `-policy-id=<value>` - ID of a policy to use for this role. May be specified
|
||
|
|
multiple times
|
||
|
|
|
||
|
|
* `-policy-name=<value>` - Name of a policy to use for this role. May be
|
||
|
|
specified multiple times
|
||
|
|
|
||
|
|
* `-service-identity=<value>` - Name of a service identity to use for this
|
||
|
|
role. May be specified multiple times. Format is the `SERVICENAME` or
|
||
|
|
`SERVICENAME:DATACENTER1,DATACENTER2,...`
|
||
|
|
|
||
|
|
## Examples
|
||
|
|
|
||
|
|
Update a role:
|
||
|
|
|
||
|
|
```sh
|
||
|
|
$ consul acl role update -id 57147d87-6bf7-f794-1a6e-7d038c4e4ae9 \
|
||
|
|
-description 'web crawler updated role' -service-identity 'crawler'
|
||
|
|
Role updated successfully
|
||
|
|
ID: 57147d87-6bf7-f794-1a6e-7d038c4e4ae9
|
||
|
|
Name: crawler
|
||
|
|
Description: web crawler updated role
|
||
|
|
Policies:
|
||
|
|
2f8f99c7-edd9-2f09-7e4b-a1f519eb4fc2 - crawler-kv
|
||
|
|
Service Identities:
|
||
|
|
crawler (Datacenters: all)
|
||
|
|
```
|
||
|
|
|
||
|
|
Rename a role by prefix:
|
||
|
|
|
||
|
|
```sh
|
||
|
|
$ consul acl role update -id 57147 -name web-crawler
|
||
|
|
Role updated successfully
|
||
|
|
ID: 57147d87-6bf7-f794-1a6e-7d038c4e4ae9
|
||
|
|
Name: web-crawler
|
||
|
|
Description: web crawler updated role
|
||
|
|
Policies:
|
||
|
|
2f8f99c7-edd9-2f09-7e4b-a1f519eb4fc2 - crawler-kv
|
||
|
|
Service Identities:
|
||
|
|
crawler (Datacenters: all)
|
||
|
|
```
|