Follow

fs.assign_qos  

ROLE: Admin 

Description

Assign filesystem to policy.

Syntaxfs.assign_qos fs=FS[,FS,...] policy=QOSPOLICY
ArgumentsfsName of an existing filesystem (multiple values separated by commas) 
policyQoS policy
Examplefs.assign_qos fs=fs1 policy=q2
Filesystem 'fs1' was assigned to policy 'q2'



fs.cache  

ROLE: Admin, Pool Admin

Description

Enable or disable SSD cache.

Set the optional parameter Recursive to Yes in order to apply the SSD cache settings to the entire volume tree.

Syntaxfs.cache fs=FS ssd_cache=YES|NO|Y|N [recursive=YES|NO|Y|N]
ArgumentsfsName of an existing filesystem
ssd_cacheEither yes or no 
recursiveEither yes or no 
Examplefs.cache name=fs1 ssd=yes recursive=yes
Filesystem fs1 and all descendants are SSD cache enabled



fs.create  

ROLE: Admin, Pool Admin

Description

Create a new filesystem. 

Syntax

fs.create name=NAME[,NAME,...] size=SIZE [snapshot_directory_name=NAME] [snapshot_directory_accessible={YES|NO|Y|N}] [pool=STANDARDPOOL] [thin={YES|NO|Y|N}] [ssd_cache={YES|NO|Y|N}] [series=SERIES] [compression={YES|NO|Y|N}] [atime_granularity=TIMEDELTA] [security_style={UNIX|WINDOWS}]

ArgumentspoolName of an existing standard pool
snapshot_directory_accessibleEither yes or no
snapshot_directory_nameA maximum of 65 Latin characters, numbers, spaces, and the following symbols: ^&'@()[]$=!-#{}%.+~_
Leading and trailing whitespace characters are stripped.
sizeA positive number (up to 2 digits beyond the decimal point) in bytes unless followed by a different unit; e.g. 1TB, 1000000000000
nameA maximum of 65 Latin characters, numbers, spaces, and the following symbols: ^&'@()[]$=!-#{}%.+~_
Leading and trailing whitespace characters are stripped. (multiple values, separated by commas)
seriesEither a range of numbers, e.g "3-7", or a single number, e.g "5", which is the same as "1-5". Zero-padding the numbers yields a zero-padded sequence. The series may contain at most 100 items, and the index of the last item may not exceed 10000000000
ssd_cacheEither yes or no
thinEither yes or no
compressionEither yes or no
atime_granularityA time delta, e.g: '02:02', '05:11:06' or DISABLED.
security_styleEither UNIX or Windows
ExampleCreating a single filesystem, providing a name and specifying its size and the pool it will created in.
fs.create name=fs1 size=1g pool=pool1
Volume fs1 created
ExampleCreating a series of filesystems specifying their number. The filesystems will be numbered from 1 onward. Note that the name parameter serves as a prefix to the entire series.
fs.create name=fs- size=1g pool=pool1 series=10
Created 10 filessytems: fs-01 through fs-10
ExampleCreating a series of filesystems specifying the first and last ordinal numbers.
fs.create name=fs- size=1g pool=pool1 count=11-20
Created 10 filesystems: fs-11 through fs-20
ExampleCreating a filesystem and making its snapshot directory accessible
fs.create name=fs1 size=1g snapshot_directory_accessible=yes pool=p1
Filesystem "fs1" created



fs.delete  

ROLE: Admin, Pool Admin

Description

Delete filesystem.

This command succeeds only if the filesystem has no active exports. 

Syntaxfs.delete fs=FS[,FS,...]
ArgumentsfsName of an existing filesystem (multiple values, separated by commas)
Example
fs.delete name=fs1
Filesystem fs1 deleted



fs.move  

ROLE: Admin, Pool Admin

Description

Move filesystem to a different pool. 

