Add acl commands -format option to doc.

pull/7198/head
Artur Mullakhmetov 2020-03-26 19:03:22 +03:00
parent 845b9c23fe
commit 0396340e2c
22 changed files with 45 additions and 0 deletions

View File

@ -42,6 +42,8 @@ Usage: `consul acl auth-method create [options] [args]`
used to access the TokenReview API to validate other JWTs during login. This used to access the TokenReview API to validate other JWTs during login. This
flag is required for `-type=kubernetes`. flag is required for `-type=kubernetes`.
* `-format={pretty|json}` - Command output format. The default value is `pretty`.
#### Enterprise Options #### Enterprise Options
<%= partial "docs/commands/http_api_namespace_options" %> <%= partial "docs/commands/http_api_namespace_options" %>

View File

@ -23,6 +23,8 @@ Usage: `consul acl auth-method list`
* `-meta` - Indicates that auth method metadata such as the raft indices should * `-meta` - Indicates that auth method metadata such as the raft indices should
be shown for each entry. be shown for each entry.
* `-format={pretty|json}` - Command output format. The default value is `pretty`.
#### Enterprise Options #### Enterprise Options

View File

@ -26,6 +26,8 @@ Usage: `consul acl auth-method read [options] [args]`
* `-name=<string>` - The name of the auth method to read. * `-name=<string>` - The name of the auth method to read.
* `-format={pretty|json}` - Command output format. The default value is `pretty`.
#### Enterprise Options #### Enterprise Options
<%= partial "docs/commands/http_api_namespace_options" %> <%= partial "docs/commands/http_api_namespace_options" %>

View File

@ -46,6 +46,8 @@ Usage: `consul acl auth-method update [options] [args]`
* `-no-merge` - Do not merge the current auth method information with what is provided * `-no-merge` - Do not merge the current auth method information with what is provided
to the command. Instead overwrite all fields with the exception of the auth method to the command. Instead overwrite all fields with the exception of the auth method
ID which is immutable. ID which is immutable.
* `-format={pretty|json}` - Command output format. The default value is `pretty`.
#### Enterprise Options #### Enterprise Options

View File

@ -37,6 +37,8 @@ Usage: `consul acl binding-rule create [options] [args]`
* `-selector=<string>` - Selector is an expression that matches against * `-selector=<string>` - Selector is an expression that matches against
verified identity attributes returned from the auth method during login. verified identity attributes returned from the auth method during login.
* `-format={pretty|json}` - Command output format. The default value is `pretty`.
#### Enterprise Options #### Enterprise Options
<%= partial "docs/commands/http_api_namespace_options" %> <%= partial "docs/commands/http_api_namespace_options" %>

View File

@ -24,6 +24,8 @@ Usage: `consul acl binding-rule list`
* `-meta` - Indicates that binding rule metadata such as the raft indices * `-meta` - Indicates that binding rule metadata such as the raft indices
should be shown for each entry. should be shown for each entry.
* `-format={pretty|json}` - Command output format. The default value is `pretty`.
#### Enterprise Options #### Enterprise Options
<%= partial "docs/commands/http_api_namespace_options" %> <%= partial "docs/commands/http_api_namespace_options" %>

View File

@ -27,6 +27,8 @@ Usage: `consul acl binding-rule read [options] [args]`
* `-meta` - Indicates that binding rule metadata such as the raft * `-meta` - Indicates that binding rule metadata such as the raft
indices should be shown for each entry. indices should be shown for each entry.
* `-format={pretty|json}` - Command output format. The default value is `pretty`.
#### Enterprise Options #### Enterprise Options
<%= partial "docs/commands/http_api_namespace_options" %> <%= partial "docs/commands/http_api_namespace_options" %>

View File

@ -44,6 +44,8 @@ Usage: `consul acl binding-rule update [options] [args]`
* `-selector=<string>` - Selector is an expression that matches against * `-selector=<string>` - Selector is an expression that matches against
verified identity attributes returned from the auth method during login. verified identity attributes returned from the auth method during login.
* `-format={pretty|json}` - Command output format. The default value is `pretty`.
#### Enterprise Options #### Enterprise Options
<%= partial "docs/commands/http_api_namespace_options" %> <%= partial "docs/commands/http_api_namespace_options" %>

View File

@ -24,6 +24,9 @@ Usage: `consul acl bootstrap [options]`
<%= partial "docs/commands/http_api_options_client" %> <%= partial "docs/commands/http_api_options_client" %>
<%= partial "docs/commands/http_api_options_server" %> <%= partial "docs/commands/http_api_options_server" %>
#### Command Options
* `-format={pretty|json}` - Command output format. The default value is `pretty`.
The output looks like this: The output looks like this:
```text ```text

View File

@ -55,6 +55,8 @@ Usage: `consul acl policy create [options] [args]`
* `-valid-datacenter=<value>` - Datacenter that the policy should be valid within. * `-valid-datacenter=<value>` - Datacenter that the policy should be valid within.
This flag may be specified multiple times. This flag may be specified multiple times.
* `-format={pretty|json}` - Command output format. The default value is `pretty`.
#### Enterprise Options #### Enterprise Options
<%= partial "docs/commands/http_api_namespace_options" %> <%= partial "docs/commands/http_api_namespace_options" %>

View File

@ -24,6 +24,8 @@ Usage: `consul acl policy list`
* `-meta` - Indicates that policy metadata such as the content hash and * `-meta` - Indicates that policy metadata such as the content hash and
Raft indices should be shown for each entry. Raft indices should be shown for each entry.
* `-format={pretty|json}` - Command output format. The default value is `pretty`.
#### Enterprise Options #### Enterprise Options
<%= partial "docs/commands/http_api_namespace_options" %> <%= partial "docs/commands/http_api_namespace_options" %>

