Inheritance diagram for OMV\System\Filesystem\IFilesystem:

Public Member Functions
	exists ()

	getDeviceFile ()

	getCanonicalDeviceFile ()

	getDeviceFileById ()

	getDeviceFileByUuid ()

	getDeviceFileByLabel ()

	getPreferredDeviceFile ()

	getDeviceFileSymlinks ()

	getDeviceFiles ()

	getParentDeviceFile ()

	hasUuid ()

	getUuid ()

	hasLabel ()

	getLabel ()

	getType ()

	getSize ()

	getDescription ()

	isMounted ()

	mount ($options)

	umount ($force, $lazy)

	grow ()

	shrink ()

	remove ()

Detailed Description

Interface for filesystems.

Member Function Documentation

OMV\System\Filesystem\IFilesystem::exists ( )

Checks if the device exists.

Returns: TRUE if the device exists, otherwise FALSE.

Implemented in OMV\System\Filesystem\Filesystem.

OMV\System\Filesystem\IFilesystem::getCanonicalDeviceFile ( )

Get the canonical device file, e.g.

/dev/root -> /dev/sde1

/dev/disk/by-uuid/4B04EA317E4AA567 -> /dev/sdd1
/dev/mapper/vg0-lv0 -> /dev/dm-0
Returns
Returns the canonical device file.

OMV\System\Filesystem\IFilesystem::getDescription ( )

Get the description (e.g. incl. additional information like used and available disk space usage) of the file system.

Returns: The file system description.

Implemented in OMV\System\Filesystem\Filesystem.

OMV\System\Filesystem\IFilesystem::getDeviceFile ( )

Get the device file, e.g.

/dev/sda1

/dev/mapper/vg0-lv0
/dev/disk/by-uuid/fc3e1da5-fd8d-4fda-341e-d0135efa7a7c
/dev/disk/by-id/scsi-SATA_ST3200XXXX2AS_5XWXXXR6-part1
/dev/disk/by-path/pci-0000:00:10.0-scsi-0:0:0:0-part2
Returns
Returns the device file.

Implemented in OMV\System\Filesystem\Filesystem.

OMV\System\Filesystem\IFilesystem::getDeviceFileById ( )

Get the device file by ID, e.g.

/dev/disk/by-id/wwn-0x5000cca211cc703c

/dev/disk/by-id/scsi-SATA_IBM-DHEA-36481_SG0SGF08038
/dev/disk/by-id/ata-Hitachi_HDT725032VLA360_VFD200R2CWB7ML-part2 The following order of paths will be retured if available:
ata-xxx
wwn-xxx
scsi-xxx
...
Returns
The device file (/dev/disk/by-id/xxx) if available, otherwise NULL will be returned.

Implemented in OMV\System\Filesystem\Filesystem.

OMV\System\Filesystem\IFilesystem::getDeviceFileByLabel ( )

Get the device path by label, e.g.

/dev/disk/by-label/data

Returns: The device path (/dev/disk/by-label/xxx).

Implemented in OMV\System\Filesystem\Filesystem.

OMV\System\Filesystem\IFilesystem::getDeviceFileByUuid ( )

Get the device path by UUID, e.g.

/dev/disk/by-uuid/ad3ee177-777c-4ad3-8353-9562f85c0895

/dev/disk/by-uuid/2ED43920D438EC29 (NTFS)
Returns
The device path (/dev/disk/by-uuid/xxx).

Implemented in OMV\System\Filesystem\Filesystem.

OMV\System\Filesystem\IFilesystem::getDeviceFiles ( )

Get all devices that make up the filesystem.

Returns: An array that contains the component devices of the filesystem.

Implemented in OMV\System\Filesystem\Filesystem, and OMV\System\Filesystem\Btrfs.

OMV\System\Filesystem\IFilesystem::getDeviceFileSymlinks ( )

Get all device file symlinks via udev, e.g.

/dev/disk/by-id/wwn-0x5000cca211cc703c

/dev/disk/by-id/scsi-SATA_IBM-DHEA-36481_SG0SGF08038
/dev/disk/by-id/ata-Hitachi_HDT725032VLA360_VFD200R2CWB7ML
/dev/disk/by-path/pci-0000:00:02.5-scsi-0:0:0:0
/dev/disk/by-id/ata-WDC_WD15EARS-00MVWB0_WD-WMAZB2574325-part1
/dev/disk/by-uuid/fc3e1da5-fd8d-4fda-341e-d0135efa7a7c
Returns
Returns an string array of device files.

OMV\System\Filesystem\IFilesystem::getLabel ( )

Get the filesystem label.

Returns: Returns the label of the filesystem, otherwise an empty string.

Implemented in OMV\System\Filesystem\Filesystem.

OMV\System\Filesystem\IFilesystem::getParentDeviceFile ( )

Get the device file of the storage device which contains this file system. Example:

/dev/sdb1 => /dev/sdb

/dev/cciss/c0d0p2 => /dev/cciss/c0d0
Returns
The device file of the underlying storage device.

Implemented in OMV\System\Filesystem\Filesystem.

OMV\System\Filesystem\IFilesystem::getPreferredDeviceFile ( )

Get the special device file to present in the UI instead of the value of the getDeviceFile method. Get the special device file in the following preferred order:

/dev/disk/by-label/xxx