OMVIBlockDevice Interface Reference

Inheritance diagram for OMVIBlockDevice:

Public Member Functions
	exists ()
	getDeviceFile ()
	getDeviceName ($canonical=FALSE)
	getDeviceNumber ()
	getMajor ()
	getMinor ()
	getSize ()
	getBlockSize ()
	getSectorSize ()
	getDescription ()

Detailed Description

Class implementing generic block devices.

Member Function Documentation

OMVIBlockDevice::exists

(

)

Checks if the device exists.

Returns

TRUE if the device exists, otherwise FALSE.

Implemented in OMVLvmLogicalVolume, OMVStorageDeviceMdadm, OMVStorageDeviceAbstract, and OMVBlockDeviceAbstract.

OMVIBlockDevice::getBlockSize

(

)

Get the blocksize of the device in bytes.

Returns

The blocksize of the device in bytes, otherwise FALSE.

Implemented in OMVStorageDeviceAbstract, and OMVBlockDeviceAbstract.

OMVIBlockDevice::getDescription

(

)

Get the description of the device.

Returns

The device description.

Implemented in OMVLvmLogicalVolume, OMVStorageDeviceBcache, OMVStorageDeviceLoop, OMVStorageDeviceDM, OMVStorageDeviceMdadm, OMVStorageDeviceAbstract, and OMVBlockDevice.

OMVIBlockDevice::getDeviceFile

(

)

Get the device path, e.g. /dev/sda.

Returns

The device path.

Implemented in OMVStorageDeviceAbstract, and OMVBlockDeviceAbstract.

OMVIBlockDevice::getDeviceName

(

$canonical = FALSE

)

Get the device name, e.g. sda or hdb.

Parameters

canonical

If set to TRUE the canonical device file will be used. Defaults to FALSE.

Returns

The device name.

Implemented in OMVStorageDeviceCCISS, and OMVBlockDeviceAbstract.

OMVIBlockDevice::getDeviceNumber

(

)

Get the device number, e.g. 8:17. https://www.kernel.org/doc/Documentation/devices.txt for more information.

Returns

The device number as string or FALSE on failure.

Implemented in OMVBlockDeviceAbstract.

OMVIBlockDevice::getMajor

(

)

Get the major device number. https://www.kernel.org/doc/Documentation/devices.txt for more information.

Returns

The major device number or FALSE on failure.

Implemented in OMVBlockDeviceAbstract.

OMVIBlockDevice::getMinor

(

)

Get the minor device number. https://www.kernel.org/doc/Documentation/devices.txt for more information.

Returns

The minor device number or FALSE on failure.

Implemented in OMVBlockDeviceAbstract.

OMVIBlockDevice::getSectorSize

(

)

Get the sectorsize of the device in bytes.

Returns

The sectorsize of the device in bytes, otherwise FALSE.

Implemented in OMVStorageDeviceAbstract, and OMVBlockDeviceAbstract.

OMVIBlockDevice::getSize

(

)

Get the size of the device in bytes.

Returns

The size of the device in bytes, otherwise FALSE.

Implemented in OMVLvmLogicalVolume, OMVStorageDeviceAbstract, and OMVBlockDeviceAbstract.

---

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

• system.inc