Filesystem Snapshot commands – INFINIDAT Support

fs.snap.assign_qos

ROLE: Admin

Description	Assign filesystem to policy.
Syntax	`fs.snap.assign_qos SNAP=SNAP[,SNAP,...] policy=QOSPOLICY`
Arguments	`fs`	Name of an existing filesystem snapshot (multiple values separated by commas)
	`policy`	QoS policy
Example	`fs.snap.assign_qos snap=fs1-s1 policy=q2`
	`Filesystem 'fs1-s1' was assigned to policy 'q2'`

fs.snap.cache

ROLE: Admin, Pool Admin

Description	Enable or disable SSD cache. Use the recursive argument in order to enable SSD for the snapshot and its descendants.
Syntax	`fs.snap.cache snap=SNAP ssd_cache=YESNO [recursive=YESNO]`
Arguments	`recursive`	Either yes or no
	ssd_cache	Either yes or no
	`snap`	Name of an existing filesystem snapshot
Example	`fs.snap.cache name=fs1s1 ssd=yes`
	`Filesystem fs1s1 SSD cache enabled`

fs.snap.create

ROLE: Admin, Pool Admin

Description	Create a new filesystem snapshot. Create a snapshot from a filesystem.
Syntax	`fs.snap.create fs={FS\|SNAP} name=NAME [ssd_cache=YESNO] [lock_duration=DATEDURATION] [snapshot_directory_accessible=YESNO]`
Arguments	`snapshot_directory_accessible`	Either yes or no
	`lock_duration`	Name of an existing pool
	`sad_cache`	A positive number, followed by a unit; e.g. 1M, 10DAYS
	`name`	Either yes or no
	`fs`	Name of an existing filesystem or snapshot
Example	`fs.snap.create source=fs1 name=fs1s1`
	`Filesystem snapshot fs1s1 created`
Example	Creating a filesystem snapshot and making the snapshot directory accessible
	`fs.snap.create fs=fs-1 name=fs-1-s-1 snapshot_directory_accessible=yes`
	`Filesystem snapshot "fs-1-s-1" created`

fs.snap.delete

ROLE: Admin, Pool Admin

Example
Description	Delete filesystem snapshot.
Syntax	`fs.snap.delete snap=SNAP[,SNAP,...]`
Arguments	`snap`	Name of an existing filesystem snapshot (multiple values, separated by commas)
	`fs.snap.delete name=fs1s1`
	`Filesystem snapshot fs1s1 deleted`

fs.snap.query

ROLE: Admin, Pool Admin

READ ONLY

Description	List existing snapshots This command lists either all filsystem snashots, or snapshots per specific filesystem. The source parameter of this command is the filesystem whose snapshots are queried.
Syntax	`fs.snap.query [snap=SNAP[,SNAP,...]] [source={FS\|SNAP}] [expiry_date_from=TIMESTAMP] [expiry_date_to=TIMESTAMP] [pool=STANDARDPOOL] [unit=NASCAPACITYUNIT] [has_exports=YESNO] [write_protected=YESNO] [lock=Lock type]`
Arguments	`lock`	EXPIRED, LOCKED or UNLOCKED
	`write_protected`	Either yes or no
	`has_exports`	Either yes or no
	`unit`	B, G (or GB), GiB, T (or TB), TiB
	`pool`	Name of an existing standardpool
	`expiry_date_to`	EXPIRED, LOCKED or UNLOCKED
	`expiry_date_from`	EXPIRED, LOCKED or UNLOCKED
	`source`	Name of an existing filesystem or snapshot
	`snap`	Name of an existing filesystem snapshot (multiple values, separated by commas)
Example	`fs.snap.query source=fs1`
	`NAME THIN SIZE USED ALLOCATED POOL LOCKED STATE CREATED AT``fs1S1 yes 1.00 GB 327.68 KB 65.53 KB pool1 LOCKED 2015-06-01 10:00:00 fs1S2 yes 1.00 GB 327.68 KB 65.53 KB pool1 UNLOCKED 2015-06-01 10:00:00`
