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 Get'
|
2018-05-29 21:07:40 +00:00
|
|
|
---
|
|
|
|
|
|
|
|
# Consul Intention Get
|
|
|
|
|
|
|
|
Command: `consul intention get`
|
|
|
|
|
2022-01-11 14:41:54 +00:00
|
|
|
Corresponding HTTP API Endpoints: [\[GET\] /v1/connect/intentions/exact](/api-docs/connect/intentions#read-specific-intention-by-name), [\[GET\] /v1/connect/intentions/:uuid](/api-docs/connect/intentions#read-specific-intention-by-id)
|
2022-01-10 17:40:11 +00:00
|
|
|
|
2018-05-29 21:07:40 +00:00
|
|
|
The `intention get` command shows a single intention.
|
|
|
|
|
2020-10-14 15:23:05 +00:00
|
|
|
-> **Deprecated** - The one argument form of this command is deprecated in
|
|
|
|
Consul 1.9.0. Intentions no longer need IDs when represented as
|
2021-01-13 20:48:48 +00:00
|
|
|
[`service-intentions`](/docs/connect/config-entries/service-intentions) config
|
2020-10-14 15:23:05 +00:00
|
|
|
entries.
|
|
|
|
|
2022-10-18 19:49:07 +00:00
|
|
|
The table below shows this command's [required ACLs](/api-docs/api-structure#authentication). Configuration of
|
2022-03-30 21:16:26 +00:00
|
|
|
[blocking queries](/api-docs/features/blocking) and [agent caching](/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 |
|
|
|
|
| ----------------------------- |
|
|
|
|
| `intentions:read`<sup>1</sup> |
|
|
|
|
|
|
|
|
<p>
|
|
|
|
<sup>1</sup> Intention ACL rules are specified as part of a{' '}
|
|
|
|
<code>service</code> rule. See{' '}
|
|
|
|
<a href="/docs/connect/intentions#intention-management-permissions">
|
|
|
|
Intention Management Permissions
|
|
|
|
</a>{' '}
|
|
|
|
for more details.
|
|
|
|
</p>
|
2022-01-10 21:44:56 +00:00
|
|
|
|
2018-05-29 21:07:40 +00:00
|
|
|
## Usage
|
|
|
|
|
|
|
|
Usage:
|
|
|
|
|
2020-04-07 18:55:19 +00:00
|
|
|
- `consul intention get [options] SRC DST`
|
|
|
|
- `consul intention get [options] ID`
|
2018-05-29 21:07:40 +00:00
|
|
|
|
2020-10-14 15:23:05 +00:00
|
|
|
`SRC` and `DST` can both take [several forms](/commands/intention#source-and-destination-naming).
|
2020-06-26 21:59:15 +00:00
|
|
|
|
|
|
|
#### Enterprise Options
|
|
|
|
|
2022-07-27 06:17:11 +00:00
|
|
|
@include 'http_api_partition_options.mdx'
|
|
|
|
|
2020-06-26 21:59:15 +00:00
|
|
|
@include 'http_api_namespace_options.mdx'
|
|
|
|
|
2022-07-27 06:17:11 +00:00
|
|
|
#### API Options
|
|
|
|
|
|
|
|
@include 'http_api_options_client.mdx'
|
2021-12-15 01:55:21 +00:00
|
|
|
|
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 get web db
|
|
|
|
Source: web
|
|
|
|
Destination: db
|
|
|
|
Action: deny
|
|
|
|
ID: 20edfa56-9cd4-51db-8c22-db09fdec61ef
|
|
|
|
Created At: Thursday, 24-May-18 17:07:49 PDT
|
|
|
|
```
|