Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion doc/ovhcloud_cloud_storage_file.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ Manage file storage shares in the given cloud project
```
--cloud-project string Cloud project ID
-h, --help help for file
--region string Region (skip region discovery if set)
```

### Options inherited from parent commands
Expand Down
1 change: 0 additions & 1 deletion doc/ovhcloud_cloud_storage_file_network.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ Manage file storage share networks
--output 'name+","+type' (to extract and concatenate fields in a string)
--output '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
--profile string Use a specific profile from the configuration file
--region string Region (skip region discovery if set)
```

### SEE ALSO
Expand Down
1 change: 0 additions & 1 deletion doc/ovhcloud_cloud_storage_file_network_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,6 @@ ovhcloud cloud storage file network create <region> [flags]
--output 'name+","+type' (to extract and concatenate fields in a string)
--output '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
--profile string Use a specific profile from the configuration file
--region string Region (skip region discovery if set)
```

### SEE ALSO
Expand Down
1 change: 0 additions & 1 deletion doc/ovhcloud_cloud_storage_file_network_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ ovhcloud cloud storage file network delete <share_network_id> [flags]
--output 'name+","+type' (to extract and concatenate fields in a string)
--output '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
--profile string Use a specific profile from the configuration file
--region string Region (skip region discovery if set)
```

### SEE ALSO
Expand Down
1 change: 0 additions & 1 deletion doc/ovhcloud_cloud_storage_file_network_get.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ ovhcloud cloud storage file network get <share_network_id> [flags]
--output 'name+","+type' (to extract and concatenate fields in a string)
--output '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
--profile string Use a specific profile from the configuration file
--region string Region (skip region discovery if set)
```

### SEE ALSO
Expand Down
1 change: 0 additions & 1 deletion doc/ovhcloud_cloud_storage_file_network_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@ ovhcloud cloud storage file network list [flags]
--output 'name+","+type' (to extract and concatenate fields in a string)
--output '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
--profile string Use a specific profile from the configuration file
--region string Region (skip region discovery if set)
```

### SEE ALSO
Expand Down
1 change: 0 additions & 1 deletion doc/ovhcloud_cloud_storage_file_share.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ Manage file storage shares
--output 'name+","+type' (to extract and concatenate fields in a string)
--output '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
--profile string Use a specific profile from the configuration file
--region string Region (skip region discovery if set)
```

### SEE ALSO
Expand Down
1 change: 0 additions & 1 deletion doc/ovhcloud_cloud_storage_file_share_acl.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ Manage share access control lists
--output 'name+","+type' (to extract and concatenate fields in a string)
--output '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
--profile string Use a specific profile from the configuration file
--region string Region (skip region discovery if set)
```

### SEE ALSO
Expand Down
1 change: 0 additions & 1 deletion doc/ovhcloud_cloud_storage_file_share_acl_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ ovhcloud cloud storage file share acl create <share_id> [flags]
--output 'name+","+type' (to extract and concatenate fields in a string)
--output '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
--profile string Use a specific profile from the configuration file
--region string Region (skip region discovery if set)
```

### SEE ALSO
Expand Down
1 change: 0 additions & 1 deletion doc/ovhcloud_cloud_storage_file_share_acl_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ ovhcloud cloud storage file share acl delete <share_id> <acl_id> [flags]
--output 'name+","+type' (to extract and concatenate fields in a string)
--output '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
--profile string Use a specific profile from the configuration file
--region string Region (skip region discovery if set)
```

### SEE ALSO
Expand Down
1 change: 0 additions & 1 deletion doc/ovhcloud_cloud_storage_file_share_acl_get.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ ovhcloud cloud storage file share acl get <share_id> <acl_id> [flags]
--output 'name+","+type' (to extract and concatenate fields in a string)
--output '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
--profile string Use a specific profile from the configuration file
--region string Region (skip region discovery if set)
```

### SEE ALSO
Expand Down
1 change: 0 additions & 1 deletion doc/ovhcloud_cloud_storage_file_share_acl_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@ ovhcloud cloud storage file share acl list <share_id> [flags]
--output 'name+","+type' (to extract and concatenate fields in a string)
--output '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
--profile string Use a specific profile from the configuration file
--region string Region (skip region discovery if set)
```

### SEE ALSO
Expand Down
1 change: 0 additions & 1 deletion doc/ovhcloud_cloud_storage_file_share_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,6 @@ ovhcloud cloud storage file share create <region> [flags]
--output 'name+","+type' (to extract and concatenate fields in a string)
--output '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
--profile string Use a specific profile from the configuration file
--region string Region (skip region discovery if set)
```

