libstorage
|
Abstract class defining the interface for libstorage. More...
#include <StorageInterface.h>
Public Member Functions | |
virtual void | getContainers (deque< ContainerInfo > &infos)=0 |
virtual int | getDiskInfo (const string &disk, DiskInfo &info)=0 |
virtual int | getContDiskInfo (const string &disk, ContainerInfo &cinfo, DiskInfo &info)=0 |
virtual int | getLvmVgInfo (const string &name, LvmVgInfo &info)=0 |
virtual int | getContLvmVgInfo (const string &name, ContainerInfo &cinfo, LvmVgInfo &info)=0 |
virtual int | getDmraidCoInfo (const string &name, DmraidCoInfo &info)=0 |
virtual int | getContDmraidCoInfo (const string &name, ContainerInfo &cinfo, DmraidCoInfo &info)=0 |
virtual int | getDmmultipathCoInfo (const string &name, DmmultipathCoInfo &info)=0 |
virtual int | getContDmmultipathCoInfo (const string &name, ContainerInfo &cinfo, DmmultipathCoInfo &info)=0 |
virtual int | getMdPartCoInfo (const string &name, MdPartCoInfo &info)=0 |
virtual int | getContMdPartCoInfo (const string &name, ContainerInfo &cinfo, MdPartCoInfo &info)=0 |
virtual void | setMultipathAutostart (MultipathAutostart multipath_autostart)=0 |
virtual MultipathAutostart | getMultipathAutostart () const =0 |
virtual void | getVolumes (deque< VolumeInfo > &infos)=0 |
virtual int | getVolume (const string &device, VolumeInfo &info)=0 |
virtual int | getPartitionInfo (const string &disk, deque< PartitionInfo > &plist)=0 |
virtual int | getLvmLvInfo (const string &name, deque< LvmLvInfo > &plist)=0 |
virtual int | getMdInfo (deque< MdInfo > &plist)=0 |
virtual int | getMdPartInfo (const string &device, deque< MdPartInfo > &plist)=0 |
virtual int | getNfsInfo (deque< NfsInfo > &plist)=0 |
virtual int | getLoopInfo (deque< LoopInfo > &plist)=0 |
virtual int | getDmInfo (deque< DmInfo > &plist)=0 |
virtual int | getBtrfsInfo (deque< BtrfsInfo > &plist)=0 |
virtual int | getTmpfsInfo (deque< TmpfsInfo > &plist)=0 |
virtual int | getDmraidInfo (const string &name, deque< DmraidInfo > &plist)=0 |
virtual int | getDmmultipathInfo (const string &name, deque< DmmultipathInfo > &plist)=0 |
virtual bool | getFsCapabilities (FsType fstype, FsCapabilities &fscapabilities) const =0 |
virtual bool | getDlabelCapabilities (const string &dlabel, DlabelCapabilities &dlabelcapabilities) const =0 |
virtual list< string > | getAllUsedFs () const =0 |
virtual int | createPartition (const string &disk, PartitionType type, const RegionInfo &cylRegion, string &SWIG_OUTPUT(device))=0 |
virtual int | resizePartition (const string &device, unsigned long sizeCyl)=0 |
virtual int | resizePartitionNoFs (const string &device, unsigned long sizeCyl)=0 |
virtual int | updatePartitionArea (const string &device, const RegionInfo &cylRegion)=0 |
virtual int | freeCylindersAroundPartition (const string &device, unsigned long &SWIG_OUTPUT(freeCylsBefore), unsigned long &SWIG_OUTPUT(freeCylsAfter))=0 |
virtual int | nextFreePartition (const string &disk, PartitionType type, unsigned &SWIG_OUTPUT(nr), string &SWIG_OUTPUT(device))=0 |
virtual int | createPartitionKb (const string &disk, PartitionType type, const RegionInfo &kRegion, string &SWIG_OUTPUT(device))=0 |
virtual int | createPartitionAny (const string &disk, unsigned long long sizeK, string &SWIG_OUTPUT(device))=0 |
virtual int | createPartitionMax (const string &disk, PartitionType type, string &SWIG_OUTPUT(device))=0 |
virtual unsigned long long | cylinderToKb (const string &disk, unsigned long sizeCyl)=0 |
virtual unsigned long | kbToCylinder (const string &disk, unsigned long long sizeK)=0 |
virtual int | removePartition (const string &partition)=0 |
virtual int | changePartitionId (const string &partition, unsigned id)=0 |
virtual int | forgetChangePartitionId (const string &partition)=0 |
virtual string | getPartitionPrefix (const string &disk)=0 |
virtual string | getPartitionName (const string &disk, int partition_no)=0 |
virtual int | getUnusedPartitionSlots (const string &disk, list< PartitionSlotInfo > &slots)=0 |
virtual int | destroyPartitionTable (const string &disk, const string &label)=0 |
virtual int | initializeDisk (const string &disk, bool value)=0 |
virtual string | defaultDiskLabel (const string &device)=0 |
virtual int | changeFormatVolume (const string &device, bool format, FsType fs)=0 |
virtual int | changeLabelVolume (const string &device, const string &label)=0 |
virtual int | changeMkfsOptVolume (const string &device, const string &opts)=0 |
virtual int | changeTunefsOptVolume (const string &device, const string &opts)=0 |
virtual int | changeMountPoint (const string &device, const string &mount)=0 |
virtual int | getMountPoint (const string &device, string &SWIG_OUTPUT(mount))=0 |
virtual int | changeMountBy (const string &device, MountByType mby)=0 |
virtual int | getMountBy (const string &device, MountByType &SWIG_OUTPUT(mby))=0 |
virtual int | changeFstabOptions (const string &device, const string &options)=0 |
virtual int | getFstabOptions (const string &device, string &SWIG_OUTPUT(options))=0 |
virtual int | addFstabOptions (const string &device, const string &options)=0 |
virtual int | removeFstabOptions (const string &device, const string &options)=0 |
virtual int | setCryptPassword (const string &device, const string &pwd)=0 |
virtual int | forgetCryptPassword (const string &device)=0 |
virtual int | getCryptPassword (const string &device, string &SWIG_OUTPUT(pwd))=0 |
virtual int | verifyCryptPassword (const string &device, const string &pwd, bool erase)=0 |
virtual bool | needCryptPassword (const string &device)=0 |
virtual int | setCrypt (const string &device, bool val)=0 |
virtual int | setCryptType (const string &device, bool val, EncryptType typ)=0 |
virtual int | getCrypt (const string &device, bool &SWIG_OUTPUT(val))=0 |
virtual int | setIgnoreFstab (const string &device, bool val)=0 |
virtual int | getIgnoreFstab (const string &device, bool &SWIG_OUTPUT(val))=0 |
virtual int | changeDescText (const string &device, const string &txt)=0 |
virtual int | addFstabEntry (const string &device, const string &mount, const string &vfs, const string &options, unsigned freq, unsigned passno)=0 |
virtual int | resizeVolume (const string &device, unsigned long long newSizeK)=0 |
virtual int | resizeVolumeNoFs (const string &device, unsigned long long newSizeK)=0 |
virtual int | forgetResizeVolume (const string &device)=0 |
virtual void | setRecursiveRemoval (bool val)=0 |
virtual bool | getRecursiveRemoval () const =0 |
virtual int | getRecursiveUsing (const list< string > &devices, bool itself, list< string > &using_devices)=0 |
virtual int | getRecursiveUsedBy (const list< string > &devices, bool itself, list< string > &usedby_devices)=0 |
virtual void | setZeroNewPartitions (bool val)=0 |
virtual bool | getZeroNewPartitions () const =0 |
virtual void | setPartitionAlignment (PartAlign val)=0 |
virtual PartAlign | getPartitionAlignment () const =0 |
virtual void | setDefaultMountBy (MountByType val)=0 |
virtual MountByType | getDefaultMountBy () const =0 |
virtual void | setDefaultFs (FsType val)=0 |
virtual FsType | getDefaultFs () const =0 |
virtual void | setDefaultSubvolName (const string &val)=0 |
virtual string | getDefaultSubvolName () const =0 |
virtual bool | getEfiBoot ()=0 |
virtual void | setRootPrefix (const string &root)=0 |
virtual string | getRootPrefix () const =0 |
virtual void | setDetectMountedVolumes (bool val)=0 |
virtual bool | getDetectMountedVolumes () const =0 |
virtual int | removeVolume (const string &device)=0 |
virtual int | createLvmVg (const string &name, unsigned long long peSizeK, bool lvm1, const deque< string > &devs)=0 |
virtual int | removeLvmVg (const string &name)=0 |
virtual int | extendLvmVg (const string &name, const deque< string > &devs)=0 |
virtual int | shrinkLvmVg (const string &name, const deque< string > &devs)=0 |
virtual int | createLvmLv (const string &vg, const string &name, unsigned long long sizeK, unsigned stripes, string &SWIG_OUTPUT(device))=0 |
virtual int | removeLvmLvByDevice (const string &device)=0 |
virtual int | removeLvmLv (const string &vg, const string &name)=0 |
virtual int | changeLvStripeCount (const string &vg, const string &name, unsigned long stripes)=0 |
virtual int | changeLvStripeSize (const string &vg, const string &name, unsigned long long stripeSizeK)=0 |
virtual int | createLvmLvSnapshot (const string &vg, const string &origin, const string &name, unsigned long long cowSizeK, string &SWIG_OUTPUT(device))=0 |
virtual int | removeLvmLvSnapshot (const string &vg, const string &name)=0 |
virtual int | getLvmLvSnapshotStateInfo (const string &vg, const string &name, LvmLvSnapshotStateInfo &info)=0 |
virtual int | createLvmLvPool (const string &vg, const string &name, unsigned long long sizeK, string &SWIG_OUTPUT(device))=0 |
virtual int | createLvmLvThin (const string &vg, const string &name, const string &pool, unsigned long long sizeK, string &SWIG_OUTPUT(device))=0 |
virtual int | changeLvChunkSize (const string &vg, const string &name, unsigned long long chunkSizeK)=0 |
virtual int | nextFreeMd (unsigned &SWIG_OUTPUT(nr), string &SWIG_OUTPUT(device))=0 |
virtual int | createMd (const string &name, MdType md_type, const list< string > &devices, const list< string > &spares)=0 |
virtual int | createMdAny (MdType md_type, const list< string > &devices, const list< string > &spares, string &SWIG_OUTPUT(device))=0 |
virtual int | removeMd (const string &name, bool destroySb)=0 |
virtual int | extendMd (const string &name, const list< string > &devices, const list< string > &spares)=0 |
virtual int | updateMd (const string &name, const list< string > &devices, const list< string > &spares)=0 |
virtual int | shrinkMd (const string &name, const list< string > &devices, const list< string > &spares)=0 |
virtual int | changeMdType (const string &name, MdType md_type)=0 |
virtual int | changeMdChunk (const string &name, unsigned long chunkSizeK)=0 |
virtual int | changeMdParity (const string &name, MdParity ptype)=0 |
virtual int | checkMd (const string &name)=0 |
virtual int | getMdStateInfo (const string &name, MdStateInfo &info)=0 |
virtual int | getMdPartCoStateInfo (const string &name, MdPartCoStateInfo &info)=0 |
virtual int | computeMdSize (MdType md_type, const list< string > &devices, const list< string > &spares, unsigned long long &SWIG_OUTPUT(sizeK))=0 |
virtual list< int > | getMdAllowedParity (MdType md_type, unsigned devnr)=0 |
virtual int | removeMdPartCo (const string &name, bool destroySb)=0 |
virtual int | addNfsDevice (const string &nfsDev, const string &opts, unsigned long long sizeK, const string &mp, bool nfs4)=0 |
virtual int | checkNfsDevice (const string &nfsDev, const string &opts, bool nfs4, unsigned long long &SWIG_OUTPUT(sizeK))=0 |
virtual int | createFileLoop (const string &lname, bool reuseExisting, unsigned long long sizeK, const string &mp, const string &pwd, string &SWIG_OUTPUT(device))=0 |
virtual int | modifyFileLoop (const string &device, const string &lname, bool reuseExisting, unsigned long long sizeK)=0 |
virtual int | removeFileLoop (const string &lname, bool removeFile)=0 |
virtual int | removeDmraid (const string &name)=0 |
virtual bool | existSubvolume (const string &device, const string &name)=0 |
virtual int | createSubvolume (const string &device, const string &name)=0 |
virtual int | removeSubvolume (const string &device, const string &name)=0 |
virtual int | extendBtrfsVolume (const string &name, const deque< string > &devs)=0 |
virtual int | shrinkBtrfsVolume (const string &name, const deque< string > &devs)=0 |
virtual int | addTmpfsMount (const string &mp, const string &opts)=0 |
virtual int | removeTmpfsMount (const string &mp)=0 |
virtual void | getCommitInfos (list< CommitInfo > &infos) const =0 |
virtual const string & | getLastAction () const =0 |
virtual const string & | getExtendedErrorMessage () const =0 |
virtual void | setCallbackProgressBar (CallbackProgressBar pfnc)=0 |
virtual CallbackProgressBar | getCallbackProgressBar () const =0 |
virtual void | setCallbackShowInstallInfo (CallbackShowInstallInfo pfnc)=0 |
virtual CallbackShowInstallInfo | getCallbackShowInstallInfo () const =0 |
virtual void | setCallbackInfoPopup (CallbackInfoPopup pfnc)=0 |
virtual CallbackInfoPopup | getCallbackInfoPopup () const =0 |
virtual void | setCallbackYesNoPopup (CallbackYesNoPopup pfnc)=0 |
virtual CallbackYesNoPopup | getCallbackYesNoPopup () const =0 |
virtual void | setCallbackCommitErrorPopup (CallbackCommitErrorPopup pfnc)=0 |
virtual CallbackCommitErrorPopup | getCallbackCommitErrorPopup () const =0 |
virtual void | setCallbackPasswordPopup (CallbackPasswordPopup pfnc)=0 |
virtual CallbackPasswordPopup | getCallbackPasswordPopup () const =0 |
virtual void | setCacheChanges (bool cache)=0 |
virtual bool | isCacheChanges () const =0 |
virtual int | commit ()=0 |
virtual string | getErrorString (int error) const =0 |
virtual int | createBackupState (const string &name)=0 |
virtual int | restoreBackupState (const string &name)=0 |
virtual bool | checkBackupState (const string &name) const =0 |
virtual bool | equalBackupStates (const string &lhs, const string &rhs, bool verbose_log) const =0 |
virtual int | removeBackupState (const string &name)=0 |
virtual bool | checkDeviceMounted (const string &device, list< string > &mps)=0 |
virtual bool | umountDevice (const string &device)=0 |
virtual bool | umountDeviceUns (const string &device, bool unsetup)=0 |
virtual bool | mountDevice (const string &device, const string &mp)=0 |
virtual int | activateEncryption (const string &device, bool on)=0 |
virtual bool | mountDeviceOpts (const string &device, const string &mp, const string &opts)=0 |
virtual bool | mountDeviceRo (const string &device, const string &mp, const string &opts)=0 |
virtual bool | checkDmMapsTo (const string &device)=0 |
virtual void | removeDmTableTo (const string &device)=0 |
virtual int | renameCryptDm (const string &device, const string &new_name)=0 |
virtual bool | getFreeInfo (const string &device, bool get_resize, ResizeInfo &resize_info, bool get_content, ContentInfo &content_info, bool use_cache)=0 |
virtual bool | readFstab (const string &dir, deque< VolumeInfo > &infos)=0 |
virtual void | activateHld (bool val)=0 |
virtual void | activateMultipath (bool val)=0 |
virtual void | rescanEverything ()=0 |
virtual bool | rescanCryptedObjects ()=0 |
virtual void | dumpObjectList ()=0 |
virtual void | dumpCommitInfos () const =0 |
virtual int | getContVolInfo (const string &dev, ContVolInfo &info)=0 |
virtual int | setUserdata (const string &device, const map< string, string > &userdata)=0 |
virtual int | getUserdata (const string &device, map< string, string > &userdata)=0 |
Abstract class defining the interface for libstorage.
|
pure virtual |
Mount the given device and do what is necessary to access volume (e.g. do losetup if loop is set up)
The function mounts at once, /etc/fstab is unaffected
device | device name |
on | if true activate access to encrypted data, otherwise deactivate it |
|
pure virtual |
Activate or deactivate higher level devices as MD, LVM, DM
Multipath is not activate by this function. Only use in instsys mode.
val | flag if devices should be activated or deactivated |
|
pure virtual |
Activate or deactivate multipath
Only use in instsys mode.
val | flag if multipath should be activated or deactivated |
|
pure virtual |
Adds the specified entry to /etc/fstab
This function does not cache the changes but writes them immediately.
device | name of volume, e.g. /dev/hda1 |
mount | mount point, e.g. /home |
vfs | virtual filesystem type, e.g. reiserfs or ext3 |
options | fstab options e.g. noauto,user,sync |
freq | value for fifth fstab field |
passno | value for sixth fstab field |
|
pure virtual |
Add to the fstab options of a volume
device | name of volume, e.g. /dev/hda1 |
options | fstab options to add to already exiting options of the volume (e.g. noauto,user,sync). Multiple options are separated by ",". |
|
pure virtual |
Add knowledge about existence of nfs device.
nfsDev | name of nfs device |
sizeK | size of the nfs device |
opts | mount options for nfs mount |
mp | mount point of the nfs device |
nfs4 | use NFS4 for device |
|
pure virtual |
Add new tmpfs filesystem
mp | mount point for the tmpfs |
opts | mount options for tmpfs mount |
|
pure virtual |
Sets the value of description text. This text will be returned together with the text returned by getCommitInfos().
device | name of volume, e.g. /dev/hda1 |
txt | description text for this partition |
|
pure virtual |
Sets or unsets the format flag for the given volume.
device | name of volume, e.g. /dev/hda1 |
format | flag if format is set on or off |
fs | type of filesystem to create if format is true |
|
pure virtual |
Changes the fstab options of a volume
device | name of volume, e.g. /dev/hda1 |
options | new fstab options of the volume (e.g. noauto,user,sync). Multiple options are separated by ",". It is valid to set an empty fstab option. |
|
pure virtual |
Sets the value of the filesystem label.
device | name of volume, e.g. /dev/hda1 |
label | value of the label |
|
pure virtual |
Change chunk size of a LVM pool or snapshot. This can only be before the volume is created on disk.
vg | name of volume group |
name | of thin pool or snapshot |
chunkSizeK | new chunk size |
|
pure virtual |
Change stripe count of a LVM logical volume. This can only be before the volume is created on disk.
vg | name of volume group |
name | of logical volume |
stripes | new stripe count of logical volume |
|
pure virtual |
Change stripe size of a LVM logical volume. This can only be before the volume is created on disk.
vg | name of volume group |
name | of logical volume |
stripeSizeK | new stripe size of logical volume |
|
pure virtual |
Change chunk size of a raid device. This can only be done before the raid is created on disk.
name | name of software raid device (e.g. /dev/md0) |
chunkSizeK | new chunk size of the software raid |
|
pure virtual |
Change parity of a raid device with raid type raid5, raid6 or raid10. This can only be done before the raid is created on disk.
name | name of software raid device (e.g. /dev/md0) |
ptype | new parity of the software raid |
|
pure virtual |
Change raid type of a raid device. This can only be done before the raid is created on disk.
name | name of software raid device (e.g. /dev/md0) |
md_type | new raid personality of the software raid |
|
pure virtual |
Sets the value of mkfs options.
device | name of volume, e.g. /dev/hda1 |
opts | options for mkfs command |
|
pure virtual |
Changes mount by value in fstab of a volume
device | name of volume, e.g. /dev/hda1 |
mby | new mount by value of the volume. |
|
pure virtual |
Changes the mount point of a volume
device | name of volume, e.g. /dev/hda1 |
mount | new mount point of the volume (e.g. /home). it is valid to set an empty mount point |
|
pure virtual |
Change partition id of a partition
partition | name of partition, e.g. /dev/hda1 |
id | new partition id (e.g. 0x82 swap, 0x8e for lvm, ...) |
|
pure virtual |
Sets the value of tunefs options.
device | name of volume, e.g. /dev/hda1 |
opts | options for tunefs command |
|
pure virtual |
Checks if a backup with a certain name already exists
name | name of the backup to check |
|
pure virtual |
Determine if the given device is known and mounted somewhere
device | device name to check (checks also all alias names) |
mps | set to current mount points if mounted |
|
pure virtual |
Check if there are dm maps to a given device
device | device name for which dm maps should be checked |
|
pure virtual |
Check if a raid device is valid
name | name of software raid device (e.g. /dev/md0) |
|
pure virtual |
Check accessibility and size of nfs device.
nfsDev | name of nfs device |
opts | mount options for nfs mount |
nfs4 | use NFS4 for device |
sizeK | size of the nfs device |
|
pure virtual |
Commit the current state to the system. Only useful in caching mode.
|
pure virtual |
Compute the size of a raid device.
The size compute may not be accurate. It must not be used for further computations. Do not used in new code.
md_type | raid type of the software raid |
devices | list with physical devices for the software raid |
spares | list with spare physical devices for the software raid |
sizeK | will contain the computed size in kilobytes |
|
pure virtual |
Create backup of current state of all containers
name | name under which the backup should be created |
|
pure virtual |
Create a file based loop device. Encryption is automatically activated on the loop device.
lname | name of file the loop device is based on |
reuseExisting | if true an already existing file will be reused. if false the file will be created new. if false the format flag for the device is set by default. |
sizeK | size of the created file, this parameter is ignored if reuseExisting is true and a file already exists. |
mp | mount point of the file based loop device |
pwd | crypt password for the loop device, encryption type is determined automatically by the system |
device | the name of the created loop device |
|
pure virtual |
Create a LVM logical volume
vg | name of volume group |
name | of logical volume |
sizeK | size of logical volume in kilobytes |
stripes | stripe count of logical volume (use 1 unless you know exactly what you are doing) |
device | is set to the device name of the new LV |
|
pure virtual |
Create a LVM thin pool
vg | name of volume group |
name | of thin pool |
sizeK | size of thin pool in kilobytes |
device | is set to the device name of the new pool |
|
pure virtual |
Create a LVM logical volume snapshot
vg | name of volume group |
origin | name of logical volume origin |
name | of logical volume snapshot |
cowSizeK | size of snapshot in kilobytes |
device | is set to the device name of the new snapshot |
|
pure virtual |
Create a LVM logical volume that is thin provisioned
vg | name of volume group |
name | of logical volume |
pool | name of the pool this logical volume allocates from |
sizeK | virtual size of logical volume in kilobytes |
device | is set to the device name of the logical volume |
|
pure virtual |
Create a LVM volume group
name | name of volume group, must not contain blanks, colons and shell special characters (e.g. system) |
peSizeK | physical extent size in kilobytes |
lvm1 | flag if lvm1 compatible format should be used |
devs | list with physical devices to add to that volume group |
|
pure virtual |
Create a Software raid device by name
name | name of software raid device to create (e.g. /dev/md0) |
md_type | raid personality of the new software raid |
devices | list with physical devices for the new software raid |
spares | list with spare physical devices for the new software raid |
|
pure virtual |
Create a Software raid device. Name determined by library.
md_type | raid personality of the new software raid |
devices | list with physical devices for the new software raid |
spares | list with spare physical devices for the new software raid |
device | device name of created software raid device |
|
pure virtual |
Create a new partition. Units given in disk cylinders.
disk | device name of disk, e.g. /dev/hda |
type | type of partition to create, e.g. primary or extended |
cylRegion | region in cylinder of partition (cylinders are numbered starting with 0) |
device | is set to the device name of the new partition The name is returned instead of the number since creating the name from the number is not straight-forward. |
|
pure virtual |
Create a new partition of any type anywhere on the disk. Units given in Kilobytes.
disk | device name of disk, e.g. /dev/hda |
sizeK | size of partition in kilobytes |
device | is set to the device name of the new partition The name is returned instead of the number since creating the name from the number is not straight-forward. |
|
pure virtual |
Create a new partition. Units given in Kilobytes.
disk | device name of disk, e.g. /dev/hda |
type | type of partition to create, e.g. primary or extended |
kRegion | region in kilobyte of partition |
device | is set to the device name of the new partition The name is returned instead of the number since creating the name from the number is not straight-forward. |
|
pure virtual |
Create a new partition of given type as large as possible.
disk | device name of disk, e.g. /dev/hda |
type | type of partition to create, e.g. primary or extended |
device | is set to the device name of the new partition The name is returned instead of the number since creating the name from the number is not straight-forward. |
|
pure virtual |
Create a BTRFS subvolume
device | of the main BTRFS volume |
name | of subvolume |
|
pure virtual |
Compute number of kilobytes of a given number of disk cylinders
disk | device name of disk, e.g. /dev/hda |
sizeCyl | number of disk cylinders |
|
pure virtual |
Query the default disk label of the architecture of the machine (e.g. msdos for ix86, gpt for ia64, ...) for a disk
device | device of disk |
|
pure virtual |
Destroys the partition table of a disk. An empty disk label of the given type without any partition is created.
disk | device name of disk, e.g. /dev/hda |
label | disk label to create on disk, e.g. msdos, gpt, ... |
|
pure virtual |
Dump list of commit actions to log file.
|
pure virtual |
Dump list of all objects to log file.
|
pure virtual |
Compare two backup states
lhs | name of backup to compare, empty string means active state |
rhs | name of backup to compare, empty string means active state |
verbose_log | flag if differences should be logged in detail |
|
pure virtual |
Check for existence of a BTRFS subvolume
device | of the main BTRFS volume |
name | of subvolume |
|
pure virtual |
Extend a BTRFS volume with additional devices
name | name of BTRFS volume (this can contain a device name or be specified as "UUID=<uuid>") |
devs | list with devices to add to that BTRFS volume |
|
pure virtual |
Extend a LVM volume group with additional physical devices
name | name of volume group |
devs | list with physical devices to add to that volume group |
|
pure virtual |
Add a partition to a raid device. This can only be done before the raid is created on disk.
name | name of software raid device (e.g. /dev/md0) |
devices | list with physical devices to add to the raid |
spares | list with spare physical devices to add to the raid |
|
pure virtual |
Forget previously issued change of partition id
partition | name of partition, e.g. /dev/hda1 |
|
pure virtual |
Makes library forget a crypt password of a volume
device | name of volume, e.g. /dev/hda1 |
|
pure virtual |
Forget about possible resize of an volume.
device | device name of volume |
|
pure virtual |
Return the number of free cylinders before and after a partition.
device | device name of partition, e.g. /dev/sda1 |
freeCylsBefore | is set to the number of free cylinders before the partition |
freeCylsAfter | is set to the number of free cylinders after the partition |
|
pure virtual |
Get list of filesystem types present on any block devices.
|
pure virtual |
Query infos for btrfs devices in system
plist | list of records that get filled with btrfs specific info |
|
pure virtual |
Query the callback function called for errors during commit.
|
pure virtual |
Query the callback function called to display info popup to the user
|
pure virtual |
Query the callback function called to query a password from the user.
|
pure virtual |
Query the callback function called on progress bar events
|
pure virtual |
Query the callback function called to display install info
|
pure virtual |
Query the callback function called to get a Yes/No decision by the user.
|
pure virtual |
Gets info about actions to be executed after next call to commit().
infos | list of records that gets filled with infos |
|
pure virtual |
Query all containers found in system
|
pure virtual |
Query disk info for a disk device
disk | device name of disk, e.g. /dev/hda |
cinfo | record that gets filled with container general data |
info | record that gets filled with disk special data |
|
pure virtual |
Query container info for a DMMULTIPATH container
name | name of container, e.g. 3600508b400105f590000900000300000 |
cinfo | record that gets filled with container general data |
info | record that gets filled with DMMULTIPATH Container special data |
|
pure virtual |
Query container info for a DMRAID container
name | name of container, e.g. pdc_ccaihgii |
cinfo | record that gets filled with container general data |
info | record that gets filled with DMRAID Container special data |
|
pure virtual |
Query info for a LVM volume group
name | name of volume group, e.g. system |
cinfo | record that gets filled with container general data |
info | record that gets filled with LVM VG special data |
|
pure virtual |
Query container info for a MDPART container
name | name of container, e.g. md126 |
cinfo | record that gets filled with container general data |
info | record that gets filled with MDPART Container special data |
|
pure virtual |
Split volume device name up into container name and a volume name. For Containers where this is appropriate (e.g. disks, MD, loop) also a volume number is provided.
dev | device name of volume, e.g. /dev/hda1 |
info | record that get filled with split data |
|
pure virtual |
Get encryption state of a volume
device | name of volume, e.g. /dev/hda1 |
val | will be set if encryption is activated |
|
pure virtual |
Get crypt password of a volume
device | name of volume, e.g. /dev/hda1 |
pwd | crypt password for this volume |
|
pure virtual |
Get default filesystem.
|
pure virtual |
Get default value for mount by.
|
pure virtual |
Get default filesystem.
|
pure virtual |
Get value of the flag for detection of mounted volumes.
|
pure virtual |
Query disk info for a disk device
disk | device name of disk, e.g. /dev/hda |
info | record that get filled with disk special data |
|
pure virtual |
Query capabilities of a disk label.
|
pure virtual |
Query infos for dm devices in system
plist | list of records that get filled with dm specific info |
|
pure virtual |
Query container info for a DMMULTIPATH container
name | name of container, e.g. 3600508b400105f590000900000300000 |
info | record that gets filled with DMMULTIPATH Container special data |
|
pure virtual |
Query infos for dmmultipath devices in system
plist | list of records that get filled with dmmultipath specific info |
name | name of dmmultipath, e.g. 3600508b400105f590000900000300000 |
|
pure virtual |
Query container info for a DMRAID container
name | name of container, e.g. pdc_ccaihgii |
info | record that gets filled with DMRAID Container special data |
|
pure virtual |
Query infos for dmraid devices in system
plist | list of records that get filled with dmraid specific info |
name | name of dmraid, e.g. pdc_igeeeadj |
|
pure virtual |
Get value for EFI boot.
|
pure virtual |
Get a textual message for an error code. Can be empty.
|
pure virtual |
Gets a possible existing extended error message describing failure of to last call commit()
|
pure virtual |
Detect potentially available free space on a partition
device | device to check |
get_resize | flag to indicate that resize_info should be queried |
resize_info | struct that gets filled with resize info |
get_content | flag to indicate that content_info should be queried |
content_info | struct that gets filled with content info |
use_cache | function should return cached data if available |
|
pure virtual |
Query capabilities of a filesystem type.
|
pure virtual |
Get the fstab options of a volume
device | name of volume, e.g. /dev/hda1 |
options | will be set to the fstab options of the volume (e.g. noauto,user,sync). Multiple options are separated by ",". |
|
pure virtual |
Get fstab handling state of a volume.
device | name of volume, e.g. /dev/hda1 |
val | will be set if fstab should be ignored for this volume |
|
pure virtual |
Gets action performed last during previous call to commit()
|
pure virtual |
Query infos for file based loop devices in system
plist | list of records that get filled with loop specific info |
|
pure virtual |
Query infos for LVM LVs of a LVM VG
name | name of volume group, e.g. system |
plist | list of records that get filled with LV specific info |
|
pure virtual |
Get state of a LVM logical volume snapshot
vg | name of volume group |
name | name of logical volume snapshot |
info | record that gets filled with snapshot special data |
|
pure virtual |
Query info for a LVM volume group
name | name of volume group, e.g. system |
info | record that gets filled with LVM VG special data |
|
pure virtual |
Determine allowed parity types for raid type.
md_type | raid type of the software raid |
devnr | number of physical devices for the software raid |
|
pure virtual |
Query infos for software raid devices in system
plist | list of records that get filled with MD specific info |
|
pure virtual |
Query container info for a MDPART container
name | name of container, e.g. md126 |
info | record that gets filled with MDPART Container special data |
|
pure virtual |
Get state of a MD software raid device.
name | name of software raid device (e.g. /dev/md125) |
info | record that gets filled with raid special data |
|
pure virtual |
Query infos for partitions on raid device in system
device | device name of the parent MdPartCo, e.g. /dev/md125 |
plist | list of records that get filled with MdPart specific info |
|
pure virtual |
Get state of a raid device.
name | name of software raid device (e.g. /dev/md0) |
info | record that gets filled with raid special data |
|
pure virtual |
Get mount by value in fstab of a volume
device | name of volume, e.g. /dev/hda1 |
mby | will be set to the mount by value of the volume. |
|
pure virtual |
Get the mount point of a volume
device | name of volume, e.g. /dev/hda1 |
mount | will be set to the mount point of the volume (e.g. /home). |
|
pure virtual |
Query whether multipath should be started automatically if detected.
|
pure virtual |
Query infos for nfs devices in system
plist | list of records that get filled with nfs info |
|
pure virtual |
Get value for the alignment of newly created partitions
|
pure virtual |
Query infos for partitions of a disk
disk | device name of disk, e.g. /dev/hda |
plist | list of records that get filled with partition specific info |
|
pure virtual |
Construct the device name for a partiton from the disk name and partiton number.
disk | name of disk, e.g. /dev/sda |
partition_no | number of partition, e.g. 1 |
|
pure virtual |
Return the prefix that is inserted between the disk name and the partition number.
disk | name of disk, e.g. /dev/sda |
|
pure virtual |
Get value of the flag for recursive removal
|
pure virtual |
Recursively get all devices used by devices. Containers of volumes are also considered as used by the devices.
devices | list of name of devices, e.g. /dev/sda1 |
itself | whether the device itself is included in the result |
usedby_devices | name of devices used by devices, e.g. /dev/sda |
|
pure virtual |
Recursively get all devices using devices. Volumes of containers are also considered as using the devices.
devices | name of device, e.g. /dev/sda |
itself | whether the device itself is included in the result |
using_devices | name of devices using device, e.g. /dev/sda1 /dev/sda2 |
|
pure virtual |
Get value for root prefix.
|
pure virtual |
Query infos for tmpfs devices in system
plist | list of records that get filled with tmpfs specific info |
|
pure virtual |
Query unused slots on a disk suitable for creating partitions. The returned information gets invalid as soon as one partition is created. If more partitions should be created the slots must be queried again.
disk | name of disk, e.g. /dev/hda1 |
slots | list of records that get filled with partition slot specific info |
|
pure virtual |
Get the userdata of a device.
device | device name of volume, e.g. /dev/sda1 |
userdata | gets filled with the userdata of the device |
|
pure virtual |
Query a volume by device name found in system
device | device name , e.g. /dev/hda1 |
info | record that gets filled with data |
|
pure virtual |
Query all volumes found in system
infos | list of records that get filled with volume info |
|
pure virtual |
Get value of the flag for zeroing newly created partitions
|
pure virtual |
Do what is needed for low level initialisation of a disk. This function does nothing on normal disks but is needed e.g. on S/390 DASD devices where it executes dasdfmt. If should be considered as destroying all data on the disk.
disk | device name of disk, e.g. /dev/hda |
value | toggle if disk should be initialized or not |
|
pure virtual |
Query the caching mode.
|
pure virtual |
Compute number of disk cylinders needed for given space
disk | device name of disk, e.g. /dev/hda |
sizeK | number of kilobytes |
|
pure virtual |
Modify size and pathname of a file based loop device. This function can only be used between the creation of a device and the next call to commit(). Containers that are already created cannot have these properties changed. The size has only a meaning if reuseExisting is true, otherwise it is ignored.
device | device name of the loop device |
lname | name of file the loop device is based on |
reuseExisting | if true an already existing file will be reused. if false the file will be created new. if false the format flag for the device is set by default. |
sizeK | size of the created file, this parameter is ignored if reuseExisting is false |
|
pure virtual |
Mount the given device and do what is necessary to access volume (e.g. do losetup if loop is set up)
The function mounts at once, /etc/fstab is unaffected
device | device name to mount |
mp | mount point to mount to |
|
pure virtual |
Mount the given device with given options and do what is necessary to access volume (e.g. do losetup if loop is set up)
The function mounts at once, /etc/fstab is unaffected
device | device name to mount |
mp | mount point to mount to |
opts | options to use for mount |
|
pure virtual |
Mount the given device readonly and do what is necessary to access volume (e.g. do losetup if loop is set up)
The function mounts at once, /etc/fstab is unaffected
device | device name to mount |
mp | mount point to mount to |
opts | options to use for mount |
|
pure virtual |
Check if crypt password is required
device | name of volume, e.g. /dev/hda1 |
|
pure virtual |
Determine the device name of the next created software raid device
nr | is set to the number of the next created software raid device |
device | is set to the device name of the next created software raid device |
|
pure virtual |
Determine the device name of the next created partition
disk | device name of disk, e.g. /dev/hda |
type | type of partition to create, e.g. primary or extended |
nr | is set to the number of the next created partition |
device | is set to the device name of the next created partition |
Deprecated. Do not use. Use getUnusedPartitionSlots() to get number and device name of partition since number and device name depend on region, e.g. for DASD partition table.
|
pure virtual |
Read fstab and cryptotab, if existent, from a specified directory and return the volumes found in fstab and cryptotab
dir | directory where fstab and cryptotab are read from |
infos | list of records that get filled with volume info |
|
pure virtual |
Remove existing backup state
name | name of backup to remove, empty string means to remove all existing backup states |
|
pure virtual |
Remove a Software raid device.
name | name of dmraid device to remove (e.g. pdc_dabaheedj) |
|
pure virtual |
Remove all possibly existing dm maps to a given device
device | device name for which dm maps should be removed |
|
pure virtual |
Remove a file based loop device from the system.
lname | name of file the loop device is based on |
removeFile | if true the file is removed together with the based loop device. If false the file is not touched. |
|
pure virtual |
Remove from the fstab options of a volume
device | name of volume, e.g. /dev/hda1 |
options | fstab options to remove from already existing options of the volume (e.g. noauto). Multiple options are separated by ",". It is possible to specify wildcards, so "uid=.*" matches every option starting with the string "uid=". |
|
pure virtual |
Remove a LVM logical volume
vg | name of volume group |
name | of logical volume |
|
pure virtual |
Remove a LVM logical volume
device | name of logical volume |
|
pure virtual |
Remove a LVM logical volume snapshot
vg | name of volume group |
name | name of logical volume snapshot |
|
pure virtual |
Remove a LVM volume group. If the volume group contains logical volumes, these are automatically also removed.
name | name of volume group |
|
pure virtual |
Remove a Software raid device.
name | name of software raid device to remove (e.g. /dev/md0) |
destroySb | flag if the MD superblocks on the physical devices should be destroyed after md device is deleted |
|
pure virtual |
Remove a Partitionable Software raid device.
Only RAID with persistent superblock can be removed. IMSM and DDF RAIDs cannot be removed.
name | name of software raid device to remove (e.g. /dev/md0) |
destroySb | flag if the MD superblocks on the physical devices should be destroyed after md device is deleted |
|
pure virtual |
Remove a partition
partition | name of partition, e.g. /dev/hda1 |
|
pure virtual |
Remove a BTRFS subvolume
device | of the main BTRFS volume |
name | of subvolume |
|
pure virtual |
Remove tmpfs filesystem
mp | mount point for the tmpfs |
|
pure virtual |
Removes a volume from the system. This function can be used for removing all types of volumes (partitions, LVM LVs, MD devices ...)
device | name of volume, e.g. /dev/hda1 |
|
pure virtual |
If device has an encrypted dm map, rename it en device
device | device name for which dm map should be renamed |
new_name | new dm name used for the device |
|
pure virtual |
Rescan after unlocked encrypted volume. Rescan for objects that might be newly found after at least one encrypted volume has been unlocked. Currently the only supported containers on an decrypted volume is a LVM Volume Group.
|
pure virtual |
Rescan all disks. All currently detected objects are forgotten and a new scan for all type of objects (disks, LVM, MD) is initiated. This function makes sense to be called after something outside of libstorage changed disk layout or created storage objects. Any changes already cached are lost.
|
pure virtual |
Resize an existing disk partition. Units given in disk cylinders. Filesystem data is resized accordingly.
device | device name of partition |
sizeCyl | new size of partition in disk cylinders |
|
pure virtual |
Resize an existing disk partition. Units given in disk cylinders. Filesystem data is ignored.
device | device name of partition |
sizeCyl | new size of partition in disk cylinders |
|
pure virtual |
Resizes a volume while keeping the data on the filesystem
device | name of volume, e.g. /dev/hda1 |
newSizeK | new size desired volume in kilobytes |
|
pure virtual |
Resizes a volume while ignoring the data on the filesystem
device | name of volume, e.g. /dev/hda1 |
newSizeK | new size desired volume in kilobytes |
|
pure virtual |
Restore state to a previously created backup
name | name of the backup to restore |
|
pure virtual |
With the function setCacheChanges you can turn the caching mode on and off. Turning of caching mode will cause all changes done so far to be committed upto the next modifying function.
|
pure virtual |
Sets the callback function called for errors during commit.
pfnc | pointer to function |
|
pure virtual |
Sets the callback function called to display a info popup to the user
pfnc | pointer to function |
|
pure virtual |
Sets the callback function called to query a password by the user.
pfnc | pointer to function. |
|
pure virtual |
Sets the callback function called on progress bar events
pfnc | pointer to function |
|
pure virtual |
Sets the callback function called to display install info
pfnc | pointer to function |
|
pure virtual |
Sets the callback function called to get a Yes/No decision by the user.
pfnc | pointer to function |
|
pure virtual |
Set encryption state of a volume
device | name of volume, e.g. /dev/hda1 |
val | flag if encryption should be activated |
|
pure virtual |
Set crypt password of a volume
device | name of volume, e.g. /dev/hda1 |
pwd | crypt password for this volume |
|
pure virtual |
Set encryption state of a volume
device | name of volume, e.g. /dev/hda1 |
val | flag if encryption should be activated |
typ | type of encryption to set up |
|
pure virtual |
Set default filesystem.
val | new default filesystem. |
|
pure virtual |
Set default value for mount by.
val | new default mount by value. |
|
pure virtual |
Set default subvolume name.
val | new default subvolume name. |
|
pure virtual |
Determine of libstorage should detect mounted volumes.
val | flag if mounted volumes should be detected |
|
pure virtual |
Set fstab handling state of a volume. This way one can make libstorage ignore fstab handling for a volume. Use this with care.
device | name of volume, e.g. /dev/hda1 |
val | flag if fstab should be ignored for this volume |
|
pure virtual |
Set whether multipath should be started automatically if detected.
multipath_autostart | value for automatically start of multipath. |
|
pure virtual |
Set alignment of newly created partitions. PartAlign has value ALIGN_OPTIMAL or ALIGN_CYLINDER. ALIGN_CYLINDER aligns partiton start to cylinder boundaries like it was traditionally for a long time. ALIGN_OPTIMAL aligns according to values provided by kernel. Default alignment is to multiples of 2048 sectors which is compatible to partition layout of Windows Vista and Windows 7.
val | value of new alignment type |
|
pure virtual |
Set handling of deletion of entities that belong to other volumes. Normally it is not possible to remove a volume that is part of another entity (e.g. you cannot remove a partition that is part of an LVM Volume group or a Software raid). This setting makes the removal recursive, this means all entities where the removed volume is a part of are also removed. Use this setting with extreme care, it may cause the removal of LVM Volume group spanning multiple disks just because one partition of the LVM Volume group got deleted. Default value of this flag is false.
val | flag if removal is done recursive |
|
pure virtual |
Set value for root prefix.
This value is appended to all mount points of volumes, when changes are commited. Config files fstab, crypttab and mdadm.conf are also created relative to this prefix. This variable must be set before first call to commit.
root | new value for root prefix |
|
pure virtual |
Set new userdata of a device. The userdata is only stored by libstorage but not processed.
device | device name of volume, e.g. /dev/sda1 |
userdata | new userdata for the device |
|
pure virtual |
Set handling of newly created partitions. With this flag once can make the library overwrite start and end of newly created partitions with zeroes. This prevents that obsolete structures (e.g. LVM VGs or MD superblocks) still exists on newly created partitions since the area on disk previously contained a LVM PV or a device of a software raid. volumes. Use this setting with extreme care, it make libstorage behave fundamentally different from all other partitioning tools. Default value of this flag is false.
val | flag if newly created partitions should be zeroed |
|
pure virtual |
Shrink a BTRFS volume by some devices
name | name of BTRFS volume (this can contain a device name or be specified as "UUID=<uuid>") |
devs | list with devices to remove from that BTRFS volume |
|
pure virtual |
Shrink a LVM volume group
name | name of volume group |
devs | list with physical devices to remove from that volume group |
|
pure virtual |
Remove a partition from a raid device. This can only be done before the raid is created on disk.
name | name of software raid device (e.g. /dev/md0) |
devices | list of physical devices to remove from the raid |
spares | list of spare physical devices to remove from the raid |
|
pure virtual |
Umount the given device and do what is necessary to remove underlying volume (e.g. do losetup -d if loop is set up or dmsetup remove if dmcrypt is used)
The function umounts at once, /etc/fstab is unaffected
device | device name to umount |
|
pure virtual |
Umount the given device and dependent of parameter unsetup do what is necessary to remove underlying volume (e.g. do losetup -d if loop is set up or dmsetup remove if dmcrypt is used
The function umounts at once, /etc/fstab is unaffected
device | device name to umount |
unsetup | flag if losetup/dmcrypt should be removed |
|
pure virtual |
Update all partitions of a raid device. This can only be done before the raid is created on disk.
name | name of software raid device (e.g. /dev/md0) |
devices | list with physical devices to create the raid with |
spares | list with spare physical devices to create the raid with |
|
pure virtual |
Update area used by a new partition. Units given in disk cylinders. This function can only be used with a partition created but not yet committed.
device | device name of partition, e.g. /dev/hda1 |
cylRegion | region in cylinder of partition (cylinders are numbered starting with 0) |
|
pure virtual |
Verify password of a volume
device | name of volume, e.g. /dev/hda1 |
pwd | crypt password for this volume |
erase | if true remove password even after successful verification |