Copy page

Commands

Documentation for `scw file`

This API allows you to manage your File Storage resources.

Attachment management

Attachment management.

List filesystems attachments

List all existing attachments in a specified region. By default, the attachments listed are ordered by creation date in ascending order. This can be modified using the order_by field.

Usage:

Code
scw file attachment list [arg=value ...]

Arguments:

Name	Description	Argument Specifications
filesystem-id	UUID of the File Storage volume
resource-id	Filter by resource ID
resource-type	Filter by resource type	One of: unknown_resource_type, instance_server
zone	Filter by resource zone
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par, all

Filesystem management

Filesystem management.

Create a new filesystem

To create a new filesystem, you must specify a name, a size, and a project ID.

Usage:

Code
scw file filesystem create [arg=value ...]

Arguments:

Name	Description	Argument Specifications
name	Name of the filesystem	Required
project-id	Project ID to use. If none is passed the default project ID will be used
size	Filesystem size in bytes, with a granularity in GB (10^9 bytes).	Required
type	Type of the filesystem
tags.{index}	List of tags assigned to the filesystem
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par

Delete a detached filesystem

You must specify the filesystem_id of the filesystem you want to delete.

Usage:

Code
scw file filesystem delete <filesystem-id ...> [arg=value ...]

Arguments:

Name	Description	Argument Specifications
filesystem-id	UUID of the filesystem	Required
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par

Get filesystem details

Retrieve all properties and current status of a specific filesystem identified by its ID.

Usage:

Code
scw file filesystem get <filesystem-id ...> [arg=value ...]

Arguments:

Name	Description	Argument Specifications
filesystem-id	UUID of the filesystem	Required
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par

List all filesystems

Retrieve all filesystems in the specified region. By default, the filesystems listed are ordered by creation date in ascending order. This can be modified using the order_by field.

Usage:

Code
scw file filesystem list [arg=value ...]

Arguments:

Name	Description	Argument Specifications
order-by	Criteria to use when ordering the list	One of: created_at_asc, created_at_desc, name_asc, name_desc
project-id	Filter by project ID
name	Filter the returned filesystems by their names
filesystem-type	Type of the filesystem
tags.{index}	Filter by tags. Only filesystems with one or more matching tags will be returned
filesystem-ids.{index}	Filter by filesystem IDs. Only filesystems with one or more matching IDs will be returned
organization-id	Filter by organization ID
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par, all

Update filesystem properties

Update the technical details of a filesystem, such as its name, tags or its new size.

Usage:

Code
scw file filesystem update [arg=value ...]

Arguments:

Name	Description	Argument Specifications
filesystem-id	UUID of the filesystem	Required
name	When defined, is the new name of the filesystem
size	Optional field for increasing the size of the filesystem (must be larger than the current size)
tags.{index}	List of tags assigned to the filesystem
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par

Filesystem-type management

Filesystem-type management.

List filesystems types

List filesystems types.

Usage:

Code
scw file filesystem-type list [arg=value ...]

Arguments:

Name	Description	Argument Specifications
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par, all