Added Corresponding HTTP API Endpoints for every CLI command
This commit is contained in:
parent
e3f5dc0987
commit
9ec94fd268
|
@ -7,6 +7,8 @@ page_title: 'Commands: ACL Auth Method Create'
|
|||
|
||||
Command: `consul acl auth-method create`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[PUT\] /v1/acl/auth-method](https://www.consul.io/api-docs/acl/auth-methods#create-an-auth-method)
|
||||
|
||||
The `acl auth-method create` command creates new auth methods.
|
||||
|
||||
## Usage
|
||||
|
|
|
@ -7,6 +7,8 @@ page_title: 'Commands: ACL Auth Method Delete'
|
|||
|
||||
Command: `consul acl auth-method delete`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[DELETE\] /v1/acl/auth-method/:name](https://www.consul.io/api-docs/acl/auth-methods#delete-an-auth-method)
|
||||
|
||||
The `acl auth-method delete` command deletes an auth method.
|
||||
|
||||
## Usage
|
||||
|
|
|
@ -7,7 +7,9 @@ page_title: 'Commands: ACL Auth Method List'
|
|||
|
||||
Command: `consul acl auth-method list`
|
||||
|
||||
The `acl auth-method list`s command lists all auth methods. By default it will not show metadata.
|
||||
Corresponding HTTP API Endpoint: [\[GET\] /v1/acl/auth-methods](https://www.consul.io/api-docs/acl/auth-methods#list-auth-methods)
|
||||
|
||||
The `acl auth-method list` command lists all auth methods. By default it will not show metadata.
|
||||
|
||||
## Usage
|
||||
|
||||
|
|
|
@ -7,6 +7,8 @@ page_title: 'Commands: ACL Auth Method Read'
|
|||
|
||||
Command: `consul acl auth-method read`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[GET\] /v1/acl/auth-method/:name](https://www.consul.io/api-docs/acl/auth-methods#read-an-auth-method)
|
||||
|
||||
The `acl auth-method read` command reads and displays an auth method's details.
|
||||
|
||||
## Usage
|
||||
|
|
|
@ -7,6 +7,8 @@ page_title: 'Commands: ACL Auth Method Update'
|
|||
|
||||
Command: `consul acl auth-method update`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[PUT\] /v1/acl/auth-method/:name](https://www.consul.io/api-docs/acl/auth-methods#update-an-auth-method)
|
||||
|
||||
The `acl auth-method update` command is used to update an auth method. The
|
||||
default operations is to merge the current auth method with those values
|
||||
provided to the command invocation. Therefore to update just one field, only
|
||||
|
|
|
@ -7,6 +7,8 @@ page_title: 'Commands: ACL Binding Rule Create'
|
|||
|
||||
Command: `consul acl binding-rule create`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[PUT\] /v1/acl/binding-rule](https://www.consul.io/api-docs/acl/binding-rules#create-a-binding-rule)
|
||||
|
||||
The `acl binding-rule create` command creates new binding rules.
|
||||
|
||||
## Usage
|
||||
|
|
|
@ -7,6 +7,8 @@ page_title: 'Commands: ACL Binding Rule Delete'
|
|||
|
||||
Command: `consul acl binding-rule delete`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[DELETE\] /v1/acl/binding-rule/:id](https://www.consul.io/api-docs/acl/binding-rules#delete-a-binding-rule)
|
||||
|
||||
The `acl binding-rule delete` command deletes a binding rule.
|
||||
|
||||
## Usage
|
||||
|
|
|
@ -7,6 +7,8 @@ page_title: 'Commands: ACL Binding Rule List'
|
|||
|
||||
Command: `consul acl binding-rule list`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[GET\] /v1/acl/binding-rules](https://www.consul.io/api-docs/acl/binding-rules#list-binding-rules)
|
||||
|
||||
The `acl binding-rule list` command lists all binding rules. By default it will not show metadata.
|
||||
|
||||
## Usage
|
||||
|
|
|
@ -7,6 +7,8 @@ page_title: 'Commands: ACL Binding Rule Read'
|
|||
|
||||
Command: `consul acl binding-rule read`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[GET\] /v1/acl/binding-rule/:id](https://www.consul.io/api-docs/acl/binding-rules#read-a-binding-rule)
|
||||
|
||||
The `acl binding-rule read` command reads and displays a binding rules details.
|
||||
|
||||
## Usage
|
||||
|
|
|
@ -7,6 +7,8 @@ page_title: 'Commands: ACL Binding Rule Update'
|
|||
|
||||
Command: `consul acl binding-rule update`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[PUT\] /v1/acl/binding-rule/:id](https://www.consul.io/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
|
||||
|
|
|
@ -7,6 +7,8 @@ page_title: 'Commands: ACL Bootstrap'
|
|||
|
||||
Command: `consul acl bootstrap`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[PUT\] /v1/acl/bootstrap](https://www.consul.io/api-docs/acl#bootstrap-acls)
|
||||
|
||||
The `acl bootstrap` command will request Consul to generate a new token with unlimited privileges to use
|
||||
for management purposes and output its details. This can only be done once and afterwards bootstrapping
|
||||
will be disabled. If all tokens are lost and you need to bootstrap again you can follow the bootstrap
|
||||
|
|
|
@ -7,6 +7,8 @@ page_title: 'Commands: ACL Policy Create'
|
|||
|
||||
Command: `consul acl policy create`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[PUT\] /v1/acl/policy](https://www.consul.io/api-docs/acl/policies#create-a-policy)
|
||||
|
||||
The `acl policy create` command creates new policies. The policies rules can either be set explicitly or the
|
||||
`-from-token` parameter may be used to load the rules from a legacy ACL token. When loading
|
||||
the rules from an existing legacy ACL token, the rules get translated from the legacy syntax
|
||||
|
|
|
@ -7,6 +7,8 @@ page_title: 'Commands: ACL Policy Delete'
|
|||
|
||||
Command: `consul acl policy delete`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[DELETE\] /v1/acl/policy/:id](https://www.consul.io/api-docs/acl/policies#delete-a-policy)
|
||||
|
||||
The `acl policy delete` command deletes a policy. Policies may be deleted by their ID or by name.
|
||||
|
||||
## Usage
|
||||
|
|
|
@ -7,6 +7,8 @@ page_title: 'Commands: ACL Policy List'
|
|||
|
||||
Command: `consul acl policy list`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[GET\] /v1/acl/policies](https://www.consul.io/api-docs/acl/policies#list-policies)
|
||||
|
||||
The `acl policy list` command lists all policies. By default it will not show metadata.
|
||||
|
||||
## Usage
|
||||
|
|
|
@ -7,6 +7,8 @@ page_title: 'Commands: ACL Policy Read'
|
|||
|
||||
Command: `consul acl policy read`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[GET\] /v1/acl/policy/:id](https://www.consul.io/api-docs/acl/policies#read-a-policy)
|
||||
|
||||
The `acl policy read` command reads and displays a policies details.
|
||||
|
||||
## Usage
|
||||
|
|
|
@ -7,6 +7,8 @@ page_title: 'Commands: ACL Policy Update'
|
|||
|
||||
Command: `consul acl policy update`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[PUT\] /v1/acl/policy/:id](https://www.consul.io/api-docs/acl/policies#update-a-policy)
|
||||
|
||||
The `acl policy update` command is used to update a policy. The default operations is to merge the current policy
|
||||
with those values provided to the command invocation. Therefore to update just one field, only
|
||||
the `-id` or `-name` options and the option to modify must be provided. Note that renaming
|
||||
|
|
|
@ -7,6 +7,8 @@ page_title: 'Commands: ACL Role Create'
|
|||
|
||||
Command: `consul acl role create`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[PUT\] /v1/acl/role](https://www.consul.io/api-docs/acl/roles#create-a-role)
|
||||
|
||||
The `acl role create` command creates new roles.
|
||||
|
||||
## Usage
|
||||
|
|
|
@ -7,6 +7,8 @@ page_title: 'Commands: ACL Role Delete'
|
|||
|
||||
Command: `consul acl role delete`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[DELETE\] /v1/acl/role/:id](https://www.consul.io/api-docs/acl/roles#delete-a-role)
|
||||
|
||||
The `acl role delete` command deletes a role. Roles may be deleted by their ID or by name.
|
||||
|
||||
## Usage
|
||||
|
|
|
@ -7,6 +7,8 @@ page_title: 'Commands: ACL Role List'
|
|||
|
||||
Command: `consul acl role list`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[GET\] /v1/acl/roles](https://www.consul.io/api-docs/acl/roles#list-roles)
|
||||
|
||||
The `acl role list` command lists all roles. By default it will not show metadata.
|
||||
|
||||
## Usage
|
||||
|
|
|
@ -7,6 +7,8 @@ page_title: 'Commands: ACL Role Read'
|
|||
|
||||
Command: `consul acl role read`
|
||||
|
||||
Corresponding HTTP API Endpoints: [\[GET\] /v1/acl/role/:id](https://www.consul.io/api-docs/acl/roles#read-a-role), [\[GET\] /v1/acl/role/name/:name](https://www.consul.io/api-docs/acl/roles#read-a-role-by-name)
|
||||
|
||||
The `acl role read` command reads and displays a roles details.
|
||||
|
||||
## Usage
|
||||
|
|
|
@ -7,6 +7,8 @@ page_title: 'Commands: ACL Role Update'
|
|||
|
||||
Command: `consul acl role update`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[PUT\] /v1/acl/role/:id](https://www.consul.io/api-docs/acl/roles#update-a-role)
|
||||
|
||||
The `acl role update` command is used to update a role. The default operations is to merge the
|
||||
current role with those values provided to the command invocation. Therefore to
|
||||
update just one field, only the `-id` or `-name` options and the option to
|
||||
|
|
|
@ -7,6 +7,8 @@ page_title: 'Commands: ACL Set Agent Token'
|
|||
|
||||
Command: `consul acl set-agent-token`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[PUT\] /v1/agent/token/:type](https://www.consul.io/api-docs/agent#update-acl-tokens)
|
||||
|
||||
This command updates the ACL tokens currently in use by the agent. It can be used to introduce
|
||||
ACL tokens to the agent for the first time, or to update tokens that were initially loaded from
|
||||
the agent's configuration. Tokens are not persisted unless
|
||||
|
|
|
@ -7,6 +7,8 @@ page_title: 'Commands: ACL Token Clone'
|
|||
|
||||
Command: `consul acl token clone`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[PUT\] /v1/acl/token/:AccessorID/clone](https://www.consul.io/api-docs/acl/tokens#clone-a-token)
|
||||
|
||||
The `acl token clone` command clones an existing token.
|
||||
|
||||
## Usage
|
||||
|
|
|
@ -7,6 +7,8 @@ page_title: 'Commands: ACL Token Create'
|
|||
|
||||
Command: `consul acl token create`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[PUT\] /v1/acl/token](https://www.consul.io/api-docs/acl/tokens#create-a-token)
|
||||
|
||||
This command creates new tokens. When creating a new token, policies may be linked using
|
||||
either the `-policy-id` or the `-policy-name` options. When specifying policies by IDs you
|
||||
may use a unique prefix of the UUID as a shortcut for specifying the entire UUID.
|
||||
|
|
|
@ -7,6 +7,8 @@ page_title: 'Commands: ACL Token Delete'
|
|||
|
||||
Command: `consul acl token delete`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[DELETE\] /v1/acl/token/:AccessorID](https://www.consul.io/api-docs/acl/tokens#delete-a-token)
|
||||
|
||||
The `acl token delete` command deletes a token.
|
||||
|
||||
## Usage
|
||||
|
|
|
@ -7,6 +7,8 @@ page_title: 'Commands: ACL Token List'
|
|||
|
||||
Command: `consul acl token list`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[GET\] /v1/acl/tokens](https://www.consul.io/api-docs/acl/tokens#list-tokens)
|
||||
|
||||
The `acl token list` command lists all tokens. By default it will not show metadata.
|
||||
|
||||
## Usage
|
||||
|
|
|
@ -7,6 +7,8 @@ page_title: 'Commands: ACL Token Read'
|
|||
|
||||
Command: `consul acl token read`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[GET\] /v1/acl/token/:AccessorID](https://www.consul.io/api-docs/acl/tokens#read-a-token)
|
||||
|
||||
The `acl token read` command reads and displays a token details.
|
||||
|
||||
## Usage
|
||||
|
|
|
@ -7,6 +7,8 @@ page_title: 'Commands: ACL Token Update'
|
|||
|
||||
Command: `consul acl token update`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[PUT\] /v1/acl/token/:AccessorID](https://www.consul.io/api-docs/acl/tokens#update-a-token)
|
||||
|
||||
The `acl token update` command will update a token. Some parts of the token like whether the
|
||||
token is local to the datacenter cannot be changed.
|
||||
|
||||
|
|
|
@ -10,6 +10,8 @@ It will be removed in a future major release when support for the legacy ACL sys
|
|||
|
||||
Command: `consul acl translate-rules`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[GET\] /v1/acl/rules/translate/:accessor_id](https://www.consul.io/api-docs/acl#translate-a-legacy-token-s-rules)
|
||||
|
||||
This command translates the legacy ACL rule syntax into the new syntax.
|
||||
|
||||
### Usage
|
||||
|
|
|
@ -7,6 +7,8 @@ page_title: 'Commands: Catalog List Datacenters'
|
|||
|
||||
Command: `consul catalog datacenters`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[GET\] /v1/catalog/datacenters](https://www.consul.io/api-docs/catalog#list-datacenters)
|
||||
|
||||
The `catalog datacenters` command prints all known datacenters.
|
||||
|
||||
## Examples
|
||||
|
|
|
@ -7,6 +7,8 @@ page_title: 'Commands: Catalog List Nodes'
|
|||
|
||||
Command: `consul catalog nodes`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[GET\] /v1/catalog/nodes](https://www.consul.io/api-docs/catalog#list-nodes)
|
||||
|
||||
The `catalog nodes` command prints all known nodes and metadata about them.
|
||||
It can also query for nodes that match a particular metadata or provide a
|
||||
particular service.
|
||||
|
|
|
@ -7,6 +7,8 @@ page_title: 'Commands: Catalog List Services'
|
|||
|
||||
Command: `consul catalog services`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[GET\] /v1/catalog/services](https://www.consul.io/api-docs/catalog#list-services)
|
||||
|
||||
The `catalog services` command prints all known services. It can also query
|
||||
for services that match particular metadata or list the services that a
|
||||
particular node provides.
|
||||
|
|
|
@ -7,6 +7,8 @@ page_title: 'Commands: Config Delete'
|
|||
|
||||
Command: `consul config delete`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[DELETE\] /v1/config/:kind/:name](https://www.consul.io/api-docs/config#delete-configuration)
|
||||
|
||||
The `config delete` command deletes the configuration entry specified by the
|
||||
kind and name. See the [configuration entries docs](/docs/agent/config-entries)
|
||||
for more details about configuration entries.
|
||||
|
|
|
@ -7,6 +7,8 @@ page_title: 'Commands: Config List'
|
|||
|
||||
Command: `consul config list`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[GET\] /v1/config/:kind](https://www.consul.io/api-docs/config#list-configurations)
|
||||
|
||||
The `config list` command lists all given config entries of the given kind.
|
||||
See the [configuration entries docs](/docs/agent/config-entries) for more
|
||||
details about configuration entries.
|
||||
|
|
|
@ -7,6 +7,8 @@ page_title: 'Commands: Config Read'
|
|||
|
||||
Command: `consul config read`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[GET\] /v1/config/:kind/:name](https://www.consul.io/api-docs/config#get-configuration)
|
||||
|
||||
The `config read` command reads the config entry specified by the given
|
||||
kind and name and outputs its JSON representation. See the
|
||||
[configuration entries docs](/docs/agent/config-entries) for more
|
||||
|
|
|
@ -7,6 +7,8 @@ page_title: 'Commands: Config Write'
|
|||
|
||||
Command: `consul config write`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[PUT\] /v1/config](https://www.consul.io/api-docs/config#apply-configuration)
|
||||
|
||||
The `config write` command creates or updates a centralized config entry.
|
||||
See the [configuration entries docs](/docs/agent/config-entries) for more
|
||||
details about configuration entries.
|
||||
|
|
|
@ -44,6 +44,8 @@ This command displays the current CA configuration.
|
|||
|
||||
Usage: `consul connect ca get-config [options]`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[GET\] /v1/connect/ca/configuration](https://www.consul.io/api-docs/connect/ca#get-ca-configuration)
|
||||
|
||||
#### API Options
|
||||
|
||||
@include 'http_api_options_client.mdx'
|
||||
|
@ -69,6 +71,8 @@ will be triggered.
|
|||
|
||||
Usage: `consul connect ca set-config [options]`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[PUT\] /v1/connect/ca/configuration](https://www.consul.io/api-docs/connect/ca#update-ca-configuration)
|
||||
|
||||
#### API Options
|
||||
|
||||
@include 'http_api_options_client.mdx'
|
||||
|
|
|
@ -13,6 +13,8 @@ description: >-
|
|||
|
||||
Command: `consul event`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[PUT\] /v1/event/fire/:name](https://www.consul.io/api-docs/event#fire-event)
|
||||
|
||||
The `event` command provides a mechanism to fire a custom user event to an
|
||||
entire datacenter. These events are opaque to Consul, but they can be used
|
||||
to build scripting infrastructure to do automated deploys, restart services,
|
||||
|
|
|
@ -11,6 +11,8 @@ description: >-
|
|||
|
||||
Command: `consul force-leave`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[PUT\] /v1/agent/force-leave/:node](https://www.consul.io/api-docs/agent#force-leave-and-shutdown)
|
||||
|
||||
The `force-leave` command forces a member of a Consul cluster to enter the
|
||||
"left" state. The purpose of this method is to force-remove a node that has failed or
|
||||
was shutdown without a [graceful leave](/commands/leave).
|
||||
|
|
|
@ -7,6 +7,8 @@ page_title: 'Commands: Intention Check'
|
|||
|
||||
Command: `consul intention check`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[GET\] /v1/connect/intentions/check](https://www.consul.io/api-docs/connect/intentions#check-intention-result)
|
||||
|
||||
The `intention check` command checks whether a connection attempt between
|
||||
two services would be authorized given the current set of intentions and
|
||||
Consul configuration.
|
||||
|
|
|
@ -13,6 +13,8 @@ entry for the destination.
|
|||
|
||||
Command: `consul intention create`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[POST\] /v1/connect/intentions](https://www.consul.io/api-docs/connect/intentions#create-intention-with-id)
|
||||
|
||||
The `intention create` command creates or updates an L4 intention.
|
||||
|
||||
## Usage
|
||||
|
|
|
@ -7,6 +7,8 @@ page_title: 'Commands: Intention Delete'
|
|||
|
||||
Command: `consul intention delete`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[DELETE\] /v1/connect/intentions/exact](https://www.consul.io/api-docs/connect/intentions#delete-intention-by-name)
|
||||
|
||||
The `intention delete` command deletes a matching intention.
|
||||
|
||||
-> **Deprecated** - The one argument form of this command is deprecated in
|
||||
|
|
|
@ -7,6 +7,8 @@ page_title: 'Commands: Intention Get'
|
|||
|
||||
Command: `consul intention get`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[GET\] /v1/connect/intentions/exact](https://www.consul.io/api-docs/connect/intentions##read-specific-intention-by-name)
|
||||
|
||||
The `intention get` command shows a single intention.
|
||||
|
||||
-> **Deprecated** - The one argument form of this command is deprecated in
|
||||
|
|
|
@ -7,6 +7,8 @@ page_title: 'Commands: Intention List'
|
|||
|
||||
Command: `consul intention list`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[GET\] /v1/connect/intentions](https://www.consul.io/api-docs/connect/intentions#list-intentions)
|
||||
|
||||
The `intention list` command shows all intentions including ID and precedence.
|
||||
|
||||
## Usage
|
||||
|
|
|
@ -7,6 +7,8 @@ page_title: 'Commands: Intention Match'
|
|||
|
||||
Command: `consul intention match`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[GET\] /v1/connect/intentions/match](https://www.consul.io/api-docs/connect/intentions#list-matching-intentions)
|
||||
|
||||
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.
|
||||
|
|
|
@ -12,6 +12,8 @@ description: >-
|
|||
|
||||
Command: `consul join`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[PUT\] /v1/agent/join/:address](https://www.consul.io/api-docs/agent#join-agent)
|
||||
|
||||
The `join` command tells a Consul agent to join an existing cluster.
|
||||
A new Consul agent may join any node in the existing cluster. After joining
|
||||
with one member, the gossip communication will propagate the updated membership
|
||||
|
|
|
@ -7,6 +7,8 @@ page_title: 'Commands: Keyring'
|
|||
|
||||
Command: `consul keyring`
|
||||
|
||||
Corresponding HTTP API Endpoints: [\[VARIES\] /v1/operator/keyring](https://www.consul.io/api-docs/operator/keyring)
|
||||
|
||||
The `keyring` command is used to examine and modify the encryption keys used in
|
||||
Consul's [Gossip Pools](/docs/internals/gossip). It is capable of
|
||||
distributing new encryption keys to the cluster, retiring old encryption keys,
|
||||
|
|
|
@ -7,6 +7,8 @@ page_title: 'Commands: KV Delete'
|
|||
|
||||
Command: `consul kv delete`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[DELETE\] /v1/kv/:key](https://www.consul.io/api-docs/kv#delete-key)
|
||||
|
||||
The `kv delete` command removes the value from Consul's KV store at the
|
||||
given path. If no key exists at the path, no action is taken.
|
||||
|
||||
|
|
|
@ -7,6 +7,8 @@ page_title: 'Commands: KV Get'
|
|||
|
||||
Command: `consul kv get`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[GET\] /v1/kv/:key](https://www.consul.io/api-docs/kv#read-key)
|
||||
|
||||
The `kv get` command is used to retrieve the value from Consul's KV
|
||||
store at the given key name. If no key exists with that name, an error is
|
||||
returned. If a key exists with that name but has no data, nothing is returned.
|
||||
|
|
|
@ -7,6 +7,8 @@ page_title: 'Commands: KV Put'
|
|||
|
||||
Command: `consul kv put`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[PUT\] /v1/kv/:key](https://www.consul.io/api-docs/kv#create-update-key)
|
||||
|
||||
The `kv put` command writes the data to the given path in the KV store.
|
||||
|
||||
## Usage
|
||||
|
|
|
@ -11,6 +11,8 @@ description: >-
|
|||
|
||||
Command: `consul leave`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[PUT\] /v1/agent/leave](https://www.consul.io/api-docs/agent#graceful-leave-and-shutdown)
|
||||
|
||||
The `leave` command triggers a graceful leave and shutdown of the agent.
|
||||
It is used to ensure other nodes see the agent as "left" instead of
|
||||
"failed". Nodes that leave will not attempt to re-join the cluster
|
||||
|
|
|
@ -14,7 +14,7 @@ Command: `consul license`
|
|||
|
||||
The `license` command provides a datacenter-level view of the Consul Enterprise license. This was added
|
||||
in Consul 1.1.0 but Consul 1.10.0 removed the ability to set and reset the license using the CLI.
|
||||
See the [licensing documentation](/docs/enterprise/license/overview) for more information about
|
||||
See the [licensing documentation](/docs/enterprise/license/overview) for more information about
|
||||
Consul Enterprise license management.
|
||||
|
||||
If ACLs are enabled then a token with operator privileges may be required in
|
||||
|
@ -44,9 +44,9 @@ Usage: consul license <subcommand> [options] [args]
|
|||
Retrieve the current license:
|
||||
|
||||
$ consul license get
|
||||
|
||||
|
||||
Inspect a license:
|
||||
|
||||
|
||||
$ consul license inspect "<path to license file>"
|
||||
|
||||
Reset the current license:
|
||||
|
@ -66,7 +66,7 @@ Subcommands:
|
|||
## inspect
|
||||
|
||||
This command inspects and validates a license. Just like a Consul agent it
|
||||
can load the license from a file on disk or from the `CONSUL_LICENSE` and
|
||||
can load the license from a file on disk or from the `CONSUL_LICENSE` and
|
||||
`CONSUL_LICENSE_PATH` environment variables.
|
||||
|
||||
Usage: `consul license inspect [<options>] [<license file>]`
|
||||
|
@ -117,12 +117,15 @@ Features:
|
|||
License is valid
|
||||
|
||||
```
|
||||
|
||||
## put
|
||||
|
||||
-> **Deprecated** The ability to manage the cluster's license via the CLI
|
||||
was removed in Consul 1.10. While the CLI command still exists it will
|
||||
always return an error. This command will be fully removed in a future release.
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[PUT\] /v1/operator/license](https://www.consul.io/api-docs/operator/license#updating-the-consul-license)
|
||||
|
||||
This command sets the Consul Enterprise license.
|
||||
|
||||
Usage: `consul license put [options] LICENSE`
|
||||
|
@ -153,6 +156,8 @@ Licensed Features:
|
|||
|
||||
## get
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[GET\] /v1/operator/license](https://www.consul.io/api-docs/operator/license#getting-the-consul-license)
|
||||
|
||||
This command gets the Consul Enterprise license.
|
||||
|
||||
Usage: `consul license get [options]`
|
||||
|
@ -187,6 +192,8 @@ Licensed Features:
|
|||
was removed in Consul 1.10. While the CLI command still exists it will
|
||||
always return an error. This command will be fully removed in a future release.
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[DELETE\] /v1/operator/license](https://www.consul.io/api-docs/operator/license#resetting-the-consul-license)
|
||||
|
||||
Resets license for the datacenter to the one builtin in Consul binary, if it is still valid.
|
||||
If the builtin license is invalid, the current one stays active.
|
||||
|
||||
|
|
|
@ -10,6 +10,8 @@ description: >
|
|||
|
||||
Command: `consul login`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[POST\] /v1/acl/login](https://www.consul.io/api-docs/acl#login-to-auth-method)
|
||||
|
||||
The `login` command will exchange the provided third party credentials with the
|
||||
requested auth method for a newly minted Consul ACL token. The companion
|
||||
command `consul logout` should be used to destroy any tokens created this way
|
||||
|
|
|
@ -10,6 +10,8 @@ description: >
|
|||
|
||||
Command: `consul logout`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[POST\] /v1/acl/logout](https://www.consul.io/api-docs/acl#logout-from-auth-method)
|
||||
|
||||
The `logout` command will destroy the provided token if it was created from
|
||||
`consul login`.
|
||||
|
||||
|
|
|
@ -9,6 +9,8 @@ description: |
|
|||
|
||||
Command: `consul maint`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[PUT\] /v1/agent/maintenance](https://www.consul.io/api-docs/agent#enable-maintenance-mode)
|
||||
|
||||
The `maint` command provides control of service maintenance mode.
|
||||
Using the command, it is possible to mark a service provided by a node or all the services on the
|
||||
node as a whole as "under maintenance". In this mode of operation, the service
|
||||
|
|
|
@ -11,6 +11,8 @@ description: >-
|
|||
|
||||
Command: `consul members`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[GET\] /v1/agent/members](https://www.consul.io/api-docs/agent#list-members)
|
||||
|
||||
The `members` command outputs the current list of members that a Consul
|
||||
agent knows about, along with their state. The state of a node can only
|
||||
be "alive", "left", or "failed".
|
||||
|
|
|
@ -7,6 +7,8 @@ page_title: 'Commands: Namespace Create'
|
|||
|
||||
Command: `consul namespace create`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[PUT\] /v1/namespace](https://www.consul.io/api-docs/namespaces#create-a-namespace)
|
||||
|
||||
<EnterpriseAlert />
|
||||
|
||||
This `namespace create` command creates a namespaces using the CLI parameters provided.
|
||||
|
|
|
@ -7,6 +7,8 @@ page_title: 'Commands: Namespace Delete'
|
|||
|
||||
Command: `consul namespace delete`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[DELETE\] /v1/namespace/:name](https://www.consul.io/api-docs/namespaces#delete-a-namespace)
|
||||
|
||||
<EnterpriseAlert />
|
||||
|
||||
This `namespace delete` command deletes a namespace. This was added in Consul Enterprise 1.7.0. If
|
||||
|
|
|
@ -7,6 +7,8 @@ page_title: 'Commands: Namespace List'
|
|||
|
||||
Command: `consul namespace list`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[GET\] /v1/namespaces](https://www.consul.io/api-docs/namespaces#list-all-namespaces)
|
||||
|
||||
<EnterpriseAlert />
|
||||
|
||||
This `namespace list` command lists all namespace configurations. This was added in Consul Enterprise 1.7.0. If
|
||||
|
|
|
@ -7,6 +7,8 @@ page_title: 'Commands: Namespace Read'
|
|||
|
||||
Command: `consul namespace read`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[GET\] /v1/namespace/:name](https://www.consul.io/api-docs/namespaces#read-a-namespace)
|
||||
|
||||
<EnterpriseAlert />
|
||||
|
||||
This `namespace read` command reads a namespaces configuration. This was added in Consul Enterprise 1.7.0. If
|
||||
|
|
|
@ -7,6 +7,8 @@ page_title: 'Commands: Namespace Update'
|
|||
|
||||
Command: `consul namespace update`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[PUT\] /v1/namespace/:name](https://www.consul.io/api-docs/namespaces#update-a-namespace)
|
||||
|
||||
<EnterpriseAlert />
|
||||
|
||||
This `namespace update` command updates a namespaces using the CLI parameters provided.
|
||||
|
|
|
@ -7,6 +7,8 @@ page_title: 'Commands: Namespace Write'
|
|||
|
||||
Command: `consul namespace write`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[PUT\] /v1/namespace/:name](https://www.consul.io/api-docs/namespaces#update-a-namespace)
|
||||
|
||||
<EnterpriseAlert />
|
||||
|
||||
This `namespace write` command creates or updates a namespace's configuration from its full definition. This was added in Consul Enterprise 1.7.0.
|
||||
|
|
|
@ -47,6 +47,8 @@ read or write privileges to use these commands.
|
|||
|
||||
## create
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[POST\] /v1/operator/area](https://www.consul.io/api-docs/operator/area#create-network-area)
|
||||
|
||||
This command creates a new network area.
|
||||
|
||||
Usage: `consul operator area create [options]`
|
||||
|
@ -79,6 +81,8 @@ The return code will indicate success or failure.
|
|||
|
||||
## delete
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[DELETE\] /v1/operator/area/:uuid](https://www.consul.io/api-docs/operator/area#delete-network-area)
|
||||
|
||||
This command deletes an existing network area.
|
||||
|
||||
Usage: `consul operator area delete [options]`
|
||||
|
@ -107,6 +111,8 @@ The return code will indicate success or failure.
|
|||
|
||||
## join
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[PUT\] /v1/operator/area/:uuid/join](https://www.consul.io/api-docs/operator/area#join-network-area)
|
||||
|
||||
This command joins Consul servers into an existing network area by address, such as
|
||||
an IP or hostname with an optional port. Multiple addresses may be given.
|
||||
|
||||
|
@ -142,6 +148,8 @@ The return code will indicate success or failure.
|
|||
|
||||
## list
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[GET\] /v1/operator/area](https://www.consul.io/api-docs/operator/area#list-network-areas)
|
||||
|
||||
This command lists all network areas.
|
||||
|
||||
Usage: `consul operator area list [options]`
|
||||
|
@ -170,6 +178,8 @@ The return code will indicate success or failure.
|
|||
|
||||
## members
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[GET\] /v1/operator/area/:uuid/members](https://www.consul.io/api-docs/operator/area#list-network-area-members)
|
||||
|
||||
This command displays Consul server nodes present in a network area, or all
|
||||
areas if no area is specified.
|
||||
|
||||
|
@ -225,6 +235,8 @@ The return code will indicate success or failure.
|
|||
|
||||
## update
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[PUT\] /v1/operator/area/:uuid](https://www.consul.io/api-docs/operator/area#update-network-area)
|
||||
|
||||
This command updates the configuration of network area.
|
||||
|
||||
Usage: `consul operator area update [options]`
|
||||
|
|
|
@ -28,6 +28,8 @@ Subcommands:
|
|||
|
||||
## get-config
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[GET\] /v1/operator/autopilot/configuration](https://www.consul.io/api-docs/operator/autopilot#read-configuration)
|
||||
|
||||
This command displays the current autopilot configuration.
|
||||
|
||||
Usage: `consul operator autopilot get-config [options]`
|
||||
|
@ -53,6 +55,8 @@ UpgradeMigrationTag = ""
|
|||
|
||||
## set-config
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[PUT\] /v1/operator/autopilot/configuration](https://www.consul.io/api-docs/operator/autopilot#update-configuration)
|
||||
|
||||
Modifies the current Autopilot configuration.
|
||||
|
||||
Usage: `consul operator autopilot set-config [options]`
|
||||
|
@ -101,6 +105,8 @@ The return code will indicate success or failure.
|
|||
|
||||
## state
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[GET\] /v1/operator/autopilot/state](https://www.consul.io/api-docs/operator/autopilot#read-the-autopilot-state)
|
||||
|
||||
This command displays the current autopilot state.
|
||||
|
||||
Usage: `consul operator autopilot state [options]`
|
||||
|
|
|
@ -29,6 +29,8 @@ Subcommands:
|
|||
|
||||
## list-peers
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[GET\] /v1/status/peers](https://www.consul.io/api-docs/status#list-raft-peers)
|
||||
|
||||
This command displays the current Raft peer configuration.
|
||||
|
||||
Usage: `consul operator raft list-peers -stale=[true|false]`
|
||||
|
@ -62,6 +64,8 @@ configuration.
|
|||
|
||||
## remove-peer
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[DELETE\] /v1/operator/raft/peer](https://www.consul.io/api-docs/operator/raft#delete-raft-peer)
|
||||
|
||||
This command removes the Consul server with given address from the Raft configuration.
|
||||
|
||||
There are rare cases where a peer may be left behind in the Raft configuration
|
||||
|
|
|
@ -8,6 +8,8 @@ description: The `reload` command triggers a reload of configuration files for t
|
|||
|
||||
Command: `consul reload`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[PUT\] /v1/agent/reload](https://www.consul.io/api-docs/agent#reload-agent)
|
||||
|
||||
The `reload` command triggers a reload of configuration files for the agent.
|
||||
|
||||
The `SIGHUP` signal is usually used to trigger a reload of configurations,
|
||||
|
|
|
@ -9,6 +9,8 @@ description: |
|
|||
|
||||
Command: `consul rtt`
|
||||
|
||||
Corresponding HTTP API Endpoints: [\[GET\] /v1/coordinate/datacenters](https://www.consul.io/api-docs/coordinate#read-wan-coordinates), [\[GET\] /v1/coordinate/nodes](https://www.consul.io/api-docs/coordinate#read-lan-coordinates-for-all-nodes)
|
||||
|
||||
The `rtt` command estimates the network round trip time between two nodes using
|
||||
Consul's network coordinate model of the cluster.
|
||||
|
||||
|
|
|
@ -7,6 +7,8 @@ page_title: 'Commands: Services Deregister'
|
|||
|
||||
Command: `consul services deregister`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[PUT\] /v1/agent/service/deregister/:service_id](https://www.consul.io/api-docs/agent/service#deregister-service)
|
||||
|
||||
The `services deregister` command deregisters a service with the local agent.
|
||||
Note that this command can only deregister services that were registered
|
||||
with the agent specified (defaults to the local agent) and is meant to
|
||||
|
|
|
@ -7,6 +7,8 @@ page_title: 'Commands: Services Register'
|
|||
|
||||
Command: `consul services register`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[PUT\] /v1/agent/service/register](https://www.consul.io/api-docs/agent/service#register-service)
|
||||
|
||||
The `services register` command registers a service with the local agent.
|
||||
This command returns after registration and must be paired with explicit
|
||||
service deregistration. This command simplifies service registration from
|
||||
|
|
|
@ -7,6 +7,8 @@ page_title: 'Commands: Snapshot Restore'
|
|||
|
||||
Command: `consul snapshot restore`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[PUT\] /v1/snapshot](https://www.consul.io/api-docs/snapshot#restore-snapshot)
|
||||
|
||||
The `snapshot restore` command is used to restore an atomic, point-in-time
|
||||
snapshot of the state of the Consul servers which includes key/value entries,
|
||||
service catalog, prepared queries, sessions, and ACLs. The snapshot is read
|
||||
|
|
|
@ -7,6 +7,8 @@ page_title: 'Commands: Snapshot Save'
|
|||
|
||||
Command: `consul snapshot save`
|
||||
|
||||
Corresponding HTTP API Endpoint: [\[GET\] /v1/snapshot](https://www.consul.io/api-docs/snapshot#generate-snapshot)
|
||||
|
||||
The `snapshot save` command is used to retrieve an atomic, point-in-time snapshot
|
||||
of the state of the Consul servers which includes key/value entries,
|
||||
service catalog, prepared queries, sessions, and ACLs. The snapshot is saved to
|
||||
|
|
Loading…
Reference in New Issue