Inheritance diagram for OMV\System\Storage\StorageDeviceLvm:

Public Member Functions
	__construct ($deviceFile)

	refresh ()

	exists ()

	getPreferredDeviceFile ()

	getVGName ()

	getName ()

	getPath ()

	getSize ()

	getUuid ()

	getAttributes ()

	getVGAttributes ()

	IsMediaAvailable ()

	getDescription ()

	create ($name, $size, $vgName)

	createSnapshot ($name, $size)

	remove ()

	rename ($name)

	extend ($size)

	reduce ($size)

Public Member Functions inherited from OMV\System\Storage\StorageDeviceDM
	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
	getDeviceFile ()

	getCanonicalDeviceFile ()

	getDeviceFileById ()

	hasDeviceFileById ()

	getDeviceFileSymlinks ()

	getDeviceName ($canonical=FALSE)

	getBlockSize ()

	getSectorSize ()

	isMediaAvailable ()

Static Public Member Functions
static	enumerate ()

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 Attributes
	$uuid = ""

	$lvAttr = ""

	$vgAttr = ""

	$kernelMajor = ""

	$kernelMinor = ""

	$lvName = ""

	$vgName = ""

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

Additional Inherited Members
Protected Member Functions inherited from OMV\System\BlockDevice
	getUdevData ($force=FALSE)

Detailed Description

This class provides a simple interface to handle a LVM logical volume.

Constructor & Destructor Documentation

◆ __construct()

OMV\System\Storage\StorageDeviceLvm::__construct ( $deviceFile )

Constructor

Parameters

deviceFile Specifies the device file, e.g. /dev/dm-1, /dev/vg0/lv0 or /dev/mapper/vg0-lv0.

Member Function Documentation

◆ create()

OMV\System\Storage\StorageDeviceLvm::create	(	$name,
		$size,
		$vgName
	)

Create the logical volume.

Parameters

name	The name for the new logical volume.
size	The size of bytes to allocate for the new logical volume.
vgName	The name of the volume group where to create the logical volume.

Returns: None.

Exceptions

◆ createSnapshot()

OMV\System\Storage\StorageDeviceLvm::createSnapshot	(	$name,
		$size
	)

Create a snapshot of a logical volume.

Parameters

name	The name for the snapshot.
size	The size of the snapshot in bytes.

Returns: None.

Exceptions

◆ enumerate()

static OMV\System\Storage\StorageDeviceLvm::enumerate ( )

static

Enumerate LVM logical volumes.

Returns: A list of LVM logical volumes, otherwise FALSE. Example: array( 0 => /dev/mapper/vgName-lvName 1 => /dev/mapper/... )

Exceptions

◆ exists()

OMV\System\Storage\StorageDeviceLvm::exists ( )

Checks if the logical volume exists.

Returns: TRUE if the logical volume exists, otherwise FALSE.

Implements OMV\System\Storage\IStorageDevice.

◆ extend()

OMV\System\Storage\StorageDeviceLvm::extend ( $size )

Extend the logical volume.

Parameters

size	Gives the size of bytes to extend the logical volume.

Returns: None.

Exceptions

◆ getAttributes()

OMV\System\Storage\StorageDeviceLvm::getAttributes ( )

Get the logical volume attributes.

See also: http://www.unixarena.com/2013/08/redhat-linux-lvm-volume-attributes.html

Returns: Returns an array with the attribtes.

◆ getDescription()

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

Get the description of the logical volume.

Returns: The logical volume description.

Implements OMV\System\Storage\IStorageDevice.

◆ getName()

OMV\System\Storage\StorageDeviceLvm::getName ( )

Get the name of the logical volume.

Returns: The logical volume name, e.g. lvol0, or FALSE on failure.

◆ getPath()

OMV\System\Storage\StorageDeviceLvm::getPath ( )

Get the path of the logical volume.

Returns: The logical volume path, e.g. /dev/vg0/lvol0.

◆ getPreferredDeviceFile()

OMV\System\Storage\StorageDeviceLvm::getPreferredDeviceFile ( )

Get the device file to present in the UI, e.g.:

/dev/disk/by-id/xxx

/dev/disk/by-path/xxx
/dev/xxx
Returns
Returns a device file.

Implements OMV\System\IBlockDevice.

◆ getSize()

OMV\System\Storage\StorageDeviceLvm::getSize ( )

Get the size of the logical volume in bytes.

Returns: The size of the logical volume in bytes as string.

Implements OMV\System\Storage\IStorageDevice.

◆ getUuid()

OMV\System\Storage\StorageDeviceLvm::getUuid ( )

Get the UUID of the array.

Returns: The UUID of the array.

◆ getVGAttributes()

OMV\System\Storage\StorageDeviceLvm::getVGAttributes ( )

Get the volume group attributes.

See also: http://www.unixarena.com/2013/08/redhat-linux-lvm-volume-attributes.html

Returns: Returns an array with the attribtes.

◆ getVGName()

OMV\System\Storage\StorageDeviceLvm::getVGName ( )

Get the name of the volume group.

Returns: The volume group name, FALSE on failure.

◆ IsMediaAvailable()

OMV\System\Storage\StorageDeviceLvm::IsMediaAvailable ( )

Check if a medium is available.

Returns: Set to FALSE if no medium is available.

◆ reduce()

OMV\System\Storage\StorageDeviceLvm::reduce ( $size )

Reduce the logical volume.

Parameters

size	Gives the size of bytes to extend the logical volume.

Returns: None.

Exceptions

◆ refresh()

OMV\System\Storage\StorageDeviceLvm::refresh ( )

Refresh the cached information.

Returns: None.

◆ remove()

OMV\System\Storage\StorageDeviceLvm::remove ( )

Remove the logical volume.

Returns: None.

Exceptions

◆ rename()

OMV\System\Storage\StorageDeviceLvm::rename ( $name )

Rename the logical volume.

Parameters

name	The new logical volume path/name.

Returns: None.

Exceptions

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

storagedevicelvm.inc

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ create()

◆ createSnapshot()

◆ enumerate()

◆ exists()

◆ extend()

◆ getAttributes()

◆ getDescription()

◆ getName()

◆ getPath()

◆ getPreferredDeviceFile()

◆ getSize()

◆ getUuid()

◆ getVGAttributes()

◆ getVGName()

◆ IsMediaAvailable()

◆ reduce()

◆ refresh()

◆ remove()

◆ rename()