Skip to content

Commit e0e5ddd

Browse files
Benjosh95Benjosh95
committed
generate docs for volume backup api
1 parent afcf18c commit e0e5ddd

8 files changed

+315
-0
lines changed

‎docs/stackit_volume.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ stackit volume [flags]
3030
### SEE ALSO
3131

3232
* [stackit](./stackit.md) - Manage STACKIT resources using the command line
33+
* [stackit volume backup](./stackit_volume_backup.md) - Provides functionality for volume backups
3334
* [stackit volume create](./stackit_volume_create.md) - Creates a volume
3435
* [stackit volume delete](./stackit_volume_delete.md) - Deletes a volume
3536
* [stackit volume describe](./stackit_volume_describe.md) - Shows details of a volume

‎docs/stackit_volume_backup.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
## stackit volume backup
2+
3+
Provides functionality for volume backups
4+
5+
### Synopsis
6+
7+
Provides functionality for volume backups.
8+
9+
```
10+
stackit volume backup [flags]
11+
```
12+
13+
### Options
14+
15+
```
16+
-h, --help Help for "stackit volume backup"
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 backup create](./stackit_volume_backup_create.md) - Creates a backup from a specific source
34+
* [stackit volume backup delete](./stackit_volume_backup_delete.md) - Deletes a backup
35+
* [stackit volume backup describe](./stackit_volume_backup_describe.md) - Describes a backup
36+
* [stackit volume backup list](./stackit_volume_backup_list.md) - Lists all backups
37+
* [stackit volume backup restore](./stackit_volume_backup_restore.md) - Restores a backup
38+
* [stackit volume backup update](./stackit_volume_backup_update.md) - Updates a backup
39+

‎docs/stackit_volume_backup_create.md‎

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

‎docs/stackit_volume_backup_delete.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
## stackit volume backup delete
2+
3+
Deletes a backup
4+
5+
### Synopsis
6+
7+
Deletes a backup by its ID.
8+
9+
```
10+
stackit volume backup delete BACKUP_ID [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
Delete a backup
17+
$ stackit volume backup delete xxx-xxx-xxx
18+
19+
Delete a backup and wait for deletion to be completed
20+
$ stackit volume backup delete xxx-xxx-xxx --async=false
21+
```
22+
23+
### Options
24+
25+
```
26+
-h, --help Help for "stackit volume backup 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 backup](./stackit_volume_backup.md) - Provides functionality for volume backups
43+

‎docs/stackit_volume_backup_describe.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
## stackit volume backup describe
2+
3+
Describes a backup
4+
5+
### Synopsis
6+
7+
Describes a backup by its ID.
8+
9+
```
10+
stackit volume backup describe BACKUP_ID [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
Get details of a backup
17+
$ stackit volume backup describe xxx-xxx-xxx
18+
19+
Get details of a backup in JSON format
20+
$ stackit volume backup describe xxx-xxx-xxx --output-format json
21+
```
22+
23+
### Options
24+
25+
```
26+
-h, --help Help for "stackit volume backup 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 backup](./stackit_volume_backup.md) - Provides functionality for volume backups
43+

‎docs/stackit_volume_backup_list.md‎

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

‎docs/stackit_volume_backup_restore.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
## stackit volume backup restore
2+
3+
Restores a backup
4+
5+
### Synopsis
6+
7+
Restores a backup by its ID.
8+
9+
```
10+
stackit volume backup restore BACKUP_ID [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
Restore a backup
17+
$ stackit volume backup restore xxx-xxx-xxx
18+
19+
Restore a backup and wait for restore to be completed
20+
$ stackit volume backup restore xxx-xxx-xxx --async=false
21+
```
22+
23+
### Options
24+
25+
```
26+
-h, --help Help for "stackit volume backup restore"
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 backup](./stackit_volume_backup.md) - Provides functionality for volume backups
43+

‎docs/stackit_volume_backup_update.md‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
## stackit volume backup update
2+
3+
Updates a backup
4+
5+
### Synopsis
6+
7+
Updates a backup by its ID.
8+
9+
```
10+
stackit volume backup update BACKUP_ID [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
Update a backup name
17+
$ stackit volume backup update xxx-xxx-xxx --name new-name
18+
19+
Update backup labels
20+
$ stackit volume backup update xxx-xxx-xxx --labels key1=value1,key2=value2
21+
```
22+
23+
### Options
24+
25+
```
26+
-h, --help Help for "stackit volume backup update"
27+
--labels stringToString Key-value string pairs as labels (default [])
28+
--name string Name of the backup
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 backup](./stackit_volume_backup.md) - Provides functionality for volume backups
45+

0 commit comments

Comments
 (0)