### SEE ALSO
Expand Down
1 change: 0 additions & 1 deletion doc/ovhcloud_cloud_storage_file_share_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ ovhcloud cloud storage file share delete <share_id> [flags]
--output 'name+","+type' (to extract and concatenate fields in a string)
--output '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
--profile string Use a specific profile from the configuration file
--region string Region (skip region discovery if set)
```

### SEE ALSO
Expand Down
1 change: 0 additions & 1 deletion doc/ovhcloud_cloud_storage_file_share_edit.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@ ovhcloud cloud storage file share edit <share_id> [flags]
--output 'name+","+type' (to extract and concatenate fields in a string)
--output '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
--profile string Use a specific profile from the configuration file
--region string Region (skip region discovery if set)
```

### SEE ALSO
Expand Down
1 change: 0 additions & 1 deletion doc/ovhcloud_cloud_storage_file_share_get.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ ovhcloud cloud storage file share get <share_id> [flags]
--output 'name+","+type' (to extract and concatenate fields in a string)
--output '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
--profile string Use a specific profile from the configuration file
--region string Region (skip region discovery if set)
```

### SEE ALSO
Expand Down
1 change: 0 additions & 1 deletion doc/ovhcloud_cloud_storage_file_share_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@ ovhcloud cloud storage file share list [flags]
--output 'name+","+type' (to extract and concatenate fields in a string)
--output '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
--profile string Use a specific profile from the configuration file
--region string Region (skip region discovery if set)
```

### SEE ALSO
Expand Down
2 changes: 1 addition & 1 deletion doc/ovhcloud_cloud_storage_file_share_snapshot.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,14 +26,14 @@ Manage share snapshots
--output 'name+","+type' (to extract and concatenate fields in a string)
--output '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
--profile string Use a specific profile from the configuration file
--region string Region (skip region discovery if set)
```

### SEE ALSO

* [ovhcloud cloud storage file share](ovhcloud_cloud_storage_file_share.md) - Manage file storage shares
* [ovhcloud cloud storage file share snapshot create](ovhcloud_cloud_storage_file_share_snapshot_create.md) - Create a snapshot of the given share
* [ovhcloud cloud storage file share snapshot delete](ovhcloud_cloud_storage_file_share_snapshot_delete.md) - Delete a snapshot from the given share
* [ovhcloud cloud storage file share snapshot edit](ovhcloud_cloud_storage_file_share_snapshot_edit.md) - Edit a snapshot of the given share
* [ovhcloud cloud storage file share snapshot get](ovhcloud_cloud_storage_file_share_snapshot_get.md) - Get a specific snapshot for the given share
* [ovhcloud cloud storage file share snapshot list](ovhcloud_cloud_storage_file_share_snapshot_list.md) - List snapshots for the given share

6 changes: 5 additions & 1 deletion doc/ovhcloud_cloud_storage_file_share_snapshot_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,13 @@ ovhcloud cloud storage file share snapshot create <share_id> [flags]

```
--description string Snapshot description
--editor Use a text editor to define parameters
--from-file string File containing parameters
-h, --help help for create
--init-file string Create a file with example parameters
--name string Snapshot name
--replace Replace parameters file if it already exists
--wait Wait for the snapshot to be ready before exiting
```

### Options inherited from parent commands
Expand All @@ -32,7 +37,6 @@ ovhcloud cloud storage file share snapshot create <share_id> [flags]
--output 'name+","+type' (to extract and concatenate fields in a string)
--output '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
--profile string Use a specific profile from the configuration file
--region string Region (skip region discovery if set)
```

