UDisks Reference Manual: UDisks Reference Manual

UDisks Reference Manual

For version 2.10.91 — the latest version of this documentation can be found at http://storaged.org/doc/udisks2-api/latest/.

I. Manual pages and Overview
  udisksctl — The udisks command line tool
  udisksd — The udisks system daemon
  udisks — Disk Manager
  umount.udisks2 — unmount file systems that have been mounted by UDisks2
  udisks2.conf — The udisks2 configuration file
  udisks2_lsm.conf — The UDisks2 LSM Module configuration file
  Configurable mount options
II. D-Bus API Reference
  Overview
    The org.freedesktop.UDisks2 bus name
    The /org/freedesktop/UDisks2 object
    The /org/freedesktop/UDisks2/Manager object
    The /org/freedesktop/UDisks2/block_devices/* objects
    The /org/freedesktop/UDisks2/drives/* objects
    The /org/freedesktop/UDisks2/mdraid/* objects
    The /org/freedesktop/UDisks2/iscsi/session[0-9]+ objects
    The /org/freedesktop/UDisks2/jobs/* objects
    Authorization Checks
    The `options` parameter
  D-Bus Interfaces
    org.freedesktop.UDisks2.Manager — Manager singleton
    org.freedesktop.UDisks2.Drive — Disk drives
    org.freedesktop.UDisks2.Drive.Ata — Disk drives using the ATA command-set
    org.freedesktop.UDisks2.MDRaid — Linux Software RAID
    org.freedesktop.UDisks2.Block — Block device
    org.freedesktop.UDisks2.Partition — Block device representing a partition
    org.freedesktop.UDisks2.PartitionTable — Block device containing a partition table
    org.freedesktop.UDisks2.Filesystem — Block device containing a mountable filesystem
    org.freedesktop.UDisks2.Swapspace — Block device containing swap data
    org.freedesktop.UDisks2.Encrypted — Block device containing encrypted data
    org.freedesktop.UDisks2.Loop — Block device backed by a file
    org.freedesktop.UDisks2.Job — Long-running tasks
    org.freedesktop.UDisks2.NVMe.Controller — NVMe controller device
    org.freedesktop.UDisks2.NVMe.Namespace — NVMe namespace device
    org.freedesktop.UDisks2.Manager.NVMe — NVMe host management
    org.freedesktop.UDisks2.NVMe.Fabrics — NVMe over Fabrics control interface
    org.freedesktop.UDisks2.Drive.LSM — LSM interface exported on disk objects
    org.freedesktop.UDisks2.Drive.LsmLocal — Interface exported on disk drive objects for managing
    org.freedesktop.UDisks2.Block.LVM2 — LVM2 add-on to the block device
    org.freedesktop.UDisks2.LogicalVolume — A logical volume
    org.freedesktop.UDisks2.VDOVolume — A VDO logical volume
    org.freedesktop.UDisks2.Manager.LVM2 — LVM2 add-on to the manager singleton
    org.freedesktop.UDisks2.PhysicalVolume — Block device that is a physical volume
    org.freedesktop.UDisks2.VolumeGroup — A volume group
    org.freedesktop.UDisks2.ISCSI.Session — iSCSI session.
    org.freedesktop.UDisks2.Manager.ISCSI.Initiator — iSCSI add-on to the manager singleton
    org.freedesktop.UDisks2.Manager.BTRFS — BTRFS add-on to the manager singleton
    org.freedesktop.UDisks2.Filesystem.BTRFS — BTRFS filesystem interface exported on block objects
III. Library API Reference
  UDisksClient — Utility routines for accessing the UDisks service
  UDisksObjectInfo — Detailed information about objects
  UDisksError — Possible errors that can be returned
  Generated Code
    UDisksObject — Specialized GDBusObject types
    UDisksObjectManagerClient — Generated GDBusObjectManagerClient type
    UDisksManager — Generated C code for the org.freedesktop.UDisks2.Manager D-Bus interface
    UDisksDrive — Generated C code for the org.freedesktop.UDisks2.Drive D-Bus interface
    UDisksDriveAta — Generated C code for the org.freedesktop.UDisks2.Drive.Ata D-Bus interface
    UDisksMDRaid — Generated C code for the org.freedesktop.UDisks2.MDRaid D-Bus interface
    UDisksJob — Generated C code for the org.freedesktop.UDisks2.Job D-Bus interface
    UDisksBlock — Generated C code for the org.freedesktop.UDisks2.Block D-Bus interface
    UDisksPartition — Generated C code for the org.freedesktop.UDisks2.Partition D-Bus interface
    UDisksPartitionTable — Generated C code for the org.freedesktop.UDisks2.PartitionTable D-Bus interface
    UDisksFilesystem — Generated C code for the org.freedesktop.UDisks2.Filesystem D-Bus interface
    UDisksSwapspace — Generated C code for the org.freedesktop.UDisks2.Swapspace D-Bus interface
    UDisksEncrypted — Generated C code for the org.freedesktop.UDisks2.Encrypted D-Bus interface
    UDisksLoop — Generated C code for the org.freedesktop.UDisks2.Loop D-Bus interface
    UDisksNVMeController — Generated C code for the org.freedesktop.UDisks2.NVMe.Controller D-Bus interface
    UDisksNVMeNamespace — Generated C code for the org.freedesktop.UDisks2.NVMe.Namespace D-Bus interface
    UDisksManagerNVMe — Generated C code for the org.freedesktop.UDisks2.Manager.NVMe D-Bus interface
    UDisksNVMeFabrics — Generated C code for the org.freedesktop.UDisks2.NVMe.Fabrics D-Bus interface
    UDisksDriveLSM — Generated C code for the org.freedesktop.UDisks2.Drive.LSM D-Bus interface
    UDisksDriveLsmLocal — Generated C code for the org.freedesktop.UDisks2.Drive.LsmLocal D-Bus interface
    UDisksManagerLVM2 — Generated C code for the org.freedesktop.UDisks2.Manager.LVM2 D-Bus interface
    UDisksBlockLVM2 — Generated C code for the org.freedesktop.UDisks2.Block.LVM2 D-Bus interface
    UDisksPhysicalVolume — Generated C code for the org.freedesktop.UDisks2.PhysicalVolume D-Bus interface
    UDisksVolumeGroup — Generated C code for the org.freedesktop.UDisks2.VolumeGroup D-Bus interface
    UDisksLogicalVolume — Generated C code for the org.freedesktop.UDisks2.LogicalVolume D-Bus interface
    UDisksVDOVolume — Generated C code for the org.freedesktop.UDisks2.VDOVolume D-Bus interface
    UDisksISCSISession — Generated C code for the org.freedesktop.UDisks2.ISCSI.Session D-Bus interface
    UDisksManagerISCSIInitiator — Generated C code for the org.freedesktop.UDisks2.Manager.ISCSI.Initiator D-Bus interface
    UDisksManagerBTRFS — Generated C code for the org.freedesktop.UDisks2.Manager.BTRFS D-Bus interface
    UDisksFilesystemBTRFS — Generated C code for the org.freedesktop.UDisks2.Filesystem.BTRFS D-Bus interface
IV. Daemon Implementation Details
  Core
    Utilities — Various utility routines
    Logging — Logging Routines
    UDisksDaemon — Main daemon object
    UDisksProvider — Abstract base class for all data providers
    UDisksState — Object used for recording state and cleaning up
    ATA commands — Helper routines for ATA commands
    UDisksModuleManager — Manage daemon modules
    UDisksModule — Daemon module
  State and Configuration
    UDisksMountMonitor — Monitors mounted filesystems or in-use swap devices
    UDisksFstabEntry
    UDisksCrypttabMonitor — Monitors entries in the crypttab file
    UDisksUtabMonitor — Monitors entries in the utab file
  Jobs
    UDisksBaseJob — Base class for jobs.
    UDisksSimpleJob — A simple job
    UDisksThreadedJob — Job that runs in a thread
    UDisksSpawnedJob — Job that spawns a command
  Linux-specific types
    UDisksLinuxManager — Linux implementation of UDisksManager
    UDisksLinuxManagerNVMe — Linux implementation of UDisksManagerNVMe
    UDisksLinuxProvider — Provides Linux-specific objects
    UDisksLinuxDevice — Low-level devices on Linux
  Drives on Linux
    UDisksLinuxDrive — Linux implementation of UDisksDrive
    UDisksLinuxDriveAta — Linux implementation of UDisksDriveAta
    UDisksLinuxDriveObject — Object representing a drive on Linux
    UDisksLinuxNVMeController — Linux implementation of UDisksNVMeController
    UDisksLinuxNVMeFabrics — Linux implementation of UDisksNVMeFabrics
  Linux RAID
    UDisksLinuxMDRaid — Linux implementation of UDisksMDRaid
    UDisksLinuxMDRaidObject — Object representing a Linux Software RAID array
  Block devices on Linux
    UDisksLinuxBlock — Linux implementation of UDisksBlock
    UDisksLinuxPartition — Linux implementation of UDisksPartition
    UDisksLinuxPartitionTable — Linux implementation of UDisksPartitionTable
    UDisksLinuxFilesystem — Linux implementation of UDisksFilesystem
    UDisksLinuxEncrypted — Linux implementation of UDisksEncrypted
    UDisksLinuxSwapspace — Linux implementation of UDisksSwapspace
    UDisksLinuxLoop — Linux implementation of UDisksLoop
    UDisksLinuxBlockObject — Object representing a block device on Linux.
    UDisksLinuxNVMeNamespace — Linux implementation of UDisksNVMeNamespace
Index
Annotation Glossary
Object Hierarchy

Generated by GTK-Doc V1.34.0