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
2 changes: 1 addition & 1 deletion doc/ovhcloud_cloud_storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Manage storage services in the given cloud project

* [ovhcloud cloud](ovhcloud_cloud.md) - Manage your projects and services in the Public Cloud universe (MKS, MPR, MRS, Object Storage...)
* [ovhcloud cloud storage block](ovhcloud_cloud_storage_block.md) - Manage block storage volumes in the given cloud project
* [ovhcloud cloud storage file](ovhcloud_cloud_storage_file.md) - Manage file storage shares in the given cloud project
* [ovhcloud cloud storage file](ovhcloud_cloud_storage_file.md) - Manage file storage in the given cloud project
* [ovhcloud cloud storage object](ovhcloud_cloud_storage_object.md) - Manage S3™* compatible storage containers in the given cloud project (* S3 is a trademark filed by Amazon Technologies,Inc. OVHcloud's service is not sponsored by, endorsed by, or otherwise affiliated with Amazon Technologies,Inc.)
* [ovhcloud cloud storage swift](ovhcloud_cloud_storage_swift.md) - Manage SWIFT storage containers in the given cloud project

5 changes: 3 additions & 2 deletions doc/ovhcloud_cloud_storage_file.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
## ovhcloud cloud storage file

Manage file storage shares in the given cloud project
Manage file storage in the given cloud project

### Options

```
--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 All @@ -32,5 +31,7 @@ Manage file storage shares in the given cloud project
### SEE ALSO

* [ovhcloud cloud storage](ovhcloud_cloud_storage.md) - Manage storage services in the given cloud project
* [ovhcloud cloud storage file network](ovhcloud_cloud_storage_file_network.md) - Manage file storage share networks
* [ovhcloud cloud storage file share](ovhcloud_cloud_storage_file_share.md) - Manage file storage shares
* [ovhcloud cloud storage file snapshot](ovhcloud_cloud_storage_file_snapshot.md) - Manage file storage snapshots

38 changes: 38 additions & 0 deletions doc/ovhcloud_cloud_storage_file_network.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
## ovhcloud cloud storage file network

Manage file storage share networks

### Options

```
-h, --help help for network
```

### 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](ovhcloud_cloud_storage_file.md) - Manage file storage in the given cloud project
* [ovhcloud cloud storage file network create](ovhcloud_cloud_storage_file_network_create.md) - Create a new file storage share network
* [ovhcloud cloud storage file network delete](ovhcloud_cloud_storage_file_network_delete.md) - Delete the given file storage share network
* [ovhcloud cloud storage file network get](ovhcloud_cloud_storage_file_network_get.md) - Get a specific file storage share network
* [ovhcloud cloud storage file network list](ovhcloud_cloud_storage_file_network_list.md) - List file storage share networks

49 changes: 49 additions & 0 deletions doc/ovhcloud_cloud_storage_file_network_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
## ovhcloud cloud storage file network create

Create a new file storage share network

```
ovhcloud cloud storage file network create [flags]
```

### Options

```
--availability-zone string Availability zone within the region
--description string Description of the share network
--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 Name of the share network
--network-id string ID of the private network to back the share network
--region string Region where the share network is created
--replace Replace parameters file if it already exists
--subnet-id string ID of the subnet to back the share network
--wait Wait for the share network 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 network](ovhcloud_cloud_storage_file_network.md) - Manage file storage share networks

38 changes: 38 additions & 0 deletions doc/ovhcloud_cloud_storage_file_network_delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
## ovhcloud cloud storage file network delete

Delete the given file storage share network

```
ovhcloud cloud storage file network delete <network_id> [flags]
```

### Options

```
-h, --help help for delete
```

### 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 network](ovhcloud_cloud_storage_file_network.md) - Manage file storage share networks

38 changes: 38 additions & 0 deletions doc/ovhcloud_cloud_storage_file_network_get.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
## ovhcloud cloud storage file network get

Get a specific file storage share network

```
ovhcloud cloud storage file network get <network_id> [flags]
```

### Options

```
-h, --help help for get
```

### 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 network](ovhcloud_cloud_storage_file_network.md) - Manage file storage share networks

45 changes: 45 additions & 0 deletions doc/ovhcloud_cloud_storage_file_network_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
## ovhcloud cloud storage file network list

List file storage share networks

```
ovhcloud cloud storage file network list [flags]
```

### Options

```
--filter stringArray Filter results by any property using https://github.com/PaesslerAG/gval syntax
Examples:
--filter 'state=="running"'
--filter 'name=~"^my.*"'
--filter 'nested.property.subproperty>10'
--filter 'startDate>="2023-12-01"'
--filter 'name=~"something" && nbField>10'
-h, --help help for list
```

