Storaged Reference Manual: Storaged Reference Manual

For version 2.5.2 — the latest version of this documentation can be found at https://storaged-project.github.io/doc/latest/.

I. Manual pages and Overview

storaged — The storaged system daemon
storaged-lvm — The storaged command line tool
storaged-project — Disk Manager
storagectl — The storaged command line tool
umount.storaged — unmount file systems that have been mounted by storaged
storaged.conf — The storaged configuration file
storaged_lsm.conf — The Storaged LSM Module configuration file

II. D-Bus API Reference

Overview

The org.storaged.Storaged bus name
The /org/storaged/Storaged object
The /org/storaged/Storaged/Manager object
The /org/storaged/Storaged/block_devices/* objects
The /org/storaged/Storaged/drives/* objects
The /org/storaged/Storaged/mdraid/* objects
The /org/storaged/Storaged/iscsi/session[0-9]+ objects
The /org/storaged/Storaged/jobs/* objects
Authorization Checks
The options parameter

D-Bus Interfaces

org.storaged.Storaged.Manager — Manager singleton
org.storaged.Storaged.Drive — Disk drives
org.storaged.Storaged.Drive.Ata — Disk drives using the ATA command-set
org.storaged.Storaged.MDRaid — Linux Software RAID
org.storaged.Storaged.Block — Block device
org.storaged.Storaged.Partition — Block device representing a partition
org.storaged.Storaged.PartitionTable — Block device containing a partition table
org.storaged.Storaged.Filesystem — Block device containing a mountable filesystem
org.storaged.Storaged.Swapspace — Block device containing swap data
org.storaged.Storaged.Encrypted — Block device containing encrypted data
org.storaged.Storaged.Loop — Block device backed by a file
org.storaged.Storaged.Job — Long-running tasks
org.storaged.Storaged.Manager.LSM — LSM add-on to the manager singleton
org.storaged.Storaged.Drive.LSM — LSM interface exported on disk objects
org.storaged.Storaged.Block.LVM2 — LVM2 add-on to the block device
org.storaged.Storaged.LogicalVolume — A logical volume
org.storaged.Storaged.Manager.LVM2 — LVM2 add-on to the manager singleton
org.storaged.Storaged.PhysicalVolume — Block device that is a physical volume
org.storaged.Storaged.VolumeGroup — A volume group
org.storaged.Storaged.ISCSI.Session — iSCSI session.
org.storaged.Storaged.Manager.ISCSI.Initiator — iSCSI add-on to the manager singleton
org.storaged.Storaged.Manager.BTRFS — BTRFS add-on to the manager singleton
org.storaged.Storaged.Filesystem.BTRFS — BTRFS filesystem interface exported on block objects
org.storaged.Storaged.Manager.ZRAM — ZRAM add-on to the manager singleton
org.storaged.Storaged.Block.ZRAM — ZRAM block device
org.storaged.Storaged.Manager.Bcache
org.storaged.Storaged.Block.Bcache

III. Library API Reference

StoragedClient — Utility routines for accessing the Storaged service

StoragedObjectInfo — Detailed information about objects

StoragedError — Possible errors that can be returned

Generated Code

StoragedObject — Specialized GDBusObject types
StoragedObjectManagerClient — Generated GDBusObjectManagerClient type
StoragedManager — Generated C code for the org.storaged.Storaged.Manager D-Bus interface
StoragedDrive — Generated C code for the org.storaged.Storaged.Drive D-Bus interface
StoragedDriveAta — Generated C code for the org.storaged.Storaged.Drive.Ata D-Bus interface
StoragedMDRaid — Generated C code for the org.storaged.Storaged.MDRaid D-Bus interface
StoragedJob — Generated C code for the org.storaged.Storaged.Job D-Bus interface
StoragedBlock — Generated C code for the org.storaged.Storaged.Block D-Bus interface
StoragedPartition — Generated C code for the org.storaged.Storaged.Partition D-Bus interface
StoragedPartitionTable — Generated C code for the org.storaged.Storaged.PartitionTable D-Bus interface
StoragedFilesystem — Generated C code for the org.storaged.Storaged.Filesystem D-Bus interface
StoragedSwapspace — Generated C code for the org.storaged.Storaged.Swapspace D-Bus interface
StoragedEncrypted — Generated C code for the org.storaged.Storaged.Encrypted D-Bus interface
StoragedLoop — Generated C code for the org.storaged.Storaged.Loop D-Bus interface
StoragedManagerLSM — Generated C code for the org.storaged.Storaged.Manager.LSM D-Bus interface
StoragedDriveLSM — Generated C code for the org.storaged.Storaged.Drive.LSM D-Bus interface
StoragedManagerLVM2 — Generated C code for the org.storaged.Storaged.Manager.LVM2 D-Bus interface
StoragedBlockLVM2 — Generated C code for the org.storaged.Storaged.Block.LVM2 D-Bus interface
StoragedPhysicalVolume — Generated C code for the org.storaged.Storaged.PhysicalVolume D-Bus interface
StoragedVolumeGroup — Generated C code for the org.storaged.Storaged.VolumeGroup D-Bus interface
StoragedLogicalVolume — Generated C code for the org.storaged.Storaged.LogicalVolume D-Bus interface
StoragedISCSISession — Generated C code for the org.storaged.Storaged.ISCSI.Session D-Bus interface
StoragedManagerISCSIInitiator — Generated C code for the org.storaged.Storaged.Manager.ISCSI.Initiator D-Bus interface
StoragedManagerBTRFS — Generated C code for the org.storaged.Storaged.Manager.BTRFS D-Bus interface
StoragedFilesystemBTRFS — Generated C code for the org.storaged.Storaged.Filesystem.BTRFS D-Bus interface
StoragedManagerZRAM — Generated C code for the org.storaged.Storaged.Manager.ZRAM D-Bus interface
StoragedBlockZRAM — Generated C code for the org.storaged.Storaged.Block.ZRAM D-Bus interface
StoragedManagerBcache — Generated C code for the org.storaged.Storaged.Manager.Bcache D-Bus interface
StoragedBlockBcache — Generated C code for the org.storaged.Storaged.Block.Bcache D-Bus interface

IV. Daemon Implementation Details

Core

Utilities — Various utility routines
Logging — Logging Routines
StoragedDaemon — Main daemon object
StoragedProvider — Abstract base class for all data providers
StoragedState — Object used for recording state and cleaning up
ATA commands — Helper routines for ATA commands
StoragedModuleManager — Manages daemon modules

State and Configuration

StoragedMountMonitor — Monitors mounted filesystems or in-use swap devices
StoragedFstabMonitor — Monitors entries in the fstab file
StoragedCrypttabMonitor — Monitors entries in the crypttab file

Jobs

StoragedBaseJob — Base class for jobs.
StoragedSimpleJob — A simple job
StoragedThreadedJob — Job that runs in a thread
StoragedSpawnedJob — Job that spawns a command

Linux-specific types

StoragedLinuxManager — Linux implementation of StoragedManager
StoragedLinuxProvider — Provides Linux-specific objects
StoragedLinuxDevice — Low-level devices on Linux

Drives on Linux

StoragedLinuxDrive — Linux implementation of StoragedDrive
DummyLinuxDrive — Linux implementation of DummyDriveDummy
StoragedLinuxDriveObject — Object representing a drive on Linux

Linux RAID

StoragedLinuxMDRaid — Linux implementation of StoragedMDRaid
StoragedLinuxMDRaidObject — Object representing a Linux Software RAID array

Block devices on Linux

StoragedLinuxBlock — Linux implementation of StoragedBlock
StoragedLinuxPartition — Linux implementation of StoragedPartition
StoragedLinuxPartitionTable — Linux implementation of StoragedPartitionTable
StoragedLinuxFilesystem — Linux implementation of StoragedFilesystem
StoragedLinuxEncrypted — Linux implementation of StoragedEncrypted
StoragedLinuxSwapspace — Linux implementation of StoragedSwapspace
StoragedLinuxLoop — Linux implementation of StoragedLoop
StoragedLinuxBlockObject — Object representing a block device on Linux.

Index

Index of deprecated symbols

Index of new symbols in 2.5.2

Annotation Glossary

Object Hierarchy