How to use the BlobFuse2 mount command

Article
05/13/2024

Use the blobfuse2 mount command to mount a Blob Storage container as a file system in Linux, or to display existing mount points.

Command Syntax

The blobfuse2 mount command has 2 formats:

blobfuse2 mount [path] --[flag-name]=[flag-value]

blobfuse2 mount [command] --[flag-name]=[flag-value]

Arguments

[path]

Specify a file path to the directory where the storage container will be mounted. Example:

blobfuse2 mount ./mount_path ...

[command]

The supported subcommands for blobfuse2 mount are:

Command	Description
all	Mounts all blob containers in a specified storage account
list	Lists all BlobFuse2 mount points

Select one of the command links in the table above to view the documentation for the individual subcommands, including the arguments and flags they support.

Flags (options)

Some flags are inherited from the parent command, blobfuse2, and others only apply to the blobfuse2 mount command.

Flags inherited from the BlobFuse2 command

The following flags are inherited from parent command blobfuse2):

Flag	Short version	Value type	Default value	Description
disable-version-check		boolean	false	Enables or disables automatic version checking of the BlobFuse2 binaries
help	-h	n/a	n/a	Help info for the blobfuse2 command and subcommands

Flags that apply only to the BlobFuse2 mount command

The following flags apply only to command blobfuse2 mount:

Flag	Value type	Default value	Description
allow-other	boolean	false	Allow other users to access this mount point
attr-cache-timeout	uint32	120	Attribute cache timeout _{(in seconds)}
attr-timeout	uint32		Attribute timeout _{(in seconds)}
config-file	string	./config.yaml	The path to the configuration file where the account credentials are provided.
container-name	string		The name of the container to be mounted
entry-timeout	uint32		Entry timeout _{(in seconds)}
file-cache-timeout	uint32	120	File cache timeout _{(in seconds)}
foreground	boolean	false	Whether the file system is mounted in foreground mode
log-file-path	string	$HOME/.blobfuse2/blobfuse2.log	The path for log files
log-level	LOG_OFF LOG_CRIT LOG_ERR LOG_WARNING LOG_INFO LOG_DEBUG LOG_WARNING	LOG_WARNING	The level of logging written to `--log-file-path`.
negative-timeout	uint32		The negative entry timeout _{(in seconds)}
no-symlinks	boolean	false	Whether or not symlinks should be supported
passphrase	string		Key to decrypt config file. Can also be specified by env-variable BLOBFUSE2_SECURE_CONFIG_PASSPHRASE The key length shall be 16 (AES-128), 24 (AES-192), or 32 (AES-256) bytes in length.
read-only	boolean	false	Mount the system in read only mode
secure-config	boolean	false	Encrypt auto generated config file for each container
tmp-path	string	n/a	Configures the tmp location for the cache. (Configure the fastest disk (SSD or ramdisk) for best performance).

Examples

Note

The following examples assume you have already created a configuration file in the current directory.

Mount an individual Azure Blob Storage container to a new directory using the settings from a configuration file, and with foreground mode disabled:
```
sudo mkdir bf2a
sudo blobfuse2 mount ./bf2a --config-file=./config.yaml --foreground=false
```
```
sudo blobfuse2 mount list
```
Example output
```
1 : /home/<user>/bf2a
```

Mount all Blob Storage containers in the storage account specified in the configuration file to the path specified in the command. (Each container will be a subdirectory under the directory specified):

sudo mkdir bf2all

sudo blobfuse2 mount all ./bf2all --config-file=./config.yaml

Example output

Mounting container : blobfuse2a to path : bf2all/blobfuse2a
Mounting container : blobfuse2b to path : bf2all/blobfuse2b

sudo blobfuse2 mount list

Example output

1 : /home/<user>/bf2all/blobfuse2a
2 : /home/<user>/bf2all/blobfuse2b

Mount a fast storage device, then mount a Blob Storage container specifying the path to the mounted disk as the BlobFuse2 file caching location:

sudo mkdir /mnt/resource/blobfuse2tmp -p
sudo chown <youruser> /mnt/resource/blobfuse2tmp
sudo mkdir bf2a
sudo blobfuse2 mount ./bf2a --config-file=./config.yaml --tmp-path=/mnt/resource/blobfuse2tmp

blobfuse2 mount list

1 : /home/<user>/bf2a/blobfuse2a

Mount a Blob Storage container in read-only mode and skipping the automatic BlobFuse2 version check:

sudo blobfuse2 mount ./mount_dir --config-file=./config.yaml --read-only --disable-version-check=true

Mount a Blob Storage container using an existing configuration file, but override the container name (mounting another container in the same storage account):
```
sudo blobfuse2 mount ./mount_dir2 --config-file=./config.yaml --container-name=container2
```