Skip to content

Commit a107df6

Browse files
committed
feat(server): add documentation for security group attach and detach commands
1 parent 902777c commit a107df6

File tree

4 files changed

+120
-0
lines changed

4 files changed

+120
-0
lines changed

docs/stackit_server.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ stackit server [flags]
4646
* [stackit server reboot](./stackit_server_reboot.md) - Reboots a server
4747
* [stackit server rescue](./stackit_server_rescue.md) - Rescues an existing server
4848
* [stackit server resize](./stackit_server_resize.md) - Resizes the server to the given machine type
49+
* [stackit server security-group](./stackit_server_security-group.md) - Allows attaching/detaching security groups to servers
4950
* [stackit server service-account](./stackit_server_service-account.md) - Allows attaching/detaching service accounts to servers
5051
* [stackit server start](./stackit_server_start.md) - Starts an existing server or allocates the server if deallocated
5152
* [stackit server stop](./stackit_server_stop.md) - Stops an existing server
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
## stackit server security-group
2+
3+
Allows attaching/detaching security groups to servers
4+
5+
### Synopsis
6+
7+
Allows attaching/detaching security groups to servers.
8+
9+
```
10+
stackit server security-group [flags]
11+
```
12+
13+
### Options
14+
15+
```
16+
-h, --help Help for "stackit server 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+
--region string Target region for region-specific requests
27+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
28+
```
29+
30+
### SEE ALSO
31+
32+
* [stackit server](./stackit_server.md) - Provides functionality for servers
33+
* [stackit server security-group attach](./stackit_server_security-group_attach.md) - Attaches a security group to a server
34+
* [stackit server security-group detach](./stackit_server_security-group_detach.md) - Detaches a security group from a server
35+
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
## stackit server security-group attach
2+
3+
Attaches a security group to a server
4+
5+
### Synopsis
6+
7+
Attaches a security group to a server.
8+
9+
```
10+
stackit server security-group attach [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
Attach a security group with ID "xxx" to a server with ID "yyy"
17+
$ stackit server security-group attach --server-id yyy --security-group-id xxx
18+
```
19+
20+
### Options
21+
22+
```
23+
-h, --help Help for "stackit server security-group attach"
24+
--security-group-id string Security Group ID
25+
--server-id string Server ID
26+
```
27+
28+
### Options inherited from parent commands
29+
30+
```
31+
-y, --assume-yes If set, skips all confirmation prompts
32+
--async If set, runs the command asynchronously
33+
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
34+
-p, --project-id string Project ID
35+
--region string Target region for region-specific requests
36+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
37+
```
38+
39+
### SEE ALSO
40+
41+
* [stackit server security-group](./stackit_server_security-group.md) - Allows attaching/detaching security groups to servers
42+
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
## stackit server security-group detach
2+
3+
Detaches a security group from a server
4+
5+
### Synopsis
6+
7+
Detaches a security group from a server.
8+
9+
```
10+
stackit server security-group detach [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
Detach a security group with ID "xxx" from a server with ID "yyy"
17+
$ stackit server security-group detach --server-id yyy --security-group-id xxx
18+
```
19+
20+
### Options
21+
22+
```
23+
-h, --help Help for "stackit server security-group detach"
24+
--security-group-id string Security Group ID
25+
--server-id string Server ID
26+
```
27+
28+
### Options inherited from parent commands
29+
30+
```
31+
-y, --assume-yes If set, skips all confirmation prompts
32+
--async If set, runs the command asynchronously
33+
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
34+
-p, --project-id string Project ID
35+
--region string Target region for region-specific requests
36+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
37+
```
38+
39+
### SEE ALSO
40+
41+
* [stackit server security-group](./stackit_server_security-group.md) - Allows attaching/detaching security groups to servers
42+

0 commit comments

Comments
 (0)