Syntaxfs.move fs=FS pool=STANDARDPOOL [move_capacity=YES|NO|Y|N]
Argumentsmove_capacityEither yes or no
poolName of an existing standardpool
fsName of an existing filesystem
ExampleMoving a filesystem with its capacity
fs.move name=fs1 pool=pool2 move_capacity=yes
Filesystem fs1 moved to pool pool2 without its capacity
ExampleMoving a filesystem without its capacity
fs.move name=fs1 pool=pool2
Filesystem fs1 moved to pool pool2



fs.query 

ROLE: Admin, Pool Admin

READ ONLY

Description

List existing filesystems.

Syntaxfs.query [fs=FS[,FS,...]] [pool=POOL] [unit=NASCAPACITYUNIT] [has_exports=YES|NO|Y|N] [write_protected=YES|NO|Y|N] [thin=YES|NO|Y|N] [compression_enabled=YES|NO|Y|N] [ssd_enabled=YES|NO|Y|N]
Argumentscompression_enabledEither yes or no
thinEither yes or no
write_protectedEither yes or no
has_exportsEither yes or no
unitB, G (or GB), GiB, T (or TB), TiB
poolName of an existing pool
fsName of an existing filesystem (multiple values, separated by commas)
ssd_enabledEither yes or no
Examplefs.query name=fs1
NAME THIN SIZE     USED      ALLOCATED  COMPRESSION SNAPSHOTS POOL WP EXPORTED COMPRESSION
                                        SAVINGS
fs1  yes  1.00 GB  327.68 KB 327.68 KB  1.00:0      0         p1   no yes      yes
ExampleQuerying for filesystems that are assigned to a QoS policy
fs.query --columns=name,policy
NAME  POLICY
FS1   Q2
ExampleQuerying for the filesystem snapshot directory accessibility
fs.query pool=p1 --columns=name,snapshot_dir_accessible,snapshot_dir_name
NAME  SNAPSHOT DIR ACCESSIBLE  SNAPSHOT DIR NAME
fs1   yes                      .snapshot



fs.reclaimable  

ROLE: Admin, Pool Admin

Description

Estimate reclaimed capacity (deletion simulation).

You may simulate the deletion of the filesystem and its descendants. 

Syntaxfs.reclaimable fs={FS|SNAP}
ArgumentsfsName of an existing filesystem or snapshot
Example
fs.reclaimable name=fs1
Estimated reclaimable space for filesystem fs1 and its tree descendants: 1.00 TB



fs.rename 

ROLE: Admin, Pool Admin

Description

Rename filesystem.

Syntaxfs.rename fs=FS new_name=NAME
Argumentsnew_nameA maximum of 65 Latin characters, numbers, spaces, and the following symbols: ^&'@()[]$=!-#{}%.+~_
Leading and trailing whitespace characters are stripped.
fsName of an existing filesystem 
Examplefs.rename name=fs1 new_name=fs2
Filesystem fs1 renamed to fs2



fs.resize  

ROLE: Admin, Pool Admin

Description

Resize filesystem.

The filesystem can only be resized upwards. Its size cannot be decreased.

Syntaxfs.resize fs=FS size=SIZEPOSITIVEDELTA
ArgumentssizeA number (up to 2 digits beyond the decimal point), optionally followed by a unit; e.g. 1TB, 1000000000000. When preceded by a plus sign, represents a delta; e.g. 3000000m (absolute size), +2000GB (positive delta)
fsName of an existing filesystem 
Examplefs.resize name=fs1 size=1GB
Filesystem fs1 resized



fs.restore 

ROLE: Admin, Pool Admin

Description

This command restores a filesystem from one of its snapshots.

Syntaxfs.restore fs=FS source=SNAP
ArgumentssourceName of an existing filesystem snapshot
fsName of an existing filesystem 
Examplefs.restore name=fs1 snap=fs1s1
Filesystem fs1 restored from snapshot fs1s1



fs.set_atime_granularity 

ROLE: Admin, Pool Admin

Description

Enable and set the automatic atime update granularity, or disable it.

