Blivet’s test suite relies on the base classes shown below. These classes take care of working with fake block or loop devices.
-Actual test cases inherit either unittest.TestCase or one of
+
Actual test cases inherit either unittest.TestCase or one of
these base classes. Some use cases require more levels of abstraction
which is shown on the following diagram.
Note: with sphinx.ext.inheritance_diagram it is not possible to
@@ -93,7 +93,7 @@
Bases: object
Bases: object
This object merely collects what the /sys/firmware/edd/* entries can provide.
Bases: object
Bases: object
This object tries to match given entry to a disk device name.
Assuming, heuristic analysis and guessing hapens here.
Given an absolute path at which a filesystem is to be mounted, @@ -425,7 +425,7 @@
the GPT partition type UUID or None
Given a volume type defined by one of the GPT_VOL constants, @@ -450,7 +450,7 @@
Bases: tuple
Bases: tuple
Create new instance of ThPoolProfile(name, desc)
levels (list of valid RAID level descriptors) – the levels to be added to this object
+levels (list of valid RAID level descriptors) – the levels to be added to this object
If levels is True, add all standard levels. Else, levels @@ -564,7 +564,7 @@
level (object) – an object representing a RAID level
+level (object) – an object representing a RAID level
There must be at least one element in the names list, or the level @@ -661,7 +661,7 @@
Bases: object
Bases: object
An abstract class which is the parent of all classes which represent a RAID level.
It ensures that RAIDLevel objects will really be singleton objects @@ -759,7 +759,7 @@
Bases: object
Bases: object
A class which keeps track of registered RAID levels. This class may be extended, overriding the is_raid method to include any additional properties that a client of this package may require @@ -767,7 +767,7 @@
levels (list of valid RAID level descriptors) – the levels to be added to this object
+levels (list of valid RAID level descriptors) – the levels to be added to this object
If levels is True, add all standard levels. Else, levels @@ -779,7 +779,7 @@
level (object) – an object representing a RAID level
+level (object) – an object representing a RAID level
Raises a RaidError if level is not valid.
@@ -793,7 +793,7 @@level (object) – an object representing a RAID level
+level (object) – an object representing a RAID level
There must be at least one element in the names list, or the level @@ -812,7 +812,7 @@
descriptor (object) – a RAID level descriptor
+descriptor (object) – a RAID level descriptor
Note that descriptor may be any object that identifies a @@ -861,7 +861,7 @@
member_count (int) – the number of members belonging to the array
+member_count (int) – the number of members belonging to the array
Raiess a RaidError if member_count is fewer than the minimum @@ -903,7 +903,7 @@
member_count (int) – the number of members in the array
member_count (int) – the number of members in the array
smallest_member_size (Size) – the size of the smallest
member of this array
member_count (int) – the number of members in the array
+member_count (int) – the number of members in the array
int or None
+int or None
Raises a RaidError if member_count is fewer than the @@ -945,7 +945,7 @@
member_size (list of Size) – a list of the sizes of members of this array
num_members (int) – the number of members in the array
num_members (int) – the number of members in the array
chunk_size (Size) – the smallest unit of size read or written
superblock_size_func (a function from Size to
Size) – a function that estimates the
@@ -974,7 +974,7 @@
size (Size) – the amount of data on this array
num_members (int) – the number of members in the array
num_members (int) – the number of members in the array
chunk_size (Size) – the smallest unit of size read or written
superblock_size_func (a function from Size to
Size) – a function that estimates the
@@ -1071,8 +1071,8 @@
descriptor (object) – a RAID level descriptor
+descriptor (object) – a RAID level descriptor
whether this device depends on ‘dep’
new (bool) – whether this device is new to the devicetree
+new (bool) – whether this device is new to the devicetree
The only intended use case for new=False is when unhiding a device @@ -219,7 +219,7 @@
modparent (bool) – whether to account for removal in parents
+modparent (bool) – whether to account for removal in parents
Parents’ list of child devices is updated regardless of modparent. @@ -253,8 +253,8 @@
Bases: object
Bases: object
Abstract base class for cache objects providing the cache-related functionality on cached devices. Instances of this class are not expected to be devices (both in what they represent as well as not instances of the @@ -393,7 +393,7 @@
Bases: object
Bases: object
Abstract base class for cache requests specifying cache parameters for a cached device
Bases: object
Bases: object
Abstract base class for common statistics of caches (cached devices). Inheriting classes are expected to add (cache-)type-specific attributes on top of the common set.
@@ -476,19 +476,19 @@name (str) – the device name (generally a device node’s basename)
exists (bool) – does this device exist?
name (str) – the device name (generally a device node’s basename)
exists (bool) – does this device exist?
size (Size) – the device’s size
parents (list of StorageDevice) – a list of parent devices
fmt (DeviceFormat or a subclass of it) – this device’s formatting
uuid (str) – universally unique identifier (device – not fs)
sysfs_path (str) – sysfs device path
major (int) – the device major
minor (int) – the device minor
serial (str) – the ID_SERIAL_SHORT for this device
vendor (str) – the manufacturer of this Device
model (str) – manufacturer’s device model string
bus (str) – the interconnect this device uses
uuid (str) – universally unique identifier (device – not fs)
sysfs_path (str) – sysfs device path
major (int) – the device major
minor (int) – the device minor
serial (str) – the ID_SERIAL_SHORT for this device
vendor (str) – the manufacturer of this Device
model (str) – manufacturer’s device model string
bus (str) – the interconnect this device uses
whether this device depends on ‘dep’
the external dependencies of this device and all parents.
set of availability.ExternalResource
+names of packages required by device and all ancestors
orig (bool) – set up original format instead of current format
+orig (bool) – set up original format instead of current format
recursive (bool) – tear down all ancestor devices recursively
+recursive (bool) – tear down all ancestor devices recursively
a set of external dependencies
set of availability.ExternalResource
+The external dependencies include the dependencies of this @@ -781,7 +781,7 @@
A list of unavailable external dependencies.
set of availability.external_resource
+set of availability.external_resource
A list of unavailable external dependencies.
set of availability.external_resource
+set of availability.external_resource
the unavailable external dependencies for this type
set of availability.ExternalResource
+name (str) – the device name (generally a device node’s basename)
exists (bool) – does this device exist?
name (str) – the device name (generally a device node’s basename)
exists (bool) – does this device exist?
size (Size) – the device’s size
parents (list of StorageDevice) – a list of parent devices
format (DeviceFormat or a subclass of it) – this device’s formatting
wwn (str) – the disk’s WWN
wwn (str) – the disk’s WWN
busid – bus ID
opts (dict with option name keys and option value values) – options
name (str) – the device name (generally a device node’s basename)
name (str) – the device name (generally a device node’s basename)
size (Size) – the device’s size
parents (list of StorageDevice) – a list of parent devices
fmt (DeviceFormat or a subclass of it) – this device’s formatting
uuid (str) – universally unique identifier (device – not fs)
sysfs_path (str) – sysfs device path
removable (bool) – whether or not this is a removable device
serial (str) – the ID_SERIAL_RAW, ID_SERIAL or ID_SERIAL_SHORT for +
uuid (str) – universally unique identifier (device – not fs)
sysfs_path (str) – sysfs device path
removable (bool) – whether or not this is a removable device
serial (str) – the ID_SERIAL_RAW, ID_SERIAL or ID_SERIAL_SHORT for this device (which one is available)
vendor (str) – the manufacturer of this Device
model (str) – manufacturer’s device model string
bus (str) – the interconnect this device uses
wwn (str) – the disk’s WWN
vendor (str) – the manufacturer of this Device
model (str) – manufacturer’s device model string
bus (str) – the interconnect this device uses
wwn (str) – the disk’s WWN
name (str) – the full path to the backing regular file
+name (str) – the full path to the backing regular file
:keyword DeviceFormat fmt: the device’s format
name (str) – the device name (generally a device node’s basename)
exists (bool) – does this device exist?
name (str) – the device name (generally a device node’s basename)
exists (bool) – does this device exist?
size (Size) – the device’s size
parents (list of StorageDevice) – a list of parent devices
format (DeviceFormat or a subclass of it) – this device’s formatting
wwn (str) – the disk’s WWN
wwn (str) – the disk’s WWN
nic – name of NIC to use
identifier –
???
name (str) – the device name (generally a device node’s basename)
name (str) – the device name (generally a device node’s basename)
size (Size) – the device’s size
parents (list of StorageDevice) – a list of parent devices
fmt (DeviceFormat or a subclass of it) – this device’s formatting
sysfs_path (str) – sysfs device path
wwn (str) – the device’s WWN
sysfs_path (str) – sysfs device path
wwn (str) – the device’s WWN
name (str) – the device name (generally a device node’s basename)
exists (bool) – does this device exist?
name (str) – the device name (generally a device node’s basename)
exists (bool) – does this device exist?
size (Size) – the device’s size
parents (list of StorageDevice) – a list of parent devices
format (DeviceFormat or a subclass of it) – this device’s formatting
mode (str) – mode of the namespace
devname (str) – name of the namespace (e.g. ‘namespace0.0’)
sector_size (str) – sector size of the namespace in sector mode
mode (str) – mode of the namespace
devname (str) – name of the namespace (e.g. ‘namespace0.0’)
sector_size (str) – sector size of the namespace in sector mode
Bases: tuple
Bases: tuple
Create new instance of NVMeController(name, serial, nvme_ver, id, subsysnqn, transport, transport_address)
name (str) – the device name (generally a device node’s basename)
exists (bool) – does this device exist?
name (str) – the device name (generally a device node’s basename)
exists (bool) – does this device exist?
size (Size) – the device’s size
parents (list of StorageDevice) – a list of parent devices
format (DeviceFormat or a subclass of it) – this device’s formatting
name (str) – the device name (generally a device node’s basename)
exists (bool) – does this device exist?
name (str) – the device name (generally a device node’s basename)
exists (bool) – does this device exist?
size (Size) – the device’s size
parents (list of StorageDevice) – a list of parent devices
format (DeviceFormat or a subclass of it) – this device’s formatting
nsid (int) – namespace ID
nsid (int) – namespace ID
name (str) – the device name (generally a device node’s basename)
exists (bool) – does this device exist?
name (str) – the device name (generally a device node’s basename)
exists (bool) – does this device exist?
size (Size) – the device’s size
parents (list of StorageDevice) – a list of parent devices
format (DeviceFormat or a subclass of it) – this device’s formatting
wwn (str) – the disk’s WWN
wwn (str) – the disk’s WWN
hba_id –
???
wwpn –
???
@@ -1197,29 +1197,29 @@name (str) – the device name (generally a device node’s basename)
exists (bool) – does this device exist?
name (str) – the device name (generally a device node’s basename)
exists (bool) – does this device exist?
size (Size) – the device’s size
parents (list of StorageDevice) – a list of parent devices
format (DeviceFormat or a subclass of it) – this device’s formatting
wwn (str) – the disk’s WWN
target (str) – the name of the iscsi target
wwn (str) – the disk’s WWN
target (str) – the name of the iscsi target
lun – lun of the target
iface (str) – name of network interface to use for operation
initiator (str) – initiator name
iface (str) – name of network interface to use for operation
initiator (str) – initiator name
offload – a partial offload device (qla4xxx)
address – ip address of the target
port – port of the target
name (str) – the device name (generally a device node’s basename)
exists (bool) – does this device exist?
name (str) – the device name (generally a device node’s basename)
exists (bool) – does this device exist?
size (Size) – the device’s size
parents (list of StorageDevice) – a list of parent devices
fmt (DeviceFormat or a subclass of it) – this device’s formatting
sysfs_path (str) – sysfs device path
sysfs_path (str) – sysfs device path
name (str) – the device name (generally a device node’s basename)
exists (bool) – does this device exist?
name (str) – the device name (generally a device node’s basename)
exists (bool) – does this device exist?
size (Size) – the device’s size
parents (list of StorageDevice) – a list of parent devices
fmt (DeviceFormat or a subclass of it) – this device’s formatting
sysfs_path (str) – sysfs device path
dm_uuid (str) – device-mapper UUID (see note below)
target (str) – device mapper table/target name (eg: “linear”)
sysfs_path (str) – sysfs device path
dm_uuid (str) – device-mapper UUID (see note below)
target (str) – device mapper table/target name (eg: “linear”)
name (str) – the device name (generally a device node’s basename)
exists (bool) – does this device exist?
name (str) – the device name (generally a device node’s basename)
exists (bool) – does this device exist?
size (Size) – the device’s size
parents (list of StorageDevice) – a list of parent devices
fmt (DeviceFormat or a subclass of it) – this device’s formatting
sysfs_path (str) – sysfs device path
sysfs_path (str) – sysfs device path
name (str) – the device name (generally a device node’s basename)
exists (bool) – does this device exist?
name (str) – the device name (generally a device node’s basename)
exists (bool) – does this device exist?
size (Size) – the device’s size
parents (list of StorageDevice) – a list of parent devices
fmt (DeviceFormat or a subclass of it) – this device’s formatting
sysfs_path (str) – sysfs device path
dm_uuid (str) – device-mapper UUID
sysfs_path (str) – sysfs device path
dm_uuid (str) – device-mapper UUID
path (str) – full path to the file
exists (bool) – does this device exist?
path (str) – full path to the file
exists (bool) – does this device exist?
size (Size) – the device’s size
parents (list of StorageDevice) – a list of parent devices
fmt (DeviceFormat or a subclass of it) – this device’s formatting
path (str) – full path to the file
exists (bool) – does this device exist?
path (str) – full path to the file
exists (bool) – does this device exist?
size (Size) – the device’s size
parents (list of StorageDevice) – a list of parent devices
fmt (DeviceFormat or a subclass of it) – this device’s formatting
path (str) – full path to the file
exists (bool) – does this device exist?
path (str) – full path to the file
exists (bool) – does this device exist?
size (Size) – the device’s size
parents (list of StorageDevice) – a list of parent devices
fmt (DeviceFormat or a subclass of it) – this device’s formatting
Bases: object
Bases: object
A list with auditing and side-effects for additions and removals.
The class provides an ordered list with guaranteed unique members and
optional functions to run before adding or removing a member. It
-provides a subset of the functionality provided by list,
+provides a subset of the functionality provided by list,
making it easy to ensure that changes pass through the check functions.
The following operations are implemented:
ml.append(x)
@@ -1523,7 +1523,7 @@ Submodules
-
class blivet.devices.lib.Tags(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)¶
--
+
-
Tags that describe various classes of disk.
@@ -1585,13 +1585,13 @@ Submodules
- Parameters:
-device_path (str) – the path to a device node
+device_path (str) – the path to a device node
- Returns:
the name
- Return type:
--
+
-
@@ -1602,10 +1602,10 @@ Submodules
- Parameters:
-major (int) – major number
+major (int) – major number
- Return type:
--
+
-
@@ -1620,10 +1620,10 @@ Submodules
- Parameters:
-device_type (str) – device type string (eg: ‘device-mapper’, ‘md’)
+device_type (str) – device type string (eg: ‘device-mapper’, ‘md’)
- Return type:
--
+
-
@@ -1643,8 +1643,8 @@ Submodules
- Parameters:
-name (str) – the device name (generally a device node’s basename)
exists (bool) – does this device exist?
name (str) – the device name (generally a device node’s basename)
exists (bool) – does this device exist?
size (Size) – the device’s size
parents (list of StorageDevice) – a list of parent devices
fmt (DeviceFormat or a subclass of it) – this device’s formatting
Submodules
- Parameters:
-name (str) – the device name (generally a device node’s basename)
exists (bool) – does this device exist?
name (str) – the device name (generally a device node’s basename)
exists (bool) – does this device exist?
size (Size) – the device’s size
parents (list of StorageDevice) – a list of parent devices
fmt (DeviceFormat or a subclass of it) – this device’s formatting
sysfs_path (str) – sysfs device path
uuid (str) – the device UUID
sysfs_path (str) – sysfs device path
uuid (str) – the device UUID
Submodules
- Parameters:
-name (str) – the device name (generally a device node’s basename)
exists (bool) – does this device exist?
name (str) – the device name (generally a device node’s basename)
exists (bool) – does this device exist?
size (Size) – the device’s size
parents (list of StorageDevice) – a list of parent devices
fmt (DeviceFormat or a subclass of it) – this device’s formatting
sysfs_path (str) – sysfs device path
uuid (str) – the device UUID
sysfs_path (str) – sysfs device path
uuid (str) – the device UUID
SubmodulesSize or NoneType) – size of the metadata part (LV) of the cache (for
non-existing caches that cannot determine their metadata
size dynamically) or None to use the default (see note below)
-
exists (bool) – whether the cache exists or not
exists (bool) – whether the cache exists or not
pvs (list of LVPVSpec) – PVs to allocate the cache on/from (ignored for existing)
mode (str) – desired mode for non-existing cache (ignored for existing)
mode (str) – desired mode for non-existing cache (ignored for existing)
Submodulesspace to be occupied by the cache on its LV’s VG’s PVs (one has to love LVM)
- Return type:
--
+
-
@@ -1900,7 +1900,7 @@ Submodules
-
class blivet.devices.lvm.LVMCachePoolMixin(metadata_size, cache_mode=None, attach_to=None)¶
-Bases: object
+Bases: object
-
add_hook(new=True)¶
@@ -1971,7 +1971,7 @@ Submodules
size (Size) – requested size of the cache
pvs (list of (StorageDevice or LVPVSpec)) – PVs to allocate the cache on/from
mode (str) – requested mode for the cache (None means the default is used)
mode (str) – requested mode for the cache (None means the default is used)
cache_type (enum LVMCacheType) – type of the cache to use (writecache or “normal” cache)
Submodulesspace to be occupied by the cache on its LV’s VG’s PVs (one has to love LVM)
- Return type:
--
+
-
@@ -2093,7 +2093,7 @@ Submodules
-
class blivet.devices.lvm.LVMCacheType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)¶
-Bases: Enum
+Bases: Enum
-
lvmcache = 1¶
@@ -2109,7 +2109,7 @@ Submodules
-
class blivet.devices.lvm.LVMInternalLVtype(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)¶
-Bases: Enum
+Bases: Enum
-
cache_pool = 6¶
@@ -2155,7 +2155,7 @@ Submodules
-
class blivet.devices.lvm.LVMInternalLogicalVolumeMixin(vg, parent_lv, lv_type)¶
-Bases: object
+Bases: object
-
add_hook(new=True)¶
@@ -2269,14 +2269,14 @@ Submodules
- Parameters:
-name (str) – the device name (generally a device node’s basename)
exists (bool) – does this device exist?
name (str) – the device name (generally a device node’s basename)
exists (bool) – does this device exist?
size (Size) – the device’s size
parents (list of StorageDevice) – a list of parent devices
fmt (DeviceFormat or a subclass of it) – this device’s formatting
sysfs_path (str) – sysfs device path
dm_uuid (str) – device-mapper UUID (see note below)
target (str) – device mapper table/target name (eg: “linear”)
sysfs_path (str) – sysfs device path
dm_uuid (str) – device-mapper UUID (see note below)
target (str) – device mapper table/target name (eg: “linear”)
@@ -2434,7 +2434,7 @@ Submodulesspace occupied by this LV on its VG’s PVs (if we have and idea)
- Return type:
--
+
-
@@ -2478,14 +2478,14 @@ Submodules
- Parameters:
-name (str) – the device name (generally a device node’s basename)
exists (bool) – does this device exist?
name (str) – the device name (generally a device node’s basename)
exists (bool) – does this device exist?
size (Size) – the device’s size
parents (list of StorageDevice) – a list of parent devices
fmt (DeviceFormat or a subclass of it) – this device’s formatting
sysfs_path (str) – sysfs device path
uuid (str) – the device UUID
seg_type (str) – segment type (eg: “linear”, “raid1”, “thin-pool”, “thin”,…)
sysfs_path (str) – sysfs device path
uuid (str) – the device UUID
seg_type (str) – segment type (eg: “linear”, “raid1”, “thin-pool”, “thin”,…)
Submodules
- Parameters:
-grow (bool) – whether to grow this LV
grow (bool) – whether to grow this LV
maxsize (Size) – maximum size for growable LV
percent (int) – percent of VG space to take
percent (int) – percent of VG space to take
cache_request (LVMCacheRequest) – parameters of requested cache (if any)
pvs (list of StorageDevice or LVPVSpec objects (tuples)) – list of PVs to allocate extents from (size could be specified for each PV)
shared (bool) – whether to activate the newly create LV in shared mode
SubmodulesParameters:
origin (StorageDevice) – origin of this snapshot
vorigin (bool) – is this a vorigin snapshot?
vorigin (bool) – is this a vorigin snapshot?
Submodules
- Parameters:
-compression (bool) – whether to enable compression on the VDO pool
dudplication (bool) – whether to enable dudplication on the VDO pool
index_memory (int) – amount of index memory (in bytes) or 0 for default
write_policy (str) – write policy for the volume or None for default
compression (bool) – whether to enable compression on the VDO pool
dudplication (bool) – whether to enable dudplication on the VDO pool
index_memory (int) – amount of index memory (in bytes) or 0 for default
write_policy (str) – write policy for the volume or None for default
SubmodulesParameters:
metadata_size (Size) – the size of the metadata LV
cache_mode (str) – mode for the cache or None for default (writethrough)
cache_mode (str) – mode for the cache or None for default (writethrough)
attach_to (LVMLogicalVolumeDevice) – for non-existing cache pools a logical volume the pool should
be attached to when created
@@ -2569,7 +2570,7 @@ Submodules
- Parameters:
-new (bool) – whether this device is new to the devicetree
+new (bool) – whether this device is new to the devicetree
The only intended use case for new=False is when unhiding a device
@@ -2609,7 +2610,7 @@
Submoduleswhether this device depends on ‘dep’
- Return type:
--
+
-
@@ -2707,7 +2708,7 @@ Submodules
- Parameters:
-modparent (bool) – whether to account for removal in parents
+modparent (bool) – whether to account for removal in parents
Parents’ list of child devices is updated regardless of modparent.
@@ -2791,7 +2792,7 @@
Submodules
-
class blivet.devices.lvm.LVMSnapshotMixin(origin=None, vorigin=False)¶
-Bases: object
+Bases: object
-
depends_on(dep)¶
@@ -2861,7 +2862,7 @@ Submodules
-
class blivet.devices.lvm.LVMThinLogicalVolumeMixin¶
-Bases: object
+Bases: object
-
add_hook(new=True)¶
@@ -2916,7 +2917,7 @@ Submodules
-
class blivet.devices.lvm.LVMThinPoolMixin(metadata_size=None, chunk_size=None, profile=None)¶
-Bases: object
+Bases: object
-
autoset_md_size(enforced=False)¶
@@ -2986,7 +2987,7 @@ Submodules
-
class blivet.devices.lvm.LVMVDOLogicalVolumeMixin¶
-Bases: object
+Bases: object
-
add_hook(new=True)¶
@@ -3042,7 +3043,7 @@ Submodules
-
class blivet.devices.lvm.LVMVDOPoolMixin(compression=True, deduplication=True, index_memory=0, write_policy=None)¶
-Bases: object
+Bases: object
-
property direct¶
@@ -3105,10 +3106,10 @@ Submodules
- Parameters:
-name (str) – the device name (generally a device node’s basename)
exists (bool) – does this device exist?
name (str) – the device name (generally a device node’s basename)
exists (bool) – does this device exist?
parents (list of StorageDevice) – a list of parent devices
sysfs_path (str) – sysfs device path
sysfs_path (str) – sysfs device path
pe_size (Size) – physical extent size
Submodules
+- Parameters:
+shared (bool) – whether to create this VG as shared
+
-
add_hook(new=True)¶
Perform actions related to adding a device to the devicetree.
- Parameters:
-new (bool) – whether this device is new to the devicetree
+new (bool) – whether this device is new to the devicetree
The only intended use case for new=False is when unhiding a device
@@ -3266,7 +3273,7 @@
Submodulesinformation about sizes and free space in this VG’s PVs
- Return type:
-list of PVFreeInfo
+list of PVFreeInfo
@@ -3283,7 +3290,7 @@ Submodules
- Parameters:
-modparent (bool) – whether to account for removal in parents
+modparent (bool) – whether to account for removal in parents
Parents’ list of child devices is updated regardless of modparent.
@@ -3390,7 +3397,7 @@
Submodulesspace to be occupied by the cache on its LV’s VG’s PVs (one has to love LVM)
- Return type:
--
+
-
@@ -3423,21 +3430,21 @@ Submodules
-
class blivet.devices.lvm.LVPVSpec(pv, size)¶
-Bases: object
+Bases: object
Class for specifying how much space on a PV should be allocated for some LV
-
exception blivet.devices.lvm.NotTypeSpecific¶
-Bases: Exception
+Bases: Exception
Exception class for invalid type-specific calls
-
class blivet.devices.lvm.PVFreeInfo(pv, size, free)¶
-Bases: tuple
+Bases: tuple
A namedtuple class holding the information about PV’s (usable) size and free space
-
@@ -3462,7 +3469,7 @@
Submodules
-
class blivet.devices.lvm.ThPoolReserveSpec(percent, min, max)¶
-Bases: tuple
+Bases: tuple
A namedtuple class for specifying restrictions of space reserved for a thin pool to grow
-
@@ -3494,19 +3501,19 @@
Submodules
- Parameters:
-name (str) – the device name (generally a device node’s basename)
exists (bool) – does this device exist?
name (str) – the device name (generally a device node’s basename)
exists (bool) – does this device exist?
size (Size) – the device’s size
parents (list of StorageDevice) – a list of parent devices
fmt (DeviceFormat or a subclass of it) – this device’s formatting
sysfs_path (str) – sysfs device path
sysfs_path (str) – sysfs device path
chunk_size (Size) – chunk size for the device
uuid (str) – the device UUID
uuid (str) – the device UUID
level (any valid RAID level descriptor) – the device’s RAID level
member_devices (int) – the number of active member devices
total_devices (int) – the total number of member devices
metadata_version (str (eg: "0.90")) – the version of the device’s md metadata
minor (int) – the device minor (obsolete?)
member_devices (int) – the number of active member devices
total_devices (int) – the total number of member devices
metadata_version (str (eg: "0.90")) – the version of the device’s md metadata
minor (int) – the device minor (obsolete?)
@@ -3579,19 +3586,19 @@ Submodules
- Parameters:
-name (str) – the device name (generally a device node’s basename)
exists (bool) – does this device exist?
name (str) – the device name (generally a device node’s basename)
exists (bool) – does this device exist?
size (Size) – the device’s size
parents (list of StorageDevice) – a list of parent devices
fmt (DeviceFormat or a subclass of it) – this device’s formatting
sysfs_path (str) – sysfs device path
sysfs_path (str) – sysfs device path
chunk_size (Size) – chunk size for the device
uuid (str) – the device UUID
uuid (str) – the device UUID
level (any valid RAID level descriptor) – the device’s RAID level
member_devices (int) – the number of active member devices
total_devices (int) – the total number of member devices
metadata_version (str (eg: "0.90")) – the version of the device’s md metadata
minor (int) – the device minor (obsolete?)
member_devices (int) – the number of active member devices
total_devices (int) – the total number of member devices
metadata_version (str (eg: "0.90")) – the version of the device’s md metadata
minor (int) – the device minor (obsolete?)
@@ -3653,19 +3660,19 @@ Submodules
- Parameters:
-name (str) – the device name (generally a device node’s basename)
exists (bool) – does this device exist?
name (str) – the device name (generally a device node’s basename)
exists (bool) – does this device exist?
size (Size) – the device’s size
parents (list of StorageDevice) – a list of parent devices
fmt (DeviceFormat or a subclass of it) – this device’s formatting
sysfs_path (str) – sysfs device path
sysfs_path (str) – sysfs device path
chunk_size (Size) – chunk size for the device
uuid (str) – the device UUID
uuid (str) – the device UUID
level (any valid RAID level descriptor) – the device’s RAID level
member_devices (int) – the number of active member devices
total_devices (int) – the total number of member devices
metadata_version (str (eg: "0.90")) – the version of the device’s md metadata
minor (int) – the device minor (obsolete?)
member_devices (int) – the number of active member devices
total_devices (int) – the total number of member devices
metadata_version (str (eg: "0.90")) – the version of the device’s md metadata
minor (int) – the device minor (obsolete?)
@@ -3790,7 +3797,7 @@ Submodulesthe array’s UUID in mdadm format, if available
- Return type:
-str or NoneType
+str or NoneType
Submodules
-
class blivet.devices.network.NetworkStorageDevice(host_address=None, nic=None)¶
-Bases: object
+Bases: object
Virtual base class for network backed storage devices
Note this class is only to be used as a baseclass and then only with
multiple inheritance. The only correct use is:
@@ -3925,8 +3932,8 @@
Submodules
- Parameters:
-
@@ -3943,7 +3950,7 @@ Submodules
- Parameters:
-device (str) – the device name (generally a device node’s basename)
device (str) – the device name (generally a device node’s basename)
parents (list of StorageDevice) – a list of parent devices
fmt (DeviceFormat or a subclass of it) – this device’s formatting
@@ -4107,19 +4114,19 @@ Submodules
- Parameters:
-name (str) – the device name (generally a device node’s basename)
exists (bool) – does this device exist?
name (str) – the device name (generally a device node’s basename)
exists (bool) – does this device exist?
size (Size) – the device’s size
parents (list of StorageDevice) – a list of parent devices
fmt (DeviceFormat or a subclass of it) – this device’s formatting
uuid (str) – universally unique identifier (device – not fs)
sysfs_path (str) – sysfs device path
major (int) – the device major
minor (int) – the device minor
serial (str) – the ID_SERIAL_SHORT for this device
vendor (str) – the manufacturer of this Device
model (str) – manufacturer’s device model string
bus (str) – the interconnect this device uses
uuid (str) – universally unique identifier (device – not fs)
sysfs_path (str) – sysfs device path
major (int) – the device major
minor (int) – the device minor
serial (str) – the ID_SERIAL_SHORT for this device
vendor (str) – the manufacturer of this Device
model (str) – manufacturer’s device model string
bus (str) – the interconnect this device uses
Submodules
- Parameters:
-name (str) – the device name (generally a device node’s basename)
exists (bool) – does this device exist?
name (str) – the device name (generally a device node’s basename)
exists (bool) – does this device exist?
size (:class:Size) – the device’s size
parents (list of StorageDevice) – a list of parent devices
fmt (DeviceFormat or a subclass of it) – this device’s formatting
Submodules
- Parameters:
-
@@ -4179,15 +4186,15 @@ Submodules
part_type (parted partition type constant) – parted type constant, eg:
parted.PARTITION_NORMAL
grow (bool) – whether or not to grow the partition
grow (bool) – whether or not to grow the partition
maxsize (Size) – max size for growable partitions
start (long) – start sector (see note, below)
end (long) – end sector (see note, below)
bootable (bool) – whether the partition is bootable
weight (int or NoneType) – an initial sorting weight to assign
bootable (bool) – whether the partition is bootable
weight (int or NoneType) – an initial sorting weight to assign
disk_tags (iterable) – (str) tags defining candidate disk set
part_type_uuid (uuid.UUID or NoneType) – GPT partition type UUID or None
mountpoint (str or NoneType) – where the partition’s format will be mounted
part_type_uuid (uuid.UUID or NoneType) – GPT partition type UUID or None
mountpoint (str or NoneType) – where the partition’s format will be mounted
Submodules
- Parameters:
-new (bool) – whether this device is new to the devicetree
+new (bool) – whether this device is new to the devicetree
The only intended use case for new=False is when unhiding a device
@@ -4414,7 +4421,7 @@
Submodules
- Parameters:
-modparent (bool) – whether to account for removal in parents
+modparent (bool) – whether to account for removal in parents
Parents’ list of child devices is updated regardless of modparent.
@@ -4480,19 +4487,19 @@
Submodules
- Parameters:
-name (str) – the device name (generally a device node’s basename)
exists (bool) – does this device exist?
name (str) – the device name (generally a device node’s basename)
exists (bool) – does this device exist?
size (Size) – the device’s size
parents (list of StorageDevice) – a list of parent devices
fmt (DeviceFormat or a subclass of it) – this device’s formatting
uuid (str) – universally unique identifier (device – not fs)
sysfs_path (str) – sysfs device path
major (int) – the device major
minor (int) – the device minor
serial (str) – the ID_SERIAL_SHORT for this device
vendor (str) – the manufacturer of this Device
model (str) – manufacturer’s device model string
bus (str) – the interconnect this device uses
uuid (str) – universally unique identifier (device – not fs)
sysfs_path (str) – sysfs device path
major (int) – the device major
minor (int) – the device minor
serial (str) – the ID_SERIAL_SHORT for this device
vendor (str) – the manufacturer of this Device
model (str) – manufacturer’s device model string
bus (str) – the interconnect this device uses
Submodules
- Parameters:
-name (str) – the device name (generally a device node’s basename)
exists (bool) – does this device exist?
name (str) – the device name (generally a device node’s basename)
exists (bool) – does this device exist?
size (Size) – the device’s size
parents (list of StorageDevice) – a list of parent devices
fmt (DeviceFormat or a subclass of it) – this device’s formatting
uuid (str) – universally unique identifier (device – not fs)
sysfs_path (str) – sysfs device path
major (int) – the device major
minor (int) – the device minor
serial (str) – the ID_SERIAL_SHORT for this device
vendor (str) – the manufacturer of this Device
model (str) – manufacturer’s device model string
bus (str) – the interconnect this device uses
uuid (str) – universally unique identifier (device – not fs)
sysfs_path (str) – sysfs device path
major (int) – the device major
minor (int) – the device minor
serial (str) – the ID_SERIAL_SHORT for this device
vendor (str) – the manufacturer of this Device
model (str) – manufacturer’s device model string
bus (str) – the interconnect this device uses
Submodules
- Parameters:
-new (bool) – whether this device is new to the devicetree
+new (bool) – whether this device is new to the devicetree
The only intended use case for new=False is when unhiding a device
@@ -4791,7 +4798,7 @@
Submodules
- Parameters:
-modparent (bool) – whether to account for removal in parents
+modparent (bool) – whether to account for removal in parents
Parents’ list of child devices is updated regardless of modparent.
@@ -4908,19 +4915,19 @@
Submodules
- Parameters:
-name (str) – the device name (generally a device node’s basename)
exists (bool) – does this device exist?
name (str) – the device name (generally a device node’s basename)
exists (bool) – does this device exist?
size (Size) – the device’s size
parents (list of StorageDevice) – a list of parent devices
fmt (DeviceFormat or a subclass of it) – this device’s formatting
uuid (str) – universally unique identifier (device – not fs)
sysfs_path (str) – sysfs device path
major (int) – the device major
minor (int) – the device minor
serial (str) – the ID_SERIAL_SHORT for this device
vendor (str) – the manufacturer of this Device
model (str) – manufacturer’s device model string
bus (str) – the interconnect this device uses
uuid (str) – universally unique identifier (device – not fs)
sysfs_path (str) – sysfs device path
major (int) – the device major
minor (int) – the device minor
serial (str) – the ID_SERIAL_SHORT for this device
vendor (str) – the manufacturer of this Device
model (str) – manufacturer’s device model string
bus (str) – the interconnect this device uses
SubmodulesParameters:
-
@@ -4971,7 +4978,7 @@ Submodules
- Parameters:
-new (bool) – whether this device is new to the devicetree
+new (bool) – whether this device is new to the devicetree
The only intended use case for new=False is when unhiding a device
@@ -5032,7 +5039,7 @@
Submodules
- Parameters:
-modparent (bool) – whether to account for removal in parents
+modparent (bool) – whether to account for removal in parents
Parents’ list of child devices is updated regardless of modparent.
@@ -5902,7 +5909,7 @@
Navigation
-
previous |
-
+
diff --git a/blivet/blivet.events.html b/blivet/blivet.events.html
index 47a2b8167..519d203a7 100644
--- a/blivet/blivet.events.html
+++ b/blivet/blivet.events.html
@@ -6,7 +6,7 @@
- blivet.events package — Blivet 3.8.1 documentation
+ blivet.events package — Blivet 3.8.2 documentation
@@ -37,7 +37,7 @@ Navigation
-
previous |
-
+
@@ -154,7 +154,7 @@ Submodules
-
class blivet.events.handler.EventHandlerMixin¶
-Bases: object
+Bases: object
-
handle_event(event, notify_cb)¶
@@ -177,8 +177,8 @@ Submodules
- Parameters:
-
@@ -188,7 +188,7 @@ Submodules
-
class blivet.events.manager.EventManager(handler_cb=None, notify_cb=None, error_cb=None)¶
-Bases: object
+Bases: object
-
add_mask(device=None, action=None, partitions=False)¶
@@ -196,9 +196,9 @@ Submodules
- Parameters:
-device (str) – ignore events on the named device
action (str) – ignore events of the specified type
partitions (bool) – also match events on child partitions
device (str) – ignore events on the named device
action (str) – ignore events of the specified type
partitions (bool) – also match events on child partitions
@@ -281,9 +281,9 @@ Submodules
- Parameters:
-device (str) – basename of device to mask events on
action (str) – action type to mask events of
partitions (bool) – also match events on child partitions
device (str) – basename of device to mask events on
action (str) – action type to mask events of
partitions (bool) – also match events on child partitions
@@ -452,7 +452,7 @@ Navigation
-
previous |
-
+
diff --git a/blivet/blivet.formats.html b/blivet/blivet.formats.html
index f5602758f..64f8c7817 100644
--- a/blivet/blivet.formats.html
+++ b/blivet/blivet.formats.html
@@ -6,7 +6,7 @@
- blivet.formats package — Blivet 3.8.1 documentation
+ blivet.formats package — Blivet 3.8.2 documentation
@@ -37,7 +37,7 @@ Navigation
-
previous |
-
+
@@ -63,8 +63,8 @@ Submodules
- Parameters:
-
@@ -102,10 +102,10 @@ Submodules
- Parameters:
-device (str) – full path to the block device node
uuid (str) – disklabel UUID
label_type (str) – type of disklabel to create
exists (bool) – whether the formatting exists
device (str) – full path to the block device node
uuid (str) – disklabel UUID
label_type (str) – type of disklabel to create
exists (bool) – whether the formatting exists
Submodules
- Parameters:
-start (int) – start sector
end (int) – end sector
ptype (int (parted partition type constant) or NoneType) – partition type or None
part_type_uuid (uuid.UUID or NoneType) – partition type UUID or None
start (int) – start sector
end (int) – end sector
ptype (int (parted partition type constant) or NoneType) – partition type or None
part_type_uuid (uuid.UUID or NoneType) – partition type UUID or None
Submodules
- Parameters:
-
@@ -459,9 +459,9 @@ Submodulesstr) – mount options for the filesystem
+
mountopts (str) – mount options for the filesystem
size – the filesystem’s size in MiB
exists (bool) – indicates whether this is an existing filesystem
exists (bool) – indicates whether this is an existing filesystem
Submodulesstr) – mount options for the filesystem
+
mountopts (str) – mount options for the filesystem
size – the filesystem’s size in MiB
exists (bool) – indicates whether this is an existing filesystem
exists (bool) – indicates whether this is an existing filesystem
Submodulesstr) – mount options for the filesystem
+
mountopts (str) – mount options for the filesystem
size – the filesystem’s size in MiB
exists (bool) – indicates whether this is an existing filesystem
exists (bool) – indicates whether this is an existing filesystem
Submodulesstr) – mount options for the filesystem
+
mountopts (str) – mount options for the filesystem
size – the filesystem’s size in MiB
exists (bool) – indicates whether this is an existing filesystem
exists (bool) – indicates whether this is an existing filesystem
Submodulesstr) – mount options for the filesystem
+
mountopts (str) – mount options for the filesystem
size – the filesystem’s size in MiB
exists (bool) – indicates whether this is an existing filesystem
exists (bool) – indicates whether this is an existing filesystem
Submodulesstr) – mount options for the filesystem
+
mountopts (str) – mount options for the filesystem
size – the filesystem’s size in MiB
exists (bool) – indicates whether this is an existing filesystem
exists (bool) – indicates whether this is an existing filesystem
Submodulesstr) – mount options for the filesystem
+
mountopts (str) – mount options for the filesystem
size – the filesystem’s size in MiB
exists (bool) – indicates whether this is an existing filesystem
exists (bool) – indicates whether this is an existing filesystem
Submodulesstr) – mount options for the filesystem
+
mountopts (str) – mount options for the filesystem
size – the filesystem’s size in MiB
exists (bool) – indicates whether this is an existing filesystem
exists (bool) – indicates whether this is an existing filesystem
Submodulesstr) – mount options for the filesystem
+
mountopts (str) – mount options for the filesystem
size – the filesystem’s size in MiB
exists (bool) – indicates whether this is an existing filesystem
exists (bool) – indicates whether this is an existing filesystem
Submodulesstr) – mount options for the filesystem
+
mountopts (str) – mount options for the filesystem
size – the filesystem’s size in MiB
exists (bool) – indicates whether this is an existing filesystem
exists (bool) – indicates whether this is an existing filesystem
Submodulesstr) – mount options for the filesystem
+
mountopts (str) – mount options for the filesystem
size – the filesystem’s size in MiB
exists (bool) – indicates whether this is an existing filesystem
exists (bool) – indicates whether this is an existing filesystem
Submodulesstr) – mount options for the filesystem
+
mountopts (str) – mount options for the filesystem
size – the filesystem’s size in MiB
exists (bool) – indicates whether this is an existing filesystem
exists (bool) – indicates whether this is an existing filesystem
Submodules
- Return type:
--
+
-
@@ -888,9 +888,9 @@ Submodulesstr) – mount options for the filesystem
+
mountopts (str) – mount options for the filesystem
size – the filesystem’s size in MiB
exists (bool) – indicates whether this is an existing filesystem
exists (bool) – indicates whether this is an existing filesystem
Submodules
- Return type:
--
+
-
@@ -936,7 +936,7 @@ Submodules
- Return type:
--
+
-
@@ -948,7 +948,7 @@ Submodules
- Return type:
--
+
-
@@ -1035,7 +1035,7 @@ Submodules
- Return type:
--
+
-
@@ -1078,7 +1078,7 @@ Submodules
- Parameters:
-label (str or None) – A possible label
+label (str or None) – A possible label
Submodules
- Return type:
--
+
-
@@ -1151,7 +1151,7 @@ Submodulesthe filesystem’s label
- Return type:
--
+
-
Raises a FSReadLabelError if the label can not be read.
@@ -1164,7 +1164,7 @@ Submodules
- Return type:
--
+
-
@@ -1222,7 +1222,7 @@ Submodules
- Parameters:
-mountpoint (str) – Optional mountpoint to be unmounted.
+mountpoint (str) – Optional mountpoint to be unmounted.
- Raises:
FSError
@@ -1252,7 +1252,7 @@ Submodules
- Parameters:
-uuid (str) – An UUID
+uuid (str) – An UUID
Submodulesstr) – mount options for the filesystem
+
mountopts (str) – mount options for the filesystem
size – the filesystem’s size in MiB
exists (bool) – indicates whether this is an existing filesystem
exists (bool) – indicates whether this is an existing filesystem
Submodulesstr) – mount options for the filesystem
+
mountopts (str) – mount options for the filesystem
size – the filesystem’s size in MiB
exists (bool) – indicates whether this is an existing filesystem
exists (bool) – indicates whether this is an existing filesystem
@@ -1365,9 +1365,9 @@ Submodulesstr) – mount options for the filesystem
+
mountopts (str) – mount options for the filesystem
size – the filesystem’s size in MiB
exists (bool) – indicates whether this is an existing filesystem
exists (bool) – indicates whether this is an existing filesystem
Submodulesstr) – mount options for the filesystem
+
mountopts (str) – mount options for the filesystem
size – the filesystem’s size in MiB
exists (bool) – indicates whether this is an existing filesystem
exists (bool) – indicates whether this is an existing filesystem
Submodulesstr) – mount options for the filesystem
+
mountopts (str) – mount options for the filesystem
size – the filesystem’s size in MiB
exists (bool) – indicates whether this is an existing filesystem
exists (bool) – indicates whether this is an existing filesystem
Submodulesstr) – mount options for the filesystem
+
mountopts (str) – mount options for the filesystem
size – the filesystem’s size in MiB
exists (bool) – indicates whether this is an existing filesystem
exists (bool) – indicates whether this is an existing filesystem
Submodulesstr) – mount options for the filesystem
+
mountopts (str) – mount options for the filesystem
size – the filesystem’s size in MiB
exists (bool) – indicates whether this is an existing filesystem
exists (bool) – indicates whether this is an existing filesystem
Submodulesstr) – mount options for the filesystem
+
mountopts (str) – mount options for the filesystem
size – the filesystem’s size in MiB
exists (bool) – indicates whether this is an existing filesystem
exists (bool) – indicates whether this is an existing filesystem
Submodulesstr) – mount options for the filesystem
+
mountopts (str) – mount options for the filesystem
size – the filesystem’s size in MiB
exists (bool) – indicates whether this is an existing filesystem
exists (bool) – indicates whether this is an existing filesystem
Submodules
- Return type:
--
+
-
@@ -1605,9 +1605,9 @@ Submodulesstr) – mount options for the filesystem
+
mountopts (str) – mount options for the filesystem
size – the filesystem’s size in MiB
exists (bool) – indicates whether this is an existing filesystem
exists (bool) – indicates whether this is an existing filesystem
Submodulesstr) – mount options for the filesystem
+
mountopts (str) – mount options for the filesystem
size – the filesystem’s size in MiB
exists (bool) – indicates whether this is an existing filesystem
exists (bool) – indicates whether this is an existing filesystem
Submodulesstr) – mount options for the filesystem
+
mountopts (str) – mount options for the filesystem
size – the filesystem’s size in MiB
exists (bool) – indicates whether this is an existing filesystem
exists (bool) – indicates whether this is an existing filesystem
Submodulesstr) – mount options for the filesystem
+
mountopts (str) – mount options for the filesystem
size – the filesystem’s size in MiB
exists (bool) – indicates whether this is an existing filesystem
exists (bool) – indicates whether this is an existing filesystem
Submodulesstr) – mount options for the filesystem
+
mountopts (str) – mount options for the filesystem
size – the filesystem’s size in MiB
exists (bool) – indicates whether this is an existing filesystem
exists (bool) – indicates whether this is an existing filesystem
Submodulesstr) – mount options for the filesystem
+
mountopts (str) – mount options for the filesystem
size – the filesystem’s size in MiB
exists (bool) – indicates whether this is an existing filesystem
exists (bool) – indicates whether this is an existing filesystem
Submodulesstr) – mount options for the filesystem
+
mountopts (str) – mount options for the filesystem
size – the filesystem’s size in MiB
exists (bool) – indicates whether this is an existing filesystem
exists (bool) – indicates whether this is an existing filesystem
Submodulesstr) – mount options for the filesystem
+
mountopts (str) – mount options for the filesystem
size – the filesystem’s size in MiB
exists (bool) – indicates whether this is an existing filesystem
exists (bool) – indicates whether this is an existing filesystem
Submodulesstr) – mount options for the filesystem
+
mountopts (str) – mount options for the filesystem
size – the filesystem’s size in MiB
exists (bool) – indicates whether this is an existing filesystem
exists (bool) – indicates whether this is an existing filesystem
Submodulesstr) – mount options for the filesystem
+
mountopts (str) – mount options for the filesystem
size – the filesystem’s size in MiB
exists (bool) – indicates whether this is an existing filesystem
exists (bool) – indicates whether this is an existing filesystem
Submodules
-
class blivet.formats.fslib.FSResize¶
-Bases: object
+Bases: object
-
OFFLINE_GROW = 4¶
@@ -1987,10 +1987,10 @@ SubmodulesParameters:
device – the path to the underlying device
exists (bool) – indicates whether this is an existing format
exists (bool) – indicates whether this is an existing format
name – the name of the mapped device
algorithm – integrity algorithm (HMAC is not supported)
sector_size (int) – integrity sector size
sector_size (int) – integrity sector size
@@ -2025,20 +2025,20 @@ Submodules
device – the path to the underlying device
uuid – the LUKS UUID
exists (bool) – indicates whether this is an existing format
exists (bool) – indicates whether this is an existing format
name – the name of the mapped device
passphrase (str) – device passphrase
key_file (str) – path to a file containing a key
cipher (str) – cipher mode
key_size (int) – key size in bits
escrow_cert (str) – certificate (contents) to use for key escrow
passphrase (str) – device passphrase
key_file (str) – path to a file containing a key
cipher (str) – cipher mode
key_size (int) – key size in bits
escrow_cert (str) – certificate (contents) to use for key escrow
add_backup_passphrase (bool.) – generate a backup passphrase?
min_luks_entropy (int) – minimum entropy in bits required for
+
min_luks_entropy (int) – minimum entropy in bits required for
format creation
luks_version (str) – luks format version (“luks1” or “luks2”)
luks_version (str) – luks format version (“luks1” or “luks2”)
pbkdf_args (LUKS2PBKDFArgs) – optional arguments for LUKS2 key derivation function
(for non-existent format only)
luks_sector_size (int) – encryption sector size (use only with LUKS version 2)
luks_sector_size (int) – encryption sector size (use only with LUKS version 2)
Submodules
-
class blivet.formats.luks.LUKS2PBKDFArgs(type=None, max_memory_kb=0, iterations=0, time_ms=0, hash_fn=None)¶
-Bases: object
+Bases: object
PBKDF arguments for LUKS 2 format
Submodules
device – path to the block device node
uuid – this PV’s uuid (not the VG uuid)
exists (bool) – indicates whether this is an existing format
exists (bool) – indicates whether this is an existing format
vg_name – the name of the VG this PV belongs to
vg_uuid – the UUID of the VG this PV belongs to
pe_start (Size) – offset of first physical extent
Submodules
Submodules
SubmodulesParameters:
-
@@ -2445,13 +2445,13 @@ Submodules
device – path to the block device node
uuid – this Stratis block device UUID (not the pool UUID)
exists (bool) – indicates whether this is an existing format
exists (bool) – indicates whether this is an existing format
pool_name – the name of the pool this block device belongs to
pool_uuid – the UUID of the pool this block device belongs to
locked_pool (bool) – whether this block device belongs to a locked pool or not
locked_pool_key_desc (str) – kernel keyring description for locked pool
passphrase (str) – passphrase for the locked pool
key_file (str) – path to a file containing a key
locked_pool (bool) – whether this block device belongs to a locked pool or not
locked_pool_key_desc (str) – kernel keyring description for locked pool
passphrase (str) – passphrase for the locked pool
key_file (str) – path to a file containing a key
@@ -2513,9 +2513,9 @@ Submodules
device – path to the block device node
uuid – this swap space’s uuid
exists (bool) – whether this is an existing format
exists (bool) – whether this is an existing format
label – this swap space’s label
priority (int) – this swap space’s priority
priority (int) – this swap space’s priority
@@ -2638,8 +2638,8 @@ Submodules
- Parameters:
-
@@ -2671,7 +2671,7 @@ SubmodulesTrue if this format can be set up, otherwise False
- Return type:
--
+
-
@@ -2787,10 +2787,10 @@ Submodules
- Parameters:
-label (str) – The label to be checked
+label (str) – The label to be checked
- Return type:
--
+
-
- Returns:
True if the format of the label is OK, otherwise False
@@ -3418,7 +3418,7 @@ Navigation
-
previous |
-
+
diff --git a/blivet/blivet.html b/blivet/blivet.html
index 6995c8d4f..790ae81f9 100644
--- a/blivet/blivet.html
+++ b/blivet/blivet.html
@@ -6,7 +6,7 @@
- blivet package — Blivet 3.8.1 documentation
+ blivet package — Blivet 3.8.2 documentation
@@ -37,7 +37,7 @@ Navigation
-
previous |
-
+
@@ -2360,7 +2360,7 @@ Submodules
-
class blivet.actionlist.ActionList(addfunc=None, removefunc=None)¶
-Bases: object
+Bases: object
-
add(action)¶
@@ -2376,10 +2376,10 @@ SubmodulesParameters:
device (StorageDevice or None) – device to match
action_type (str or None) – action type to match (eg: “create”, “destroy”)
object_type (str or None) – operand type to match (eg: “device” or “format”)
path (str or None) – device path to match
devid (int or None) – device id to match
action_type (str or None) – action type to match (eg: “create”, “destroy”)
object_type (str or None) – operand type to match (eg: “device” or “format”)
path (str or None) – device path to match
devid (int or None) – device id to match
- Returns:
@@ -2592,7 +2592,7 @@ Submodulesboolean
- Parameters:
-bits (int) – The number of bits used to define a memory address.
+bits (int) – The number of bits used to define a memory address.
Submodulesboolean
- Parameters:
-bits (int) – The number of bits used to define a memory address.
+bits (int) – The number of bits used to define a memory address.
Submodulesboolean
- Parameters:
-bits (int) – The number of bits used to define a memory address.
+bits (int) – The number of bits used to define a memory address.
Submodules
-
class blivet.blivet.Blivet¶
-Bases: object
+Bases: object
Top-level class for managing storage configuration.
-
@@ -2783,7 +2783,7 @@
Submoduleslist of dependent devices
- Return type:
--
+
-
@@ -2878,15 +2878,15 @@ Submodules
- Parameters:
-partitions (list) – overrides partitions
partitions (list) – overrides partitions
- Returns:
dict with disk name keys and tuple (disk, fs) free values
- Return type:
--
+
-
@@ -2973,9 +2973,9 @@ Submodules
- Parameters:
-fmt_args (dict) – arguments for format constructor
mountpoint (str) – mountpoint for format (filesystem)
subvol (bool) – whether this is a subvol (as opposed to a volume)
fmt_args (dict) – arguments for format constructor
mountpoint (str) – mountpoint for format (filesystem)
subvol (bool) – whether this is a subvol (as opposed to a volume)
- Returns:
@@ -3004,8 +3004,8 @@ Submodules
- Parameters:
-
- Returns:
@@ -3031,14 +3031,14 @@ Submodules
- Parameters:
-fmt_type (str) – format type
fmt_args (dict) – arguments for format constructor
mountpoint (str) – mountpoint for format (filesystem)
thin_pool (bool) – whether to create a thin pool
thin_volume (bool) – whether to create a thin volume
vdo_pool (bool) – whether to create a vdo pool
vdo_lv (bool) – whether to create a vdo lv
cache_pool (bool) – whether to create a cache pool
fmt_type (str) – format type
fmt_args (dict) – arguments for format constructor
mountpoint (str) – mountpoint for format (filesystem)
thin_pool (bool) – whether to create a thin pool
thin_volume (bool) – whether to create a thin volume
vdo_pool (bool) – whether to create a vdo pool
vdo_lv (bool) – whether to create a vdo lv
cache_pool (bool) – whether to create a cache pool
- Returns:
@@ -3067,8 +3067,8 @@ SubmodulesParameters:
vg (LVMVolumeGroupDevice) – VG to create the new LV in
name (str) – name of the new LV
seg_type (str) – segment type of the new LV
name (str) – name of the new LV
seg_type (str) – segment type of the new LV
from_lvs (tuple of LVMLogicalVolumeDevice) – LVs to create the new LV from (in the (data_lv, metadata_lv) order)
Submodules
- Parameters:
-
- Returns:
@@ -3112,9 +3112,9 @@ Submodules
- Parameters:
-
@@ -3128,7 +3128,7 @@ Submodules
- Parameters:
-mountpoint (str) – mountpoint for filesystem
+mountpoint (str) – mountpoint for filesystem
- Returns:
the new device
@@ -3251,7 +3251,7 @@ Submodules
- Parameters:
-cleanup_only (bool) – prepare the tree only to deactivate devices
+cleanup_only (bool) – prepare the tree only to deactivate devices
See devicetree.Devicetree.populate() for more information
@@ -3345,7 +3345,7 @@
Submodulesthe suggested name
- Return type:
--
+
-
@@ -3358,16 +3358,16 @@ SubmodulesParameters:
-
- Returns:
the suggested name
- Return type:
--
+
-
@@ -3424,7 +3424,7 @@ Submodules
-
class blivet.callbacks.CallbackList¶
-Bases: object
+Bases: object
-
add(cb)¶
@@ -3442,7 +3442,7 @@ Submodules
-
class blivet.callbacks.Callbacks¶
-Bases: object
+Bases: object
A collection of callbacks for various events
Each trigger/event gets a list of callbacks to run, represented by an
instance of CallbackList.
@@ -3523,7 +3523,7 @@ Submodules
-
class blivet.callbacks.CreateFormatPostData(msg)¶
-Bases: tuple
+Bases: tuple
Create new instance of CreateFormatPostData(msg,)
-
@@ -3536,7 +3536,7 @@
Submodules
-
class blivet.callbacks.CreateFormatPreData(msg)¶
-Bases: tuple
+Bases: tuple
Create new instance of CreateFormatPreData(msg,)
-
@@ -3549,7 +3549,7 @@
Submodules
-
class blivet.callbacks.ReportProgressData(msg)¶
-Bases: tuple
+Bases: tuple
Create new instance of ReportProgressData(msg,)
-
@@ -3562,7 +3562,7 @@
Submodules
-
class blivet.callbacks.ResizeFormatPostData(msg)¶
-Bases: tuple
+Bases: tuple
Create new instance of ResizeFormatPostData(msg,)
-
@@ -3575,7 +3575,7 @@
Submodules
-
class blivet.callbacks.ResizeFormatPreData(msg)¶
-Bases: tuple
+Bases: tuple
Create new instance of ResizeFormatPreData(msg,)
-
@@ -3588,7 +3588,7 @@
Submodules
-
class blivet.callbacks.WaitForEntropyData(msg, min_entropy)¶
-Bases: tuple
+Bases: tuple
Create new instance of WaitForEntropyData(msg, min_entropy)
-
@@ -4544,12 +4544,12 @@
SubmodulesBlivet) – a Blivet instance
size (Size) – the desired size for the device
disks (list of StorageDevice) – the set of disks to use
fstype (str) – filesystem type
mountpoint (str) – filesystem mount point
label (str) – filesystem label text
fstype (str) – filesystem type
mountpoint (str) – filesystem mount point
label (str) – filesystem label text
raid_level (any valid RAID level descriptor) – raid level descriptor
encrypted (bool) – whether to encrypt (boolean)
name (str) – name of requested device
encrypted (bool) – whether to encrypt (boolean)
name (str) – name of requested device
device (StorageDevice) – an already-defined but non-existent device to
adjust instead of creating a new device
Submodules
- Parameters:
-container_name (str) – name of requested container
container_name (str) – name of requested container
container_raid_level (any valid RAID level descriptor) – raid level for container
container_encrypted (bool) – whether to encrypt the container
container_encrypted (bool) – whether to encrypt the container
container_size (Size, SIZE_POLICY_AUTO (the default),
or SIZE_POLICY_MAX) – requested container size
min_luks_entropy (int) – minimum entropy in bits required for
+
min_luks_entropy (int) – minimum entropy in bits required for
LUKS format creation
luks_version (str) – luks format version (“luks1” or “luks2”)
luks_version (str) – luks format version (“luks1” or “luks2”)
pbkdf_args (LUKS2PBKDFArgs) – optional arguments for LUKS2 key derivation function
luks_sector_size (int) – encryption sector size (use only with LUKS version 2)
luks_sector_size (int) – encryption sector size (use only with LUKS version 2)
@@ -4598,7 +4598,7 @@ Submodules
-
class blivet.devicefactory.DeviceFactory(storage, **kwargs)¶
-Bases: object
+Bases: object
Class for creation of devices based on a top-down specification
DeviceFactory instances can be combined/stacked to create more complex
device stacks like lvm with md pvs.
@@ -4706,12 +4706,12 @@ SubmodulesBlivet) – a Blivet instance
size (Size) – the desired size for the device
disks (list of StorageDevice) – the set of disks to use
fstype (str) – filesystem type
mountpoint (str) – filesystem mount point
label (str) – filesystem label text
fstype (str) – filesystem type
mountpoint (str) – filesystem mount point
label (str) – filesystem label text
raid_level (any valid RAID level descriptor) – raid level descriptor
encrypted (bool) – whether to encrypt (boolean)
name (str) – name of requested device
encrypted (bool) – whether to encrypt (boolean)
name (str) – name of requested device
device (StorageDevice) – an already-defined but non-existent device to
adjust instead of creating a new device
Submodules
- Parameters:
-container_name (str) – name of requested container
container_name (str) – name of requested container
container_raid_level (any valid RAID level descriptor) – raid level for container
container_encrypted (bool) – whether to encrypt the container
container_encrypted (bool) – whether to encrypt the container
container_size (Size, SIZE_POLICY_AUTO (the default),
or SIZE_POLICY_MAX) – requested container size
min_luks_entropy (int) – minimum entropy in bits required for
+
min_luks_entropy (int) – minimum entropy in bits required for
LUKS format creation
luks_version (str) – luks format version (“luks1” or “luks2”)
luks_version (str) – luks format version (“luks1” or “luks2”)
pbkdf_args (LUKS2PBKDFArgs) – optional arguments for LUKS2 key derivation function
luks_sector_size (int) – encryption sector size (use only with LUKS version 2)
luks_sector_size (int) – encryption sector size (use only with LUKS version 2)
@@ -4826,12 +4826,12 @@ SubmodulesBlivet) – a Blivet instance
size (Size) – the desired size for the device
disks (list of StorageDevice) – the set of disks to use
fstype (str) – filesystem type
mountpoint (str) – filesystem mount point
label (str) – filesystem label text
fstype (str) – filesystem type
mountpoint (str) – filesystem mount point
label (str) – filesystem label text
raid_level (any valid RAID level descriptor) – raid level descriptor
encrypted (bool) – whether to encrypt (boolean)
name (str) – name of requested device
encrypted (bool) – whether to encrypt (boolean)
name (str) – name of requested device
device (StorageDevice) – an already-defined but non-existent device to
adjust instead of creating a new device
Submodules
- Parameters:
-container_name (str) – name of requested container
container_name (str) – name of requested container
container_raid_level (any valid RAID level descriptor) – raid level for container
container_encrypted (bool) – whether to encrypt the container
container_encrypted (bool) – whether to encrypt the container
container_size (Size, SIZE_POLICY_AUTO (the default),
or SIZE_POLICY_MAX) – requested container size
min_luks_entropy (int) – minimum entropy in bits required for
+
min_luks_entropy (int) – minimum entropy in bits required for
LUKS format creation
luks_version (str) – luks format version (“luks1” or “luks2”)
luks_version (str) – luks format version (“luks1” or “luks2”)
pbkdf_args (LUKS2PBKDFArgs) – optional arguments for LUKS2 key derivation function
luks_sector_size (int) – encryption sector size (use only with LUKS version 2)
luks_sector_size (int) – encryption sector size (use only with LUKS version 2)
@@ -4946,12 +4946,12 @@ SubmodulesBlivet) – a Blivet instance
size (Size) – the desired size for the device
disks (list of StorageDevice) – the set of disks to use
fstype (str) – filesystem type
mountpoint (str) – filesystem mount point
label (str) – filesystem label text
fstype (str) – filesystem type
mountpoint (str) – filesystem mount point
label (str) – filesystem label text
raid_level (any valid RAID level descriptor) – raid level descriptor
encrypted (bool) – whether to encrypt (boolean)
name (str) – name of requested device
encrypted (bool) – whether to encrypt (boolean)
name (str) – name of requested device
device (StorageDevice) – an already-defined but non-existent device to
adjust instead of creating a new device
Submodules
- Parameters:
-container_name (str) – name of requested container
container_name (str) – name of requested container
container_raid_level (any valid RAID level descriptor) – raid level for container
container_encrypted (bool) – whether to encrypt the container
container_encrypted (bool) – whether to encrypt the container
container_size (Size, SIZE_POLICY_AUTO (the default),
or SIZE_POLICY_MAX) – requested container size
min_luks_entropy (int) – minimum entropy in bits required for
+
min_luks_entropy (int) – minimum entropy in bits required for
LUKS format creation
luks_version (str) – luks format version (“luks1” or “luks2”)
luks_version (str) – luks format version (“luks1” or “luks2”)
pbkdf_args (LUKS2PBKDFArgs) – optional arguments for LUKS2 key derivation function
luks_sector_size (int) – encryption sector size (use only with LUKS version 2)
luks_sector_size (int) – encryption sector size (use only with LUKS version 2)
@@ -4998,20 +4998,20 @@ Submodules
- Parameters:
-pool_name (str) – name for the VDO pool, if not specified unique name will be generated
pool_name (str) – name for the VDO pool, if not specified unique name will be generated
virtual_size – size for the VDO volume, usually bigger than pool size, if not
specified physical size (pool size) will be used
compression (bool) – whether to enable compression (defaults to True)
deduplication (bool) – whether to enable deduplication (defaults to True)
compression (bool) – whether to enable compression (defaults to True)
deduplication (bool) – whether to enable deduplication (defaults to True)
storage (Blivet) – a Blivet instance
size (Size) – the desired size for the device
disks (list of StorageDevice) – the set of disks to use
fstype (str) – filesystem type
mountpoint (str) – filesystem mount point
label (str) – filesystem label text
fstype (str) – filesystem type
mountpoint (str) – filesystem mount point
label (str) – filesystem label text
raid_level (any valid RAID level descriptor) – raid level descriptor
encrypted (bool) – whether to encrypt (boolean)
name (str) – name of requested device
encrypted (bool) – whether to encrypt (boolean)
name (str) – name of requested device
device (StorageDevice) – an already-defined but non-existent device to
adjust instead of creating a new device
@@ -5025,16 +5025,16 @@ Submodules
- Parameters:
-container_name (str) – name of requested container
container_name (str) – name of requested container
container_raid_level (any valid RAID level descriptor) – raid level for container
container_encrypted (bool) – whether to encrypt the container
container_encrypted (bool) – whether to encrypt the container
container_size (Size, SIZE_POLICY_AUTO (the default),
or SIZE_POLICY_MAX) – requested container size
min_luks_entropy (int) – minimum entropy in bits required for
+
min_luks_entropy (int) – minimum entropy in bits required for
LUKS format creation
luks_version (str) – luks format version (“luks1” or “luks2”)
luks_version (str) – luks format version (“luks1” or “luks2”)
pbkdf_args (LUKS2PBKDFArgs) – optional arguments for LUKS2 key derivation function
luks_sector_size (int) – encryption sector size (use only with LUKS version 2)
luks_sector_size (int) – encryption sector size (use only with LUKS version 2)
@@ -5051,12 +5051,12 @@ SubmodulesBlivet) – a Blivet instance
size (Size) – the desired size for the device
disks (list of StorageDevice) – the set of disks to use
fstype (str) – filesystem type
mountpoint (str) – filesystem mount point
label (str) – filesystem label text
fstype (str) – filesystem type
mountpoint (str) – filesystem mount point
label (str) – filesystem label text
raid_level (any valid RAID level descriptor) – raid level descriptor
encrypted (bool) – whether to encrypt (boolean)
name (str) – name of requested device
encrypted (bool) – whether to encrypt (boolean)
name (str) – name of requested device
device (StorageDevice) – an already-defined but non-existent device to
adjust instead of creating a new device
Submodules
- Parameters:
-container_name (str) – name of requested container
container_name (str) – name of requested container
container_raid_level (any valid RAID level descriptor) – raid level for container
container_encrypted (bool) – whether to encrypt the container
container_encrypted (bool) – whether to encrypt the container
container_size (Size, SIZE_POLICY_AUTO (the default),
or SIZE_POLICY_MAX) – requested container size
min_luks_entropy (int) – minimum entropy in bits required for
+
min_luks_entropy (int) – minimum entropy in bits required for
LUKS format creation
luks_version (str) – luks format version (“luks1” or “luks2”)
luks_version (str) – luks format version (“luks1” or “luks2”)
pbkdf_args (LUKS2PBKDFArgs) – optional arguments for LUKS2 key derivation function
luks_sector_size (int) – encryption sector size (use only with LUKS version 2)
luks_sector_size (int) – encryption sector size (use only with LUKS version 2)
@@ -5134,12 +5134,12 @@ SubmodulesBlivet) – a Blivet instance
size (Size) – the desired size for the device
disks (list of StorageDevice) – the set of disks to use
fstype (str) – filesystem type
mountpoint (str) – filesystem mount point
label (str) – filesystem label text
fstype (str) – filesystem type
mountpoint (str) – filesystem mount point
label (str) – filesystem label text
raid_level (any valid RAID level descriptor) – raid level descriptor
encrypted (bool) – whether to encrypt (boolean)
name (str) – name of requested device
encrypted (bool) – whether to encrypt (boolean)
name (str) – name of requested device
device (StorageDevice) – an already-defined but non-existent device to
adjust instead of creating a new device
Submodules
- Parameters:
-container_name (str) – name of requested container
container_name (str) – name of requested container
container_raid_level (any valid RAID level descriptor) – raid level for container
container_encrypted (bool) – whether to encrypt the container
container_encrypted (bool) – whether to encrypt the container
container_size (Size, SIZE_POLICY_AUTO (the default),
or SIZE_POLICY_MAX) – requested container size
min_luks_entropy (int) – minimum entropy in bits required for
+
min_luks_entropy (int) – minimum entropy in bits required for
LUKS format creation
luks_version (str) – luks format version (“luks1” or “luks2”)
luks_version (str) – luks format version (“luks1” or “luks2”)
pbkdf_args (LUKS2PBKDFArgs) – optional arguments for LUKS2 key derivation function
luks_sector_size (int) – encryption sector size (use only with LUKS version 2)
luks_sector_size (int) – encryption sector size (use only with LUKS version 2)
@@ -5227,12 +5227,12 @@ SubmodulesBlivet) – a Blivet instance
size (Size) – the desired size for the device
disks (list of StorageDevice) – the set of disks to use
fstype (str) – filesystem type
mountpoint (str) – filesystem mount point
label (str) – filesystem label text
fstype (str) – filesystem type
mountpoint (str) – filesystem mount point
label (str) – filesystem label text
raid_level (any valid RAID level descriptor) – raid level descriptor
encrypted (bool) – whether to encrypt (boolean)
name (str) – name of requested device
encrypted (bool) – whether to encrypt (boolean)
name (str) – name of requested device
device (StorageDevice) – an already-defined but non-existent device to
adjust instead of creating a new device
Submodules
- Parameters:
-container_name (str) – name of requested container
container_name (str) – name of requested container
container_raid_level (any valid RAID level descriptor) – raid level for container
container_encrypted (bool) – whether to encrypt the container
container_encrypted (bool) – whether to encrypt the container
container_size (Size, SIZE_POLICY_AUTO (the default),
or SIZE_POLICY_MAX) – requested container size
min_luks_entropy (int) – minimum entropy in bits required for
+
min_luks_entropy (int) – minimum entropy in bits required for
LUKS format creation
luks_version (str) – luks format version (“luks1” or “luks2”)
luks_version (str) – luks format version (“luks1” or “luks2”)
pbkdf_args (LUKS2PBKDFArgs) – optional arguments for LUKS2 key derivation function
luks_sector_size (int) – encryption sector size (use only with LUKS version 2)
luks_sector_size (int) – encryption sector size (use only with LUKS version 2)
Submodules
- Parameters:
-device_type (int) – an enumeration indicating the device type
+device_type (int) – an enumeration indicating the device type
- Returns:
a set of supported raid levels for this device type
@@ -5323,13 +5323,13 @@ Submodules
- Parameters:
-device_type (int) – an enumeration indicating the device type
+device_type (int) – an enumeration indicating the device type
- Returns:
True if this device type is supported
- Return type:
--
+
-
@@ -5344,8 +5344,8 @@ Submodules
- Parameters:
-
@@ -5356,8 +5356,8 @@ Submodules
- Parameters:
-
@@ -5368,7 +5368,7 @@ Submodules
-
class blivet.devicetree.DeviceTreeBase(ignored_disks=None, exclusive_disks=None)¶
-Bases: object
+Bases: object
A quasi-tree that represents the devices in the system.
The tree contains a list of StorageDevice instances,
which does not necessarily reflect the actual state of the system’s
@@ -5385,8 +5385,8 @@
Submodules
- Parameters:
-
@@ -5427,7 +5427,7 @@ Submodulesset of devices
- Return type:
-set of strings
+set of strings
Raise ValueError if unknown tag encountered in taglist
@@ -5452,7 +5452,7 @@ SubmodulesParameters:
-
@@ -5465,9 +5465,9 @@ Submodules
- Parameters:
-
- Returns:
@@ -5486,9 +5486,9 @@ Submodules
- Parameters:
-label (str) – the filesystem label to match
incomplete (bool) – include incomplete devices in search
hidden (bool) – include hidden devices in search
label (str) – the filesystem label to match
incomplete (bool) – include incomplete devices in search
hidden (bool) – include hidden devices in search
- Returns:
@@ -5507,9 +5507,9 @@ Submodules
- Parameters:
-
- Returns:
@@ -5530,9 +5530,9 @@ Submodules
- Parameters:
-
- Returns:
@@ -5551,9 +5551,9 @@ Submodules
- Parameters:
-
- Returns:
@@ -5572,9 +5572,9 @@ Submodules
- Parameters:
-
- Returns:
@@ -5701,8 +5701,8 @@ Submodules
- Parameters:
-
@@ -5718,11 +5718,11 @@ Submodules
- Parameters:
-devspec (str) – a string describing a block device
devspec (str) – a string describing a block device
blkid_tab (BlkidTab) – blkid info
crypt_tab (CryptTab) – crypto info
options (str) – mount options
subvolspec (str) – btrfs subvolume specification
options (str) – mount options
subvolspec (str) – btrfs subvolume specification
- Returns:
@@ -5795,7 +5795,7 @@ Submodules
-
exception blivet.errors.BTRFSValueError(*args, **kwargs)¶
-Bases: BTRFSError, ValueError
+Bases: BTRFSError, ValueError
@@ -5926,7 +5926,7 @@ Submodules
-
exception blivet.errors.DuplicateUUIDError(message, dev_name=None)¶
-Bases: UnusableConfigurationError, ValueError
+Bases: UnusableConfigurationError, ValueError
-
suggestion = 'This is usually caused by cloning the device image resulting in duplication of the UUID value which should be unique. In that case you can either disconnect one of the devices or reformat it.'¶
@@ -5966,7 +5966,7 @@ Submodules
-
exception blivet.errors.FCoEError(*args, **kwargs)¶
-Bases: StorageError, OSError
+Bases: StorageError, OSError
@@ -6044,13 +6044,13 @@ Submodules
-
exception blivet.errors.ISCSIError(*args, **kwargs)¶
-Bases: StorageError, OSError
+Bases: StorageError, OSError
-
exception blivet.errors.InconsistentPVSectorSize(*args, **kwargs)¶
-Bases: DeviceError, ValueError
+Bases: DeviceError, ValueError
@@ -6121,7 +6121,7 @@ Submodules
-
exception blivet.errors.NVMeError(*args, **kwargs)¶
-Bases: StorageError, OSError
+Bases: StorageError, OSError
@@ -6169,7 +6169,7 @@ Submodules
-
exception blivet.errors.StorageError(*args, **kwargs)¶
-Bases: Exception
+Bases: Exception
@@ -6221,7 +6221,7 @@ Submodules
-
class blivet.fcoe.FCoE¶
-Bases: object
+Bases: object
FCoE utility class.
This class will automatically discover and connect to EDD configured
FCoE SAN’s when the startup() method gets called. It can also be
@@ -6270,7 +6270,7 @@
Submodules
-
class blivet.flags.Flags¶
-Bases: object
+Bases: object
-
get_boot_cmdline()¶
@@ -6302,13 +6302,13 @@ Submodules
-
class blivet.iscsi.LoginInfo(node, logged_in)¶
-Bases: object
+Bases: object
-
class blivet.iscsi.NodeInfo(name, tpgt, address, port, iface)¶
-Bases: object
+Bases: object
Simple representation of node information.
-
@@ -6322,7 +6322,7 @@
Submodules
-
class blivet.iscsi.TargetInfo(ipaddr, port)¶
-Bases: tuple
+Bases: tuple
Create new instance of TargetInfo(ipaddr, port)
-
@@ -6346,7 +6346,7 @@
Submodules
-
class blivet.iscsi.iSCSI¶
-Bases: object
+Bases: object
iSCSI utility class.
This class will automatically discover and login to iBFT (or
other firmware) configured iscsi devices when the startup() method
@@ -6380,18 +6380,18 @@
Submodules
- Parameters:
-ipaddr (str) – target IP address
port (str) – target port
user (str or NoneType) – CHAP username for node login
pw (str or NoneType) – CHAP password for node login
ipaddr (str) – target IP address
port (str) – target port
user (str or NoneType) – CHAP username for node login
pw (str or NoneType) – CHAP password for node login
user_in – reverse CHAP username for node login
pw_in (str or NoneType) – reverse CHAP password for node login
target (str or NoneType) – only add this target (if present)
iface (str or NoneType) – interface to use
discover_user (str or NoneType) – CHAP username for discovery
discover_pw (str or NoneType) – CHAP password for discovery
pw_in (str or NoneType) – reverse CHAP password for node login
target (str or NoneType) – only add this target (if present)
iface (str or NoneType) – interface to use
discover_user (str or NoneType) – CHAP username for discovery
discover_pw (str or NoneType) – CHAP password for discovery
discover_user_in – reverse CHAP username for discovery
discover_pw_in (str or NoneType) – reverse CHAP password for discovery
discover_pw_in (str or NoneType) – reverse CHAP password for discovery
@@ -6453,10 +6453,10 @@ SubmodulesParameters:
node (NodeInfo) – node to log into
username (str) – username to use when logging in
password (str) – password to use when logging in
r_username (str) – r_username to use when logging in
r_password (str) – r_password to use when logging in
username (str) – username to use when logging in
password (str) – password to use when logging in
r_username (str) – r_username to use when logging in
r_password (str) – r_password to use when logging in
@@ -6507,7 +6507,7 @@ Submodules
-
class blivet.mounts.MountsCache¶
-Bases: object
+Bases: object
Cache object for system mountpoints; checks /proc/mounts and
/proc/self/mountinfo for up-to-date information.
@@ -6518,14 +6518,14 @@ SubmodulesParameters:
-
- Returns:
list of mountpoints (path)
- Return type:
--
+
-
@@ -6541,7 +6541,7 @@ Submodules
- Parameters:
-path (str) – Path to check
+path (str) – Path to check
Submodules
-
class blivet.nvme.NVMe¶
-Bases: object
+Bases: object
NVMe utility class.
Warning
@@ -6568,7 +6568,7 @@ Submodules
-
-write(root)¶
+write(root, overwrite=True)¶
@@ -6585,12 +6585,12 @@ Submodules
-
class blivet.partitioning.Chunk(length, requests=None)¶
-Bases: object
+Bases: object
A free region from which devices will be allocated
- Parameters:
-
@@ -6618,7 +6618,7 @@ Submodules
- Parameters:
-uniform (bool) – grow requests uniformly instead of proportionally
+uniform (bool) – grow requests uniformly instead of proportionally
The default mode of growth is as follows: given a total number of
@@ -6659,7 +6659,7 @@
SubmodulesParameters:
-
- Raises:
@@ -6695,14 +6695,14 @@ SubmodulesParameters:
-
- Returns:
the new base or None if no base was given
- Return type:
-int or None
+int or None
Submodules
-
class blivet.partitioning.Request(device)¶
-Bases: object
+Bases: object
A partition request.
Request instances are used for calculating how much to grow
partitions.
@@ -6835,14 +6835,14 @@ Submodules
-
class blivet.partitioning.SameSizeSet(devices, size, grow=False, max_size=None)¶
-Bases: object
+Bases: object
Set of device requests with a common target size.
- Parameters:
-
@@ -6867,7 +6867,7 @@ Submodules
-
class blivet.partitioning.TotalSizeSet(devices, size)¶
-Bases: object
+Bases: object
Set of device requests with a target combined size.
This will be handled by growing the requests until the desired combined
size has been achieved.
@@ -6948,8 +6948,8 @@ Submodulesparted.Geometry) – the free region in which to place the new partition
part_type (a parted.PARTITION_* constant) – the partition type
size (Size) – size of the new partition
start (int) – starting sector for the partition
end (int) – ending sector for the partition
start (int) – starting sector for the partition
end (int) – ending sector for the partition
- Raises:
@@ -7048,10 +7048,10 @@ Submodulesparted.Disk) – the disk
part_type (one of parted's PARTITION_* constants) – the type of partition we want to allocate
req_size (Size) – the requested size of the partition in MiB
start (int) – requested start sector for the partition
boot (bool) – whether this will be a bootable partition
start (int) – requested start sector for the partition
boot (bool) – whether this will be a bootable partition
best_free (parted.Geometry) – current best free region for this partition
grow (bool) – indicates whether this is a growable request
grow (bool) – indicates whether this is a growable request
alignment (parted.Alignment) – disk alignment requirements
SubmodulesParameters:
-
- Returns:
@@ -7210,7 +7210,7 @@ Submodulessee above
- Return type:
--
+
-
@@ -7247,7 +7247,7 @@ SubmodulesParameters:
-
@@ -7262,7 +7262,7 @@ Submodules
- Parameters:
-
@@ -7290,7 +7290,7 @@ Submodulessector count
- Return type:
--
+
-
@@ -7336,7 +7336,7 @@ Submodules
-
exception blivet.safe_dbus.SafeDBusError¶
-Bases: Exception
+Bases: Exception
Class for exceptions defined in this module.
Submodules
- Parameters:
-service (str) – DBus service to use
obj_path (str) – object path of the object to call method on
iface (str) – interface to use
method (str) – name of the method to call
service (str) – DBus service to use
obj_path (str) – object path of the object to call method on
iface (str) – interface to use
method (str) – name of the method to call
args (GVariant) – arguments to pass to the method
connection (Gio.DBusConnection) – connection to use (if None, a new connection is
established)
SubmodulesRaises:
DBusCallError – if some DBus related error appears
OSError – if unable to set the effective UID
OSError – if unable to set the effective UID
Submodules
- Parameters:
-service (str) – DBus service to use
obj_path (str) – object path
iface (str) – interface to use
service (str) – DBus service to use
obj_path (str) – object path
iface (str) – interface to use
connection (Gio.DBusConnection) – connection to use (if None, a new connection is
established)
@@ -7447,10 +7447,10 @@ Submodules
- Parameters:
-service (str) – DBus service to use
obj_path (str) – object path
iface (str) – interface to use
prop_name (str) – name of the property
service (str) – DBus service to use
obj_path (str) – object path
iface (str) – interface to use
prop_name (str) – name of the property
connection (Gio.DBusConnection) – connection to use (if None, a new connection is
established)
@@ -7499,7 +7499,7 @@ SubmodulesDecimal
- Raises:
-ValueError – if Size unit specifier is non-positive
+ValueError – if Size unit specifier is non-positive
SubmodulesParameters:
min_unit (one of the B, KiB, MiB,... (binary) units from this module
-or str ("B", "KiB",...)) – the smallest unit the returned representation should use
max_places (an integer type or NoneType) – number of decimal places to use
xlate (bool) – If True, translate for current locale
xlate (bool) – If True, translate for current locale
- Returns:
a representation of the size
- Return type:
--
+
-
@@ -7592,7 +7592,7 @@ SubmodulesParameters:
-
- Return type:
@@ -7620,9 +7620,9 @@ SubmodulesParameters:
log_func – the desired logging function
fmt_str (str) – a format string for any additional message
fmt_args (a list of str) – arguments for the format string
ignored (bool) – True if no action is taken regarding the exception
fmt_str (str) – a format string for any additional message
fmt_args (a list of str) – arguments for the format string
ignored (bool) – True if no action is taken regarding the exception
Submodules
-
class blivet.threads.SynchronizedABCMeta(name, bases, dct)¶
-Bases: SynchronizedMeta, ABCMeta
+Bases: SynchronizedMeta, ABCMeta
-
class blivet.threads.SynchronizedMeta(name, bases, dct)¶
-Bases: type
+Bases: type
Metaclass that wraps all methods with the exclusive decorator.
To prevent specific methods from being wrapped, add the method name(s)
to a class attribute called _unsynchronized_methods (list of str).
@@ -7688,7 +7688,7 @@ Submodules
-
exception blivet.tsort.CyclicGraphError¶
-Bases: Exception
+Bases: Exception
@@ -7879,10 +7879,10 @@ Submodulesblivet.udev.device_get_md_container(info)¶
-
@@ -7893,13 +7893,13 @@ Submodules
- Parameters:
-info (dict) – dictionary of name-value pairs as strings
+info (dict) – dictionary of name-value pairs as strings
- Returns:
the uuid of this device (which is a member of an md array)
- Return type:
-str or NoneType
+str or NoneType
Submodules
- Parameters:
-info (dict) – dictionary of name-value pairs as strings
+info (dict) – dictionary of name-value pairs as strings
- Returns:
the number of devices belonging to this device’s md array
- Return type:
--
+
-
- Raises:
KeyError, ValueError
@@ -7931,13 +7931,13 @@ Submodules
- Parameters:
-info (dict) – dictionary of name-value pairs as strings
+info (dict) – dictionary of name-value pairs as strings
- Returns:
the RAID level of this device’s md array
- Return type:
-str or NoneType
+str or NoneType
Submodules
- Parameters:
-info (dict) – dictionary of name-value pairs as strings
+info (dict) – dictionary of name-value pairs as strings
- Returns:
the metadata version number of the md array
- Return type:
-str or NoneType
+str or NoneType
Submodules
- Parameters:
-info (dict) – dictionary of name-value pairs as strings
+info (dict) – dictionary of name-value pairs as strings
- Returns:
the name of this device’s md array
- Return type:
-str or NoneType
+str or NoneType
Submodules
- Parameters:
-info (dict) – dictionary of name-value pairs as strings
+info (dict) – dictionary of name-value pairs as strings
- Returns:
the UUID of this device’s md array
- Return type:
--
+
-
- Raises:
KeyError
@@ -8064,7 +8064,7 @@ Submoduleslist of symbolic links
- Return type:
--
+
-
@@ -8080,13 +8080,13 @@ Submodules
- Parameters:
-udev_info (dict) – dictionary of name-value pairs as strings
+udev_info (dict) – dictionary of name-value pairs as strings
- Returns:
a UUID or None
- Return type:
-str or NoneType
+str or NoneType
Submodulesblivet.udev.resolve_glob(glob)¶
- Parameters:
-