CLI Commands

Note: Mapfs Pro doesn't have GUI so far.

 
Command Explain
mapfs
mapfs -h
mapfs --help		 Display accepted sub-commands and how to get sub-command help message.
mapfs -v
mapfs --version		 Display mapfs product information: Copyright, EULA, Privacy.
mapfs add

Adding a new mapping.
One mapping is a mapper between Cloud Object Storage and Local Volume.
After adding, a new volume is created.

If no arguments given, or incorrect arguments given, the detailed help message for "add" subcommand is displayed.

Notes:

  • at most 10 existing volumes.
  • mapfs will verifies the parameters for accessing the Object Storage, it may takes a few seconds or a few minutes depending on your network connection to the Object Storage.

Examples:

1, AWS S3

$ mapfs add <VolumeName> aws <AccessKeyID> <SecretAccessKey> <BucketName> <Region> [Options]

2, Azure

$ mapfs add <VolumeName> azure "<ConnectionString>" <ContainerName> [Options]

Note: ConnectionString is a long character sequence, must be wrapped with "".

3, Google/GCS

$ mapfs add <VolumeName> google <AccessKeyID> <SecretAccessKey> <BucketName> <Region> [Options]

4, Wasabi

$ mapfs add <VolumeName> wasabi <AccessKeyID> <SecretAccessKey> <BucketName> <Region> [Options]

5, Cloudflare

$ mapfs add <VolumeName> cloudflare <AccessKeyID> <SecretAccessKey> <BucketName> <AccountID> [Options]

6, Aliyun

$ mapfs add <VolumeName> aliyun <AccessKeyID> <SecretAccessKey> <BucketName> <Region> [Options]

7, Oracle Cloud Storage

$ mapfs add <VolumeName> oracle <AccessKeyID> <SecretAccessKey> <BucketName> <Region> <OCI-Namespace> [Options]
mapfs remove

Remove an existing volume.

If no arguments given, or incorrect arguments given, the detailed help message for "delete" subcommand is displayed.

Note: before removing an existing mapping, the volume must be in the Offline/Unmont status.
mapfs list Displays all the volumes' information.
mapfs configure

Configuring the Cache Parameters for one specific volume.

If no arguments given, or incorrect arguments given, the detailed help message for "configure" subcommand is displayed.

Notes:

  • before configuring, the volume must be in the Offline/Unmont status.
  • Shrinking CacheSize is not supported.
  • Change Cache Directory will delete all Cache Data.

Examples:

$ mapfs configure <VolumeName> cache_dir=/data cache_size=100 cache_timeout=300
mapfs mount

Mounting one volume to one specific local folder.

If no arguments given, or incorrect arguments given, the detailed help message for "mount" subcommand is displayed.

Notes:

  • Mapfs doesn't support duplicate mounting. If this volume has already been mounted to a local folder, it can not be re-mount again.
  • Mounting a volume will checks incomplete multipart uploads firstly, it may takes a few seconds or a few minutes according to your network connection to the underlying Cloud Object Storage.
mapfs umount Unmount one volume, disconnects the connection between local folder and Object Storage.

If no arguments given, or incorrect arguments given, the detailed help message for "umount" subcommand is displayed.
mapfs stat Displays the IO Status, Cache Hit/Miss Statistics information for all the mounted volumes.

Note: Only applies for mounted volumes.