Follow

fs.share.create  

ROLE: Admin, Pool Admin

Description

Create a new filesystem share.

Syntaxfs.share.create name=SHARENAME fs={FS|SNAP} [internal_path=STR] [offline_caching={MANUAL|AUTO|VDO|DISABLED}] [description=STR]
ArgumentsnameName of the share in 1-80 characters other than  \ / [ ] : | < > + = ; , * ?
fsName of an existing filesystem or snapshot
internal_pathAny sequence of characters
offline_cachingMANUAL, AUTO, VDO, DISABLED
descriptionAny sequence of characters
Examplefs.share.create name=Share01 fs=FS1
Share "Share01" created
ExampleAdding a description, and setting offline caching to auto.
fs.share.create name=Share01 fs=FS1 offline_caching=auto description=Share-of-this-file
Share "Share01" created



fs.share.delete  

ROLE: Admin, Pool Admin

Description

Delete a filesystem share. 

Syntaxfs.share.delete share=SHARE
ArgumentsshareName of an existing share
Example
fs.share.delete share=Share01
Deleting share 'Share01' will cause all clients using this share to disconnect.
Are you sure?[y/n]
y
Share "Share01" deleted



fs.share.disable  

ROLE: Admin, Pool Admin

Description

Disable a filesystem share.

Syntaxfs.share.disable share=SHARE
ArgumentsshareName of an existing share 
Example
fs.share.disable share=Share01
Disabling share 'Share01' will cause all clients using this share to disconnect.
Are you sure?[y/n]
y
Share "Share01" disabled



fs.share.enable  

ROLE: Admin, Pool Admin

Description

Enable a filesystem share.

Syntaxfs.share.enable share=SHARE
ArgumentsshareName of an existing share
Example
fs.share.enable share=Share01
Share "Share01" enabled



fs.share.query  

ROLE: All Roles 

DescriptionList the existing filesystem shares.
Syntaxfs.share.query [fs={FS|SNAP},[fs={FS|SNAP},...]] [enabled={YES|NO|Y|N}] [name=SHARE]
ArgumentsfsName of an existing filesystem or snapshot
enabledEither yes or no
nameName of an existing share
Example
fs.share.query

NAME             FILESYSTEM        INTERNAL PATH          ENABLED          OFFLINE CACHING
A-01             fs-xx             /                      yes              MANUAL
Share01          fs-yy             /                      yes              AUTO
Share02          FS1               /                      yes              MANUAL
Share2-ACME      FS1               /                      no               MANUAL

ExampleRun the command for a specific filesystem, and request the detailed results in JSON format.
fs.share.query fs=FS1 --format=json --detailed

{
"command": "fs.share.query fs=FS1 --format=json --detailed",
"result": [
{
"description": "Share-of-this-file",
"enabled": "yes",
"filesystem": "FS1",
"inner_path": "/",
"name": "Share01",
"offline_caching": "AUTO"
},
{
"description": "Share for ACME department",
"enabled": "no",
"filesystem": "FS1",
"inner_path": "/",
"name": "Share2 ACME",
"offline_caching": "MANUAL"
}
],
"number_of_objects": 2



fs.share.set_description

ROLE: Admin, Pool Admin

Description

Modify an SMB share's description.

Syntaxfs.share.set_description share=SHARE description=STR
ArgumentsshareName of an existing share
descriptionAny sequence of characters
Examplefs.share.set_description share=Share01 description="New share"
Share "Share01" Description updated



fs.share.set_offline_caching

ROLE: Admin, Pool Admin

Description

Change an SMB share's offline caching hint to clients.

Syntaxfs.share.set_offline_caching share=SHARE offline_caching={MANUAL|AUTO|VDO|DISABLED}
ArgumentsshareName of an existing share
offline_cachingMANUAL, AUTO, VDO, DISABLED
Examplefs.share.set_description share=Share01 offline_caching=disabled
Was this article helpful?
0 out of 0 found this helpful

0 out of 0 found this helpful

Last edited: 2022-08-06 08:32:09 UTC

Comments