### 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 network](ovhcloud_cloud_storage_file_network.md) - Manage file storage share networks

15 changes: 6 additions & 9 deletions doc/ovhcloud_cloud_storage_file_share.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,17 +26,14 @@ 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

* [ovhcloud cloud storage file](ovhcloud_cloud_storage_file.md) - Manage file storage shares in the given cloud project
* [ovhcloud cloud storage file share acl](ovhcloud_cloud_storage_file_share_acl.md) - Manage share access control lists
* [ovhcloud cloud storage file share create](ovhcloud_cloud_storage_file_share_create.md) - Create a new share
* [ovhcloud cloud storage file share delete](ovhcloud_cloud_storage_file_share_delete.md) - Delete the given share
* [ovhcloud cloud storage file share edit](ovhcloud_cloud_storage_file_share_edit.md) - Edit the given share
* [ovhcloud cloud storage file share get](ovhcloud_cloud_storage_file_share_get.md) - Get a specific share
* [ovhcloud cloud storage file share list](ovhcloud_cloud_storage_file_share_list.md) - List shares
* [ovhcloud cloud storage file share snapshot](ovhcloud_cloud_storage_file_share_snapshot.md) - Manage share snapshots
* [ovhcloud cloud storage file](ovhcloud_cloud_storage_file.md) - Manage file storage in the given cloud project
* [ovhcloud cloud storage file share create](ovhcloud_cloud_storage_file_share_create.md) - Create a new file storage share
* [ovhcloud cloud storage file share delete](ovhcloud_cloud_storage_file_share_delete.md) - Delete the given file storage share
* [ovhcloud cloud storage file share edit](ovhcloud_cloud_storage_file_share_edit.md) - Edit the given file storage share
* [ovhcloud cloud storage file share get](ovhcloud_cloud_storage_file_share_get.md) - Get a specific file storage share
* [ovhcloud cloud storage file share list](ovhcloud_cloud_storage_file_share_list.md) - List file storage shares

22 changes: 11 additions & 11 deletions doc/ovhcloud_cloud_storage_file_share_create.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,28 @@
## ovhcloud cloud storage file share create

Create a new share
Create a new file storage share

```
ovhcloud cloud storage file share create <region> [flags]
ovhcloud cloud storage file share create [flags]
```

### Options

```
--availability-zone string Availability zone (required in 3AZ regions)
--description string Share description
--availability-zone string Availability zone within the region
--description string Description of the file storage share
--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 Share name
--network-id string Network ID
--name string Name of the file storage share
--protocol string File sharing protocol (NFS)
--region string Region where the share is created
--replace Replace parameters file if it already exists
--size int Share size in GB
--snapshot-id string Snapshot ID to create the share from
--subnet-id string Subnet ID
--type string Share type
--share-network-id string ID of the share network to attach the share to
--share-type string File storage type / performance tier (STANDARD_1AZ)
--size int Size of the file storage share in GB
--wait Wait for the share to be ready before exiting
```

### Options inherited from parent commands
Expand All @@ -42,7 +43,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
3 changes: 1 addition & 2 deletions doc/ovhcloud_cloud_storage_file_share_delete.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## ovhcloud cloud storage file share delete

Delete the given share
Delete the given file storage share

```
ovhcloud cloud storage file share delete <share_id> [flags]
Expand Down 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
10 changes: 5 additions & 5 deletions doc/ovhcloud_cloud_storage_file_share_edit.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## ovhcloud cloud storage file share edit

Edit the given share
Edit the given file storage share

```
ovhcloud cloud storage file share edit <share_id> [flags]
Expand All @@ -9,11 +9,12 @@ ovhcloud cloud storage file share edit <share_id> [flags]
### Options

```
--description string Share description
--description string Description of the file storage share
--editor Use a text editor to define parameters
--from-file string File containing parameters
-h, --help help for edit
--name string Share name
--new-size int New share size in GB
--name string Name of the file storage share
--size int New size of the file storage share in GB
```

### Options inherited from parent commands
Expand All @@ -34,7 +35,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
3 changes: 1 addition & 2 deletions doc/ovhcloud_cloud_storage_file_share_get.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## ovhcloud cloud storage file share get

Get a specific share
Get a specific file storage share

```
ovhcloud cloud storage file share get <share_id> [flags]
Expand Down 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
3 changes: 1 addition & 2 deletions doc/ovhcloud_cloud_storage_file_share_list.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## ovhcloud cloud storage file share list

List shares
List file storage shares

```
ovhcloud cloud storage file share list [flags]
Expand Down 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
Loading
Loading