2018-05-29 14:07:40 -07:00
---
2020-09-01 10:14:13 -05:00
layout: commands
2020-04-07 14:55:19 -04:00
page_title: 'Commands: Intention Match'
2023-01-26 12:42:13 -06:00
description: >-
The `consul intention match` command returns inbound and outbound service intentions for a specific service.
2018-05-29 14:07:40 -07:00
---
# Consul Intention Match
Command: `consul intention match`
2023-01-25 10:52:43 -06:00
Corresponding HTTP API Endpoint: [\[GET\] /v1/connect/intentions/match](/consul/api-docs/connect/intentions#list-matching-intentions)
2022-01-10 12:40:11 -05:00
2018-05-29 14:07:40 -07: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 10:52:43 -06:00
The [check](/consul/commands/intention/check) command can be used to
2020-10-14 10:23:05 -05:00
check whether an L4 connection would be authorized between any two services.
2018-05-29 14:07:40 -07:00
2023-01-25 10:52:43 -06: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 16:44:56 -05:00
are not supported from commands, but may be from the corresponding HTTP endpoint.
2022-01-11 09:41:54 -05:00
| ACL Required |
| ----------------------------- |
2023-03-24 15:16:06 -07: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 16:44:56 -05:00
2018-05-29 14:07:40 -07:00
## Usage
Usage: `consul intention match [options] SRC_OR_DST`
2023-01-25 10:52:43 -06:00
`SRC` and `DST` can both take [several forms](/consul/commands/intention#source-and-destination-naming).
2020-06-26 16:59:15 -05:00
2022-07-26 23:17:11 -07:00
#### Command Options
2018-05-29 14:07:40 -07:00
2022-07-26 23:17:11 -07:00
- `-destination` - Match by destination.
2018-05-29 14:07:40 -07:00
2022-07-26 23:17:11 -07:00
- `-source` - Match by source.
2020-06-26 16:59:15 -05:00
2022-07-26 23:17:11 -07:00
#### Enterprise Options
2020-06-26 16:59:15 -05:00
2024-07-18 12:02:45 -05:00
@include 'cli-http-api-partition-options.mdx'
2021-12-14 17:55:21 -08:00
2022-07-26 23:17:11 -07:00
@include 'http_api_namespace_options.mdx'
2018-05-29 14:07:40 -07:00
2022-07-26 23:17:11 -07:00
#### API Options
2018-05-29 14:07:40 -07:00
2022-07-26 23:17:11 -07:00
@include 'http_api_options_client.mdx'
2018-05-29 14:07:40 -07:00
## Examples
2020-05-19 14:32:38 -04:00
```shell-session
2018-05-29 14:07:40 -07:00
$ consul intention match -source web
web => db (deny)
2020-10-14 10:23:05 -05:00
web => api (2 permissions)
2018-05-29 14:07:40 -07:00
web => * (allow)
```