Skip to content

Commit a5f83af

Browse files
authored
Merge branch 'main' into remediation_support_features
2 parents b8f0bd5 + f3373cb commit a5f83af

17 files changed

+323
-34
lines changed

crowdsec-docs/docs/cscli/cscli.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ It is meant to allow you to manage bans, parsers/scenarios/etc, api and generall
2828
### SEE ALSO
2929

3030
* [cscli alerts](/cscli/cscli_alerts.md) - Manage alerts
31+
* [cscli allowlists](/cscli/cscli_allowlists.md) - Manage centralized allowlists
3132
* [cscli appsec-configs](/cscli/cscli_appsec-configs.md) - Manage hub appsec-configs
3233
* [cscli appsec-rules](/cscli/cscli_appsec-rules.md) - Manage hub appsec-rules
3334
* [cscli bouncers](/cscli/cscli_bouncers.md) - Manage bouncers [requires local API]
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
id: cscli_allowlists
3+
title: cscli allowlists
4+
---
5+
## cscli allowlists
6+
7+
Manage centralized allowlists
8+
9+
### Options
10+
11+
```
12+
-h, --help help for allowlists
13+
```
14+
15+
### Options inherited from parent commands
16+
17+
```
18+
--color string Output color: yes, no, auto (default "auto")
19+
-c, --config string path to crowdsec config file (default "/etc/crowdsec/config.yaml")
20+
--debug Set logging to debug
21+
--error Set logging to error
22+
--info Set logging to info
23+
-o, --output string Output format: human, json, raw
24+
--trace Set logging to trace
25+
--warning Set logging to warning
26+
```
27+
28+
### SEE ALSO
29+
30+
* [cscli](/cscli/cscli.md) - cscli allows you to manage crowdsec
31+
* [cscli allowlists add](/cscli/cscli_allowlists_add.md) - Add content to an allowlist
32+
* [cscli allowlists create](/cscli/cscli_allowlists_create.md) - Create a new allowlist
33+
* [cscli allowlists delete](/cscli/cscli_allowlists_delete.md) - Delete an allowlist
34+
* [cscli allowlists inspect](/cscli/cscli_allowlists_inspect.md) - Inspect an allowlist
35+
* [cscli allowlists list](/cscli/cscli_allowlists_list.md) - List all allowlists
36+
* [cscli allowlists remove](/cscli/cscli_allowlists_remove.md) - Remove content from an allowlist
37+
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
id: cscli_allowlists_add
3+
title: cscli allowlists add
4+
---
5+
## cscli allowlists add
6+
7+
Add content to an allowlist
8+
9+
```
10+
cscli allowlists add [allowlist_name] [value...] [-e expiration] [-d comment] [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
cscli allowlists add my_allowlist 1.2.3.4 2.3.4.5 -e 1h -d "my comment"
17+
```
18+
19+
### Options
20+
21+
```
22+
-d, --comment string comment for the value
23+
-e, --expiration string expiration duration
24+
-h, --help help for add
25+
```
26+
27+
### Options inherited from parent commands
28+
29+
```
30+
--color string Output color: yes, no, auto (default "auto")
31+
-c, --config string path to crowdsec config file (default "/etc/crowdsec/config.yaml")
32+
--debug Set logging to debug
33+
--error Set logging to error
34+
--info Set logging to info
35+
-o, --output string Output format: human, json, raw
36+
--trace Set logging to trace
37+
--warning Set logging to warning
38+
```
39+
40+
### SEE ALSO
41+
42+
* [cscli allowlists](/cscli/cscli_allowlists.md) - Manage centralized allowlists
43+
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
id: cscli_allowlists_create
3+
title: cscli allowlists create
4+
---
5+
## cscli allowlists create
6+
7+
Create a new allowlist
8+
9+
```
10+
cscli allowlists create [allowlist_name] [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
cscli allowlists create my_allowlist -d 'my allowlist description'
17+
```
18+
19+
### Options
20+
21+
```
22+
-d, --description string description of the allowlist
23+
-h, --help help for create
24+
```
25+
26+
### Options inherited from parent commands
27+
28+
```
29+
--color string Output color: yes, no, auto (default "auto")
30+
-c, --config string path to crowdsec config file (default "/etc/crowdsec/config.yaml")
31+
--debug Set logging to debug
32+
--error Set logging to error
33+
--info Set logging to info
34+
-o, --output string Output format: human, json, raw
35+
--trace Set logging to trace
36+
--warning Set logging to warning
37+
```
38+
39+
### SEE ALSO
40+
41+
* [cscli allowlists](/cscli/cscli_allowlists.md) - Manage centralized allowlists
42+
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
id: cscli_allowlists_delete
3+
title: cscli allowlists delete
4+
---
5+
## cscli allowlists delete
6+
7+
Delete an allowlist
8+
9+
```
10+
cscli allowlists delete [allowlist_name] [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
cscli allowlists delete my_allowlist
17+
```
18+
19+
### Options
20+
21+
```
22+
-h, --help help for delete
23+
```
24+
25+
### Options inherited from parent commands
26+
27+
```
28+
--color string Output color: yes, no, auto (default "auto")
29+
-c, --config string path to crowdsec config file (default "/etc/crowdsec/config.yaml")
30+
--debug Set logging to debug
31+
--error Set logging to error
32+
--info Set logging to info
33+
-o, --output string Output format: human, json, raw
34+
--trace Set logging to trace
35+
--warning Set logging to warning
36+
```
37+
38+
### SEE ALSO
39+
40+
* [cscli allowlists](/cscli/cscli_allowlists.md) - Manage centralized allowlists
41+
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
id: cscli_allowlists_inspect
3+
title: cscli allowlists inspect
4+
---
5+
## cscli allowlists inspect
6+
7+
Inspect an allowlist
8+
9+
```
10+
cscli allowlists inspect [allowlist_name] [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
cscli allowlists inspect my_allowlist
17+
```
18+
19+
### Options
20+
21+
```
22+
-h, --help help for inspect
23+
```
24+
25+
### Options inherited from parent commands
26+
27+
```
28+
--color string Output color: yes, no, auto (default "auto")
29+
-c, --config string path to crowdsec config file (default "/etc/crowdsec/config.yaml")
30+
--debug Set logging to debug
31+
--error Set logging to error
32+
--info Set logging to info
33+
-o, --output string Output format: human, json, raw
34+
--trace Set logging to trace
35+
--warning Set logging to warning
36+
```
37+
38+
### SEE ALSO
39+
40+
* [cscli allowlists](/cscli/cscli_allowlists.md) - Manage centralized allowlists
41+
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
id: cscli_allowlists_list
3+
title: cscli allowlists list
4+
---
5+
## cscli allowlists list
6+
7+
List all allowlists
8+
9+
```
10+
cscli allowlists list [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
cscli allowlists list
17+
```
18+
19+
### Options
20+
21+
```
22+
-h, --help help for list
23+
```
24+
25+
### Options inherited from parent commands
26+
27+
```
28+
--color string Output color: yes, no, auto (default "auto")
29+
-c, --config string path to crowdsec config file (default "/etc/crowdsec/config.yaml")
30+
--debug Set logging to debug
31+
--error Set logging to error
32+
--info Set logging to info
33+
-o, --output string Output format: human, json, raw
34+
--trace Set logging to trace
35+
--warning Set logging to warning
36+
```
37+
38+
### SEE ALSO
39+
40+
* [cscli allowlists](/cscli/cscli_allowlists.md) - Manage centralized allowlists
41+
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
id: cscli_allowlists_remove
3+
title: cscli allowlists remove
4+
---
5+
## cscli allowlists remove
6+
7+
Remove content from an allowlist
8+
9+
```
10+
cscli allowlists remove [allowlist_name] [value] [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
cscli allowlists remove my_allowlist 1.2.3.4 2.3.4.5
17+
```
18+
19+
### Options
20+
21+
```
22+
-h, --help help for remove
23+
```
24+
25+
### Options inherited from parent commands
26+
27+
```
28+
--color string Output color: yes, no, auto (default "auto")
29+
-c, --config string path to crowdsec config file (default "/etc/crowdsec/config.yaml")
30+
--debug Set logging to debug
31+
--error Set logging to error
32+
--info Set logging to info
33+
-o, --output string Output format: human, json, raw
34+
--trace Set logging to trace
35+
--warning Set logging to warning
36+
```
37+
38+
### SEE ALSO
39+
40+
* [cscli allowlists](/cscli/cscli_allowlists.md) - Manage centralized allowlists
41+

