socactl filesystems

socactl filesystems helps you manage the filesystems you are planning to mount to SOCA (see: SOCA Shared Storage)

Run socactl filesystems --help to display help message.

filesystems get

Retrieve your filesystems mount table. Use --output

./socactl filesystems get --output json
{
    "apps": {
        "enabled": "true",
        "mount_options": "nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2,noresvport",
        "mount_path": "/apps",
        "mount_target": "fs-00a47e67c069b22b8",
        "on_mount_failure": "exit",
        "provider": "efs"
    },
    "data": {
        "enabled": "true",
        "mount_options": "nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2,noresvport",
        "mount_path": "/data",
        "mount_target": "fs-087d9cff9c982be64",
        "on_mount_failure": "exit",
        "provider": "efs"
    }
}

Specify --key to filter a specific filesystem mount

./socactl filesystems get --key apps
{'apps': {'enabled': 'true', 'mount_options': 'nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2,noresvport', 'mount_path': '/apps', 'mount_target': 'fs-00a47e67c069b22b8', 'on_mount_failure': 'exit', 'provider': 'efs'}}

filesystems set

Create a new filesystem mount. View all options via filesystems set --help

./socactl filesystems set \
  --filesystem-name "testfs" \
  --provider "efs" \
  --mount-target "fs-087d9cff9c982be64" \
  --mount-path "/testpath"
Mount options not specified. Using default: nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2,noresvport
{
    "/configuration/FileSystems/testfs/provider": "efs",
    "/configuration/FileSystems/testfs/mount_path": "/testpath",
    "/configuration/FileSystems/testfs/mount_target": "fs-087d9cff9c982be64",
    "/configuration/FileSystems/testfs/enabled": "true",
    "/configuration/FileSystems/testfs/on_mount_failure": "ignore",
    "/configuration/FileSystems/testfs/mount_options": "nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2,noresvport"
}
Do you want to create this new filesystem (add --force to skip this confirmation)? (yes/no)yes
Cache updated
Success: Key has been updated successfully
Cache updated
Success: Key has been updated successfully
Cache updated
Success: Key has been updated successfully
Cache updated
Success: Key has been updated successfully
Cache updated
Success: Key has been updated successfully
Cache updated
Success: Key has been updated successfully

Note

Use --force to skip confirmation prompt.

filesystem update

Update an existing filesystem mount

./socactl filesystems update --filesystem-name "testfs" \
    --key "mount_path" \
    --value "/newpath"
Cache updated
Success: Key has been updated successfully

## Verify
/socactl filesystems get --key "testfs" --output json
{
    "testfs": {
        "enabled": "true",
        "mount_options": "nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2,noresvport",
        "mount_path": "/newpath", # <---- mount_path has been updated correctly
        "mount_target": "fs-087d9cff9c982be64",
        "on_mount_failure": "ignore",
        "provider": "efs"
    }
}

Note

You can only update enabled, mount_options or mount_path keys.