Example	Querying for filesystem snapshots that are assigned to a QoS policy
	`fs.snap.query --columns=name,policy`
	`NAME POLICY` fs1 q1
Example	Querying for filesystem snapshot accessibility
	`fs.snap.query --columns=name,snapshot_dir_accessible,snapshot_dir_name`
	`NAME SNAPSHOT DIR ACCESSIBLE SNAPSHOT DIR NAME` fs1 yes .snapshot
Example	Querying for the lock status of the snapshots
	`fs.snap.query --columns=name,lock_state,expiry_date`
	`NAME LOCK STATE EXPIRY DATE` `snap1 LOCKED 2018-11-01 10:00:00` `snap2 EXPIRED 2018-11-01 10:00:00`

fs.snap.refresh

ROLE: Admin, Pool Admin

Example
Description	Refresh a snapshot. This operation refreshes the snapshot with the filesystem's data, keeping the snapshot metadata as is This operation is a dangerous operation
Syntax	`fs.snap.refresh snap=SNAP`
Arguments	`snap`	Name of an existing filesystem snapshot
	`fs.snap.refresh snap=fs1-s1`
	`Filesystem snapshot "fs1-s1" refreshed`

fs.snap.rename

ROLE: Admin, Pool Admin

Description	Rename filesystem snapshot.
Syntax	`fs.snap.rename snap=SNAP new_name=NAME`
Arguments	`new_name`	A maximum of 65 Latin characters, numbers, spaces, and the following symbols: "^&'@()[]$=!-#{}%.+~_" (excluding quotation marks). Leading and trailing whitespace characters are stripped.
	`snap`	Name of an existing filesystem snapshot
Example	`fs.snap.rename name=fs1s1 new_name=fs1s2`
	`Filesystem snapshot fs1s1 renamed to fs1s2`

fs.snap.resize

ROLE: Admin, Pool Admin

Description	Resize filesystem snapshot. The snapshot size can only be increased The snapshot has to be write-enabled
Syntax	`fs.snap.resize snap=SNAP size=SIZEPOSITIVEDELTA`
Arguments	`size`	A 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)
	`snap`	Name of an existing filesystem snapshot
Example	Resizing the snapshot
	`fs.snap.resize snap=s1 size=100g`
	`Filesystem snapshot "s1" resized`
Example	Running the command with an input that is identical to the snapshot current size does not fail the command
	`fs.snap.resize snap=s1 size=100g`
	`Filesystem snapshot "s1" size is already 100.00 GB`

fs.snap.restore

ROLE: Admin, Pool Admin

Description	Restore a filesystem snapshot from one of its snapshots. The restored snapshot has to be in a write_enabled state This is a dangerous operation
Syntax	`fs.snap.restore snap=SNAP source=SNAP`
Arguments	`snap`	Name of an existing filesystem snapshot
	`source`	Name of an existing filesystem snapshot
Example	`fs.snap.restore target=fs1-s1 source=fs1-s1-s1`
	`Filesystem snapshot "fs1-s1" restored from snapshot "fs1-s1-s1"`

fs.snap.secure_lock

ROLE: Admin, Pool Admin

Description	Locks a snapshot, temporarily preventing its deletion until the provided time, or extends an existing snapshot lock.
Syntax	`fs.snap.secure_lock snap=SNAP lock_duration=DATEDURATION`
Arguments	`lock_duration`	A positive number, followed by a unit; e.g. 1M, 10DAYS
	`snap`	Name of an existing filesystem snapshot

fs.snap.set_atime_granularity

ROLE: Admin, Pool Admin

Description	Enable and set the automatic atime update granularity, or disable it.
Syntax	`fs.snap.set_atime_granularity fs=FS atime_granularity=TIMEDELTA`
Arguments	`fs`	Name of an existing filesystem snapshot
	`atime_granularity`	A time delta, e.g: '02:02', '05:11:06' or DISABLED
