2018-05-29 21:07:40 +00:00
---
2020-09-01 15:14:13 +00:00
layout: commands
2020-04-07 18:55:19 +00:00
page_title: 'Commands: Intention Match'
2023-01-26 18:42:13 +00:00
description: >-
The `consul intention match` command returns inbound and outbound service intentions for a specific service.
2018-05-29 21:07:40 +00:00
---
# Consul Intention Match
Command: `consul intention match`
2023-01-25 16:52:43 +00:00
Corresponding HTTP API Endpoint: [\[GET\] /v1/connect/intentions/match](/consul/api-docs/connect/intentions#list-matching-intentions)
2022-01-10 17:40:11 +00:00
2018-05-29 21:07:40 +00:00
The `intention match` command shows the list of intentions that match
a given source or destination. The list of intentions is listed in evaluation
order: the first intention that matches a request would be evaluated.
2023-01-25 16:52:43 +00:00
The [check](/consul/commands/intention/check) command can be used to
2020-10-14 15:23:05 +00:00
check whether an L4 connection would be authorized between any two services.
2018-05-29 21:07:40 +00:00
2023-01-25 16:52:43 +00:00
The table below shows this command's [required ACLs](/consul/api-docs/api-structure#authentication). Configuration of
[blocking queries](/consul/api-docs/features/blocking) and [agent caching](/consul/api-docs/features/caching)
2022-01-10 21:44:56 +00:00
are not supported from commands, but may be from the corresponding HTTP endpoint.
2022-01-11 14:41:54 +00:00
| ACL Required |
| ----------------------------- |
2023-03-24 22:16:06 +00:00
| `intentions:read`<p> Define intention rules in the `service` policy. Refer to [ACL requirements for intentions](/consul/docs/connect/intentions/create-manage-intentions#acl-requirements) for additional information.</p> |
2022-01-10 21:44:56 +00:00
2018-05-29 21:07:40 +00:00
## Usage
Usage: `consul intention match [options] SRC_OR_DST`
2023-01-25 16:52:43 +00:00
`SRC` and `DST` can both take [several forms](/consul/commands/intention#source-and-destination-naming).
2020-06-26 21:59:15 +00:00
2022-07-27 06:17:11 +00:00
#### Command Options
2018-05-29 21:07:40 +00:00
2022-07-27 06:17:11 +00:00
- `-destination` - Match by destination.
2018-05-29 21:07:40 +00:00
2022-07-27 06:17:11 +00:00
- `-source` - Match by source.
2020-06-26 21:59:15 +00:00
2022-07-27 06:17:11 +00:00
#### Enterprise Options
2020-06-26 21:59:15 +00:00
2021-12-15 01:55:21 +00:00
@include 'http_api_partition_options.mdx'
2022-07-27 06:17:11 +00:00
@include 'http_api_namespace_options.mdx'
2018-05-29 21:07:40 +00:00
2022-07-27 06:17:11 +00:00
#### API Options
2018-05-29 21:07:40 +00:00
2022-07-27 06:17:11 +00:00
@include 'http_api_options_client.mdx'
2018-05-29 21:07:40 +00:00
## Examples
2020-05-19 18:32:38 +00:00
```shell-session
2018-05-29 21:07:40 +00:00
$ consul intention match -source web
web => db (deny)
2020-10-14 15:23:05 +00:00
web => api (2 permissions)
2018-05-29 21:07:40 +00:00
web => * (allow)
```