Skip to content

Commit 5b89482

Browse files
committed
feature: updated generated documentation
1 parent 1d75d45 commit 5b89482

7 files changed

+250
-0
lines changed

docs/stackit_beta.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ stackit beta [flags]
4444
* [stackit beta network-area](./stackit_beta_network-area.md) - Provides functionality for STACKIT Network Area (SNA)
4545
* [stackit beta network-interface](./stackit_beta_network-interface.md) - Provides functionality for network interfaces
4646
* [stackit beta public-ip](./stackit_beta_public-ip.md) - Provides functionality for public IPs
47+
* [stackit beta security-group](./stackit_beta_security-group.md) - manage security groups.
4748
* [stackit beta server](./stackit_beta_server.md) - Provides functionality for servers
4849
* [stackit beta sqlserverflex](./stackit_beta_sqlserverflex.md) - Provides functionality for SQLServer Flex
4950
* [stackit beta volume](./stackit_beta_volume.md) - Provides functionality for volumes
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
## stackit beta security-group
2+
3+
manage security groups.
4+
5+
### Synopsis
6+
7+
manage the lifecycle of security groups.
8+
9+
```
10+
stackit beta security-group [flags]
11+
```
12+
13+
### Options
14+
15+
```
16+
-h, --help Help for "stackit beta security-group"
17+
```
18+
19+
### Options inherited from parent commands
20+
21+
```
22+
-y, --assume-yes If set, skips all confirmation prompts
23+
--async If set, runs the command asynchronously
24+
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
25+
-p, --project-id string Project ID
26+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
27+
```
28+
29+
### SEE ALSO
30+
31+
* [stackit beta](./stackit_beta.md) - Contains beta STACKIT CLI commands
32+
* [stackit beta security-group create](./stackit_beta_security-group_create.md) - create security groups
33+
* [stackit beta security-group delete](./stackit_beta_security-group_delete.md) - delete a security group
34+
* [stackit beta security-group describe](./stackit_beta_security-group_describe.md) - describe security groups
35+
* [stackit beta security-group list](./stackit_beta_security-group_list.md) - list security groups
36+
* [stackit beta security-group update](./stackit_beta_security-group_update.md) - Update a security group
37+
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
## stackit beta security-group create
2+
3+
create security groups
4+
5+
### Synopsis
6+
7+
create security groups
8+
9+
```
10+
stackit beta security-group create [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
create a named group
17+
$ stackit beta security-group create --name my-new-group
18+
19+
create a named group with labels
20+
$ stackit beta security-group create --name my-new-group --labels label1=value1,label2=value2
21+
```
22+
23+
### Options
24+
25+
```
26+
--description string an optional description of the security group. Must be <= 127 chars
27+
-h, --help Help for "stackit beta security-group create"
28+
--labels strings a list of labels in the form <key>=<value>
29+
--name string the name of the security group. Must be <= 63 chars
30+
--stateful create a stateful or a stateless security group
31+
```
32+
33+
### Options inherited from parent commands
34+
35+
```
36+
-y, --assume-yes If set, skips all confirmation prompts
37+
--async If set, runs the command asynchronously
38+
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
39+
-p, --project-id string Project ID
40+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
41+
```
42+
43+
### SEE ALSO
44+
45+
* [stackit beta security-group](./stackit_beta_security-group.md) - manage security groups.
46+
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
## stackit beta security-group delete
2+
3+
delete a security group
4+
5+
### Synopsis
6+
7+
delete a security group by its internal id
8+
9+
```
10+
stackit beta security-group delete [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
delete a named group
17+
$ stackit beta security-group delete 43ad419a-c68b-4911-87cd-e05752ac1e31
18+
```
19+
20+
### Options
21+
22+
```
23+
-h, --help Help for "stackit beta security-group delete"
24+
```
25+
26+
### Options inherited from parent commands
27+
28+
```
29+
-y, --assume-yes If set, skips all confirmation prompts
30+
--async If set, runs the command asynchronously
31+
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
32+
-p, --project-id string Project ID
33+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
34+
```
35+
36+
### SEE ALSO
37+
38+
* [stackit beta security-group](./stackit_beta_security-group.md) - manage security groups.
39+
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
## stackit beta security-group describe
2+
3+
describe security groups
4+
5+
### Synopsis
6+
7+
describe security groups
8+
9+
```
10+
stackit beta security-group describe [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
describe an existing group
17+
$ stackit beta security-group describe 9e9c44fe-eb9a-4d45-bf08-365e961845d1
18+
```
19+
20+
### Options
21+
22+
```
23+
-h, --help Help for "stackit beta security-group describe"
24+
```
25+
26+
### Options inherited from parent commands
27+
28+
```
29+
-y, --assume-yes If set, skips all confirmation prompts
30+
--async If set, runs the command asynchronously
31+
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
32+
-p, --project-id string Project ID
33+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
34+
```
35+
36+
### SEE ALSO
37+
38+
* [stackit beta security-group](./stackit_beta_security-group.md) - manage security groups.
39+
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
## stackit beta security-group list
2+
3+
list security groups
4+
5+
### Synopsis
6+
7+
list security groups
8+
9+
```
10+
stackit beta security-group list [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
list all groups
17+
$ stackit beta security-group list
18+
19+
list groups with labels
20+
$ stackit beta security-group list --labels label1=value1,label2=value2
21+
```
22+
23+
### Options
24+
25+
```
26+
-h, --help Help for "stackit beta security-group list"
27+
--labels string a list of labels in the form <key>=<value>
28+
```
29+
30+
### Options inherited from parent commands
31+
32+
```
33+
-y, --assume-yes If set, skips all confirmation prompts
34+
--async If set, runs the command asynchronously
35+
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
36+
-p, --project-id string Project ID
37+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
38+
```
39+
40+
### SEE ALSO
41+
42+
* [stackit beta security-group](./stackit_beta_security-group.md) - manage security groups.
43+
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
## stackit beta security-group update
2+
3+
Update a security group
4+
5+
### Synopsis
6+
7+
Update a named security group
8+
9+
```
10+
stackit beta security-group update [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
Update the name of a group
17+
$ stackit beta security-group update 541d122f-0a5f-4bb0-94b9-b1ccbd7ba776 --name my-new-name
18+
19+
Update the labels of a group
20+
$ stackit beta security-group update 541d122f-0a5f-4bb0-94b9-b1ccbd7ba776 --labels label1=value1,label2=value2
21+
```
22+
23+
### Options
24+
25+
```
26+
--description string an optional description of the security group. Must be <= 127 chars
27+
-h, --help Help for "stackit beta security-group update"
28+
--labels strings a list of labels in the form <key>=<value>
29+
--name string the name of the security group. Must be <= 63 chars
30+
```
31+
32+
### Options inherited from parent commands
33+
34+
```
35+
-y, --assume-yes If set, skips all confirmation prompts
36+
--async If set, runs the command asynchronously
37+
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
38+
-p, --project-id string Project ID
39+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
40+
```
41+
42+
### SEE ALSO
43+
44+
* [stackit beta security-group](./stackit_beta_security-group.md) - manage security groups.
45+

0 commit comments

Comments
 (0)