Aliases:fs, filestorageManage file storage: shared NFS filesystems that instances and Kubernetes clusters on the same network can mount. Every command acts in the organization given by --org, or the one saved in your context.Commands that act on one file storage resource take its ID or name either as a positional argument or with --id. If you omit it, the CLI opens an interactive picker, so always pass it in scripts.
List file storage resources, optionally filtered by project or region. The table shows each resource’s ID, name, region, size in GiB, and remote ports.Remote Ports is the IP range of the NFS storage endpoints for each network attachment, ready to use as the remoteports mount option. It’s empty until an attachment has been given a range.
List the file storage classes you can create file storage in. A class sets the kind of storage and the region it lives in. Pass its ID as spec.storageClassId when you create a file storage resource. The table shows each class’s ID, name, region, supported protocols, and parallelism.
Get details for a file storage resource, including its NFS settings, snapshot policies, and network attachments. Each attachment in status.attachments carries its mountSource, in <host>:<path> format, and its mountOptions.
Create a new file storage resource. Accepts input from a JSON file or stdin. With neither, the CLI prompts for the name, description, project, region, size (1 to 1013 GiB), NFS settings, networks to attach, and Default Snapshot Protection. It offers only regions that have a file storage class, and uses the first class it finds in the region you choose. To choose the class yourself or add snapshot policies, use a file.Provisioning is asynchronous: without --wait, the command returns as soon as the request is accepted.
A class from the same region. List them with classes.
spec.storageType.NFS
rootSquash is required. posixAcl and atimeUpdateIntervalSeconds are optional and default to false and 0. See NFS settings for what each does. The CLI rejects an atime interval outside the accepted range before sending the request.
spec.attachments.networkIds
Optional. The networks the file storage is mounted from.
spec.defaultSnapshotProtectionEnabled
Optional. Omit it to turn on Default Snapshot Protection, or set false to leave it off.
Update an existing file storage resource. Accepts input from a JSON file or stdin. With neither, the CLI prompts for the name, description, size, NFS settings, networks, and Default Snapshot Protection, pre-filled from the resource as it stands. The prompts leave snapshot policies unchanged; manage them with the snapshot-policy commands.A payload takes metadata and the spec fields from create except organizationId, projectId, regionId, and storageClassId. It replaces the resource’s settings, with these exceptions for omitted fields:
Field
When omitted
spec.storageType.NFS.posixAcl
Resets to false
spec.storageType.NFS.atimeUpdateIntervalSeconds
Resets to 0
spec.defaultSnapshotProtectionEnabled
Keeps the current setting
spec.snapshotPolicies
Keeps the current policies. Send [] to remove them all, or a list to replace them all.
If your payload leaves out posixAcl or atimeUpdateIntervalSeconds while the resource has them set, the CLI prints a warning on stderr before sending it, including with --dry-run. The payload is still sent as written. To keep the current values, start from nscale file-storage get <storage-id> --json.
Delete a file storage resource. Teardown is asynchronous: without --wait, the command returns as soon as the request is accepted, and the file storage disappears some time later.Aliases:rm, remove
Deleting file storage permanently removes all its data and snapshots. This can’t be undone.
A manual snapshot is a point-in-time copy of a file storage resource that you take on demand, alongside the scheduled ones from snapshot policies. It captures the whole file storage, or one path within it.The snapshot commands take the file storage resource as the positional argument or --file-storage, except get and delete, which take the snapshot ID (or name) as the positional argument and the file storage with --file-storage. If you omit the file storage, you pick it from a list.A snapshot’s protected path and expiration time can’t be changed once it’s created. Once a snapshot expires, it’s no longer listed and get reports it as not found.
List the manual snapshots of a file storage resource. Expired snapshots aren’t listed. The table shows each snapshot’s ID, name, protected path, snapshot time, expiry (never if it doesn’t expire), and status.
nscale file-storage snapshot list <storage-id> [flags]
Take a manual snapshot of a file storage resource. Pass --protected-path to snapshot one path within it instead of the whole file storage. Without --expires-at, the snapshot is kept until you delete it.With none of the snapshot flags (--name, --description, --protected-path, --expires-at, --no-expiry), the CLI prompts for the name, description, protected path, and expiry (never, in 1, 7, or 30 days, or at a time you enter). Pass any of them to skip the prompts. --name is then required unless the CLI can prompt for it.The snapshot is captured in the background: without --wait, the command returns as soon as the request is accepted.
Field
Rules
Name
Lowercase letters, numbers, and dashes
Protected path
Relative to the root of the file storage, such as datasets/model. A leading / is dropped. At most 1024 characters, no trailing slash, no repeated slashes, and no . or .. components.
Expiry
An RFC 3339 time in the future, such as 2030-01-01T00:00:00Z
Snapshot policies take point-in-time snapshots of a file storage resource on a schedule and keep a set number of them. Each resource can have up to 4 policies. For how schedules and retention work, see Snapshot policies.The snapshot-policy commands edit the policies stored on the file storage resource. Each change reads the resource and sends it back with the updated policy list. The rest of the resource is left as it is, including Default Snapshot Protection. Default Snapshot Protection is managed by Nscale and doesn’t appear in these commands.The file storage resource is the positional argument or --file-storage. Before v7.0.0 the flag was --id; passing --id now fails with an error that names --file-storage.create and update collect the policy through interactive prompts and don’t accept a JSON file, so they need a terminal. With --ci, they fail. To set policies in a script, send the full spec.snapshotPolicies list with update instead.The prompts ask for:
Prompt
Shown for
Rules
Name
Every policy
Lowercase letters, numbers, and dashes; at most 19 characters; unique on the resource
Frequency
Every policy
Hourly, Daily, Weekly, or Monthly
Day of week
Weekly
Monday through Sunday
Day of month
Monthly
1 through 28, so the policy runs every month
Time of day (UTC)
Daily, weekly, monthly
24-hour HH:MM
Latest snapshots to keep
Every policy
At least 1. Older snapshots are deleted automatically.
List the snapshot policies on a file storage resource. The table shows each policy’s name, frequency, run time, number of snapshots kept, and provisioning status.With --json or -q, the output is the array of policies from spec.snapshotPolicies. Each policy has name, schedule, and retention fields, with no metadata wrapper.
nscale file-storage snapshot-policy list <storage-id> [flags]
Add a snapshot policy to a file storage resource. The CLI prompts for the policy’s name, schedule, and retention, then asks you to confirm. It fails if the resource already has 4 policies.On success, the updated file storage resource is printed.
Change a snapshot policy’s name, schedule, or retention. The CLI prompts for each field, pre-filled from the policy as it stands, then asks you to confirm. If you omit --name, you pick the policy from a list.Policy names identify policies in the API, so renaming a policy replaces it with a new one.On success, the updated file storage resource is printed.
