docs: show CLI cmd-specific opts before general opts
Applied to all remaining CLI commands.
This commit is contained in:
parent
9bd8c0cd6d
commit
bb93a43475
|
@ -23,21 +23,21 @@ are not supported from commands, but may be from the corresponding HTTP endpoint
|
||||||
|
|
||||||
Usage: `consul acl auth-method delete [options]`
|
Usage: `consul acl auth-method delete [options]`
|
||||||
|
|
||||||
#### API Options
|
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_options_server.mdx'
|
|
||||||
|
|
||||||
#### Command Options
|
#### Command Options
|
||||||
|
|
||||||
- `-name=<string>` - The Name of the auth method to delete.
|
- `-name=<string>` - The Name of the auth method to delete.
|
||||||
|
|
||||||
#### Enterprise Options
|
#### Enterprise Options
|
||||||
|
|
||||||
|
@include 'http_api_partition_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_namespace_options.mdx'
|
@include 'http_api_namespace_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_partition_options.mdx'
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_options_server.mdx'
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|
|
@ -23,12 +23,6 @@ are not supported from commands, but may be from the corresponding HTTP endpoint
|
||||||
|
|
||||||
Usage: `consul acl auth-method list`
|
Usage: `consul acl auth-method list`
|
||||||
|
|
||||||
#### API Options
|
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_options_server.mdx'
|
|
||||||
|
|
||||||
#### Command Options
|
#### Command Options
|
||||||
|
|
||||||
- `-meta` - Indicates that auth method metadata such as the raft indices should
|
- `-meta` - Indicates that auth method metadata such as the raft indices should
|
||||||
|
@ -38,9 +32,15 @@ Usage: `consul acl auth-method list`
|
||||||
|
|
||||||
#### Enterprise Options
|
#### Enterprise Options
|
||||||
|
|
||||||
|
@include 'http_api_partition_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_namespace_options.mdx'
|
@include 'http_api_namespace_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_partition_options.mdx'
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_options_server.mdx'
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|
|
@ -23,12 +23,6 @@ are not supported from commands, but may be from the corresponding HTTP endpoint
|
||||||
|
|
||||||
Usage: `consul acl auth-method read [options] [args]`
|
Usage: `consul acl auth-method read [options] [args]`
|
||||||
|
|
||||||
#### API Options
|
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_options_server.mdx'
|
|
||||||
|
|
||||||
#### Command Options
|
#### Command Options
|
||||||
|
|
||||||
- `-meta` - Indicates that auth method metadata such as the raft
|
- `-meta` - Indicates that auth method metadata such as the raft
|
||||||
|
@ -40,9 +34,15 @@ Usage: `consul acl auth-method read [options] [args]`
|
||||||
|
|
||||||
#### Enterprise Options
|
#### Enterprise Options
|
||||||
|
|
||||||
|
@include 'http_api_partition_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_namespace_options.mdx'
|
@include 'http_api_namespace_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_partition_options.mdx'
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_options_server.mdx'
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|
|
@ -26,12 +26,6 @@ are not supported from commands, but may be from the corresponding HTTP endpoint
|
||||||
|
|
||||||
Usage: `consul acl auth-method update [options] [args]`
|
Usage: `consul acl auth-method update [options] [args]`
|
||||||
|
|
||||||
#### API Options
|
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_options_server.mdx'
|
|
||||||
|
|
||||||
#### Command Options
|
#### Command Options
|
||||||
|
|
||||||
- `-description=<string>` - A description of the auth method.
|
- `-description=<string>` - A description of the auth method.
|
||||||
|
@ -76,6 +70,8 @@ Usage: `consul acl auth-method update [options] [args]`
|
||||||
|
|
||||||
#### Enterprise Options
|
#### Enterprise Options
|
||||||
|
|
||||||
|
@include 'http_api_partition_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_namespace_options.mdx'
|
@include 'http_api_namespace_options.mdx'
|
||||||
|
|
||||||
- `-namespace-rule-bind-namespace=<value>` - Namespace to bind on match. Can
|
- `-namespace-rule-bind-namespace=<value>` - Namespace to bind on match. Can
|
||||||
|
@ -85,7 +81,11 @@ Usage: `consul acl auth-method update [options] [args]`
|
||||||
verified identity attributes returned from the auth method during login to
|
verified identity attributes returned from the auth method during login to
|
||||||
determine if the namespace rule applies. Added in Consul 1.8.0.
|
determine if the namespace rule applies. Added in Consul 1.8.0.
|
||||||
|
|
||||||
@include 'http_api_partition_options.mdx'
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_options_server.mdx'
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|
|
@ -23,12 +23,6 @@ are not supported from commands, but may be from the corresponding HTTP endpoint
|
||||||
|
|
||||||
Usage: `consul acl binding-rule create [options] [args]`
|
Usage: `consul acl binding-rule create [options] [args]`
|
||||||
|
|
||||||
#### API Options
|
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_options_server.mdx'
|
|
||||||
|
|
||||||
#### Command Options
|
#### Command Options
|
||||||
|
|
||||||
- `-bind-name=<string>` - Name to bind on match. Can use `${var}`
|
- `-bind-name=<string>` - Name to bind on match. Can use `${var}`
|
||||||
|
@ -51,9 +45,15 @@ Usage: `consul acl binding-rule create [options] [args]`
|
||||||
|
|
||||||
#### Enterprise Options
|
#### Enterprise Options
|
||||||
|
|
||||||
|
@include 'http_api_partition_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_namespace_options.mdx'
|
@include 'http_api_namespace_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_partition_options.mdx'
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_options_server.mdx'
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|
|
@ -23,12 +23,6 @@ are not supported from commands, but may be from the corresponding HTTP endpoint
|
||||||
|
|
||||||
Usage: `consul acl binding-rule delete [options]`
|
Usage: `consul acl binding-rule delete [options]`
|
||||||
|
|
||||||
#### API Options
|
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_options_server.mdx'
|
|
||||||
|
|
||||||
#### Command Options
|
#### Command Options
|
||||||
|
|
||||||
- `-id=<string>` - The ID of the binding rule to delete. It may be specified as a
|
- `-id=<string>` - The ID of the binding rule to delete. It may be specified as a
|
||||||
|
@ -36,9 +30,15 @@ Usage: `consul acl binding-rule delete [options]`
|
||||||
|
|
||||||
#### Enterprise Options
|
#### Enterprise Options
|
||||||
|
|
||||||
|
@include 'http_api_partition_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_namespace_options.mdx'
|
@include 'http_api_namespace_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_partition_options.mdx'
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_options_server.mdx'
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|
|
@ -23,12 +23,6 @@ are not supported from commands, but may be from the corresponding HTTP endpoint
|
||||||
|
|
||||||
Usage: `consul acl binding-rule list`
|
Usage: `consul acl binding-rule list`
|
||||||
|
|
||||||
#### API Options
|
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_options_server.mdx'
|
|
||||||
|
|
||||||
#### Command Options
|
#### Command Options
|
||||||
|
|
||||||
- `-meta` - Indicates that binding rule metadata such as the raft indices
|
- `-meta` - Indicates that binding rule metadata such as the raft indices
|
||||||
|
@ -38,9 +32,15 @@ Usage: `consul acl binding-rule list`
|
||||||
|
|
||||||
#### Enterprise Options
|
#### Enterprise Options
|
||||||
|
|
||||||
|
@include 'http_api_partition_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_namespace_options.mdx'
|
@include 'http_api_namespace_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_partition_options.mdx'
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_options_server.mdx'
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|
|
@ -23,12 +23,6 @@ are not supported from commands, but may be from the corresponding HTTP endpoint
|
||||||
|
|
||||||
Usage: `consul acl binding-rule read [options] [args]`
|
Usage: `consul acl binding-rule read [options] [args]`
|
||||||
|
|
||||||
#### API Options
|
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_options_server.mdx'
|
|
||||||
|
|
||||||
#### Command Options
|
#### Command Options
|
||||||
|
|
||||||
- `-id=<string>` - The ID of the binding rule to read. It may be specified as a unique ID
|
- `-id=<string>` - The ID of the binding rule to read. It may be specified as a unique ID
|
||||||
|
@ -41,9 +35,15 @@ Usage: `consul acl binding-rule read [options] [args]`
|
||||||
|
|
||||||
#### Enterprise Options
|
#### Enterprise Options
|
||||||
|
|
||||||
|
@include 'http_api_partition_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_namespace_options.mdx'
|
@include 'http_api_namespace_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_partition_options.mdx'
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_options_server.mdx'
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|
|
@ -26,12 +26,6 @@ are not supported from commands, but may be from the corresponding HTTP endpoint
|
||||||
|
|
||||||
Usage: `consul acl binding-rule update [options] [args]`
|
Usage: `consul acl binding-rule update [options] [args]`
|
||||||
|
|
||||||
#### API Options
|
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_options_server.mdx'
|
|
||||||
|
|
||||||
#### Command Options
|
#### Command Options
|
||||||
|
|
||||||
- `-bind-name=<string>` - Name to bind on match. Can use `${var}`
|
- `-bind-name=<string>` - Name to bind on match. Can use `${var}`
|
||||||
|
@ -58,9 +52,15 @@ Usage: `consul acl binding-rule update [options] [args]`
|
||||||
|
|
||||||
#### Enterprise Options
|
#### Enterprise Options
|
||||||
|
|
||||||
|
@include 'http_api_partition_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_namespace_options.mdx'
|
@include 'http_api_namespace_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_partition_options.mdx'
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_options_server.mdx'
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|
|
@ -26,12 +26,6 @@ are not supported from commands, but may be from the corresponding HTTP endpoint
|
||||||
|
|
||||||
Usage: `consul acl bootstrap [options]`
|
Usage: `consul acl bootstrap [options]`
|
||||||
|
|
||||||
#### API Options
|
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_options_server.mdx'
|
|
||||||
|
|
||||||
#### Command Options
|
#### Command Options
|
||||||
|
|
||||||
- `-format={pretty|json}` - Command output format. The default value is `pretty`.
|
- `-format={pretty|json}` - Command output format. The default value is `pretty`.
|
||||||
|
@ -47,3 +41,9 @@ Create Time: 2018-10-22 11:27:04.479026 -0400 EDT
|
||||||
Policies:
|
Policies:
|
||||||
00000000-0000-0000-0000-000000000001 - global-management
|
00000000-0000-0000-0000-000000000001 - global-management
|
||||||
```
|
```
|
||||||
|
|
||||||
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_options_server.mdx'
|
||||||
|
|
|
@ -35,12 +35,6 @@ support for the legacy ACL system is removed.
|
||||||
|
|
||||||
Usage: `consul acl policy create [options] [args]`
|
Usage: `consul acl policy create [options] [args]`
|
||||||
|
|
||||||
#### API Options
|
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_options_server.mdx'
|
|
||||||
|
|
||||||
#### Command Options
|
#### Command Options
|
||||||
|
|
||||||
- `-description=<string>` - A description of the policy.
|
- `-description=<string>` - A description of the policy.
|
||||||
|
@ -69,9 +63,15 @@ Usage: `consul acl policy create [options] [args]`
|
||||||
|
|
||||||
#### Enterprise Options
|
#### Enterprise Options
|
||||||
|
|
||||||
|
@include 'http_api_partition_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_namespace_options.mdx'
|
@include 'http_api_namespace_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_partition_options.mdx'
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_options_server.mdx'
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|
|
@ -23,12 +23,6 @@ are not supported from commands, but may be from the corresponding HTTP endpoint
|
||||||
|
|
||||||
Usage: `consul acl policy delete [options]`
|
Usage: `consul acl policy delete [options]`
|
||||||
|
|
||||||
#### API Options
|
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_options_server.mdx'
|
|
||||||
|
|
||||||
#### Command Options
|
#### Command Options
|
||||||
|
|
||||||
- `-id=<string>` - The ID of the policy to delete. It may be specified as a
|
- `-id=<string>` - The ID of the policy to delete. It may be specified as a
|
||||||
|
@ -38,9 +32,15 @@ Usage: `consul acl policy delete [options]`
|
||||||
|
|
||||||
#### Enterprise Options
|
#### Enterprise Options
|
||||||
|
|
||||||
|
@include 'http_api_partition_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_namespace_options.mdx'
|
@include 'http_api_namespace_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_partition_options.mdx'
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_options_server.mdx'
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|
|
@ -23,12 +23,6 @@ are not supported from commands, but may be from the corresponding HTTP endpoint
|
||||||
|
|
||||||
Usage: `consul acl policy list`
|
Usage: `consul acl policy list`
|
||||||
|
|
||||||
#### API Options
|
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_options_server.mdx'
|
|
||||||
|
|
||||||
#### Command Options
|
#### Command Options
|
||||||
|
|
||||||
- `-meta` - Indicates that policy metadata such as the content hash and
|
- `-meta` - Indicates that policy metadata such as the content hash and
|
||||||
|
@ -38,9 +32,15 @@ Usage: `consul acl policy list`
|
||||||
|
|
||||||
#### Enterprise Options
|
#### Enterprise Options
|
||||||
|
|
||||||
|
@include 'http_api_partition_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_namespace_options.mdx'
|
@include 'http_api_namespace_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_partition_options.mdx'
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_options_server.mdx'
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|
|
@ -23,12 +23,6 @@ are not supported from commands, but may be from the corresponding HTTP endpoint
|
||||||
|
|
||||||
Usage: `consul acl policy read [options] [args]`
|
Usage: `consul acl policy read [options] [args]`
|
||||||
|
|
||||||
#### API Options
|
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_options_server.mdx'
|
|
||||||
|
|
||||||
#### Command Options
|
#### Command Options
|
||||||
|
|
||||||
- `-id=<string>` - The ID of the policy to read. It may be specified as a unique ID
|
- `-id=<string>` - The ID of the policy to read. It may be specified as a unique ID
|
||||||
|
@ -43,9 +37,15 @@ Usage: `consul acl policy read [options] [args]`
|
||||||
|
|
||||||
#### Enterprise Options
|
#### Enterprise Options
|
||||||
|
|
||||||
|
@include 'http_api_partition_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_namespace_options.mdx'
|
@include 'http_api_namespace_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_partition_options.mdx'
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_options_server.mdx'
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|
|
@ -27,12 +27,6 @@ are not supported from commands, but may be from the corresponding HTTP endpoint
|
||||||
|
|
||||||
Usage: `consul acl policy update [options] [args]`
|
Usage: `consul acl policy update [options] [args]`
|
||||||
|
|
||||||
#### API Options
|
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_options_server.mdx'
|
|
||||||
|
|
||||||
#### Command Options
|
#### Command Options
|
||||||
|
|
||||||
- `-description=<string>` - A description of the policy.
|
- `-description=<string>` - A description of the policy.
|
||||||
|
@ -60,9 +54,15 @@ Usage: `consul acl policy update [options] [args]`
|
||||||
|
|
||||||
#### Enterprise Options
|
#### Enterprise Options
|
||||||
|
|
||||||
|
@include 'http_api_partition_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_namespace_options.mdx'
|
@include 'http_api_namespace_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_partition_options.mdx'
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_options_server.mdx'
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|
|
@ -23,12 +23,6 @@ are not supported from commands, but may be from the corresponding HTTP endpoint
|
||||||
|
|
||||||
Usage: `consul acl role create [options] [args]`
|
Usage: `consul acl role create [options] [args]`
|
||||||
|
|
||||||
#### API Options
|
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_options_server.mdx'
|
|
||||||
|
|
||||||
#### Command Options
|
#### Command Options
|
||||||
|
|
||||||
- `-description=<string>` - A description of the role.
|
- `-description=<string>` - A description of the role.
|
||||||
|
@ -56,9 +50,15 @@ Usage: `consul acl role create [options] [args]`
|
||||||
|
|
||||||
#### Enterprise Options
|
#### Enterprise Options
|
||||||
|
|
||||||
|
@include 'http_api_partition_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_namespace_options.mdx'
|
@include 'http_api_namespace_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_partition_options.mdx'
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_options_server.mdx'
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|
|
@ -23,12 +23,6 @@ are not supported from commands, but may be from the corresponding HTTP endpoint
|
||||||
|
|
||||||
Usage: `consul acl role delete [options]`
|
Usage: `consul acl role delete [options]`
|
||||||
|
|
||||||
#### API Options
|
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_options_server.mdx'
|
|
||||||
|
|
||||||
#### Command Options
|
#### Command Options
|
||||||
|
|
||||||
- `-id=<string>` - The ID of the role to delete. It may be specified as a
|
- `-id=<string>` - The ID of the role to delete. It may be specified as a
|
||||||
|
@ -38,9 +32,15 @@ Usage: `consul acl role delete [options]`
|
||||||
|
|
||||||
#### Enterprise Options
|
#### Enterprise Options
|
||||||
|
|
||||||
|
@include 'http_api_partition_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_namespace_options.mdx'
|
@include 'http_api_namespace_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_partition_options.mdx'
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_options_server.mdx'
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|
|
@ -23,12 +23,6 @@ are not supported from commands, but may be from the corresponding HTTP endpoint
|
||||||
|
|
||||||
Usage: `consul acl role list`
|
Usage: `consul acl role list`
|
||||||
|
|
||||||
#### API Options
|
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_options_server.mdx'
|
|
||||||
|
|
||||||
#### Command Options
|
#### Command Options
|
||||||
|
|
||||||
- `-meta` - Indicates that role metadata such as the content hash and
|
- `-meta` - Indicates that role metadata such as the content hash and
|
||||||
|
@ -38,9 +32,15 @@ Usage: `consul acl role list`
|
||||||
|
|
||||||
#### Enterprise Options
|
#### Enterprise Options
|
||||||
|
|
||||||
|
@include 'http_api_partition_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_namespace_options.mdx'
|
@include 'http_api_namespace_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_partition_options.mdx'
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_options_server.mdx'
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|
|
@ -23,12 +23,6 @@ are not supported from commands, but may be from the corresponding HTTP endpoint
|
||||||
|
|
||||||
Usage: `consul acl role read [options] [args]`
|
Usage: `consul acl role read [options] [args]`
|
||||||
|
|
||||||
#### API Options
|
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_options_server.mdx'
|
|
||||||
|
|
||||||
#### Command Options
|
#### Command Options
|
||||||
|
|
||||||
- `-id=<string>` - The ID of the role to read. It may be specified as a unique ID
|
- `-id=<string>` - The ID of the role to read. It may be specified as a unique ID
|
||||||
|
@ -43,9 +37,15 @@ Usage: `consul acl role read [options] [args]`
|
||||||
|
|
||||||
#### Enterprise Options
|
#### Enterprise Options
|
||||||
|
|
||||||
|
@include 'http_api_partition_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_namespace_options.mdx'
|
@include 'http_api_namespace_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_partition_options.mdx'
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_options_server.mdx'
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|
|
@ -27,12 +27,6 @@ are not supported from commands, but may be from the corresponding HTTP endpoint
|
||||||
|
|
||||||
Usage: `consul acl role update [options] [args]`
|
Usage: `consul acl role update [options] [args]`
|
||||||
|
|
||||||
#### API Options
|
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_options_server.mdx'
|
|
||||||
|
|
||||||
#### Command Options
|
#### Command Options
|
||||||
|
|
||||||
- `-description=<string>` - A description of the role.
|
- `-description=<string>` - A description of the role.
|
||||||
|
@ -67,9 +61,15 @@ Usage: `consul acl role update [options] [args]`
|
||||||
|
|
||||||
#### Enterprise Options
|
#### Enterprise Options
|
||||||
|
|
||||||
|
@include 'http_api_partition_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_namespace_options.mdx'
|
@include 'http_api_namespace_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_partition_options.mdx'
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_options_server.mdx'
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|
|
@ -26,9 +26,9 @@ are not supported from commands, but may be from the corresponding HTTP endpoint
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
Usage: `consul acl set-agent-token [options] TYPE TOKEN`
|
Usage: `consul acl set-agent-token [options] token_type token_secret_id`
|
||||||
|
|
||||||
### Token Types
|
The token types are:
|
||||||
|
|
||||||
- `default` - The default token is the token that the agent will use for
|
- `default` - The default token is the token that the agent will use for
|
||||||
both internal agent operations and operations initiated by the HTTP
|
both internal agent operations and operations initiated by the HTTP
|
||||||
|
|
|
@ -23,12 +23,6 @@ are not supported from commands, but may be from the corresponding HTTP endpoint
|
||||||
|
|
||||||
Usage: `consul acl token clone [options]`
|
Usage: `consul acl token clone [options]`
|
||||||
|
|
||||||
#### API Options
|
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_options_server.mdx'
|
|
||||||
|
|
||||||
#### Command Options
|
#### Command Options
|
||||||
|
|
||||||
- `-description=<string>` - A description of the new cloned token.
|
- `-description=<string>` - A description of the new cloned token.
|
||||||
|
@ -42,9 +36,15 @@ Usage: `consul acl token clone [options]`
|
||||||
|
|
||||||
#### Enterprise Options
|
#### Enterprise Options
|
||||||
|
|
||||||
|
@include 'http_api_partition_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_namespace_options.mdx'
|
@include 'http_api_namespace_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_partition_options.mdx'
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_options_server.mdx'
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|
|
@ -25,12 +25,6 @@ are not supported from commands, but may be from the corresponding HTTP endpoint
|
||||||
|
|
||||||
Usage: `consul acl token create [options] [args]`
|
Usage: `consul acl token create [options] [args]`
|
||||||
|
|
||||||
#### API Options
|
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_options_server.mdx'
|
|
||||||
|
|
||||||
#### Command Options
|
#### Command Options
|
||||||
|
|
||||||
- `-accessor=<string>` - Create the token with this Accessor ID. It must be a UUID. If not
|
- `-accessor=<string>` - Create the token with this Accessor ID. It must be a UUID. If not
|
||||||
|
@ -70,9 +64,15 @@ Usage: `consul acl token create [options] [args]`
|
||||||
|
|
||||||
#### Enterprise Options
|
#### Enterprise Options
|
||||||
|
|
||||||
|
@include 'http_api_partition_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_namespace_options.mdx'
|
@include 'http_api_namespace_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_partition_options.mdx'
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_options_server.mdx'
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|
|
@ -23,12 +23,6 @@ are not supported from commands, but may be from the corresponding HTTP endpoint
|
||||||
|
|
||||||
Usage: `consul acl token delete [options]`
|
Usage: `consul acl token delete [options]`
|
||||||
|
|
||||||
#### API Options
|
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_options_server.mdx'
|
|
||||||
|
|
||||||
#### Command Options
|
#### Command Options
|
||||||
|
|
||||||
- `-id=<string>` - The ID of the token to delete. It may be specified as a
|
- `-id=<string>` - The ID of the token to delete. It may be specified as a
|
||||||
|
@ -36,9 +30,15 @@ Usage: `consul acl token delete [options]`
|
||||||
|
|
||||||
#### Enterprise Options
|
#### Enterprise Options
|
||||||
|
|
||||||
|
@include 'http_api_partition_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_namespace_options.mdx'
|
@include 'http_api_namespace_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_partition_options.mdx'
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_options_server.mdx'
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|
|
@ -23,12 +23,6 @@ are not supported from commands, but may be from the corresponding HTTP endpoint
|
||||||
|
|
||||||
Usage: `consul acl token list`
|
Usage: `consul acl token list`
|
||||||
|
|
||||||
#### API Options
|
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_options_server.mdx'
|
|
||||||
|
|
||||||
#### Command Options
|
#### Command Options
|
||||||
|
|
||||||
- `-meta` - Indicates that token metadata such as the content hash and
|
- `-meta` - Indicates that token metadata such as the content hash and
|
||||||
|
@ -38,9 +32,15 @@ Usage: `consul acl token list`
|
||||||
|
|
||||||
#### Enterprise Options
|
#### Enterprise Options
|
||||||
|
|
||||||
|
@include 'http_api_partition_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_namespace_options.mdx'
|
@include 'http_api_namespace_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_partition_options.mdx'
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_options_server.mdx'
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|
|
@ -23,12 +23,6 @@ are not supported from commands, but may be from the corresponding HTTP endpoint
|
||||||
|
|
||||||
Usage: `consul acl token read [options] [args]`
|
Usage: `consul acl token read [options] [args]`
|
||||||
|
|
||||||
#### API Options
|
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_options_server.mdx'
|
|
||||||
|
|
||||||
#### Command Options
|
#### Command Options
|
||||||
|
|
||||||
- `-id=<string>` - The ID of the policy to read. It may be specified as a unique ID
|
- `-id=<string>` - The ID of the policy to read. It may be specified as a unique ID
|
||||||
|
@ -47,9 +41,15 @@ Usage: `consul acl token read [options] [args]`
|
||||||
|
|
||||||
#### Enterprise Options
|
#### Enterprise Options
|
||||||
|
|
||||||
|
@include 'http_api_partition_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_namespace_options.mdx'
|
@include 'http_api_namespace_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_partition_options.mdx'
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_options_server.mdx'
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|
|
@ -24,12 +24,6 @@ are not supported from commands, but may be from the corresponding HTTP endpoint
|
||||||
|
|
||||||
Usage: `consul acl token update [options]`
|
Usage: `consul acl token update [options]`
|
||||||
|
|
||||||
#### API Options
|
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_options_server.mdx'
|
|
||||||
|
|
||||||
#### Command Options
|
#### Command Options
|
||||||
|
|
||||||
- `-description=<string>` - A description of the token
|
- `-description=<string>` - A description of the token
|
||||||
|
@ -79,9 +73,15 @@ guide.
|
||||||
|
|
||||||
#### Enterprise Options
|
#### Enterprise Options
|
||||||
|
|
||||||
|
@include 'http_api_partition_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_namespace_options.mdx'
|
@include 'http_api_namespace_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_partition_options.mdx'
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_options_server.mdx'
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|
|
@ -26,12 +26,6 @@ are not supported from commands, but may be from the corresponding HTTP endpoint
|
||||||
|
|
||||||
Usage: `consul acl translate-rules [options] TRANSLATE`
|
Usage: `consul acl translate-rules [options] TRANSLATE`
|
||||||
|
|
||||||
#### API Options
|
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_options_server.mdx'
|
|
||||||
|
|
||||||
#### Command Options
|
#### Command Options
|
||||||
|
|
||||||
- `TRANSLATE` - The rules to translate. If `-` is used, then
|
- `TRANSLATE` - The rules to translate. If `-` is used, then
|
||||||
|
@ -47,6 +41,12 @@ Usage: `consul acl translate-rules [options] TRANSLATE`
|
||||||
holds is not a rule set but rather the token accessor ID of a
|
holds is not a rule set but rather the token accessor ID of a
|
||||||
legacy ACL token that holds the rule set.
|
legacy ACL token that holds the rule set.
|
||||||
|
|
||||||
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_options_server.mdx'
|
||||||
|
|
||||||
### Examples
|
### Examples
|
||||||
|
|
||||||
Translate rules within a file:
|
Translate rules within a file:
|
||||||
|
|
|
@ -60,13 +60,7 @@ worker-02 d407a592-e93c-4d8e-8a6d-aba853d1e067 10.4.4.158 dc1 lan=10.4.4.158
|
||||||
|
|
||||||
Usage: `consul catalog nodes [options]`
|
Usage: `consul catalog nodes [options]`
|
||||||
|
|
||||||
#### API Options
|
#### Command Options
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_options_server.mdx'
|
|
||||||
|
|
||||||
#### Catalog List Nodes Options
|
|
||||||
|
|
||||||
- `-detailed` - Output detailed information about the nodes including their
|
- `-detailed` - Output detailed information about the nodes including their
|
||||||
addresses and metadata.
|
addresses and metadata.
|
||||||
|
@ -90,3 +84,9 @@ Usage: `consul catalog nodes [options]`
|
||||||
#### Enterprise Options
|
#### Enterprise Options
|
||||||
|
|
||||||
@include 'http_api_partition_options.mdx'
|
@include 'http_api_partition_options.mdx'
|
||||||
|
|
||||||
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_options_server.mdx'
|
||||||
|
|
|
@ -53,19 +53,7 @@ redis
|
||||||
|
|
||||||
Usage: `consul catalog services [options]`
|
Usage: `consul catalog services [options]`
|
||||||
|
|
||||||
#### API Options
|
#### Command Options
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_options_server.mdx'
|
|
||||||
|
|
||||||
#### Enterprise Options
|
|
||||||
|
|
||||||
@include 'http_api_namespace_options.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_partition_options.mdx'
|
|
||||||
|
|
||||||
#### Catalog List Nodes Options
|
|
||||||
|
|
||||||
- `-node=<id or name>` - Node `id or name` for which to list services.
|
- `-node=<id or name>` - Node `id or name` for which to list services.
|
||||||
|
|
||||||
|
@ -76,3 +64,15 @@ Usage: `consul catalog services [options]`
|
||||||
|
|
||||||
- `-tags` - Display each service's tags as a comma-separated list beside each
|
- `-tags` - Display each service's tags as a comma-separated list beside each
|
||||||
service entry.
|
service entry.
|
||||||
|
|
||||||
|
#### Enterprise Options
|
||||||
|
|
||||||
|
@include 'http_api_partition_options.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_namespace_options.mdx'
|
||||||
|
|
||||||
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_options_server.mdx'
|
||||||
|
|
|
@ -38,17 +38,7 @@ are not supported from commands, but may be from the corresponding HTTP endpoint
|
||||||
|
|
||||||
Usage: `consul config delete [options]`
|
Usage: `consul config delete [options]`
|
||||||
|
|
||||||
#### API Options
|
#### Command Options
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
#### Enterprise Options
|
|
||||||
|
|
||||||
@include 'http_api_namespace_options.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_partition_options.mdx'
|
|
||||||
|
|
||||||
#### Config Delete Options
|
|
||||||
|
|
||||||
- `-kind` - Specifies the kind of the config entry to read.
|
- `-kind` - Specifies the kind of the config entry to read.
|
||||||
|
|
||||||
|
@ -64,6 +54,16 @@ Usage: `consul config delete [options]`
|
||||||
- `-modify-index=<int>` - Unsigned integer representing the ModifyIndex of the
|
- `-modify-index=<int>` - Unsigned integer representing the ModifyIndex of the
|
||||||
config entry. This is used in combination with the -cas flag.
|
config entry. This is used in combination with the -cas flag.
|
||||||
|
|
||||||
|
#### Enterprise Options
|
||||||
|
|
||||||
|
@include 'http_api_namespace_options.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_partition_options.mdx'
|
||||||
|
|
||||||
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
$ consul config delete -kind service-defaults -name web
|
$ consul config delete -kind service-defaults -name web
|
||||||
|
|
|
@ -38,19 +38,19 @@ are not supported from commands, but may be from the corresponding HTTP endpoint
|
||||||
|
|
||||||
Usage: `consul config list [options]`
|
Usage: `consul config list [options]`
|
||||||
|
|
||||||
#### API Options
|
#### Command Options
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
- `-kind` - Specifies the kind of the config entry to list.
|
||||||
|
|
||||||
#### Enterprise Options
|
#### Enterprise Options
|
||||||
|
|
||||||
@include 'http_api_namespace_options.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_partition_options.mdx'
|
@include 'http_api_partition_options.mdx'
|
||||||
|
|
||||||
#### Config List Options
|
@include 'http_api_namespace_options.mdx'
|
||||||
|
|
||||||
- `-kind` - Specifies the kind of the config entry to list.
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|
|
@ -39,16 +39,6 @@ are not supported from commands, but may be from the corresponding HTTP endpoint
|
||||||
|
|
||||||
Usage: `consul config read [options]`
|
Usage: `consul config read [options]`
|
||||||
|
|
||||||
#### API Options
|
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
#### Enterprise Options
|
|
||||||
|
|
||||||
@include 'http_api_namespace_options.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_partition_options.mdx'
|
|
||||||
|
|
||||||
#### Config Read Options
|
#### Config Read Options
|
||||||
|
|
||||||
- `-kind` - Specifies the kind of the config entry to read.
|
- `-kind` - Specifies the kind of the config entry to read.
|
||||||
|
@ -57,6 +47,16 @@ Usage: `consul config read [options]`
|
||||||
`proxy-defaults` config entry must be `global`, and the name of the `mesh`
|
`proxy-defaults` config entry must be `global`, and the name of the `mesh`
|
||||||
config entry must be `mesh`.
|
config entry must be `mesh`.
|
||||||
|
|
||||||
|
#### Enterprise Options
|
||||||
|
|
||||||
|
@include 'http_api_partition_options.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_namespace_options.mdx'
|
||||||
|
|
||||||
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
$ consul config read -kind service-defaults -name web
|
$ consul config read -kind service-defaults -name web
|
||||||
|
|
|
@ -41,23 +41,23 @@ are not supported from commands, but may be from the corresponding HTTP endpoint
|
||||||
|
|
||||||
Usage: `consul config write [options] FILE`
|
Usage: `consul config write [options] FILE`
|
||||||
|
|
||||||
#### API Options
|
#### Command Options
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
#### Enterprise Options
|
|
||||||
|
|
||||||
@include 'http_api_namespace_options.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_partition_options.mdx'
|
|
||||||
|
|
||||||
#### Config Write Options
|
|
||||||
|
|
||||||
- `-cas` - Specifies to use a Check-And-Set operation. If the index is
|
- `-cas` - Specifies to use a Check-And-Set operation. If the index is
|
||||||
0, Consul will only store the entry if it does not already exist. If the index is
|
0, Consul will only store the entry if it does not already exist. If the index is
|
||||||
non-zero, the entry is only set if the current index matches the `ModifyIndex`
|
non-zero, the entry is only set if the current index matches the `ModifyIndex`
|
||||||
of that entry.
|
of that entry.
|
||||||
|
|
||||||
|
#### Enterprise Options
|
||||||
|
|
||||||
|
@include 'http_api_partition_options.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_namespace_options.mdx'
|
||||||
|
|
||||||
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
From file:
|
From file:
|
||||||
|
|
|
@ -89,11 +89,13 @@ Usage: `consul connect ca set-config [options]`
|
||||||
|
|
||||||
Corresponding HTTP API Endpoint: [\[PUT\] /v1/connect/ca/configuration](/api-docs/connect/ca#update-ca-configuration)
|
Corresponding HTTP API Endpoint: [\[PUT\] /v1/connect/ca/configuration](/api-docs/connect/ca#update-ca-configuration)
|
||||||
|
|
||||||
#### API Options
|
The output looks like this:
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
```
|
||||||
|
Configuration updated!
|
||||||
|
```
|
||||||
|
|
||||||
@include 'http_api_options_server.mdx'
|
The return code will indicate success or failure.
|
||||||
|
|
||||||
#### Command Options
|
#### Command Options
|
||||||
|
|
||||||
|
@ -108,10 +110,8 @@ Corresponding HTTP API Endpoint: [\[PUT\] /v1/connect/ca/configuration](/api-doc
|
||||||
Cross-Signing](/docs/connect/ca#forced-rotation-without-cross-signing)
|
Cross-Signing](/docs/connect/ca#forced-rotation-without-cross-signing)
|
||||||
for more detail.
|
for more detail.
|
||||||
|
|
||||||
The output looks like this:
|
#### API Options
|
||||||
|
|
||||||
```
|
@include 'http_api_options_client.mdx'
|
||||||
Configuration updated!
|
|
||||||
```
|
|
||||||
|
|
||||||
The return code will indicate success or failure.
|
@include 'http_api_options_server.mdx'
|
||||||
|
|
|
@ -30,26 +30,6 @@ build on but then used in a virtualized environment that can run Envoy.
|
||||||
|
|
||||||
Usage: `consul connect envoy [options] [-- pass-through options]`
|
Usage: `consul connect envoy [options] [-- pass-through options]`
|
||||||
|
|
||||||
#### API Options
|
|
||||||
|
|
||||||
The standard API options are used to connect to the local agent to discover the
|
|
||||||
proxy configuration needed.
|
|
||||||
|
|
||||||
- `-grpc-addr=<addr>` - Address of the Consul agent with `grpc` port. This can
|
|
||||||
be an IP address or DNS address, but it must include the port. This can also
|
|
||||||
be specified via the CONSUL_GRPC_ADDR environment variable. In Consul 1.3 and
|
|
||||||
later, the default value is 127.0.0.1:8502, and https can optionally
|
|
||||||
be used instead. The scheme can also be set to HTTPS by setting the
|
|
||||||
environment variable CONSUL_HTTP_SSL=true. This may be a unix domain socket
|
|
||||||
using `unix:///path/to/socket` if the [agent is configured to
|
|
||||||
listen](/docs/agent/config/config-files#addresses) that way.
|
|
||||||
|
|
||||||
-> **Note:** gRPC uses the same TLS
|
|
||||||
settings as the HTTPS API. If HTTPS is enabled then gRPC will require HTTPS
|
|
||||||
as well.
|
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
#### Envoy Options for both Sidecars and Gateways
|
#### Envoy Options for both Sidecars and Gateways
|
||||||
|
|
||||||
- `-proxy-id` - The [proxy service](/docs/connect/registration/service-registration) ID.
|
- `-proxy-id` - The [proxy service](/docs/connect/registration/service-registration) ID.
|
||||||
|
@ -189,9 +169,29 @@ proxy configuration needed.
|
||||||
|
|
||||||
#### Enterprise Options
|
#### Enterprise Options
|
||||||
|
|
||||||
|
@include 'http_api_partition_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_namespace_options.mdx'
|
@include 'http_api_namespace_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_partition_options.mdx'
|
#### API Options
|
||||||
|
|
||||||
|
The standard API options are used to connect to the local agent to discover the
|
||||||
|
proxy configuration needed.
|
||||||
|
|
||||||
|
- `-grpc-addr=<addr>` - Address of the Consul agent with `grpc` port. This can
|
||||||
|
be an IP address or DNS address, but it must include the port. This can also
|
||||||
|
be specified via the CONSUL_GRPC_ADDR environment variable. In Consul 1.3 and
|
||||||
|
later, the default value is 127.0.0.1:8502, and https can optionally
|
||||||
|
be used instead. The scheme can also be set to HTTPS by setting the
|
||||||
|
environment variable CONSUL_HTTP_SSL=true. This may be a unix domain socket
|
||||||
|
using `unix:///path/to/socket` if the [agent is configured to
|
||||||
|
listen](/docs/agent/config/config-files#addresses) that way.
|
||||||
|
|
||||||
|
-> **Note:** gRPC uses the same TLS
|
||||||
|
settings as the HTTPS API. If HTTPS is enabled then gRPC will require HTTPS
|
||||||
|
as well.
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|
|
@ -24,13 +24,7 @@ Usage: consul connect expose [options]
|
||||||
given protocol and port.
|
given protocol and port.
|
||||||
```
|
```
|
||||||
|
|
||||||
#### API Options
|
#### Command Options
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_options_server.mdx'
|
|
||||||
|
|
||||||
#### Expose Options
|
|
||||||
|
|
||||||
- `-ingress-gateway` - (Required) The name of the ingress gateway service to use.
|
- `-ingress-gateway` - (Required) The name of the ingress gateway service to use.
|
||||||
A partition and namespace can optionally be specified as a prefix via the
|
A partition and namespace can optionally be specified as a prefix via the
|
||||||
|
@ -50,6 +44,12 @@ Usage: consul connect expose [options]
|
||||||
- `-host` - Additional DNS hostname to use for routing to this service. Can be
|
- `-host` - Additional DNS hostname to use for routing to this service. Can be
|
||||||
specified multiple times.
|
specified multiple times.
|
||||||
|
|
||||||
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_options_server.mdx'
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
The example below shows using the `expose` command to make the `foo` service available
|
The example below shows using the `expose` command to make the `foo` service available
|
||||||
|
|
|
@ -19,13 +19,7 @@ can also be used in development to connect to Connect-enabled services.
|
||||||
|
|
||||||
Usage: `consul connect proxy [options]`
|
Usage: `consul connect proxy [options]`
|
||||||
|
|
||||||
#### API Options
|
#### Command Options
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_options_server.mdx'
|
|
||||||
|
|
||||||
#### Proxy Options
|
|
||||||
|
|
||||||
- `-sidecar-for` - The _ID_ (not name if they differ) of the service instance
|
- `-sidecar-for` - The _ID_ (not name if they differ) of the service instance
|
||||||
this proxy will represent. The target service doesn't need to exist on the
|
this proxy will represent. The target service doesn't need to exist on the
|
||||||
|
@ -76,6 +70,12 @@ Usage: `consul connect proxy [options]`
|
||||||
register a fully configured proxy instance rather than specify config and
|
register a fully configured proxy instance rather than specify config and
|
||||||
registration via this command.
|
registration via this command.
|
||||||
|
|
||||||
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_options_server.mdx'
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
The example below shows how to start a local proxy for establishing outbound
|
The example below shows how to start a local proxy for establishing outbound
|
||||||
|
|
|
@ -30,11 +30,7 @@ inbound and outbound ports specified in the service registration.
|
||||||
|
|
||||||
Usage: `consul connect redirect-traffic [options]`
|
Usage: `consul connect redirect-traffic [options]`
|
||||||
|
|
||||||
#### API Options
|
#### Command Options
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
#### Options for Traffic Redirection Rules
|
|
||||||
|
|
||||||
- `-consul-dns-ip` - The IP address of the Consul DNS resolver. If provided, DNS queries will be redirected to the provided IP address for name resolution.
|
- `-consul-dns-ip` - The IP address of the Consul DNS resolver. If provided, DNS queries will be redirected to the provided IP address for name resolution.
|
||||||
|
|
||||||
|
@ -60,9 +56,13 @@ Usage: `consul connect redirect-traffic [options]`
|
||||||
|
|
||||||
#### Enterprise Options
|
#### Enterprise Options
|
||||||
|
|
||||||
|
@include 'http_api_partition_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_namespace_options.mdx'
|
@include 'http_api_namespace_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_partition_options.mdx'
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|
|
@ -45,10 +45,6 @@ or otherwise.
|
||||||
By default, the debug command will capture an archive at the current path for
|
By default, the debug command will capture an archive at the current path for
|
||||||
all targets for 2 minutes.
|
all targets for 2 minutes.
|
||||||
|
|
||||||
#### API Options
|
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
#### Command Options
|
#### Command Options
|
||||||
|
|
||||||
- `-duration` - Optional, the total time to capture data for from the target agent. Must
|
- `-duration` - Optional, the total time to capture data for from the target agent. Must
|
||||||
|
@ -66,6 +62,10 @@ all targets for 2 minutes.
|
||||||
- `-archive` - Optional, if the tool show archive the directory of data into a
|
- `-archive` - Optional, if the tool show archive the directory of data into a
|
||||||
compressed tar file. Defaults to true.
|
compressed tar file. Defaults to true.
|
||||||
|
|
||||||
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
## Capture Targets
|
## Capture Targets
|
||||||
|
|
||||||
The `-capture` flag can be specified multiple times to capture specific
|
The `-capture` flag can be specified multiple times to capture specific
|
||||||
|
|
|
@ -52,12 +52,6 @@ Usage: `consul event [options] [payload]`
|
||||||
The only required option is `-name` which specifies the event name. An optional
|
The only required option is `-name` which specifies the event name. An optional
|
||||||
payload can be provided as the final argument.
|
payload can be provided as the final argument.
|
||||||
|
|
||||||
#### API Options
|
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_options_server.mdx'
|
|
||||||
|
|
||||||
#### Command Options
|
#### Command Options
|
||||||
|
|
||||||
- `-name` - The name of the event.
|
- `-name` - The name of the event.
|
||||||
|
@ -69,3 +63,9 @@ payload can be provided as the final argument.
|
||||||
- `-tag` - Regular expression to filter to only nodes with a service that has
|
- `-tag` - Regular expression to filter to only nodes with a service that has
|
||||||
a matching tag. This must be used with `-service`. As an example, you may
|
a matching tag. This must be used with `-service`. As an example, you may
|
||||||
do `-service mysql -tag secondary`.
|
do `-service mysql -tag secondary`.
|
||||||
|
|
||||||
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_options_server.mdx'
|
||||||
|
|
|
@ -50,12 +50,6 @@ The only required option is a command to execute. This is either given
|
||||||
as trailing arguments, or by specifying `-`; STDIN will be read to
|
as trailing arguments, or by specifying `-`; STDIN will be read to
|
||||||
completion as a script to evaluate.
|
completion as a script to evaluate.
|
||||||
|
|
||||||
#### API Options
|
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_options_server.mdx'
|
|
||||||
|
|
||||||
#### Command Options
|
#### Command Options
|
||||||
|
|
||||||
- `-prefix` - Key prefix in the KV store to use for storing request data.
|
- `-prefix` - Key prefix in the KV store to use for storing request data.
|
||||||
|
@ -81,3 +75,9 @@ completion as a script to evaluate.
|
||||||
to 200 msec.
|
to 200 msec.
|
||||||
|
|
||||||
- `-verbose` - Enables verbose output.
|
- `-verbose` - Enables verbose output.
|
||||||
|
|
||||||
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_options_server.mdx'
|
||||||
|
|
|
@ -46,15 +46,15 @@ Usage: `consul intention check [options] SRC DST`
|
||||||
|
|
||||||
`SRC` and `DST` can both take [several forms](/commands/intention#source-and-destination-naming).
|
`SRC` and `DST` can both take [several forms](/commands/intention#source-and-destination-naming).
|
||||||
|
|
||||||
#### API Options
|
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
#### Enterprise Options
|
#### Enterprise Options
|
||||||
|
|
||||||
|
@include 'http_api_partition_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_namespace_options.mdx'
|
@include 'http_api_namespace_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_partition_options.mdx'
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|
|
@ -41,17 +41,7 @@ are not supported from commands, but may be from the corresponding HTTP endpoint
|
||||||
|
|
||||||
`SRC` and `DST` can both take [several forms](/commands/intention#source-and-destination-naming).
|
`SRC` and `DST` can both take [several forms](/commands/intention#source-and-destination-naming).
|
||||||
|
|
||||||
#### API Options
|
#### Command Options
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
#### Enterprise Options
|
|
||||||
|
|
||||||
@include 'http_api_namespace_options.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_partition_options.mdx'
|
|
||||||
|
|
||||||
#### Intention Create Options
|
|
||||||
|
|
||||||
- `-allow` - Set the action to "allow" for intentions. This is the default.
|
- `-allow` - Set the action to "allow" for intentions. This is the default.
|
||||||
|
|
||||||
|
@ -67,6 +57,16 @@ are not supported from commands, but may be from the corresponding HTTP endpoint
|
||||||
- `-replace` - Replace any matching intention. The replacement is done
|
- `-replace` - Replace any matching intention. The replacement is done
|
||||||
atomically per intention.
|
atomically per intention.
|
||||||
|
|
||||||
|
#### Enterprise Options
|
||||||
|
|
||||||
|
@include 'http_api_partition_options.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_namespace_options.mdx'
|
||||||
|
|
||||||
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
Create an intention `web => db`:
|
Create an intention `web => db`:
|
||||||
|
|
|
@ -42,15 +42,15 @@ Usage:
|
||||||
|
|
||||||
`SRC` and `DST` can both take [several forms](/commands/intention#source-and-destination-naming).
|
`SRC` and `DST` can both take [several forms](/commands/intention#source-and-destination-naming).
|
||||||
|
|
||||||
#### API Options
|
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
#### Enterprise Options
|
#### Enterprise Options
|
||||||
|
|
||||||
|
@include 'http_api_partition_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_namespace_options.mdx'
|
@include 'http_api_namespace_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_partition_options.mdx'
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|
|
@ -42,15 +42,15 @@ Usage:
|
||||||
|
|
||||||
`SRC` and `DST` can both take [several forms](/commands/intention#source-and-destination-naming).
|
`SRC` and `DST` can both take [several forms](/commands/intention#source-and-destination-naming).
|
||||||
|
|
||||||
#### API Options
|
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
#### Enterprise Options
|
#### Enterprise Options
|
||||||
|
|
||||||
|
@include 'http_api_partition_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_namespace_options.mdx'
|
@include 'http_api_namespace_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_partition_options.mdx'
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|
|
@ -34,14 +34,14 @@ Usage:
|
||||||
|
|
||||||
- `consul intention list`
|
- `consul intention list`
|
||||||
|
|
||||||
#### API Options
|
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
#### Enterprise Options
|
#### Enterprise Options
|
||||||
|
|
||||||
@include 'http_api_namespace_options.mdx'
|
@include 'http_api_namespace_options.mdx'
|
||||||
|
|
||||||
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
```shell-session
|
```shell-session
|
||||||
|
|
|
@ -39,22 +39,22 @@ Usage: `consul intention match [options] SRC_OR_DST`
|
||||||
|
|
||||||
`SRC` and `DST` can both take [several forms](/commands/intention#source-and-destination-naming).
|
`SRC` and `DST` can both take [several forms](/commands/intention#source-and-destination-naming).
|
||||||
|
|
||||||
#### API Options
|
#### Command Options
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
#### Enterprise Options
|
|
||||||
|
|
||||||
@include 'http_api_namespace_options.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_partition_options.mdx'
|
|
||||||
|
|
||||||
#### Intention Match Options
|
|
||||||
|
|
||||||
- `-destination` - Match by destination.
|
- `-destination` - Match by destination.
|
||||||
|
|
||||||
- `-source` - Match by source.
|
- `-source` - Match by source.
|
||||||
|
|
||||||
|
#### Enterprise Options
|
||||||
|
|
||||||
|
@include 'http_api_partition_options.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_namespace_options.mdx'
|
||||||
|
|
||||||
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
```shell-session
|
```shell-session
|
||||||
|
|
|
@ -38,12 +38,12 @@ You may call `join` with multiple addresses if you want attempt to join the clus
|
||||||
through multiple nodes. Consul will attempt to join all addresses. The join
|
through multiple nodes. Consul will attempt to join all addresses. The join
|
||||||
command will fail only if Consul was unable to join any of the specified addresses.
|
command will fail only if Consul was unable to join any of the specified addresses.
|
||||||
|
|
||||||
#### API Options
|
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
#### Command Options
|
#### Command Options
|
||||||
|
|
||||||
- `-wan` - For agents running in server mode, the agent will attempt to join
|
- `-wan` - For agents running in server mode, the agent will attempt to join
|
||||||
other servers gossiping in a WAN cluster. This is used to form a bridge between
|
other servers gossiping in a WAN cluster. This is used to form a bridge between
|
||||||
multiple datacenters.
|
multiple datacenters.
|
||||||
|
|
||||||
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
|
@ -49,10 +49,6 @@ Usage: `consul keyring [options]`
|
||||||
Only one actionable argument may be specified per run, including `-list`,
|
Only one actionable argument may be specified per run, including `-list`,
|
||||||
`-install`, `-remove`, and `-use`.
|
`-install`, `-remove`, and `-use`.
|
||||||
|
|
||||||
#### API Options
|
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
#### Command Options
|
#### Command Options
|
||||||
|
|
||||||
- `-list` - List all keys currently in use within the cluster.
|
- `-list` - List all keys currently in use within the cluster.
|
||||||
|
@ -76,6 +72,10 @@ Only one actionable argument may be specified per run, including `-list`,
|
||||||
local servers (no WAN traffic). Setting `local-only` is only allowed for list
|
local servers (no WAN traffic). Setting `local-only` is only allowed for list
|
||||||
queries.
|
queries.
|
||||||
|
|
||||||
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
## Output
|
## Output
|
||||||
|
|
||||||
The output of the `consul keyring -list` command consolidates information from
|
The output of the `consul keyring -list` command consolidates information from
|
||||||
|
|
|
@ -24,29 +24,30 @@ are not supported from commands, but may be from the corresponding HTTP endpoint
|
||||||
|
|
||||||
Usage: `consul kv delete [options] KEY_OR_PREFIX`
|
Usage: `consul kv delete [options] KEY_OR_PREFIX`
|
||||||
|
|
||||||
|
#### Command Options
|
||||||
|
|
||||||
|
- `-cas` - Perform a Check-And-Set operation.
|
||||||
|
To use this option, the `-modify-index` flag must also be set.
|
||||||
|
The default value is `false`.
|
||||||
|
|
||||||
|
- `-modify-index=<int>` - Specifies an unsigned integer that represents
|
||||||
|
the `ModifyIndex` of the key. Used in combination with the `-cas` flag.
|
||||||
|
|
||||||
|
- `-recurse` - Recursively delete all keys with the path. The default value is
|
||||||
|
`false`.
|
||||||
|
|
||||||
|
#### Enterprise Options
|
||||||
|
|
||||||
|
@include 'http_api_partition_options.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_namespace_options.mdx'
|
||||||
|
|
||||||
#### API Options
|
#### API Options
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
@include 'http_api_options_server.mdx'
|
@include 'http_api_options_server.mdx'
|
||||||
|
|
||||||
#### Enterprise Options
|
|
||||||
|
|
||||||
@include 'http_api_namespace_options.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_partition_options.mdx'
|
|
||||||
|
|
||||||
#### KV Delete Options
|
|
||||||
|
|
||||||
- `-cas` - Perform a Check-And-Set operation. Specifying this value also
|
|
||||||
requires the -modify-index flag to be set. The default value is false.
|
|
||||||
|
|
||||||
- `-modify-index=<int>` - Unsigned integer representing the ModifyIndex of the
|
|
||||||
key. This is used in combination with the -cas flag.
|
|
||||||
|
|
||||||
- `-recurse` - Recursively delete all keys with the path. The default value is
|
|
||||||
false.
|
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
To remove the value for the key named "redis/config/connections" in the
|
To remove the value for the key named "redis/config/connections" in the
|
||||||
|
|
|
@ -24,18 +24,18 @@ are not supported from commands, but may be from the corresponding HTTP endpoint
|
||||||
|
|
||||||
Usage: `consul kv export [options] [PREFIX]`
|
Usage: `consul kv export [options] [PREFIX]`
|
||||||
|
|
||||||
|
#### Enterprise Options
|
||||||
|
|
||||||
|
@include 'http_api_partition_options.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_namespace_options.mdx'
|
||||||
|
|
||||||
#### API Options
|
#### API Options
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
@include 'http_api_options_server.mdx'
|
@include 'http_api_options_server.mdx'
|
||||||
|
|
||||||
#### Enterprise Options
|
|
||||||
|
|
||||||
@include 'http_api_namespace_options.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_partition_options.mdx'
|
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
To export the tree at "vault/" in the key value store:
|
To export the tree at "vault/" in the key value store:
|
||||||
|
|
|
@ -32,19 +32,7 @@ are not supported from commands, but may be from the corresponding HTTP endpoint
|
||||||
|
|
||||||
Usage: `consul kv get [options] [KEY_OR_PREFIX]`
|
Usage: `consul kv get [options] [KEY_OR_PREFIX]`
|
||||||
|
|
||||||
#### API Options
|
#### Command Options
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_options_server.mdx'
|
|
||||||
|
|
||||||
#### Enterprise Options
|
|
||||||
|
|
||||||
@include 'http_api_namespace_options.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_partition_options.mdx'
|
|
||||||
|
|
||||||
#### KV Get Options
|
|
||||||
|
|
||||||
- `-base64` - Base 64 encode the value. The default value is false.
|
- `-base64` - Base 64 encode the value. The default value is false.
|
||||||
|
|
||||||
|
@ -64,6 +52,18 @@ Usage: `consul kv get [options] [KEY_OR_PREFIX]`
|
||||||
default value is "/", and only used when paired with the `-keys` flag. This will
|
default value is "/", and only used when paired with the `-keys` flag. This will
|
||||||
limit the prefix of keys returned, only up to the given separator.
|
limit the prefix of keys returned, only up to the given separator.
|
||||||
|
|
||||||
|
#### Enterprise Options
|
||||||
|
|
||||||
|
@include 'http_api_partition_options.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_namespace_options.mdx'
|
||||||
|
|
||||||
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_options_server.mdx'
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
To retrieve the value for the key named "redis/config/connections" in the
|
To retrieve the value for the key named "redis/config/connections" in the
|
||||||
|
|
|
@ -22,22 +22,22 @@ are not supported from commands, but may be from the corresponding HTTP endpoint
|
||||||
|
|
||||||
Usage: `consul kv import [options] [DATA]`
|
Usage: `consul kv import [options] [DATA]`
|
||||||
|
|
||||||
#### API Options
|
#### Command Options
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_options_server.mdx'
|
|
||||||
|
|
||||||
#### KV Import Options
|
|
||||||
|
|
||||||
- `-prefix` - Key prefix for imported data. The default value is empty meaning
|
- `-prefix` - Key prefix for imported data. The default value is empty meaning
|
||||||
root. Added in Consul 1.10.
|
root. Added in Consul 1.10.
|
||||||
|
|
||||||
#### Enterprise Options
|
#### Enterprise Options
|
||||||
|
|
||||||
|
@include 'http_api_partition_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_namespace_options.mdx'
|
@include 'http_api_namespace_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_partition_options.mdx'
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_options_server.mdx'
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|
|
@ -28,19 +28,7 @@ are not supported from commands, but may be from the corresponding HTTP endpoint
|
||||||
|
|
||||||
Usage: `consul kv put [options] KEY [DATA]`
|
Usage: `consul kv put [options] KEY [DATA]`
|
||||||
|
|
||||||
#### API Options
|
#### Command Options
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_options_server.mdx'
|
|
||||||
|
|
||||||
#### Enterprise Options
|
|
||||||
|
|
||||||
@include 'http_api_namespace_options.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_partition_options.mdx'
|
|
||||||
|
|
||||||
#### KV Put Options
|
|
||||||
|
|
||||||
- `-acquire` - Obtain a lock on the key. If the key does not exist, this
|
- `-acquire` - Obtain a lock on the key. If the key does not exist, this
|
||||||
operation will create the key and obtain the lock. The session must already
|
operation will create the key and obtain the lock. The session must already
|
||||||
|
@ -67,6 +55,18 @@ Usage: `consul kv put [options] KEY [DATA]`
|
||||||
robust locking, but it can be set on any key. The default value is empty (no
|
robust locking, but it can be set on any key. The default value is empty (no
|
||||||
session).
|
session).
|
||||||
|
|
||||||
|
#### Enterprise Options
|
||||||
|
|
||||||
|
@include 'http_api_partition_options.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_namespace_options.mdx'
|
||||||
|
|
||||||
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_options_server.mdx'
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
To insert a value of "5" for the key named "redis/config/connections" in the
|
To insert a value of "5" for the key named "redis/config/connections" in the
|
||||||
|
|
|
@ -138,12 +138,6 @@ are not supported from commands, but may be from the corresponding HTTP endpoint
|
||||||
|
|
||||||
Usage: `consul license put [options] LICENSE`
|
Usage: `consul license put [options] LICENSE`
|
||||||
|
|
||||||
#### API Options
|
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_options_server.mdx'
|
|
||||||
|
|
||||||
The output looks like this:
|
The output looks like this:
|
||||||
|
|
||||||
```text
|
```text
|
||||||
|
@ -162,6 +156,12 @@ Licensed Features:
|
||||||
Advanced Network Federation
|
Advanced Network Federation
|
||||||
```
|
```
|
||||||
|
|
||||||
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_options_server.mdx'
|
||||||
|
|
||||||
## get
|
## get
|
||||||
|
|
||||||
Corresponding HTTP API Endpoint: [\[GET\] /v1/operator/license](/api-docs/operator/license#getting-the-consul-license)
|
Corresponding HTTP API Endpoint: [\[GET\] /v1/operator/license](/api-docs/operator/license#getting-the-consul-license)
|
||||||
|
@ -178,12 +178,6 @@ are not supported from commands, but may be from the corresponding HTTP endpoint
|
||||||
|
|
||||||
Usage: `consul license get [options]`
|
Usage: `consul license get [options]`
|
||||||
|
|
||||||
#### API Options
|
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_options_server.mdx'
|
|
||||||
|
|
||||||
The output looks like this:
|
The output looks like this:
|
||||||
|
|
||||||
```text
|
```text
|
||||||
|
@ -202,6 +196,12 @@ Licensed Features:
|
||||||
Advanced Network Federation
|
Advanced Network Federation
|
||||||
```
|
```
|
||||||
|
|
||||||
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_options_server.mdx'
|
||||||
|
|
||||||
## reset
|
## reset
|
||||||
|
|
||||||
-> **Deprecated** The ability to manage the cluster's license via the CLI
|
-> **Deprecated** The ability to manage the cluster's license via the CLI
|
||||||
|
@ -223,12 +223,6 @@ are not supported from commands, but may be from the corresponding HTTP endpoint
|
||||||
|
|
||||||
Usage: `consul license reset [options]`
|
Usage: `consul license reset [options]`
|
||||||
|
|
||||||
#### API Options
|
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_options_server.mdx'
|
|
||||||
|
|
||||||
The output looks like this:
|
The output looks like this:
|
||||||
|
|
||||||
```text
|
```text
|
||||||
|
@ -246,3 +240,9 @@ Licensed Features:
|
||||||
Redundancy Zone
|
Redundancy Zone
|
||||||
Advanced Network Federation
|
Advanced Network Federation
|
||||||
```
|
```
|
||||||
|
|
||||||
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_options_server.mdx'
|
||||||
|
|
|
@ -46,12 +46,6 @@ of 5 seconds, a `SIGKILL` will be used to force termination. For Consul agents
|
||||||
on Windows, the child process is always terminated with a `SIGKILL`, since
|
on Windows, the child process is always terminated with a `SIGKILL`, since
|
||||||
Windows has no POSIX compatible notion for `SIGTERM`.
|
Windows has no POSIX compatible notion for `SIGTERM`.
|
||||||
|
|
||||||
#### API Options
|
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_options_server.mdx'
|
|
||||||
|
|
||||||
#### Command Options
|
#### Command Options
|
||||||
|
|
||||||
- `-child-exit-code` - Exit 2 if the child process exited with an error
|
- `-child-exit-code` - Exit 2 if the child process exited with an error
|
||||||
|
@ -82,6 +76,12 @@ Windows has no POSIX compatible notion for `SIGTERM`.
|
||||||
|
|
||||||
- `-verbose` - Enables verbose output.
|
- `-verbose` - Enables verbose output.
|
||||||
|
|
||||||
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_options_server.mdx'
|
||||||
|
|
||||||
## SHELL
|
## SHELL
|
||||||
|
|
||||||
Consul lock launches its children in a shell. By default, Consul will use the shell
|
Consul lock launches its children in a shell. By default, Consul will use the shell
|
||||||
|
|
|
@ -29,10 +29,6 @@ are not supported from commands, but may be from the corresponding HTTP endpoint
|
||||||
|
|
||||||
Usage: `consul login [options]`
|
Usage: `consul login [options]`
|
||||||
|
|
||||||
#### API Options
|
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
#### Command Options
|
#### Command Options
|
||||||
|
|
||||||
- `-bearer-token-file=<string>` - Path to a file containing a secret bearer
|
- `-bearer-token-file=<string>` - Path to a file containing a secret bearer
|
||||||
|
@ -52,11 +48,15 @@ Usage: `consul login [options]`
|
||||||
|
|
||||||
#### Enterprise Options
|
#### Enterprise Options
|
||||||
|
|
||||||
@include 'http_api_namespace_options.mdx'
|
|
||||||
|
|
||||||
- `-oidc-callback-listen-addr=<string>` - The address to bind a webserver on to
|
- `-oidc-callback-listen-addr=<string>` - The address to bind a webserver on to
|
||||||
handle the browser callback from the OIDC workflow. Added in Consul 1.8.0.
|
handle the browser callback from the OIDC workflow. Added in Consul 1.8.0.
|
||||||
|
|
||||||
|
@include 'http_api_namespace_options.mdx'
|
||||||
|
|
||||||
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
### Examples
|
### Examples
|
||||||
|
|
||||||
Login to an auth method.
|
Login to an auth method.
|
||||||
|
|
|
@ -33,10 +33,6 @@ are not supported from commands, but may be from the corresponding HTTP endpoint
|
||||||
|
|
||||||
Usage: `consul maint [options]`
|
Usage: `consul maint [options]`
|
||||||
|
|
||||||
#### API Options
|
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
#### Command Options
|
#### Command Options
|
||||||
|
|
||||||
- `-enable` - Enable node-wide maintenance mode flag. If combined with the
|
- `-enable` - Enable node-wide maintenance mode flag. If combined with the
|
||||||
|
@ -55,6 +51,10 @@ Usage: `consul maint [options]`
|
||||||
providing this flag, the `-enable` and `-disable` flags functionality is
|
providing this flag, the `-enable` and `-disable` flags functionality is
|
||||||
modified to operate on the given service ID.
|
modified to operate on the given service ID.
|
||||||
|
|
||||||
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
## List mode
|
## List mode
|
||||||
|
|
||||||
If neither `-enable` nor `-disable` are passed, the `maint` command will
|
If neither `-enable` nor `-disable` are passed, the `maint` command will
|
||||||
|
|
|
@ -33,14 +33,6 @@ are not supported from commands, but may be from the corresponding HTTP endpoint
|
||||||
|
|
||||||
Usage: `consul members [options]`
|
Usage: `consul members [options]`
|
||||||
|
|
||||||
#### API Options
|
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
#### Enterprise Options
|
|
||||||
|
|
||||||
@include 'http_api_partition_options.mdx'
|
|
||||||
|
|
||||||
#### Command Options
|
#### Command Options
|
||||||
|
|
||||||
- `-detailed` - If provided, output shows more detailed information
|
- `-detailed` - If provided, output shows more detailed information
|
||||||
|
@ -55,3 +47,11 @@ Usage: `consul members [options]`
|
||||||
- `-wan` - For agents in Server mode, this will return the list of nodes
|
- `-wan` - For agents in Server mode, this will return the list of nodes
|
||||||
in the WAN gossip pool. These are generally all the server nodes in
|
in the WAN gossip pool. These are generally all the server nodes in
|
||||||
each datacenter.
|
each datacenter.
|
||||||
|
|
||||||
|
#### Enterprise Options
|
||||||
|
|
||||||
|
@include 'http_api_partition_options.mdx'
|
||||||
|
|
||||||
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
|
@ -23,10 +23,6 @@ logs and watch the debug logs if necessary.
|
||||||
|
|
||||||
Usage: `consul monitor [options]`
|
Usage: `consul monitor [options]`
|
||||||
|
|
||||||
#### API Options
|
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
#### Command Options
|
#### Command Options
|
||||||
|
|
||||||
- `-log-level` - The log level of the messages to show. By default this
|
- `-log-level` - The log level of the messages to show. By default this
|
||||||
|
@ -35,3 +31,7 @@ Usage: `consul monitor [options]`
|
||||||
"warn", and "error".
|
"warn", and "error".
|
||||||
- `-log-json` - Toggles whether the messages are streamed in JSON format.
|
- `-log-json` - Toggles whether the messages are streamed in JSON format.
|
||||||
By default this is false.
|
By default this is false.
|
||||||
|
|
||||||
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
|
@ -29,14 +29,6 @@ Usage: `consul namespace create -name <namespace name> [options]`
|
||||||
Request a namespace to be created. Construction of the namespace definition is handled by this command
|
Request a namespace to be created. Construction of the namespace definition is handled by this command
|
||||||
from the CLI arguments.
|
from the CLI arguments.
|
||||||
|
|
||||||
#### API Options
|
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_options_server.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_partition_options.mdx'
|
|
||||||
|
|
||||||
#### Command Options
|
#### Command Options
|
||||||
|
|
||||||
- `-default-policy-id=<value>` - ID of a policy from the default namespace to inject for all tokens
|
- `-default-policy-id=<value>` - ID of a policy from the default namespace to inject for all tokens
|
||||||
|
@ -65,6 +57,14 @@ from the CLI arguments.
|
||||||
- `-show-meta` - Indicates that namespace metadata such as the raft indices should
|
- `-show-meta` - Indicates that namespace metadata such as the raft indices should
|
||||||
be shown for the namespace
|
be shown for the namespace
|
||||||
|
|
||||||
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_partition_options.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_options_server.mdx'
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
Create a new Namespace:
|
Create a new Namespace:
|
||||||
|
|
|
@ -28,12 +28,12 @@ Usage: `consul namespace delete <name>`
|
||||||
|
|
||||||
#### API Options
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_partition_options.mdx'
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
@include 'http_api_options_server.mdx'
|
@include 'http_api_options_server.mdx'
|
||||||
|
|
||||||
@include 'http_api_partition_options.mdx'
|
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
Delete a Namespace:
|
Delete a Namespace:
|
||||||
|
|
|
@ -31,14 +31,6 @@ the request has been granted any access in the namespace (read, list or write).
|
||||||
|
|
||||||
Usage: `consul namespace list`
|
Usage: `consul namespace list`
|
||||||
|
|
||||||
#### API Options
|
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_options_server.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_partition_options.mdx'
|
|
||||||
|
|
||||||
#### Command Options
|
#### Command Options
|
||||||
|
|
||||||
- `-format=<string>` - How to output the results. The choices are: pretty or json
|
- `-format=<string>` - How to output the results. The choices are: pretty or json
|
||||||
|
@ -46,6 +38,14 @@ Usage: `consul namespace list`
|
||||||
- `-meta` - Indicates that namespace metadata such as the raft indices should be
|
- `-meta` - Indicates that namespace metadata such as the raft indices should be
|
||||||
shown for the namespace
|
shown for the namespace
|
||||||
|
|
||||||
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_partition_options.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_options_server.mdx'
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
List Namespaces:
|
List Namespaces:
|
||||||
|
|
|
@ -30,14 +30,6 @@ the request has been granted any access in the namespace (read, list or write).
|
||||||
|
|
||||||
Usage: `consul namespace read <name>`
|
Usage: `consul namespace read <name>`
|
||||||
|
|
||||||
#### API Options
|
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_options_server.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_partition_options.mdx'
|
|
||||||
|
|
||||||
#### Command Options
|
#### Command Options
|
||||||
|
|
||||||
- `-format=<string>` - How to output the results. The choices are: pretty or json
|
- `-format=<string>` - How to output the results. The choices are: pretty or json
|
||||||
|
@ -45,6 +37,14 @@ Usage: `consul namespace read <name>`
|
||||||
- `-meta` - Indicates that namespace metadata such as the raft indices should be
|
- `-meta` - Indicates that namespace metadata such as the raft indices should be
|
||||||
shown for the namespace
|
shown for the namespace
|
||||||
|
|
||||||
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_partition_options.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_options_server.mdx'
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
Read a Namespace:
|
Read a Namespace:
|
||||||
|
|
|
@ -30,14 +30,6 @@ Request a namespace to be update. Construction of the namespace definition is ha
|
||||||
from the CLI arguments. Some parts of the Namespace such as ACL configurations and meta can be merged
|
from the CLI arguments. Some parts of the Namespace such as ACL configurations and meta can be merged
|
||||||
with the existing namespace definition.
|
with the existing namespace definition.
|
||||||
|
|
||||||
#### API Options
|
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_options_server.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_partition_options.mdx'
|
|
||||||
|
|
||||||
#### Command Options
|
#### Command Options
|
||||||
|
|
||||||
- `-default-policy-id=<value>` - ID of a policy from the default namespace to inject for all tokens
|
- `-default-policy-id=<value>` - ID of a policy from the default namespace to inject for all tokens
|
||||||
|
@ -72,6 +64,14 @@ with the existing namespace definition.
|
||||||
- `-show-meta` - Indicates that namespace metadata such as the raft indices should
|
- `-show-meta` - Indicates that namespace metadata such as the raft indices should
|
||||||
be shown for the namespace
|
be shown for the namespace
|
||||||
|
|
||||||
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_partition_options.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_options_server.mdx'
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
Update a namespace with a new description:
|
Update a namespace with a new description:
|
||||||
|
|
|
@ -29,14 +29,6 @@ The `<namespace definition>` must either be a file path or `-` to indicate that
|
||||||
the definition should be read from stdin. The definition can be in either JSON
|
the definition should be read from stdin. The definition can be in either JSON
|
||||||
or HCL format. See [here](/docs/enterprise/namespaces#namespace-definition) for a description of the namespace definition.
|
or HCL format. See [here](/docs/enterprise/namespaces#namespace-definition) for a description of the namespace definition.
|
||||||
|
|
||||||
#### API Options
|
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_options_server.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_partition_options.mdx'
|
|
||||||
|
|
||||||
#### Command Options
|
#### Command Options
|
||||||
|
|
||||||
- `-format=<string>` - How to output the results. The choices are: pretty or json
|
- `-format=<string>` - How to output the results. The choices are: pretty or json
|
||||||
|
@ -44,6 +36,14 @@ or HCL format. See [here](/docs/enterprise/namespaces#namespace-definition) for
|
||||||
- `-meta` - Indicates that namespace metadata such as the raft indices should be
|
- `-meta` - Indicates that namespace metadata such as the raft indices should be
|
||||||
shown for the namespace
|
shown for the namespace
|
||||||
|
|
||||||
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_partition_options.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_options_server.mdx'
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
Create a new Namespace:
|
Create a new Namespace:
|
||||||
|
|
|
@ -61,11 +61,13 @@ are not supported from commands, but may be from the corresponding HTTP endpoint
|
||||||
|
|
||||||
Usage: `consul operator area create [options]`
|
Usage: `consul operator area create [options]`
|
||||||
|
|
||||||
#### API Options
|
The following example output shows the ID of the newly-created network area:
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
```text
|
||||||
|
Created area "d2872ec5-68ea-b862-b75d-0bee99aca100" with peer datacenter "other"!
|
||||||
|
```
|
||||||
|
|
||||||
@include 'http_api_options_server.mdx'
|
The return code indicates success or failure.
|
||||||
|
|
||||||
#### Command Options
|
#### Command Options
|
||||||
|
|
||||||
|
@ -79,13 +81,11 @@ Usage: `consul operator area create [options]`
|
||||||
- `-use-tls=<value>` Specifies whether gossip over this area should be encrypted with
|
- `-use-tls=<value>` Specifies whether gossip over this area should be encrypted with
|
||||||
TLS if possible. Must be either `true` or `false`.
|
TLS if possible. Must be either `true` or `false`.
|
||||||
|
|
||||||
The output looks like this, displaying the ID of the newly-created network area:
|
#### API Options
|
||||||
|
|
||||||
```text
|
@include 'http_api_options_client.mdx'
|
||||||
Created area "d2872ec5-68ea-b862-b75d-0bee99aca100" with peer datacenter "other"!
|
|
||||||
```
|
|
||||||
|
|
||||||
The return code will indicate success or failure.
|
@include 'http_api_options_server.mdx'
|
||||||
|
|
||||||
## delete
|
## delete
|
||||||
|
|
||||||
|
@ -103,27 +103,27 @@ are not supported from commands, but may be from the corresponding HTTP endpoint
|
||||||
|
|
||||||
Usage: `consul operator area delete [options]`
|
Usage: `consul operator area delete [options]`
|
||||||
|
|
||||||
#### API Options
|
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_options_server.mdx'
|
|
||||||
|
|
||||||
#### Command Options
|
|
||||||
|
|
||||||
- `-id=<value>` - Looks up the area to operate on by its ID. This can be given
|
|
||||||
instead of a peer datacenter.
|
|
||||||
|
|
||||||
- `-peer-datacenter=<value>` - Looks up the area to operate on by its peer
|
|
||||||
datacenter. This can be given instead of an ID.
|
|
||||||
|
|
||||||
The output looks like this:
|
The output looks like this:
|
||||||
|
|
||||||
```text
|
```text
|
||||||
Deleted area "154941b0-80e2-9d69-c560-ab2c02807332"!
|
Deleted area "154941b0-80e2-9d69-c560-ab2c02807332"!
|
||||||
```
|
```
|
||||||
|
|
||||||
The return code will indicate success or failure.
|
The return code indicates success or failure.
|
||||||
|
|
||||||
|
#### Command Options
|
||||||
|
|
||||||
|
- `-id=<value>` - Specifies the ID of a network area to operate on.
|
||||||
|
Use this option as an alternative to `-peer-datacenter`.
|
||||||
|
|
||||||
|
- `-peer-datacenter=<value>` - Specifies the peer datacenter of a network area to operate on.
|
||||||
|
Use this option as an alternative to `-id`.
|
||||||
|
|
||||||
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_options_server.mdx'
|
||||||
|
|
||||||
## join
|
## join
|
||||||
|
|
||||||
|
@ -142,20 +142,6 @@ are not supported from commands, but may be from the corresponding HTTP endpoint
|
||||||
|
|
||||||
Usage: `consul operator area join [options] ADDRESSES`
|
Usage: `consul operator area join [options] ADDRESSES`
|
||||||
|
|
||||||
#### API Options
|
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_options_server.mdx'
|
|
||||||
|
|
||||||
#### Command Options
|
|
||||||
|
|
||||||
- `-id=<value>` - Looks up the area to operate on by its ID. This can be given
|
|
||||||
instead of a peer datacenter.
|
|
||||||
|
|
||||||
- `-peer-datacenter=<value>` - Looks up the area to operate on by its peer
|
|
||||||
datacenter. This can be given instead of an ID.
|
|
||||||
|
|
||||||
The output looks like this:
|
The output looks like this:
|
||||||
|
|
||||||
```text
|
```text
|
||||||
|
@ -168,7 +154,21 @@ Address Joined Error
|
||||||
The `Error` field will have a human-readable error message if Consul was unable
|
The `Error` field will have a human-readable error message if Consul was unable
|
||||||
to join the given address.
|
to join the given address.
|
||||||
|
|
||||||
The return code will indicate success or failure.
|
The return code indicates success or failure.
|
||||||
|
|
||||||
|
#### Command Options
|
||||||
|
|
||||||
|
- `-id=<value>` - Specifies the ID of a network area to operate on.
|
||||||
|
Use this option as an alternative to `-peer-datacenter`.
|
||||||
|
|
||||||
|
- `-peer-datacenter=<value>` - Specifies the peer datacenter of a network area to operate on.
|
||||||
|
Use this option as an alternative to `-id`.
|
||||||
|
|
||||||
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_options_server.mdx'
|
||||||
|
|
||||||
## list
|
## list
|
||||||
|
|
||||||
|
@ -186,12 +186,6 @@ are not supported from commands, but may be from the corresponding HTTP endpoint
|
||||||
|
|
||||||
Usage: `consul operator area list [options]`
|
Usage: `consul operator area list [options]`
|
||||||
|
|
||||||
#### API Options
|
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_options_server.mdx'
|
|
||||||
|
|
||||||
The output looks like this:
|
The output looks like this:
|
||||||
|
|
||||||
```text
|
```text
|
||||||
|
@ -206,7 +200,13 @@ Area PeerDC RetryJoin
|
||||||
|
|
||||||
`RetryJoin` is the list of servers to join, defined when the area was created.
|
`RetryJoin` is the list of servers to join, defined when the area was created.
|
||||||
|
|
||||||
The return code will indicate success or failure.
|
The return code indicates success or failure.
|
||||||
|
|
||||||
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_options_server.mdx'
|
||||||
|
|
||||||
## members
|
## members
|
||||||
|
|
||||||
|
@ -225,20 +225,6 @@ are not supported from commands, but may be from the corresponding HTTP endpoint
|
||||||
|
|
||||||
Usage: `consul operator area members [options]`
|
Usage: `consul operator area members [options]`
|
||||||
|
|
||||||
#### API Options
|
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_options_server.mdx'
|
|
||||||
|
|
||||||
#### Command Options
|
|
||||||
|
|
||||||
- `-id=<value>` - Looks up the area to operate on by its ID. This can be given
|
|
||||||
instead of a peer datacenter.
|
|
||||||
|
|
||||||
- `-peer-datacenter=<value>` - Looks up the area to operate on by its peer
|
|
||||||
datacenter. This can be given instead of an ID.
|
|
||||||
|
|
||||||
The output looks like this:
|
The output looks like this:
|
||||||
|
|
||||||
```text
|
```text
|
||||||
|
@ -271,7 +257,21 @@ spoken by the node.
|
||||||
to the given server, in a human-readable format. This is computed using
|
to the given server, in a human-readable format. This is computed using
|
||||||
[network coordinates](/docs/architecture/coordinates).
|
[network coordinates](/docs/architecture/coordinates).
|
||||||
|
|
||||||
The return code will indicate success or failure.
|
The return code indicates success or failure.
|
||||||
|
|
||||||
|
#### Command Options
|
||||||
|
|
||||||
|
- `-id=<value>` - Specifies the ID of a network area to operate on.
|
||||||
|
Use this option as an alternative to `-peer-datacenter`.
|
||||||
|
|
||||||
|
- `-peer-datacenter=<value>` - Specifies the peer datacenter of a network area to operate on.
|
||||||
|
Use this option as an alternative to `-id`.
|
||||||
|
|
||||||
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_options_server.mdx'
|
||||||
|
|
||||||
## update
|
## update
|
||||||
|
|
||||||
|
@ -289,28 +289,27 @@ are not supported from commands, but may be from the corresponding HTTP endpoint
|
||||||
|
|
||||||
Usage: `consul operator area update [options]`
|
Usage: `consul operator area update [options]`
|
||||||
|
|
||||||
#### API Options
|
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_options_server.mdx'
|
|
||||||
|
|
||||||
#### Command Options
|
|
||||||
|
|
||||||
- `-id=<value>` - Looks up the area to operate on by its ID. This can be given
|
|
||||||
instead of a peer datacenter.
|
|
||||||
|
|
||||||
- `-peer-datacenter=<value>` - Declares the peer Consul datacenter that will make up the other
|
|
||||||
side of this network area. Network areas always involve a pair of datacenters: the datacenter
|
|
||||||
where the area was created, and the peer datacenter. This is required.
|
|
||||||
|
|
||||||
- `-use-tls=<value>` Specifies whether gossip over this area should be encrypted with
|
|
||||||
TLS if possible. Must be either `true` or `false`.
|
|
||||||
|
|
||||||
The output looks like this:
|
The output looks like this:
|
||||||
|
|
||||||
```text
|
```text
|
||||||
Updated area "d2872ec5-68ea-b862-b75d-0bee99aca100"
|
Updated area "d2872ec5-68ea-b862-b75d-0bee99aca100"
|
||||||
```
|
```
|
||||||
|
|
||||||
The return code will indicate success or failure.
|
The return code indicates success or failure.
|
||||||
|
|
||||||
|
#### Command Options
|
||||||
|
|
||||||
|
- `-id=<value>` - Specifies the ID of a network area to operate on.
|
||||||
|
Use this option as an alternative to `-peer-datacenter`.
|
||||||
|
|
||||||
|
- `-peer-datacenter=<value>` - Specifies the peer datacenter of a network area to operate on.
|
||||||
|
Use this option as an alternative to `-id`.
|
||||||
|
|
||||||
|
- `-use-tls=<value>` Specifies whether gossip over this area should be encrypted with
|
||||||
|
TLS if possible. Must be either `true` or `false`.
|
||||||
|
|
||||||
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_options_server.mdx'
|
|
@ -42,13 +42,7 @@ are not supported from commands, but may be from the corresponding HTTP endpoint
|
||||||
|
|
||||||
Usage: `consul operator autopilot get-config [options]`
|
Usage: `consul operator autopilot get-config [options]`
|
||||||
|
|
||||||
#### API Options
|
#### Sample Output
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_options_server.mdx'
|
|
||||||
|
|
||||||
### Command Output
|
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
$ consul operator autopilot get-config
|
$ consul operator autopilot get-config
|
||||||
|
@ -61,6 +55,12 @@ DisableUpgradeMigration = false
|
||||||
UpgradeMigrationTag = ""
|
UpgradeMigrationTag = ""
|
||||||
```
|
```
|
||||||
|
|
||||||
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_options_server.mdx'
|
||||||
|
|
||||||
## set-config
|
## set-config
|
||||||
|
|
||||||
Corresponding HTTP API Endpoint: [\[PUT\] /v1/operator/autopilot/configuration](/api-docs/operator/autopilot#update-configuration)
|
Corresponding HTTP API Endpoint: [\[PUT\] /v1/operator/autopilot/configuration](/api-docs/operator/autopilot#update-configuration)
|
||||||
|
@ -77,11 +77,14 @@ are not supported from commands, but may be from the corresponding HTTP endpoint
|
||||||
|
|
||||||
Usage: `consul operator autopilot set-config [options]`
|
Usage: `consul operator autopilot set-config [options]`
|
||||||
|
|
||||||
#### API Options
|
#### Sample Output
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
```sh
|
||||||
|
$ consul operator autopilot set-config -min-quorum=3
|
||||||
|
Configuration updated!
|
||||||
|
```
|
||||||
|
|
||||||
@include 'http_api_options_server.mdx'
|
The return code indicates success or failure.
|
||||||
|
|
||||||
#### Command Options
|
#### Command Options
|
||||||
|
|
||||||
|
@ -110,14 +113,11 @@ Usage: `consul operator autopilot set-config [options]`
|
||||||
- `-upgrade-version-tag` <EnterpriseAlert inline /> - Controls the [`-node-meta`](/docs/agent/config/cli-flags#_node_meta)
|
- `-upgrade-version-tag` <EnterpriseAlert inline /> - Controls the [`-node-meta`](/docs/agent/config/cli-flags#_node_meta)
|
||||||
tag to use for version info when performing upgrade migrations. If left blank, the Consul version will be used.
|
tag to use for version info when performing upgrade migrations. If left blank, the Consul version will be used.
|
||||||
|
|
||||||
### Command Output
|
#### API Options
|
||||||
|
|
||||||
```sh
|
@include 'http_api_options_client.mdx'
|
||||||
$ consul operator autopilot set-config -min-quorum=3
|
|
||||||
Configuration updated!
|
|
||||||
```
|
|
||||||
|
|
||||||
The return code will indicate success or failure.
|
@include 'http_api_options_server.mdx'
|
||||||
|
|
||||||
## state
|
## state
|
||||||
|
|
||||||
|
|
|
@ -43,10 +43,6 @@ are not supported from commands, but may be from the corresponding HTTP endpoint
|
||||||
|
|
||||||
Usage: `consul operator raft list-peers -stale=[true|false]`
|
Usage: `consul operator raft list-peers -stale=[true|false]`
|
||||||
|
|
||||||
- `-stale` - Optional and defaults to "false" which means the leader provides
|
|
||||||
the result. If the cluster is in an outage state without a leader, you may need
|
|
||||||
to set this to "true" to get the configuration from a non-leader server.
|
|
||||||
|
|
||||||
The output looks like this:
|
The output looks like this:
|
||||||
|
|
||||||
```text
|
```text
|
||||||
|
@ -70,6 +66,13 @@ Raft configuration.
|
||||||
`Voter` is "true" or "false", indicating if the server has a vote in the Raft
|
`Voter` is "true" or "false", indicating if the server has a vote in the Raft
|
||||||
configuration.
|
configuration.
|
||||||
|
|
||||||
|
#### Command Options
|
||||||
|
|
||||||
|
- `-stale` - Enables non-leader servers to provide cluster state information.
|
||||||
|
If the cluster is in an outage state without a leader,
|
||||||
|
we recommend setting this option to `true.
|
||||||
|
Default is `false`.
|
||||||
|
|
||||||
## remove-peer
|
## remove-peer
|
||||||
|
|
||||||
Corresponding HTTP API Endpoint: [\[DELETE\] /v1/operator/raft/peer](/api-docs/operator/raft#delete-raft-peer)
|
Corresponding HTTP API Endpoint: [\[DELETE\] /v1/operator/raft/peer](/api-docs/operator/raft#delete-raft-peer)
|
||||||
|
|
|
@ -37,9 +37,21 @@ At least one node name is required. If the second node name isn't given, it
|
||||||
is set to the agent's node name. These are the node names as known to
|
is set to the agent's node name. These are the node names as known to
|
||||||
Consul as the `consul members` command would show, not IP addresses.
|
Consul as the `consul members` command would show, not IP addresses.
|
||||||
|
|
||||||
#### API Options
|
## Sample Output
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
If coordinates are available, the command will print the estimated round trip
|
||||||
|
time between the given nodes:
|
||||||
|
|
||||||
|
```shell-session
|
||||||
|
$ consul rtt n1 n2
|
||||||
|
Estimated n1 <-> n2 rtt: 0.610 ms (using LAN coordinates)
|
||||||
|
|
||||||
|
$ consul rtt n2 # Running from n1
|
||||||
|
Estimated n1 <-> n2 rtt: 0.610 ms (using LAN coordinates)
|
||||||
|
|
||||||
|
$ consul rtt -wan n1.dc1 n2.dc2
|
||||||
|
Estimated n1.dc1 <-> n2.dc2 rtt: 1.275 ms (using WAN coordinates)
|
||||||
|
```
|
||||||
|
|
||||||
#### Command Options
|
#### Command Options
|
||||||
|
|
||||||
|
@ -55,18 +67,6 @@ The following environment variables control accessing the HTTP server via SSL:
|
||||||
- `CONSUL_HTTP_SSL` Set this to enable SSL
|
- `CONSUL_HTTP_SSL` Set this to enable SSL
|
||||||
- `CONSUL_HTTP_SSL_VERIFY` Set this to disable certificate checking (not recommended)
|
- `CONSUL_HTTP_SSL_VERIFY` Set this to disable certificate checking (not recommended)
|
||||||
|
|
||||||
## Output
|
#### API Options
|
||||||
|
|
||||||
If coordinates are available, the command will print the estimated round trip
|
@include 'http_api_options_client.mdx'
|
||||||
time between the given nodes:
|
|
||||||
|
|
||||||
```shell-session
|
|
||||||
$ consul rtt n1 n2
|
|
||||||
Estimated n1 <-> n2 rtt: 0.610 ms (using LAN coordinates)
|
|
||||||
|
|
||||||
$ consul rtt n2 # Running from n1
|
|
||||||
Estimated n1 <-> n2 rtt: 0.610 ms (using LAN coordinates)
|
|
||||||
|
|
||||||
$ consul rtt -wan n1.dc1 n2.dc2
|
|
||||||
Estimated n1.dc1 <-> n2.dc2 rtt: 1.275 ms (using WAN coordinates)
|
|
||||||
```
|
|
||||||
|
|
|
@ -38,23 +38,20 @@ in HCL or JSON format.
|
||||||
This flexibility makes it easy to pair the command with the
|
This flexibility makes it easy to pair the command with the
|
||||||
`services register` command since the argument syntax is the same.
|
`services register` command since the argument syntax is the same.
|
||||||
|
|
||||||
#### API Options
|
#### Command Options
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
- `-id` - Specifies the ID of a service instance to deregister.
|
||||||
|
Do not use this flag if any FILE arguments are given.
|
||||||
|
|
||||||
#### Enterprise Options
|
#### Enterprise Options
|
||||||
|
|
||||||
@include 'http_api_namespace_options.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_partition_options.mdx'
|
@include 'http_api_partition_options.mdx'
|
||||||
|
|
||||||
#### Service Deregistration Flags
|
@include 'http_api_namespace_options.mdx'
|
||||||
|
|
||||||
The flags below should only be set if _no arguments_ are given. If no
|
#### API Options
|
||||||
arguments are given, the flags below can be used to deregister a single
|
|
||||||
service.
|
|
||||||
|
|
||||||
- `-id` - The ID of the service.
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|
|
@ -57,17 +57,7 @@ restarts.
|
||||||
services in the local state directory. If this state directory is deleted
|
services in the local state directory. If this state directory is deleted
|
||||||
or lost, services registered with this command will need to be reregistered.
|
or lost, services registered with this command will need to be reregistered.
|
||||||
|
|
||||||
#### API Options
|
#### Command Options
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
#### Enterprise Options
|
|
||||||
|
|
||||||
@include 'http_api_namespace_options.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_partition_options.mdx'
|
|
||||||
|
|
||||||
#### Service Registration Flags
|
|
||||||
|
|
||||||
The flags below should only be set if _no arguments_ are given. If no
|
The flags below should only be set if _no arguments_ are given. If no
|
||||||
arguments are given, the flags below can be used to register a single
|
arguments are given, the flags below can be used to register a single
|
||||||
|
@ -94,6 +84,16 @@ Please refer to that documentation for full details.
|
||||||
- `-tag value` - Associate a tag with the service instance. This flag can
|
- `-tag value` - Associate a tag with the service instance. This flag can
|
||||||
be specified multiples times.
|
be specified multiples times.
|
||||||
|
|
||||||
|
#### Enterprise Options
|
||||||
|
|
||||||
|
@include 'http_api_partition_options.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_namespace_options.mdx'
|
||||||
|
|
||||||
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
To create a simple service:
|
To create a simple service:
|
||||||
|
|
|
@ -118,11 +118,7 @@ snapshot agent is deployed across more than one host.
|
||||||
|
|
||||||
Usage: `consul snapshot agent [options]`
|
Usage: `consul snapshot agent [options]`
|
||||||
|
|
||||||
#### API Options
|
#### Config File Options
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
#### Config File Options:
|
|
||||||
|
|
||||||
- `-config-dir` - Directory to look for JSON config files. Files will be read in
|
- `-config-dir` - Directory to look for JSON config files. Files will be read in
|
||||||
alphabetical order and must end with the extension ".json". This won't
|
alphabetical order and must end with the extension ".json". This won't
|
||||||
|
@ -353,6 +349,10 @@ This integration needs the following information:
|
||||||
|
|
||||||
- `-gcs-bucket` supplies the bucket to use.
|
- `-gcs-bucket` supplies the bucket to use.
|
||||||
|
|
||||||
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
Running the agent with no arguments will run a long-running daemon process that will
|
Running the agent with no arguments will run a long-running daemon process that will
|
||||||
|
|
|
@ -40,6 +40,23 @@ The following fields are displayed when inspecting a snapshot:
|
||||||
|
|
||||||
Usage: `consul snapshot inspect [options] FILE`
|
Usage: `consul snapshot inspect [options] FILE`
|
||||||
|
|
||||||
|
#### Command Options
|
||||||
|
|
||||||
|
- `-kvdetails` - Provides information about space usage for KV data stored in Consul.
|
||||||
|
|
||||||
|
- `-kvdepth` - Adjusts the grouping levels of keys.
|
||||||
|
Can only be used with `-kvdetails`.
|
||||||
|
Default is `2`.
|
||||||
|
|
||||||
|
- `-kvfilter` - Only keys that match the specified key prefix
|
||||||
|
are included in the response.
|
||||||
|
Can only be used with `-kvdetails`.
|
||||||
|
|
||||||
|
- `-format` - Specifies an output format for the response.
|
||||||
|
Specify `pretty` (default) to format the response in a human-readable form
|
||||||
|
as shown in the examples below,
|
||||||
|
or specify `JSON` to format the response as JSON.
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
To inspect a snapshot from the file "backup.snap":
|
To inspect a snapshot from the file "backup.snap":
|
||||||
|
@ -137,10 +154,3 @@ $ consul snapshot inspect /opt/consul/raft/snapshots/9-4600669-1618935304715/sta
|
||||||
---- ---- ----
|
---- ---- ----
|
||||||
Total 4.3GB
|
Total 4.3GB
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Command Options
|
|
||||||
|
|
||||||
- `-kvdetails` - Optional, provides a space usage breakdown for any KV data stored in Consul.
|
|
||||||
- `-kvdepth` - Can only be used with `-kvdetails`. Used to adjust the grouping level of keys. Defaults to 2.
|
|
||||||
- `-kvfilter` - Can only be used with `-kvdetails`. Used to specify a key prefix that excludes keys that don't match.
|
|
||||||
- `-format` - Optional, allows from changing the output to JSON. Parameters accepted are "pretty" and "JSON".
|
|
||||||
|
|
|
@ -23,7 +23,7 @@ $ consul tls ca create
|
||||||
|
|
||||||
Usage: `consul tls ca create [filename-prefix] [options]`
|
Usage: `consul tls ca create [filename-prefix] [options]`
|
||||||
|
|
||||||
#### TLS CA Create Options
|
#### Command Options
|
||||||
|
|
||||||
- `-additional-name-constraint=<value>` - Add name constraints for the CA.
|
- `-additional-name-constraint=<value>` - Add name constraints for the CA.
|
||||||
Results in rejecting certificates for other DNS than specified. Can be used
|
Results in rejecting certificates for other DNS than specified. Can be used
|
||||||
|
|
|
@ -47,7 +47,7 @@ $ consul tls cert create -cli
|
||||||
|
|
||||||
Usage: `consul tls cert create [filename-prefix] [options]`
|
Usage: `consul tls cert create [filename-prefix] [options]`
|
||||||
|
|
||||||
#### TLS Cert Create Options
|
#### Command Options
|
||||||
|
|
||||||
- `-additional-dnsname=<string>` - Provide an additional dnsname for Subject
|
- `-additional-dnsname=<string>` - Provide an additional dnsname for Subject
|
||||||
Alternative Names. localhost is always included. This flag may be provided
|
Alternative Names. localhost is always included. This flag may be provided
|
||||||
|
|
|
@ -16,7 +16,7 @@ The `version` command prints the version of Consul and the protocol versions it
|
||||||
|
|
||||||
Usage: `consul version [options]`
|
Usage: `consul version [options]`
|
||||||
|
|
||||||
### Command Options
|
#### Command Options
|
||||||
|
|
||||||
- `-format={pretty|json}` - Command output format. The default value is `pretty`.
|
- `-format={pretty|json}` - Command output format. The default value is `pretty`.
|
||||||
|
|
||||||
|
|
|
@ -30,12 +30,6 @@ data view. Depending on the type, various options may be required
|
||||||
or optionally provided. There is more documentation on watch
|
or optionally provided. There is more documentation on watch
|
||||||
[specifications here](/docs/dynamic-app-config/watches).
|
[specifications here](/docs/dynamic-app-config/watches).
|
||||||
|
|
||||||
#### API Options
|
|
||||||
|
|
||||||
@include 'http_api_options_client.mdx'
|
|
||||||
|
|
||||||
@include 'http_api_options_server.mdx'
|
|
||||||
|
|
||||||
#### Command Options
|
#### Command Options
|
||||||
|
|
||||||
- `-key` - Key to watch. Only for `key` type.
|
- `-key` - Key to watch. Only for `key` type.
|
||||||
|
@ -58,3 +52,9 @@ or optionally provided. There is more documentation on watch
|
||||||
|
|
||||||
- `-type` - Watch type. Required, one of "`key`, `keyprefix`, `services`,
|
- `-type` - Watch type. Required, one of "`key`, `keyprefix`, `services`,
|
||||||
`nodes`, `service`, `checks`, or `event`.
|
`nodes`, `service`, `checks`, or `event`.
|
||||||
|
|
||||||
|
#### API Options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_options_server.mdx'
|
||||||
|
|
Loading…
Reference in New Issue