consul/website/content/commands/acl/binding-rule/update.mdx

80 lines
2.5 KiB
Plaintext
Raw Normal View History

---
layout: commands
2020-04-07 18:55:19 +00:00
page_title: 'Commands: ACL Binding Rule Update'
---
# Consul ACL Binding Rule Update
Command: `consul acl binding-rule update`
2022-01-11 13:26:58 +00:00
Corresponding HTTP API Endpoint: [\[PUT\] /v1/acl/binding-rule/:id](/api-docs/acl/binding-rules#update-a-binding-rule)
The `acl binding-rule update` command is used to update a binding rule. The
default operations is to merge the current binding rule with those values
provided to the command invocation. Therefore to update just one field, only
the `-id` option and the option to modify must be provided.
The table below shows this command's [required ACLs](/api#authentication). Configuration of
[blocking queries](/api/features/blocking) and [agent caching](/api/features/caching)
are not supported from commands, but may be from the corresponding HTTP endpoint.
| ACL Required |
| ------------ |
| `acl:write` |
## Usage
Usage: `consul acl binding-rule update [options] [args]`
#### API Options
2020-04-07 18:55:19 +00:00
@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'
#### Command Options
2020-04-07 18:55:19 +00:00
- `-bind-name=<string>` - Name to bind on match. Can use `${var}`
interpolation. This flag is required.
2020-04-07 18:55:19 +00:00
- `-bind-type=<string>` - Type of binding to perform (`"service"` or `"role"`).
2020-04-07 18:55:19 +00:00
- `-description=<string>` - A description of the binding rule.
2020-04-07 18:55:19 +00:00
- `-id=<string>` - The ID of the binding rule to update. It may be specified as a
unique ID prefix but will error if the prefix matches multiple binding rule IDs
2020-04-07 18:55:19 +00:00
- `-meta` - Indicates that binding rule metadata such as the raft
indices should be shown for each entry.
2020-04-07 18:55:19 +00:00
- `-no-merge` - Do not merge the current binding rule information with what is
provided to the command. Instead overwrite all fields with the exception of the
binding rule ID which is immutable.
2020-04-07 18:55:19 +00:00
- `-selector=<string>` - Selector is an expression that matches against
verified identity attributes returned from the auth method during login.
2020-04-07 18:55:19 +00:00
- `-format={pretty|json}` - Command output format. The default value is `pretty`.
#### Enterprise Options
2020-04-07 18:55:19 +00:00
@include 'http_api_namespace_options.mdx'
@include 'http_api_partition_options.mdx'
## Examples
Update a binding rule:
2020-05-19 18:32:38 +00:00
```shell-session
$ consul acl binding-rule update -id '0ec1bd2f-1d3b-bafb-d9bf-90ef04ab1890' \
-selector 'serviceaccount.namespace==default'
Binding rule updated successfully
ID: 0ec1bd2f-1d3b-bafb-d9bf-90ef04ab1890
AuthMethod: minikube
Description: wildcard service
BindType: service
BindName: k8s-${serviceaccount.name}
Selector: serviceaccount.namespace==default
```