Skip to content

Commit 96e5568

Browse files
Benjosh95Benjosh95
committed
add generate docs
1 parent 6397590 commit 96e5568

7 files changed

+267
-0
lines changed

‎docs/stackit_volume.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,5 +36,6 @@ stackit volume [flags]
3636
* [stackit volume list](./stackit_volume_list.md) - Lists all volumes of a project
3737
* [stackit volume performance-class](./stackit_volume_performance-class.md) - Provides functionality for volume performance classes available inside a project
3838
* [stackit volume resize](./stackit_volume_resize.md) - Resizes a volume
39+
* [stackit volume snapshot](./stackit_volume_snapshot.md) - Provides functionality for snapshots
3940
* [stackit volume update](./stackit_volume_update.md) - Updates a volume
4041

‎docs/stackit_volume_snapshot.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
## stackit volume snapshot
2+
3+
Provides functionality for snapshots
4+
5+
### Synopsis
6+
7+
Provides functionality for snapshots.
8+
9+
```
10+
stackit volume snapshot [flags]
11+
```
12+
13+
### Options
14+
15+
```
16+
-h, --help Help for "stackit volume snapshot"
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 volume](./stackit_volume.md) - Provides functionality for volumes
33+
* [stackit volume snapshot create](./stackit_volume_snapshot_create.md) - Creates a snapshot from a volume
34+
* [stackit volume snapshot delete](./stackit_volume_snapshot_delete.md) - Deletes a snapshot
35+
* [stackit volume snapshot describe](./stackit_volume_snapshot_describe.md) - Describes a snapshot
36+
* [stackit volume snapshot list](./stackit_volume_snapshot_list.md) - Lists all snapshots
37+
* [stackit volume snapshot update](./stackit_volume_snapshot_update.md) - Updates a snapshot
38+

‎docs/stackit_volume_snapshot_create.md‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
## stackit volume snapshot create
2+
3+
Creates a snapshot from a volume
4+
5+
### Synopsis
6+
7+
Creates a snapshot from a volume.
8+
9+
```
10+
stackit volume snapshot create [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
Create a snapshot from a volume
17+
$ stackit volume snapshot create --volume-id xxx --project-id xxx
18+
19+
Create a snapshot with a name
20+
$ stackit volume snapshot create --volume-id xxx --name my-snapshot --project-id xxx
21+
22+
Create a snapshot with labels
23+
$ stackit volume snapshot create --volume-id xxx --labels key1=value1,key2=value2 --project-id xxx
24+
```
25+
26+
### Options
27+
28+
```
29+
-h, --help Help for "stackit volume snapshot create"
30+
--labels stringToString Key-value string pairs as labels (default [])
31+
--name string Name of the snapshot
32+
--volume-id string ID of the volume from which a snapshot should be created
33+
```
34+
35+
### Options inherited from parent commands
36+
37+
```
38+
-y, --assume-yes If set, skips all confirmation prompts
39+
--async If set, runs the command asynchronously
40+
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
41+
-p, --project-id string Project ID
42+
--region string Target region for region-specific requests
43+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
44+
```
45+
46+
### SEE ALSO
47+
48+
* [stackit volume snapshot](./stackit_volume_snapshot.md) - Provides functionality for snapshots
49+

‎docs/stackit_volume_snapshot_delete.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
## stackit volume snapshot delete
2+
3+
Deletes a snapshot
4+
5+
### Synopsis
6+
7+
Deletes a snapshot by its ID.
8+
9+
```
10+
stackit volume snapshot delete SNAPSHOT_ID [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
Delete a snapshot
17+
$ stackit volume snapshot delete xxx-xxx-xxx
18+
19+
Delete a snapshot and wait for deletion to be completed
20+
$ stackit volume snapshot delete xxx-xxx-xxx --async=false
21+
```
22+
23+
### Options
24+
25+
```
26+
-h, --help Help for "stackit volume snapshot delete"
27+
```
28+
29+
### Options inherited from parent commands
30+
31+
```
32+
-y, --assume-yes If set, skips all confirmation prompts
33+
--async If set, runs the command asynchronously
34+
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
35+
-p, --project-id string Project ID
36+
--region string Target region for region-specific requests
37+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
38+
```
39+
40+
### SEE ALSO
41+
42+
* [stackit volume snapshot](./stackit_volume_snapshot.md) - Provides functionality for snapshots
43+

‎docs/stackit_volume_snapshot_describe.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
## stackit volume snapshot describe
2+
3+
Describes a snapshot
4+
5+
### Synopsis
6+
7+
Describes a snapshot by its ID.
8+
9+
```
10+
stackit volume snapshot describe SNAPSHOT_ID [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
Get details of a snapshot
17+
$ stackit volume snapshot describe xxx-xxx-xxx
18+
19+
Get details of a snapshot in JSON format
20+
$ stackit volume snapshot describe xxx-xxx-xxx --output-format json
21+
```
22+
23+
### Options
24+
25+
```
26+
-h, --help Help for "stackit volume snapshot describe"
27+
```
28+
29+
### Options inherited from parent commands
30+
31+
```
32+
-y, --assume-yes If set, skips all confirmation prompts
33+
--async If set, runs the command asynchronously
34+
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
35+
-p, --project-id string Project ID
36+
--region string Target region for region-specific requests
37+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
38+
```
39+
40+
### SEE ALSO
41+
42+
* [stackit volume snapshot](./stackit_volume_snapshot.md) - Provides functionality for snapshots
43+

‎docs/stackit_volume_snapshot_list.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
## stackit volume snapshot list
2+
3+
Lists all snapshots
4+
5+
### Synopsis
6+
7+
Lists all snapshots in a project.
8+
9+
```
10+
stackit volume snapshot list [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
List all snapshots
17+
$ stackit volume snapshot list
18+
19+
List snapshots with a limit of 10
20+
$ stackit volume snapshot list --limit 10
21+
22+
List snapshots filtered by label
23+
$ stackit volume snapshot list --label-selector key1=value1
24+
```
25+
26+
### Options
27+
28+
```
29+
-h, --help Help for "stackit volume snapshot list"
30+
--label-selector string Filter snapshots by labels
31+
--limit int Maximum number of entries to list
32+
```
33+
34+
### Options inherited from parent commands
35+
36+
```
37+
-y, --assume-yes If set, skips all confirmation prompts
38+
--async If set, runs the command asynchronously
39+
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
40+
-p, --project-id string Project ID
41+
--region string Target region for region-specific requests
42+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
43+
```
44+
45+
### SEE ALSO
46+
47+
* [stackit volume snapshot](./stackit_volume_snapshot.md) - Provides functionality for snapshots
48+

‎docs/stackit_volume_snapshot_update.md‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
## stackit volume snapshot update
2+
3+
Updates a snapshot
4+
5+
### Synopsis
6+
7+
Updates a snapshot by its ID.
8+
9+
```
10+
stackit volume snapshot update SNAPSHOT_ID [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
Update a snapshot name
17+
$ stackit volume snapshot update xxx-xxx-xxx --name my-new-name
18+
19+
Update a snapshot labels
20+
$ stackit volume snapshot update xxx-xxx-xxx --labels key1=value1,key2=value2
21+
```
22+
23+
### Options
24+
25+
```
26+
-h, --help Help for "stackit volume snapshot update"
27+
--labels stringToString Key-value string pairs as labels (default [])
28+
--name string Name of the snapshot
29+
```
30+
31+
### Options inherited from parent commands
32+
33+
```
34+
-y, --assume-yes If set, skips all confirmation prompts
35+
--async If set, runs the command asynchronously
36+
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
37+
-p, --project-id string Project ID
38+
--region string Target region for region-specific requests
39+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
40+
```
41+
42+
### SEE ALSO
43+
44+
* [stackit volume snapshot](./stackit_volume_snapshot.md) - Provides functionality for snapshots
45+

0 commit comments

Comments
 (0)