openmediavault  4.0 (Arrakis)
The open network attached storage solution
Public Member Functions | List of all members
OMV\System\Storage\StorageDeviceDM Class Reference
Inheritance diagram for OMV\System\Storage\StorageDeviceDM:
OMV\System\Storage\StorageDevice OMV\System\BlockDevice OMV\System\Storage\IStorageDevice OMV\System\IBlockDevice OMV\System\Storage\StorageDeviceLvm OMV\System\Storage\Lvm\LogicalVolume

Public Member Functions

 getDeviceMapperName ()
 
 getDeviceMapperUuid ()
 
 getSlaves ()
 
 getDescription ()
 
- Public Member Functions inherited from OMV\System\Storage\StorageDevice
 getModel ()
 
 getVendor ()
 
 getSerialNumber ()
 
 getDescription ()
 
 isRotational ()
 
 isRemovable ()
 
 isRaid ()
 
 isUsb ()
 
 isAta ()
 
 isReadOnly ()
 
 IsMediaAvailable ()
 
 hasSmartSupport ()
 
 assertHasSmartSupport ()
 
 wipe ()
 
- Public Member Functions inherited from OMV\System\BlockDevice
 __construct ($deviceFile)
 
 exists ()
 
 assertExists ()
 
 getDeviceFile ()
 
 getCanonicalDeviceFile ()
 
 getDeviceFileById ()
 
 hasDeviceFileById ()
 
 getDeviceFileByPath ()
 
 hasDeviceFileByPath ()
 
 getPredictableDeviceFile ()
 
 getPreferredDeviceFile ()
 
 getDeviceFileSymlinks ()
 
 getDeviceName ($canonical=FALSE)
 
 getSize ()
 
 getBlockSize ()
 
 getSectorSize ()
 
 getDeviceNumber ()
 
 getMajor ()
 
 getMinor ()
 
 getDescription ()
 
 hasUdevProperty ($id)
 
 assertUdevProperty ($id)
 
 getUdevProperty ($id)
 
 waitForDevice ($timeout)
 
- Public Member Functions inherited from OMV\System\Storage\IStorageDevice
 exists ()
 
 getDeviceFile ()
 
 getCanonicalDeviceFile ()
 
 getDeviceFileById ()
 
 hasDeviceFileById ()
 
 getDeviceFileSymlinks ()
 
 getDeviceName ($canonical=FALSE)
 
 getSize ()
 
 getBlockSize ()
 
 getSectorSize ()
 
 isMediaAvailable ()
 

Additional Inherited Members

- Static Public Member Functions inherited from OMV\System\Storage\StorageDevice
static enumerate ($type=OMV_STORAGE_DEVICE_TYPE_ALL)
 
static enumerateUnused ($type=OMV_STORAGE_DEVICE_TYPE_ALL)
 
static enumerateUsed ($type=OMV_STORAGE_DEVICE_TYPE_ALL)
 
static isUsed ($deviceFile, $type=OMV_STORAGE_DEVICE_TYPE_ALL)
 
static getStorageDevice ($deviceFile)
 
static assertStorageDeviceExists ($deviceFile)
 
- Protected Member Functions inherited from OMV\System\BlockDevice
 getUdevData ($force=FALSE)
 
- Protected Attributes inherited from OMV\System\Storage\StorageDevice
 $model = NULL
 
 $vendor = NULL
 
- Protected Attributes inherited from OMV\System\BlockDevice
 $deviceFile = NULL
 
 $deviceFileById = NULL
 
 $size = FALSE
 
 $blockSize = FALSE
 
 $sectorSize = FALSE
 
 $udevData = NULL
 

Detailed Description

This class provides a simple interface to handle device-mapper devices. See http://en.wikipedia.org/wiki/Device_mapper for more details.

Member Function Documentation

◆ getDescription()

OMV\System\Storage\StorageDeviceDM::getDescription ( )

Get the description of the device mapper device.

Returns
The logical volume description, FALSE on failure.

Implements OMV\System\Storage\IStorageDevice.

◆ getDeviceMapperName()

OMV\System\Storage\StorageDeviceDM::getDeviceMapperName ( )

Get the name of the device mapper device.

Returns
The name of the device mapper device, otherwise NULL.

◆ getDeviceMapperUuid()

OMV\System\Storage\StorageDeviceDM::getDeviceMapperUuid ( )

Get the UUID of the device mapper device.

Returns
The UUID of the device mapper device, otherwise NULL.

◆ getSlaves()

OMV\System\Storage\StorageDeviceDM::getSlaves ( )

Get the slave devices of the device mapper device.

Returns
An array of device files, otherwise FALSE.

The documentation for this class was generated from the following file: