Manage filesystems using the CLI
This page describes how to view and manage filesystems using the CLI.
Last updated
This page describes how to view and manage filesystems using the CLI.
Last updated
Using the CLI, you can perform the following actions:
Command: weka fs
Use this command to view information on the filesystems in the WEKA system.
Command: weka fs create
Use the following command line to create a filesystem:
weka fs create <name> <group-name> <total-capacity> [--ssd-capacity <ssd-capacity>] [--thin-provision-min-ssd <thin-provision-min-ssd>] [--thin-provision-max-ssd <thin-provision-max-ssd>] [--encrypted] [--obs-name <obs-name>] [--auth-required <auth-required>] [--data-reduction]
Parameters
name*
Descriptive label for the filesystem, limited to 32 characters and excluding slashes (/) or backslashes (\).
group-name*
Name of the filesystem group to which the new filesystem is to be connected.
total-capacity*
Total capacity of the new filesystem. Minimum value: 1GiB.
ssd-capacity
For tiered filesystems, this is the SSD capacity. If not specified, the filesystem is pinned to SSD.
To set a thin provisioned filesystem, the thin-provision-min-ssd attribute must be used instead.
SSD capacity is set to total capacity
thin-provision-min-ssd
thin-provision-max-ssd
encrypted
Encryption of filesystem.
No
obs-name*
Object store name for tiering. Mandatory for tiered filesystems.
auth-required
No
data-reduction
Enable data reduction. The filesystem must be non-tired and thin-provisioned. A license with data reduction is required.
No
To create a new filesystem, the SSD space for the filesystem must be free and unprovisioned. When using thin-provisioned filesystems, that might not be the case. SSD space can be occupied for the thin-provisioned portion of other filesystems. Even if those are tiered, and data can be released (to object-store) or deleted, the SSD space can still get filled when data keeps being written or promoted from the object-store.
To create a new filesystem, in this case, use the weka fs reserve CLI command. Once enough space is cleared from the SSD (either by releasing to object-store or explicitly deleting data), it is possible to create the new filesystem using the reserved space.
Command: weka fs update
Use the following command line to edit an existing filesystem:
weka fs update <name> [--new-name=<new-name>] [--total-capacity=<total-capacity>] [--ssd-capacity=<ssd-capacity>] [--thin-provision-min-ssd <thin-provision-min-ssd>] [--thin-provision-max-ssd <thin-provision-max-ssd>] [--max-files=<max-files>] [--auth-required=<auth-required>]
Parameters
name*
Name of the filesystem to edit.
new-name
New name for the filesystem.
total-capacity
Total capacity of the edited filesystem.
ssd-capacity
SSD capacity of the edited filesystem. Minimum value: 1GiB.
thin-provision-min-ssd
thin-provision-max-ssd
max-files
Metadata limit for the filesystem
auth-required
Command: weka fs delete
Use the following command line to delete a filesystem:
weka fs delete <name> [--purge-from-obs]
Parameters
name*
Name of the filesystem to delete.
purge-from-obs
For a tiered filesystem, if set, all filesystem data is deleted from the object store bucket.
False
Using purge-from-obs removes all data from the object-store. This includes any backup data or snapshots created from this filesystem (if this filesystem has been downloaded from a snapshot of a different filesystem, it will leave the original snapshot data intact).
If any of the removed snapshots have been (or are) downloaded and used by a different filesystem, that filesystem will stop functioning correctly, data might be unavailable and errors might occur when accessing the data.
It is possible to either un-tier or migrate such a filesystem to a different object store bucket before deleting the snapshots it has downloaded.
For filesystems, this is the minimum SSD capacity that is ensured to be always available to this filesystem. Must be set when defining a thin-provisioned filesystem. Minimum value: 1GiB.
For filesystem, this is the maximum SSD capacity the filesystem can consume.
The value cannot exceed the total-capacity.
Determines if mounting the filesystem requires to be authenticated to WEKA (see ).
If a KMS is unavailable for a POC, contact the for guidance.
For filesystems, this is the minimum SSD capacity that is ensured to be always available to this filesystem. Minimum value: 1GiB.
For filesystem, this is the maximum SSD capacity the filesystem can consume.
The value must not exceed the total-capacity.
Determines if mounting the filesystem requires being authenticated to Weka ().
Possible values: yes or no.