View File

@ -29,6 +29,8 @@ Usage: `consul acl policy read [options] [args]`
* `-name=<string>` - The name of the policy to read. * `-name=<string>` - The name of the policy to read.
* `-format={pretty|json}` - Command output format. The default value is `pretty`.
#### Enterprise Options #### Enterprise Options
<%= partial "docs/commands/http_api_namespace_options" %> <%= partial "docs/commands/http_api_namespace_options" %>

View File

@ -46,6 +46,8 @@ Usage: `consul acl policy update [options] [args]`
* `-valid-datacenter=<value>` - Datacenter that the policy should be valid within. * `-valid-datacenter=<value>` - Datacenter that the policy should be valid within.
This flag may be specified multiple times. This flag may be specified multiple times.
* `-format={pretty|json}` - Command output format. The default value is `pretty`.
#### Enterprise Options #### Enterprise Options
<%= partial "docs/commands/http_api_namespace_options" %> <%= partial "docs/commands/http_api_namespace_options" %>

View File

@ -38,6 +38,8 @@ Usage: `consul acl role create [options] [args]`
role. May be specified multiple times. Format is the `SERVICENAME` or role. May be specified multiple times. Format is the `SERVICENAME` or
`SERVICENAME:DATACENTER1,DATACENTER2,...` `SERVICENAME:DATACENTER1,DATACENTER2,...`
* `-format={pretty|json}` - Command output format. The default value is `pretty`.
#### Enterprise Options #### Enterprise Options
<%= partial "docs/commands/http_api_namespace_options" %> <%= partial "docs/commands/http_api_namespace_options" %>

View File

@ -24,6 +24,8 @@ Usage: `consul acl role list`
* `-meta` - Indicates that role metadata such as the content hash and * `-meta` - Indicates that role metadata such as the content hash and
Raft indices should be shown for each entry. Raft indices should be shown for each entry.
* `-format={pretty|json}` - Command output format. The default value is `pretty`.
#### Enterprise Options #### Enterprise Options
<%= partial "docs/commands/http_api_namespace_options" %> <%= partial "docs/commands/http_api_namespace_options" %>

View File

@ -29,6 +29,8 @@ Usage: `consul acl role read [options] [args]`
* `-name=<string>` - The name of the role to read. * `-name=<string>` - The name of the role to read.
* `-format={pretty|json}` - Command output format. The default value is `pretty`.
#### Enterprise Options #### Enterprise Options
<%= partial "docs/commands/http_api_namespace_options" %> <%= partial "docs/commands/http_api_namespace_options" %>

View File

@ -49,6 +49,8 @@ Usage: `consul acl role update [options] [args]`
role. May be specified multiple times. Format is the `SERVICENAME` or role. May be specified multiple times. Format is the `SERVICENAME` or
`SERVICENAME:DATACENTER1,DATACENTER2,...` `SERVICENAME:DATACENTER1,DATACENTER2,...`
* `-format={pretty|json}` - Command output format. The default value is `pretty`.
#### Enterprise Options #### Enterprise Options
<%= partial "docs/commands/http_api_namespace_options" %> <%= partial "docs/commands/http_api_namespace_options" %>

View File

@ -28,6 +28,8 @@ Usage: `consul acl token clone [options]`
Accessor IDs. The special value of 'anonymous' may be provided instead of Accessor IDs. The special value of 'anonymous' may be provided instead of
the anonymous tokens accessor ID the anonymous tokens accessor ID
* `-format={pretty|json}` - Command output format. The default value is `pretty`.
#### Enterprise Options #### Enterprise Options
<%= partial "docs/commands/http_api_namespace_options" %> <%= partial "docs/commands/http_api_namespace_options" %>

View File

@ -52,6 +52,8 @@ Usage: `consul acl token create [options] [args]`
**Note**: The SecretID is used to authorize operations against Consul and should **Note**: The SecretID is used to authorize operations against Consul and should
be generated from an appropriate cryptographic source. be generated from an appropriate cryptographic source.
* `-format={pretty|json}` - Command output format. The default value is `pretty`.
#### Enterprise Options #### Enterprise Options
<%= partial "docs/commands/http_api_namespace_options" %> <%= partial "docs/commands/http_api_namespace_options" %>

View File

@ -24,6 +24,8 @@ Usage: `consul acl token list`
* `-meta` - Indicates that token metadata such as the content hash and * `-meta` - Indicates that token metadata such as the content hash and
Raft indices should be shown for each entry. Raft indices should be shown for each entry.
* `-format={pretty|json}` - Command output format. The default value is `pretty`.
#### Enterprise Options #### Enterprise Options
<%= partial "docs/commands/http_api_namespace_options" %> <%= partial "docs/commands/http_api_namespace_options" %>

View File

@ -30,6 +30,8 @@ Usage: `consul acl token read [options] [args]`
* `-self` - Indicates that the current HTTP token should be read by secret ID * `-self` - Indicates that the current HTTP token should be read by secret ID
instead of expecting a -id option. instead of expecting a -id option.
* `-format={pretty|json}` - Command output format. The default value is `pretty`.
#### Enterprise Options #### Enterprise Options
<%= partial "docs/commands/http_api_namespace_options" %> <%= partial "docs/commands/http_api_namespace_options" %>

View File

@ -59,6 +59,8 @@ token
migration](https://learn.hashicorp.com/consul/day-2-agent-authentication/migrate-acl-tokens) migration](https://learn.hashicorp.com/consul/day-2-agent-authentication/migrate-acl-tokens)
guide. guide.
* `-format={pretty|json}` - Command output format. The default value is `pretty`.
#### Enterprise Options #### Enterprise Options
<%= partial "docs/commands/http_api_namespace_options" %> <%= partial "docs/commands/http_api_namespace_options" %>