luxolus
/
open-consul
2
0
Fork 0
Code Issues 1 Pull Requests Packages Releases Wiki Activity
open-consul/website/content/commands/config/list.mdx

48 lines
1.1 KiB
Plaintext
Raw Normal View History

Config Entry docs (#5734) * Add api docs for the config entry endpoints * Add enable_central_service_config field to agent docs * Add docs for config entry CLI operations * Fix wording and links in config entry docs * Add links to the central service config option * Update the central service config setting description.
2019-05-01 18:21:11 +00:00
---
docs: update structure (#8506) - moved and renamed files/folders based on new structure - updated docs navigation based on new structure - moved CLI to top nav (created commands.jsx and commands-navigation.js) - updated and added redirects - updating to be consistent with standalone categories - changing "overview" link in top nav to lead to where intro was moved (docs/intro) - adding redirects for intro content - deleting old intro folders - format all data/navigation files - deleting old commands folder - reverting changes to glossary page - adjust intro navigation for removal of 'vs' paths - add helm page redirect - fix more redirects - add a missing redirect - fix broken anchor links and formatting mistakes - deleted duplicate section, added redirect, changed link - removed duplicate glossary page
2020-09-01 15:14:13 +00:00
layout: commands
intro and api navigation converted
2020-04-07 18:55:19 +00:00
page_title: 'Commands: Config List'
Config Entry docs (#5734) * Add api docs for the config entry endpoints * Add enable_central_service_config field to agent docs * Add docs for config entry CLI operations * Fix wording and links in config entry docs * Add links to the central service config option * Update the central service config setting description.
2019-05-01 18:21:11 +00:00
---
# Consul Config List
Command: `consul config list`
Added Corresponding HTTP API Endpoints for every CLI command
2022-01-10 17:40:11 +00:00
Corresponding HTTP API Endpoint: [\[GET\] /v1/config/:kind](https://www.consul.io/api-docs/config#list-configurations)
Config Entry docs (#5734) * Add api docs for the config entry endpoints * Add enable_central_service_config field to agent docs * Add docs for config entry CLI operations * Fix wording and links in config entry docs * Add links to the central service config option * Update the central service config setting description.
2019-05-01 18:21:11 +00:00
The `config list` command lists all given config entries of the given kind.
docs: all intention documentation updates (#8869)
2020-10-14 15:23:05 +00:00
See the [configuration entries docs](/docs/agent/config-entries) for more
Add some config entry docs (#5808) * Add some config entry docs * Update website/source/docs/agent/config_entries.html.md Co-Authored-By: mkeeler <mkeeler@users.noreply.github.com> * Update website/source/docs/agent/config_entries.html.md Co-Authored-By: mkeeler <mkeeler@users.noreply.github.com> * Get rid of double negative * Some incremental updates * Update the config list docs to not point to service-default related things. * A few more doc updates to get rid of some service-defaults specific linking info in the cli docs * In progress update * Update website/source/docs/agent/config_entries.html.md Co-Authored-By: mkeeler <mkeeler@users.noreply.github.com> * Reword bootstrap section * Update example proxy-defaults config * Finish up the examples section for managing config entries with the CLI * Update website/source/docs/agent/config_entries.html.md Co-Authored-By: mkeeler <mkeeler@users.noreply.github.com> * Use $ for shell command start * Make it very clear that the normal way to manage things is via the API/CLI * Update website/source/docs/agent/options.html.md Co-Authored-By: mkeeler <mkeeler@users.noreply.github.com>
2019-05-08 20:19:37 +00:00
details about configuration entries.
Config Entry docs (#5734) * Add api docs for the config entry endpoints * Add enable_central_service_config field to agent docs * Add docs for config entry CLI operations * Fix wording and links in config entry docs * Add links to the central service config option * Update the central service config setting description.
2019-05-01 18:21:11 +00:00
Added ACL requirements for CLI commands
2022-01-10 21:44:56 +00:00
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 |
| -------------- |
| `service:read` |
Config Entry docs (#5734) * Add api docs for the config entry endpoints * Add enable_central_service_config field to agent docs * Add docs for config entry CLI operations * Fix wording and links in config entry docs * Add links to the central service config option * Update the central service config setting description.
2019-05-01 18:21:11 +00:00
## Usage
Usage: `consul config list [options]`
#### API Options
intro and api navigation converted
2020-04-07 18:55:19 +00:00
@include 'http_api_options_client.mdx'
Config Entry docs (#5734) * Add api docs for the config entry endpoints * Add enable_central_service_config field to agent docs * Add docs for config entry CLI operations * Fix wording and links in config entry docs * Add links to the central service config option * Update the central service config setting description.
2019-05-01 18:21:11 +00:00
Update config entry docs for namespaces
2020-02-07 20:01:04 +00:00
#### Enterprise Options
intro and api navigation converted
2020-04-07 18:55:19 +00:00
@include 'http_api_namespace_options.mdx'
Update config entry docs for namespaces
2020-02-07 20:01:04 +00:00
Website fixups for admin partitions (#11842) * Website fixups for admin partitions Signed-off-by: Mark Anderson <manderson@hashicorp.com>
2021-12-15 01:55:21 +00:00
@include 'http_api_partition_options.mdx'
Config Entry docs (#5734) * Add api docs for the config entry endpoints * Add enable_central_service_config field to agent docs * Add docs for config entry CLI operations * Fix wording and links in config entry docs * Add links to the central service config option * Update the central service config setting description.
2019-05-01 18:21:11 +00:00
#### Config List Options
docs: remove name field from Mesh config entry Also document the name of these config entries in the API docs, so that users know how to query for them. And fix the name of mesh on the index page.
2021-05-04 21:32:07 +00:00
- `-kind` - Specifies the kind of the config entry to list.
Config Entry docs (#5734) * Add api docs for the config entry endpoints * Add enable_central_service_config field to agent docs * Add docs for config entry CLI operations * Fix wording and links in config entry docs * Add links to the central service config option * Update the central service config setting description.
2019-05-01 18:21:11 +00:00
## Examples
$ consul config list -kind service-defaults
billing
db
web