Syntaxfs.set_atime_granularity fs=FS atime_granularity=TIMEDELTA
ArgumentsfsName of an existing filesystem
atime_granularityA time delta, e.g: '02:02', '05:11:06' or DISABLED
ExampleEnable automatic atime updates on a filesystem
fs.set_atime_granularity fs=fs1 atime_granularity=24:00:00
Filesystem updated
ExampleDisable automatic atime updates on a filesystem
fs.set_atime_granularity fs=fs1 atime_granularity=DISABLED
Filesystem updated



fs.set_compression 

ROLE: Admin, Pool Admin

Description

Set the filesystem to use compression.

Syntaxfs.set_compression fs=FS compression=YES|NO|Y|N
ArgumentscompressionEither yes or no
fsName of an existing filesystem
ExampleEnable compression on a filesystem
fs.set_compression name=fs1 enable=yes
Filesystem "fs1" Compression was enabled
ExampleDisable compression on a filesystem
fs.set_compression name=fs1 enable=no
Filesystem "fs1" Compression was disabled



fs.set_snapshot_directory_accessible 

ROLE: Admin, Pool Admin

Description

Determines whether the snapshot directory is accessible.

Syntaxfs.set_snapshot_directory_accessible fs=FS snapshot_directory_accessible=YES|NO|Y|N
Argumentssnapshot_directory_accessibleEither yes or no
fsName of an existing filesystem 
Examplefs.set_snapshot_directory_accessible fs=fs-1 snapshot_directory_accessible=yes
Filesystem "fs-1" set to allow access to snapshot directory



fs.set_thin  

ROLE: Admin, Pool Admin

Description

Set filesystem provisioning type.

Syntaxfs.set_thin fs=FS thin=YES|NO|Y|N
ArgumentsthinEither yes or no
fsName of an existing filesystem 
Examplefs.set_thin name=fs1 thin=yes
Filesystem fs1 set to thin provisioning



fs.tree  

ROLE: Admin, Pool Admin
READ ONLY

Description

Display hierarchy of filesystems along with their snapshots. 

Syntaxfs.tree [fs=FS] [pool=STANDARDPOOL] [unit=NASCAPACITYUNIT]
ArgumentsunitB, G (or GB), GiB, T (or TB), TiB
poolName of an existing standard pool
fsName of an existing filesystem
Examplefs.tree name=fs1

NAME     TYPE       SIZE    USED    ALLOCATED POOL  WP  CREATED AT
FS1      FILESYSTEM 1.00 TB 100 GB  1.00 TB   p1    no  2015-12-01 10:00:00
|-----s1 SNAP       0       0       0         p1    no  2015-12-02 10:00:00 



fs.unassign_qos 

ROLE: Admin 

Description

Unassign fs from policy.

  • Unassigning the filesystem does not unassign its snapshots, even if both filesystem and snapshot are assigned to the same policy.
  • This command allows for a multiple-entity selection.
Syntaxfs.unassign_qos fs=FS[,FS,...]
ArgumentsfsName of an existing filesystem (multiple values, separated by commas)
ExampleUnassigning a single filesystem
fs.unassign_qos fs=fs1
Filesystem 'fs1' was unassigned from policy 'q2'
ExampleUnassigning multiple filesystems
fs.unassign_qos fs=fs1,fs2
2 filesystems were unassigned from their policies



fs.write_enable  

ROLE: Admin, Pool Admin

Description

Enable write access on filesystem.

Syntaxfs.write_enable fs=FS [recursive=YES|NO|Y|N]
ArgumentsrecursiveEither yes or no
fsName of an existing filesystem 
Examplefs.write_enable name=fs1 recursive=yes
Filesystem fs1 and all descendants write access enabled



fs.write_protect  

ROLE: Admin, Pool Admin

Description

Disable write access on filesystem.

Syntaxfs.write_protect fs=FS [recursive=YES|NO|Y|N]
ArgumentsrecursiveEither yes or no
fsName of an existing filesystem 
Examplefs.write_protect name=fs1 recursive=yes
Filesystem fs1 and all descendants write access 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:31:49 UTC

Comments