Manage filesystems using the CLI

This page describes how to view and manage filesystems using the CLI.

Using the CLI, you can perform the following actions:
​View filesystems​
​Create a filesystem​
​Add a filesystem when thin-provisioning is used​
​Edit a filesystem​
​Delete a filesystem​
View filesystems
Command: weka fs
Use this command to view information on the filesystems in the WEKA system.
Create a filesystem
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>] [--max-files <max-files>] [--encrypted] [--obs-name <obs-name>] [--auth-required <auth-required>] [--data-reduction]
Parameters
Name
Value
Default
name*
Name of the filesystem being created.
​
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
For thin-provisioned 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.
​
thin-provision-max-ssd
For thin-proviosined filesystem, this is the maximum SSD capacity the filesystem can consume.
The value cannot exceed the total-capacity.
​
max-files
Metadata allocation for this filesystem.
Automatically calculated by the system based on the SSD capacity.
​
encrypted
Encryption of filesystem
No
obs-name*
Object store name for tiering.
Mandatory for tiered filesystems.
​
auth-required
Determines if mounting the filesystem requires to be authenticated to WEKA (see User management).
no
data-reduction
Enable data reduction.
The filesystem must be non-tired and thin-provisioned. A license with data reduction is required.

No
​
Note: When creating an encrypted filesystem a KMS must be defined.
Note: To define an encrypted filesystem without a KMS, it is possible to use the--allow-no-kms parameter in the command. This can be useful when running POCs but should not be used in production since the security chain is compromised when a KMS is not used.
If filesystem keys exist when adding a KMS, they are automatically re-encrypted by the KMS for any future use.
Add a filesystem when thin-provisioning is used 
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 rehydrated 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.
Edit a filesystem
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
Value
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
For thin-provisioned filesystems, this is the minimum SSD capacity that is ensured to be always available to this filesystem.
Minimum value: 1GiB.
thin-provision-max-ssd
For thin-proviosined filesystem, this is the maximum SSD capacity the filesystem can consume.
The value can cannot exceed the total-capacity
max-files
Metadata limit for the filesystem
auth-required
Determines if mounting the filesystem requires being authenticated to Weka (weka user login).
Possible values: yes or no
Delete a filesystem
Command: weka fs delete
Use the following command line to delete a filesystem:
weka fs delete <name> [--purge-from-obs]
Parameters
Name
Value
Default
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
Note: Using purge-from-obs will remove 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.

Name	Value	Default
`name`*	Name of the filesystem being created.
`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`	For thin-provisioned 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.
`thin-provision-max-ssd`	For thin-proviosined filesystem, this is the maximum SSD capacity the filesystem can consume. The value cannot exceed the `total-capacity`.
`max-files`	Metadata allocation for this filesystem. Automatically calculated by the system based on the SSD capacity.
`encrypted`	Encryption of filesystem	No
`obs-name`*	Object store name for tiering. Mandatory for tiered filesystems.
`auth-required`	Determines if mounting the filesystem requires to be authenticated to WEKA (see User management).	no
data-reduction	Enable data reduction. The filesystem must be non-tired and thin-provisioned. A license with data reduction is required.	No

Name	Value
`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`	For thin-provisioned filesystems, this is the minimum SSD capacity that is ensured to be always available to this filesystem. Minimum value: 1GiB.
`thin-provision-max-ssd`	For thin-proviosined filesystem, this is the maximum SSD capacity the filesystem can consume. The value can cannot exceed the `total-capacity`
`max-files`	Metadata limit for the filesystem
`auth-required`	Determines if mounting the filesystem requires being authenticated to Weka (weka user login). Possible values: `yes` or `no`

Name	Value	Default
`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

Manage filesystems using the GUI

Next - WEKA Filesystems & Object Stores

Attach or detach object store buckets

Last modified 11d ago