Example	Enable automatic atime updates on a filesystem
	`fs.snap.set_atime_granularity fs=fs1 atime_granularity=24:00:00`
	`Filesystem updated`
Example	Disable automatic atime updates on a filesystem
	`fs.snap.set_atime_granularity fs=fs1 atime_granularity=DISABLED`
	`Filesystem updated`

fs.snap.set_snapshot_directory_accessible

ROLE: Admin, Pool Admin

Description	Determines whether the snapshot directory is accessible.
Syntax	`fs.snap.set_snapshot_directory_accessible snap=SNAP snapshot_directory_accessible=YESNO`
Arguments	`snapshot_directory_accessible`	Either yes or no
	`snap`	Name of an existing filesystem snapshot
Example	`fs.snap.set_snapshot_directory_accessible snap=fs-1-s-1 snapshot_directory_accessible=yes`
	`Filesystem snapshot "fs-1-s-1" set to allow access to snapshot directory`

fs.snap.tree

ROLE: Admin, Pool Admin
READ ONLY

Description	Display hierarchy of snapshots and their snapshots.
Syntax	`fs.snap.tree snap=SNAP [unit=NASCAPACITYUNIT]`
Arguments	`unit`	B, G (or GB), GiB, T (or TB), TiB
	`snap`	Name of an existing filesystem snapshot
Example	fs.snap.tree name=fs1s1
	`NAME TYPE SIZE` `fs1s1 SNAPSHOT 0.002 TB \|----fs1s1s1 SNAPSHOT 0.002 TB`

fs.snap.unassign_qos

ROLE: Admin

Example
Description	Unassign fs from policy.
Syntax	`fs.snap.unassign_qos snap=SNAP[,SNAP,...]`
Arguments	`snap`	Name of an existing filesystem snapshot (multiple values, separated by commas)
	`fs.snap.unassign_qos snap=fs1-s1`
	`Filesystem 'fs1-s1' was unassigned from policy 'q2'`

fs.snap.write_enable

ROLE: Admin, Pool Admin

Description	Enable write access on filesystem snapshot.
Syntax	`fs.snap.write_enable SNAP=SNAP [recursive=YESNO]`
Arguments	`recursive`	Either yes or no
	`snap`	Name of an existing filesystem snapshot
Example	`fs.snap.write_enable fs=fs1-s1`
	`Filesystem snapshot "fs1-s1" is now write-enabled`

fs.snap.write_protect

ROLE: Admin, Pool Admin

Description	Disable write access on filesystem snapshot.
Syntax	`fs.snap.write_protect snap=SNAP [recursive=YESNO]`
Arguments	`recursive`	Either yes or no
	`snap`	Name of an existing filesystem snapshot
Example	`fs.snap.write_protect fs=fs1-s1`
	`Filesystem snapshot "fs1-s1" is already write-protected`

fs.snap.assign_qos

fs.snap.cache

fs.snap.create

fs.snap.delete

fs.snap.query

fs.snap.refresh

fs.snap.rename

fs.snap.resize

fs.snap.restore

fs.snap.secure_lock

fs.snap.set_atime_granularity

fs.snap.set_snapshot_directory_accessible

fs.snap.tree

fs.snap.unassign_qos

fs.snap.write_enable

fs.snap.write_protect

Last edited: 2022-08-06 08:31:55 UTC

Comments

INFINIDAT Support InfiniShell InfiniBox Commands Filesystem Snapshot commands

fs.snap.assign_qos

fs.snap.cache

fs.snap.create

fs.snap.delete

fs.snap.query

fs.snap.refresh

fs.snap.rename

fs.snap.resize

fs.snap.restore

fs.snap.secure_lock

fs.snap.set_atime_granularity

fs.snap.set_snapshot_directory_accessible

fs.snap.tree

fs.snap.unassign_qos

fs.snap.write_enable

fs.snap.write_protect

Last edited: 2022-08-06 08:31:55 UTC

Comments

INFINIDAT Support

InfiniShell

InfiniBox Commands

Filesystem Snapshot commands