crowdsec-docs/docs/cscli/cscli_console_enable.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Enable a console option
1212
Enable given information push to the central API. Allows to empower the console
1313

1414
```
15-
cscli console enable [option] [flags]
15+
cscli console enable [option]... [flags]
1616
```
1717

1818
### Examples

crowdsec-docs/docs/cscli/cscli_console_enroll.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,19 +24,21 @@ cscli console enroll [enroll-key] [flags]
2424
cscli console enroll YOUR-ENROLL-KEY
2525
cscli console enroll --name [instance_name] YOUR-ENROLL-KEY
2626
cscli console enroll --name [instance_name] --tags [tag_1] --tags [tag_2] YOUR-ENROLL-KEY
27-
cscli console enroll --enable context,manual YOUR-ENROLL-KEY
27+
cscli console enroll --enable console_management YOUR-ENROLL-KEY
28+
cscli console enroll --disable context YOUR-ENROLL-KEY
2829
2930
valid options are : custom,manual,tainted,context,console_management,all (see 'cscli console status' for details)
3031
```
3132

3233
### Options
3334

3435
```
35-
-e, --enable strings Enable console options
36-
-h, --help help for enroll
37-
-n, --name string Name to display in the console
38-
--overwrite Force enroll the instance
39-
-t, --tags strings Tags to display in the console
36+
-d, --disable strings Disable console options
37+
-e, --enable strings Enable console options
38+
-h, --help help for enroll
39+
-n, --name string Name to display in the console
40+
--overwrite Force enroll the instance
41+
-t, --tags strings Tags to display in the console
4042
```
4143

4244
### Options inherited from parent commands

0 commit comments

Comments
 (0)