### SEE ALSO
Expand Down
1 change: 0 additions & 1 deletion doc/ovhcloud_cloud_storage_file_share_snapshot_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ ovhcloud cloud storage file share snapshot delete <share_id> <snapshot_id> [flag
--output 'name+","+type' (to extract and concatenate fields in a string)
--output '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
--profile string Use a specific profile from the configuration file
--region string Region (skip region discovery if set)
```

### SEE ALSO
Expand Down
42 changes: 42 additions & 0 deletions doc/ovhcloud_cloud_storage_file_share_snapshot_edit.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
## ovhcloud cloud storage file share snapshot edit

Edit a snapshot of the given share

```
ovhcloud cloud storage file share snapshot edit <share_id> <snapshot_id> [flags]

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the snapshots commands should be at the same level as share to mimic the API path (/publicCloud/project/{projectId}/storage/file/snapshot) => ovhcloud cloud storage file snapshot create|edit|get|…

```

### Options

```
--description string Snapshot description
--editor Use a text editor to define parameters
-h, --help help for edit
--name string Snapshot name
--wait Wait for the snapshot to be ready before exiting
```

### Options inherited from parent commands

```
--cloud-project string Cloud project ID
-d, --debug Activate debug mode (will log all HTTP requests details)
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
-o, --output string Output format: json, yaml, interactive, or a custom format expression (using https://github.com/PaesslerAG/gval syntax)
Examples:
--output json
--output yaml
--output interactive
--output 'id' (to extract a single field)
--output 'nested.field.subfield' (to extract a nested field)
--output '[id, "name"]' (to extract multiple fields as an array)
--output '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
--output 'name+","+type' (to extract and concatenate fields in a string)
--output '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
--profile string Use a specific profile from the configuration file
```

### SEE ALSO

* [ovhcloud cloud storage file share snapshot](ovhcloud_cloud_storage_file_share_snapshot.md) - Manage share snapshots

1 change: 0 additions & 1 deletion doc/ovhcloud_cloud_storage_file_share_snapshot_get.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ ovhcloud cloud storage file share snapshot get <share_id> <snapshot_id> [flags]
--output 'name+","+type' (to extract and concatenate fields in a string)
--output '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
--profile string Use a specific profile from the configuration file
--region string Region (skip region discovery if set)
```

### SEE ALSO
Expand Down
1 change: 0 additions & 1 deletion doc/ovhcloud_cloud_storage_file_share_snapshot_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@ ovhcloud cloud storage file share snapshot list <share_id> [flags]
--output 'name+","+type' (to extract and concatenate fields in a string)
--output '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
--profile string Use a specific profile from the configuration file
--region string Region (skip region discovery if set)
```

### SEE ALSO
Expand Down
79 changes: 35 additions & 44 deletions internal/assets/api-schemas/cloud_v2.json
Original file line number Diff line number Diff line change
Expand Up @@ -9526,27 +9526,20 @@
"nullable": true,
"readOnly": true
},
"shareId": {
"type": "string",
"description": "ID of the parent file storage share",
"format": "uuid",
"readOnly": true
},
"shareProto": {
"allOf": [
{
"$ref": "#/components/schemas/publicCloud.storage.file.FileStorageProtocolEnum"
"share": {
"type": "object",
"description": "Parent file storage share",
"properties": {
"id": {
"type": "string",
"description": "ID of the parent file storage share",
"format": "uuid",
"readOnly": true
}
],
"description": "File sharing protocol of the parent share",
"readOnly": true
},
"shareSize": {
"type": "integer",
"description": "Size of the parent share in GB at the time of the snapshot",
},
"readOnly": true
},
"snapshotSize": {
"size": {
"type": "integer",
"description": "Size of the snapshot in GB",
"readOnly": true
Expand All @@ -9562,28 +9555,28 @@
"description": "Description of the snapshot",
"nullable": true
},
"location": {
"allOf": [
{
"$ref": "#/components/schemas/publicCloud.common.Location"
}
],
"description": "Location of the snapshot"
},
"name": {
"type": "string",
"description": "Desired snapshot name",
"nullable": true
},
"shareId": {
"type": "string",
"description": "ID of the parent file storage share",
"format": "uuid"
"share": {
"type": "object",
"description": "Parent file storage share",
"properties": {
"id": {
"type": "string",
"description": "ID of the parent file storage share",
"format": "uuid"
}
},
"required": [
"id"
]
}
},
"required": [
"location",
"shareId"
"share"
]
},
"publicCloud.storage.file.FileStorageSnapshotUpdate": {
Expand Down Expand Up @@ -27239,11 +27232,10 @@
"value": {
"targetSpec": {
"description": "Daily backup snapshot",
"location": {
"region": "GRA1"
},
"name": "my-share-snapshot",
"shareId": "d1e2f3a4-b5c6-7890-abcd-ef1234567890"
"share": {
"id": "d1e2f3a4-b5c6-7890-abcd-ef1234567890"
}
}
},
"summary": "Create a snapshot of a file storage"
Expand Down Expand Up @@ -27544,21 +27536,20 @@
"region": "GRA1"
},
"name": "my-share-snapshot",
"shareId": "d1e2f3a4-b5c6-7890-abcd-ef1234567890",
"shareProto": "NFS",
"shareSize": 100,
"snapshotSize": 1
"share": {
"id": "d1e2f3a4-b5c6-7890-abcd-ef1234567890"
},
"size": 1
},
"currentTasks": null,
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"resourceStatus": "READY",
"targetSpec": {
"description": "Daily backup snapshot",
"location": {
"region": "GRA1"
},
"name": "my-share-snapshot",
"shareId": "d1e2f3a4-b5c6-7890-abcd-ef1234567890"
"share": {
"id": "d1e2f3a4-b5c6-7890-abcd-ef1234567890"
}
},
"updatedAt": "2026-02-10T15:05:00Z"
},
Expand Down
Loading
Loading