### Default udisks2.conf Configuration File Example

Source: https://storaged.org/doc/udisks2-api/latest/index.html/udisks2.conf.5

An example of the default udisks2.conf configuration file, showing the [udisks2] section for module settings and the [defaults] section for encryption.

```Configuration
[udisks2]
modules=*
modules_load_preference=ondemand

[defaults]
encryption=luks1
```

--------------------------------

### Manage NVMe Controller SMART Self-Test Start Operations

Source: https://storaged.org/doc/udisks2-api/latest/index.html/UDisksNVMeController

API calls for starting a SMART self-test on an NVMe controller. This includes asynchronous initiation, completion handling, and synchronous execution.

```APIDOC
void udisks_nvme_controller_call_smart_selftest_start ()
```

```APIDOC
gboolean udisks_nvme_controller_call_smart_selftest_start_finish ()
```

```APIDOC
gboolean udisks_nvme_controller_call_smart_selftest_start_sync ()
```

```APIDOC
void udisks_nvme_controller_complete_smart_selftest_start ()
```

--------------------------------

### UDisks2 Loop Device: Setup

Source: https://storaged.org/doc/udisks2-api/latest/index.html/udisks-polkit-actions

This action manages the setup of loop devices. It requires administrative authentication for any user and inactive sessions, but allows active sessions to proceed without additional authentication.

```APIDOC
Action ID: org.freedesktop.udisks2.loop-setup
Description: Manage loop devices
Message: Authentication is required to set up a loop device
Defaults:
  allow_any: auth_admin
  allow_inactive: auth_admin
  allow_active: yes
```

--------------------------------

### UDisksSwapspace 'handle-start' Signal APIDOC

Source: https://storaged.org/doc/udisks2-api/latest/index.html/UDisksSwapspace

Documents the 'handle-start' signal, emitted when a remote caller invokes the Start() D-Bus method. This signal allows handlers to manage the starting of swapspace, with similar handling logic for invocation completion as other handle-* signals.

```APIDOC
Signal Name: handle-start
Signature: gboolean user_function (UDisksSwapspace *object, GDBusMethodInvocation *invocation, GVariant *arg_options, gpointer user_data)
Description: Signal emitted when a remote caller is invoking the Start() D-Bus method.
Parameters:
  object: A UDisksSwapspace.
  invocation: A GDBusMethodInvocation.
  arg_options: Argument passed by remote caller.
  user_data: user data set when the signal handler was connected.
Returns: G_DBUS_METHOD_INVOCATION_HANDLED or TRUE if the invocation was handled, G_DBUS_METHOD_INVOCATION_UNHANDLED or FALSE to let other signal handlers run.
```

--------------------------------

### UDisks2 API: SmartSelftestStart Method

Source: https://storaged.org/doc/udisks2-api/latest/index.html/gdbus-org.freedesktop.UDisks2.NVMe.Controller

Starts a device selftest operation on all active namespaces accessible through the controller. This diagnostic sequence tests the integrity and functionality of the controller and may include testing of the media. The method returns immediately after the test has been started successfully, and the operation is performed in the background.

```APIDOC
SmartSelftestStart (IN  s     type,
                    IN  a{sv} options);

Parameters:
  IN s type: The type test to run. Valid values are 'short', 'extended', and 'vendor-specific'.
  IN a{sv} options: Options (currently unused except for standard options).
```

--------------------------------

### C Function: udisks_provider_start

Source: https://storaged.org/doc/udisks2-api/latest/index.html/UDisksProvider

Starts the UDisksProvider. This function initializes the provider's operations and is a virtual function in the UDisksProviderClass.

```C
void
udisks_provider_start (UDisksProvider *provider);

Parameters:
  provider: A UDisksProvider.
```

--------------------------------

### UDisksThreadedJob Other Functions

Source: https://storaged.org/doc/udisks2-api/latest/index.html/UDisksThreadedJob

Lists additional functions available for interacting with UDisksThreadedJob instances, including starting, running synchronously, and retrieving user data.

```APIDOC
udisks_threaded_job_start: void udisks_threaded_job_start ()
udisks_threaded_job_run_sync: gboolean udisks_threaded_job_run_sync ()
udisks_threaded_job_get_user_data: gpointer udisks_threaded_job_get_user_data ()
```

--------------------------------

### Handle Start Signal (UDisksMDRaid D-Bus API)

Source: https://storaged.org/doc/udisks2-api/latest/index.html/UDisksMDRaid

Documents the 'handle-start' signal emitted by UDisksMDRaid when the Start() D-Bus method is invoked. It details the expected user function signature, parameter descriptions, and return values, explaining how signal handlers can manage the D-Bus invocation.

```C
gboolean
user_function (UDisksMDRaid          *object,
               GDBusMethodInvocation *invocation,
               GVariant              *arg_options,
               gpointer               user_data)
```

```APIDOC
Signal: handle-start
Method Invoked: Start() D-Bus method
Description: Signal emitted when a remote caller is invoking the Start() D-Bus method. If a signal handler returns TRUE, it means the signal handler will handle the invocation (e.g. take a reference to invocation and eventually call udisks_mdraid_complete_start() or e.g. g_dbus_method_invocation_return_error() on it) and no other signal handlers will run. If no signal handler handles the invocation, the G_DBUS_ERROR_UNKNOWN_METHOD error is returned.
Parameters:
  object: A UDisksMDRaid.
  invocation: A GDBusMethodInvocation.
  arg_options: Argument passed by remote caller.
  user_data: user data set when the signal handler was connected.
Returns:
  G_DBUS_METHOD_INVOCATION_HANDLED or TRUE if the invocation was handled, G_DBUS_METHOD_INVOCATION_UNHANDLED or FALSE to let other signal handlers run.
Flags: Run Last
Since: 2.0.0
```

--------------------------------

### Manage NVMe Controller Sanitize Start Operations

Source: https://storaged.org/doc/udisks2-api/latest/index.html/UDisksNVMeController

A collection of functions to initiate and manage the sanitization process for an NVMe controller. This includes starting the operation, handling its completion, and performing synchronous calls.

```APIDOC
void udisks_nvme_controller_call_sanitize_start ()
```

```APIDOC
gboolean udisks_nvme_controller_call_sanitize_start_finish ()
```

```APIDOC
gboolean udisks_nvme_controller_call_sanitize_start_sync ()
```

```APIDOC
void udisks_nvme_controller_complete_sanitize_start ()
```

--------------------------------

### Synchronously Invoke UDisks2 Swapspace Start Method (API Documentation)

Source: https://storaged.org/doc/udisks2-api/latest/index.html/UDisksSwapspace

Synchronously invokes the Start() D-Bus method on the proxy. The calling thread is blocked until a reply is received. This is the synchronous version of udisks_swapspace_call_start().

```C
gboolean
udisks_swapspace_call_start_sync (UDisksSwapspace *proxy,
                                  GVariant *arg_options,
                                  GCancellable *cancellable,
                                  GError **error);
```

```APIDOC
Parameters:
  - proxy (UDisksSwapspace*): A UDisksSwapspaceProxy.
  - arg_options (GVariant*): Argument to pass with the method invocation.
  - cancellable (GCancellable*): A GCancellable or NULL. [nullable]
  - error (GError**): Return location for error or NULL.
Returns:
  - gboolean: TRUE if the call succeeded, FALSE if error is set.
```

--------------------------------

### UDisks2 Manual Pages and Command-Line Tools

Source: https://storaged.org/doc/udisks2-api/latest/index.html/index

Overview of the UDisks2 command-line tools, system daemon, and configuration files, providing essential information for system administrators and users.

```APIDOC
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
```

--------------------------------

### Get Running Property (UDisks2 MD RAID API)

Source: https://storaged.org/doc/udisks2-api/latest/index.html/gdbus-org.freedesktop.UDisks2.MDRaid

Indicates whether the RAID array is considered running. It is an error to call Start on a running array, and Stop on a non-running array, for example. Available since UDisks2 2.0.0.

```APIDOC
Running  readable   b
```

--------------------------------

### UDisks2 API: Core Components Overview

Source: https://storaged.org/doc/udisks2-api/latest/index.html/index

An overview of fundamental UDisks2 API components, including helper routines for ATA commands and classes for managing daemon modules.

```APIDOC
ATA Commands: Helper routines for ATA commands
UDisksModuleManager: Manage daemon modules
UDisksModule: Daemon module
```

--------------------------------

### Finish Get VDO Volume Statistics Call (UDisksVDOVolume)

Source: https://storaged.org/doc/udisks2-api/latest/index.html/UDisksVDOVolume

Finishes an asynchronous operation started with `udisks_vdo_volume_call_get_statistics()`. This function retrieves the statistics and indicates success or failure.

```APIDOC
gboolean
udisks_vdo_volume_call_get_statistics_finish
                               (UDisksVDOVolume *proxy,
                                GVariant **out_stats,
                                GAsyncResult *res,
                                GError **error);
```

--------------------------------

### Implementation: udisks_spawned_job_start Function in C

Source: https://storaged.org/doc/udisks2-api/latest/index.html/UDisksSpawnedJob

Provides the C implementation of `udisks_spawned_job_start`. This function sets up a main context, handles job cancellation, parses command-line arguments, manages user ID switching for the child process, and spawns the process asynchronously with pipes. It also sets up a child watch source.

```C
void udisks_spawned_job_start (UDisksSpawnedJob *job)
{
GError *error;
gint child_argc;
gchar **child_argv = NULL;
struct passwd pwstruct;
gchar pwbuf[8192];
struct passwd *pw = NULL;
int rc;

job->main_context = g_main_context_get_thread_default();
if (job->main_context != NULL)
g_main_context_ref (job->main_context);

/* could already be cancelled */
error = NULL;
if (g_cancellable_set_error_if_cancelled (udisks_base_job_get_cancellable (UDISKS_BASE_JOB (job)), &error))
{
emit_completed_with_error_in_idle (job, error);
g_clear_error (&error);
goto out;
}

job->cancellable_handler_id = g_cancellable_connect (udisks_base_job_get_cancellable (UDISKS_BASE_JOB (job)),
G_CALLBACK (on_cancelled),
job,
NULL);

error = NULL;
if (!g_shell_parse_argv (job->command_line,
&child_argc,
&child_argv,
&error))
{
g_prefix_error (&error,
"Error parsing command-line '%s': ",
job->command_line);
emit_completed_with_error_in_idle (job, error);
g_clear_error (&error);
goto out;
}

/* Save real egid and gid info for the child process */
if (job->run_as_uid != getuid() || job->run_as_euid != geteuid())
{
rc = getpwuid_r (job->run_as_euid, &pwstruct, pwbuf, sizeof pwbuf, &pw);
if (rc != 0 || pw == NULL)
{
g_set_error(&error, G_IO_ERROR, G_IO_ERROR_FAILED,
"No password record for uid %d: %m\n", (gint) job->run_as_euid);
emit_completed_with_error_in_idle (job, error);
g_clear_error (&error);
goto out;
}
job->real_egid = pw->pw_gid;

rc = getpwuid_r (job->run_as_uid, &pwstruct, pwbuf, sizeof pwbuf, &pw);
if (rc != 0 || pw == NULL)
{
g_set_error(&error, G_IO_ERROR, G_IO_ERROR_FAILED,
"No password record for uid %d: %m\n", (gint) job->run_as_uid);
emit_completed_with_error_in_idle (job, error);
g_clear_error (&error);
goto out;
}
job->real_gid = pw->pw_gid;
job->real_uid = pw->pw_uid;
job->real_pwname = strdup (pw->pw_name);
}

error = NULL;
if (!g_spawn_async_with_pipes (NULL, /* working directory */
child_argv,
NULL, /* envp */
G_SPAWN_SEARCH_PATH | G_SPAWN_DO_NOT_REAP_CHILD,
child_setup, /* child_setup */
job, /* child_setup's user_data */
&(job->child_pid),
job->input_string != NULL ? &(job->child_stdin_fd) : NULL,
&(job->child_stdout_fd),
&(job->child_stderr_fd),
&error))
{
g_prefix_error (&error,
"Error spawning command-line '%s': ",
job->command_line);
emit_completed_with_error_in_idle (job, error);
g_clear_error (&error);
goto out;
}

job->child_watch_source = g_child_watch_source_new (job->child_pid);
#if __GNUC__ >= 8
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wcast-function-type"
#endif
/* parameters of the callback depend on the source and can be different
from the required "generic" GSourceFunc, see:
https://developer.gnome.org/glib/stable/glib-The-Main-Event-Loop.htmlg-source-set-callback
```

--------------------------------

### Finish Asynchronous Get BTRFS Subvolumes Operation (C)

Source: https://storaged.org/doc/udisks2-api/latest/index.html/UDisksFilesystemBTRFS

Completes an asynchronous operation started with udisks_filesystem_btrfs_call_get_subvolumes(). This function retrieves the result of the GetSubvolumes() D-Bus method invocation.

```C
gboolean
udisks_filesystem_btrfs_call_get_subvolumes_finish
                               (UDisksFilesystemBTRFS *proxy,
                                GVariant **out_subvolumes,
                                gint *out_subvolumes_cnt,
                                GAsyncResult *res,
                                GError **error);
```

```APIDOC
Function: udisks_filesystem_btrfs_call_get_subvolumes_finish
Parameters:
  proxy:
    Type: UDisksFilesystemBTRFS *
    Description: A UDisksFilesystemBTRFSProxy.
  out_subvolumes:
    Type: GVariant **
    Description: Return location for return parameter or NULL to ignore. [out][optional]
  out_subvolumes_cnt:
    Type: gint *
    Description: Return location for return parameter or NULL to ignore. [out][optional]
  res:
    Type: GAsyncResult *
    Description: The GAsyncResult obtained from the GAsyncReadyCallback passed to udisks_filesystem_btrfs_call_get_subvolumes().
  error:
    Type: GError **
    Description: Return location for error or NULL.
Returns:
  Type: gboolean
  Description: TRUE if the call succeeded, FALSE if error is set.
Since: 2.1.3
```

--------------------------------

### UDisks2.Loop SetupByUID Property

Source: https://storaged.org/doc/udisks2-api/latest/index.html/gdbus-org.freedesktop.UDisks2.Loop

Detailed documentation for the "SetupByUID" property of the org.freedesktop.UDisks2.Loop D-Bus interface. This property provides the user ID that set up the loop device.

```APIDOC
SetupByUID  readable   u

Description: The id of the user who set up the loop device or 0 if set up by root or not through udisks.
```

--------------------------------

### Check if Modules are Forced to Load in UDisksDaemon

Source: https://storaged.org/doc/udisks2-api/latest/index.html/UDisksDaemon

Gets the UDisksDaemon setting indicating whether modules should be activated upon start. Returns TRUE if the --force-load-modules commandline switch was specified.

```C
gboolean
udisks_daemon_get_force_load_modules (UDisksDaemon *daemon);
```

```APIDOC
udisks_daemon_get_force_load_modules (daemon: UDisksDaemon)
  daemon: A UDisksDaemon.
Returns: TRUE if --force-load-modules commandline switch has been specified.
```

--------------------------------

### Method: LoopSetup()

Source: https://storaged.org/doc/udisks2-api/latest/index.html/gdbus-org.freedesktop.UDisks2.Manager

Creates a block device for the file represented by `fd`. This method takes a file descriptor and options, returning an object path to the resulting block device.

```APIDOC
LoopSetup(IN h fd, IN a{sv} options, OUT o resulting_device)
  IN h fd: An index for the file descriptor to use.
  IN a{sv} options: Options - known options (in addition to standard options) includes `offset` (of type 't'), `size` (of type 't'), `read-only` (of type 'b'), `no-part-scan` (of type 'b') and `sector-size` (of type 't').
  OUT o resulting_device: An object path to the object implementing the org.freedesktop.UDisks2.Block interface.
```

--------------------------------

### Finish Asynchronous Call to Get ISCSI Initiator Name (C)

Source: https://storaged.org/doc/udisks2-api/latest/index.html/UDisksManagerISCSIInitiator

Finishes an asynchronous operation started with `udisks_manager_iscsi_initiator_call_get_initiator_name()` to retrieve the ISCSI initiator name. This function processes the `GAsyncResult` and returns the result or an error.

```C
gboolean
udisks_manager_iscsi_initiator_call_get_initiator_name_finish
                               (UDisksManagerISCSIInitiator *proxy,
                                gchar **out_result,
                                GAsyncResult *res,
                                GError **error);
```

```APIDOC
Parameters:
  proxy: A UDisksManagerISCSIInitiatorProxy.
  out_result: Return location for return parameter or NULL to ignore. [out][optional]
  res: The GAsyncResult obtained from the GAsyncReadyCallback passed to udisks_manager_iscsi_initiator_call_get_initiator_name().
  error: Return location for error or NULL.
Returns:
  TRUE if the call succeeded, FALSE if *error* is set.
Since: 2.0.1
```

--------------------------------

### Finish Getting Raw iSCSI Initiator Name (udisks2 C API)

Source: https://storaged.org/doc/udisks2-api/latest/index.html/UDisksManagerISCSIInitiator

This function finishes an asynchronous operation started by `udisks_manager_iscsi_initiator_call_get_initiator_name_raw()`. It retrieves the raw iSCSI initiator name, taking a proxy, a pointer for the result, the GAsyncResult, and an error pointer.

```APIDOC
gboolean
udisks_manager_iscsi_initiator_call_get_initiator_name_raw_finish
                               (UDisksManagerISCSIInitiator *proxy,
                                gchar **out_result,
                                GAsyncResult *res,
                                GError **error);

Parameters:
  proxy: A UDisksManagerISCSIInitiatorProxy.
  out_result: Return location for return parameter or NULL to ignore. [out][optional]
  res: The GAsyncResult obtained from the GAsyncReadyCallback passed to udisks_manager_iscsi_initiator_call_get_initiator_name_raw().
  error: Return location for error or NULL.

Returns:
  TRUE if the call succeeded, FALSE if error is set.
```

--------------------------------

### UDisks2 LogicalVolume Interface Methods Overview

Source: https://storaged.org/doc/udisks2-api/latest/index.html/gdbus-org.freedesktop.UDisks2.LogicalVolume

Overview of all methods available on the `org.freedesktop.UDisks2.LogicalVolume` D-Bus interface, including their input and output parameters.

```APIDOC
Activate       (IN  a{sv} options,
                OUT o     result);
Deactivate     (IN  a{sv} options);
Delete         (IN  a{sv} options);
Rename         (IN  s     new_name,
                IN  a{sv} options,
                OUT o     result);
Resize         (IN  t     new_size,
                IN  a{sv} options);
Repair         (IN  ao    pvs,
                IN  a{sv} options);
CreateSnapshot (IN  s     name,
                IN  t     size,
                IN  a{sv} options,
                OUT o     result);
CacheAttach    (IN  s     cache_name,
                IN  a{sv} options);
CacheSplit     (IN  a{sv} options);
CacheDetach    (IN  a{sv} options);
```

--------------------------------

### Finish getting firmware iSCSI initiator name (UDisks2 API)

Source: https://storaged.org/doc/udisks2-api/latest/index.html/UDisksManagerISCSIInitiator

Finishes an asynchronous operation started with udisks_manager_iscsi_initiator_call_get_firmware_initiator_name(). This function retrieves the result of the D-Bus method call, specifically the firmware iSCSI initiator name. It requires the GAsyncResult obtained from the callback.

```APIDOC
Function Name: udisks_manager_iscsi_initiator_call_get_firmware_initiator_name_finish
  Signature: gboolean udisks_manager_iscsi_initiator_call_get_firmware_initiator_name_finish (UDisksManagerISCSIInitiator *proxy, gchar **out_result, GAsyncResult *res, GError **error)
  Parameters:
    proxy: UDisksManagerISCSIInitiator* - A UDisksManagerISCSIInitiatorProxy.
    out_result: gchar** - Return location for return parameter or NULL to ignore. [out][optional]
    res: GAsyncResult* - The GAsyncResult obtained from the GAsyncReadyCallback passed to udisks_manager_iscsi_initiator_call_get_firmware_initiator_name().
    error: GError** - Return location for error or NULL.
  Returns:
    gboolean - TRUE if the call succeeded, FALSE if error is set.
```

```C
gboolean
udisks_manager_iscsi_initiator_call_get_firmware_initiator_name_finish
                               (UDisksManagerISCSIInitiator *proxy,
                                gchar **out_result,
                                GAsyncResult *res,
                                GError **error);
```

--------------------------------

### API Reference: udisks_daemon_util_setup_by_user

Source: https://storaged.org/doc/udisks2-api/latest/index.html/udisks2-Utilities

A utility routine for UDisks2 daemon operations.

```APIDOC
gboolean udisks_daemon_util_setup_by_user ()
```

--------------------------------

### Finish UDisks2 Swapspace Start Operation (API Documentation)

Source: https://storaged.org/doc/udisks2-api/latest/index.html/UDisksSwapspace

Finishes an asynchronous operation started with udisks_swapspace_call_start(). This function is called after the GAsyncReadyCallback is invoked to retrieve the result of the start operation.

```C
gboolean
udisks_swapspace_call_start_finish (UDisksSwapspace *proxy,
                                    GAsyncResult *res,
                                    GError **error);
```

```APIDOC
Parameters:
  - proxy (UDisksSwapspace*): A UDisksSwapspaceProxy.
  - res (GAsyncResult*): The GAsyncResult obtained from the GAsyncReadyCallback passed to udisks_swapspace_call_start().
  - error (GError**): Return location for error or NULL.
Returns:
  - gboolean: TRUE if the call succeeded, FALSE if error is set.
```

--------------------------------

### Get UUID for UDisksLinuxMDRaidObject

Source: https://storaged.org/doc/udisks2-api/latest/index.html/UDisksLinuxMDRaidObject

Gets the UUID for the UDisksLinuxMDRaidObject.

```APIDOC
udisks_linux_mdraid_object_get_uuid (object: UDisksLinuxMDRaidObject *) -> const gchar *
  object: A UDisksLinuxMDRaidObject.
  Returns: The UUID for object. Do not free, the string belongs to object.
```

--------------------------------

### UDisks2.Filesystem Interface Methods Overview

Source: https://storaged.org/doc/udisks2-api/latest/index.html/gdbus-org.freedesktop.UDisks2.Filesystem

Overview of all available methods for the org.freedesktop.UDisks2.Filesystem interface, including operations like setting labels, UUIDs, mounting, unmounting, resizing, checking, repairing, and taking ownership.

```APIDOC
SetLabel      (IN  s     label,
               IN  a{sv} options);
SetUUID       (IN  s     uuid,
               IN  a{sv} options);
Mount         (IN  a{sv} options,
               OUT s     mount_path);
Unmount       (IN  a{sv} options);
Resize        (IN  t     size,
               IN  a{sv} options);
Check         (IN  a{sv} options,
               OUT b     consistent);
Repair        (IN  a{sv} options,
               OUT b     repaired);
TakeOwnership (IN  a{sv} options);
```

--------------------------------

### UDisks2 API: Cancel job started by another user

Source: https://storaged.org/doc/udisks2-api/latest/index.html/udisks-polkit-actions

Cancel job started by another user. Authentication is required to cancel a job started by another user. Default permissions: allow_any: auth_admin, allow_inactive: auth_admin, allow_active: auth_admin_keep.

```APIDOC
<action id="org.freedesktop.udisks2.cancel-job-other-user">
    <description>Cancel job started by another user</description>
    <message>Authentication is required to cancel a job started by another user</message>
    <defaults>
      <allow_any>auth_admin</allow_any>
      <allow_inactive>auth_admin</allow_inactive>
      <allow_active>auth_admin_keep</allow_active>
    </defaults>
  </action>
```

--------------------------------

### C Type: UDisksProviderClass Structure

Source: https://storaged.org/doc/udisks2-api/latest/index.html/UDisksProvider

Defines the class structure for UDisksProvider, including its parent class (GObjectClass) and virtual functions like 'start'.

```C
struct UDisksProviderClass {
  GObjectClass parent_class;

  void (*start) (UDisksProvider *provider);
};

Members:
  start(): Virtual function for udisks_provider_start(). The default implementation does nothing.
```

--------------------------------

### Get UDisksLinuxDevice objects for RAID members

Source: https://storaged.org/doc/udisks2-api/latest/index.html/UDisksLinuxMDRaidObject

Gets the current UDisksLinuxDevice objects for the RAID members associated with the UDisksLinuxMDRaidObject.

```APIDOC
udisks_linux_mdraid_object_get_members (object: UDisksLinuxMDRaidObject *) -> GList * (list of UDisksLinuxDevice *)
  object: A UDisksLinuxMDRaidObject.
  Returns: A list of UDisksLinuxDevice objects. Free each element with g_object_unref(), then free the list with g_list_free().
```

--------------------------------

### Get UDisksLinuxDevice for RAID device

Source: https://storaged.org/doc/udisks2-api/latest/index.html/UDisksLinuxMDRaidObject

Gets the current UDisksLinuxDevice object for the RAID device (e.g. /dev/md0) associated with the UDisksLinuxMDRaidObject, if any.

```APIDOC
udisks_linux_mdraid_object_get_device (object: UDisksLinuxMDRaidObject *) -> UDisksLinuxDevice * | NULL
  object: A UDisksLinuxMDRaidObject.
  Returns: A UDisksLinuxDevice or NULL. Free with g_object_unref().
```

--------------------------------

### UDisks2.MDRaid.Start() Method Details

Source: https://storaged.org/doc/udisks2-api/latest/index.html/gdbus-org.freedesktop.UDisks2.MDRaid

Starts the RAID array. The `options` parameter can include `start-degraded` to allow starting even if some members are missing.

```APIDOC
Start (IN  a{sv} options);
  IN a{sv} options: Options - known options (in addition to standard options) includes `start-degraded` (of type 'b').
```

--------------------------------

### Get Size Property for UDisksLogicalVolume (C)

Source: https://storaged.org/doc/udisks2-api/latest/index.html/UDisksLogicalVolume

Gets the value of the 'Size' D-Bus property from a UDisksLogicalVolume object. This function is suitable for both client- and service-side use.

```C
guint64
udisks_logical_volume_get_size (UDisksLogicalVolume *object);
```

```APIDOC
Parameters:
  object: A UDisksLogicalVolume.
Returns:
  The property value.
Since: 2.0.0
```

--------------------------------

### UDisks2 iSCSI Initiator Manager Methods Overview

Source: https://storaged.org/doc/udisks2-api/latest/index.html/gdbus-org.freedesktop.UDisks2.Manager.ISCSI.Initiator

Provides a concise list of all methods available on the org.freedesktop.UDisks2.Manager.ISCSI.Initiator D-Bus interface.

```APIDOC
GetFirmwareInitiatorName (OUT s        result);
GetInitiatorName         (OUT s        result);
GetInitiatorNameRaw      (OUT ay       result);
SetInitiatorName         (IN  s        name,
                          IN  a{sv}    options);
DiscoverSendTargets      (IN  s        address,
                          IN  q        port,
                          IN  a{sv}    options,
                          OUT a(sisis) nodes,
                          OUT i        nodes_cnt);
DiscoverFirmware         (IN  a{sv}    options,
                          OUT a(sisis) nodes,
                          OUT i        nodes_cnt);
Login                    (IN  s        name,
                          IN  i        tpgt,
                          IN  s        address,
                          IN  i        port,
                          IN  s        iface,
                          IN  a{sv}    options);
Logout                   (IN  s        name,
                          IN  i        tpgt,
                          IN  s        address,
                          IN  i        port,
                          IN  s        iface,
                          IN  a{sv}    options);
```

--------------------------------

### Get Passphrase Path Field of UDisksCrypttabEntry

Source: https://storaged.org/doc/udisks2-api/latest/index.html/UDisksCrypttabMonitor

Retrieves the passphrase path field from a UDisksCrypttabEntry object. This function is used to get the path to the passphrase file for a crypttab entry, if specified.

```APIDOC
const gchar *
udisks_crypttab_entry_get_passphrase_path
                               (UDisksCrypttabEntry *entry);

Parameters:
  entry: A UDisksCrypttabEntry.

Returns:
  The passphrase path field.
```

--------------------------------

### Complete NVMe Controller SMART Self-Test Start D-Bus Method

Source: https://storaged.org/doc/udisks2-api/latest/index.html/UDisksNVMeController

This helper function is used in service implementations to finish handling invocations of the `SmartSelftestStart()` D-Bus method. It takes a `UDisksNVMeController` object and a `GDBusMethodInvocation`. Note that this method frees the `invocation` object, rendering it unusable afterwards; for returning an error, `g_dbus_method_invocation_return_error()` should be used instead.

```C
void
udisks_nvme_controller_complete_smart_selftest_start
                               (UDisksNVMeController *object,
                                GDBusMethodInvocation *invocation);
```

```APIDOC
udisks_nvme_controller_complete_smart_selftest_start (object, invocation)
  Description: Helper function used in service implementations to finish handling invocations of the SmartSelftestStart() D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. This method will free invocation, you cannot use it afterwards.
  Parameters:
    object: UDisksNVMeController* - A UDisksNVMeController.
    invocation: GDBusMethodInvocation* - A GDBusMethodInvocation. [transfer full]
  Returns:
    void
```

--------------------------------

### UDisks2 API: Start the sanitize operation

Source: https://storaged.org/doc/udisks2-api/latest/index.html/udisks-polkit-actions

Start the sanitize operation. Authentication is required to perform a sanitize operation. Default permissions: allow_any: auth_admin, allow_inactive: auth_admin, allow_active: auth_admin_keep.

```APIDOC
<action id="org.freedesktop.udisks2.nvme-sanitize">
    <description>Start the sanitize operation</description>
    <message>Authentication is required to perform a sanitize operation</message>
    <defaults>
      <allow_any>auth_admin</allow_any>
      <allow_inactive>auth_admin</allow_inactive>
      <allow_active>auth_admin_keep</allow_active>
    </defaults>
  </action>
```

--------------------------------

### Get PolicyKit Authority from UDisksDaemon

Source: https://storaged.org/doc/udisks2-api/latest/index.html/UDisksDaemon

Gets the PolicyKit authority used by the UDisksDaemon. The returned PolkitAuthority instance is owned by the daemon and should not be freed. It returns NULL if the polkit authority is not available.

```C
PolkitAuthority *
udisks_daemon_get_authority (UDisksDaemon *daemon);
```

```APIDOC
udisks_daemon_get_authority (daemon: UDisksDaemon)
  daemon: A UDisksDaemon.
Returns: A PolkitAuthority instance or NULL if the polkit authority is not available. Do not free, the object is owned by daemon.
```

--------------------------------

### UDisks2 Configuration File Example

Source: https://storaged.org/doc/udisks2-api/latest/index.html/mount_options

Illustrates the basic syntax of a UDisks2 configuration file, showing how to define default mount options and allowed options for filesystems. The `[defaults]` section applies common options to all filesystem types, which are then merged with type-specific options.

```Configuration
[defaults]
# common options, applied to any filesystem, always merged with specific filesystem type options
defaults=ro
allow=exec,noexec,nodev,nosuid,atime,noatime,nodiratime,ro,rw,sync,dirsync,noload
```

--------------------------------

### Documenting the handle-loop-setup D-Bus Signal for UDisksManager

Source: https://storaged.org/doc/udisks2-api/latest/index.html/UDisksManager

Documents the `handle-loop-setup` signal emitted when a remote caller invokes the `LoopSetup()` D-Bus method on a `UDisksManager` object. Handlers return `TRUE` to indicate they will complete the invocation, otherwise `G_DBUS_ERROR_UNKNOWN_METHOD` is returned. It details the parameters and return values for the signal handler.

```APIDOC
Signal: handle-loop-setup
Description: Signal emitted when a remote caller is invoking the LoopSetup() D-Bus method.
Handler Signature:
  gboolean
  user_function (UDisksManager         *object,
                 GDBusMethodInvocation *invocation,
                 GUnixFDList           *fd_list,
                 GVariant              *arg_fd,
                 GVariant              *arg_options,
                 gpointer               user_data)
Parameters:
  object: A UDisksManager.
  invocation: A GDBusMethodInvocation.
  fd_list: A GUnixFDList or NULL. [nullable]
  arg_fd: Argument passed by remote caller.
  arg_options: Argument passed by remote caller.
  user_data: user data set when the signal handler was connected.
Returns: G_DBUS_METHOD_INVOCATION_HANDLED or TRUE if the invocation was handled, G_DBUS_METHOD_INVOCATION_UNHANDLED or FALSE to let other signal handlers run.
Flags: Run Last
```

--------------------------------

### Check Device Setup by User (udisks_daemon_util_setup_by_user)

Source: https://storaged.org/doc/udisks2-api/latest/index.html/udisks2-Utilities

Checks whether the device represented by the UDisksObject (if any) has been setup by a specific user. This function returns TRUE if the object has been set-up by the user, FALSE if not.

```C
gboolean
udisks_daemon_util_setup_by_user (UDisksDaemon *daemon,
                                  UDisksObject *object,
                                  uid_t user);
```

```APIDOC
Parameters:
  daemon: A UDisksDaemon.
  object: The GDBusObject that the call is on or NULL.
  user: The user in question.
Returns:
  TRUE if object has been set-up by user, FALSE if not.
```

--------------------------------

### DiscoverFirmware() Method

Source: https://storaged.org/doc/udisks2-api/latest/index.html/gdbus-org.freedesktop.UDisks2.Manager.ISCSI.Initiator

Performs targets' discovery using firmware (ppc or ibft). No additional options are currently defined.

```APIDOC
DiscoverFirmware (IN  a{sv}    options,
                  OUT a(sisis) nodes,
                  OUT i        nodes_cnt);
  options (IN a{sv}): Additional options.
  nodes (OUT a(sisis)): Structure containing discovered targets (name, tpgt, address, port, iface).
  nodes_cnt (OUT i): The number of found nodes.
```

--------------------------------

### UDisks2 Manager D-Bus Methods Overview

Source: https://storaged.org/doc/udisks2-api/latest/index.html/gdbus-org.freedesktop.UDisks2.Manager

Lists all available methods for the `org.freedesktop.UDisks2.Manager` D-Bus interface, including their input and output parameters.

```APIDOC
CanFormat       (IN  s     type,
                 OUT (bs)  available);
CanResize       (IN  s     type,
                 OUT (bts) available);
CanCheck        (IN  s     type,
                 OUT (bs)  available);
CanRepair       (IN  s     type,
                 OUT (bs)  available);
LoopSetup       (IN  h     fd,
                 IN  a{sv} options,
                 OUT o     resulting_device);
MDRaidCreate    (IN  ao    blocks,
                 IN  s     level,
                 IN  s     name,
                 IN  t     chunk,
                 IN  a{sv} options,
                 OUT o     resulting_array);
EnableModules   (IN  b     enable);
EnableModule    (IN  s     name,
                 IN  b     enable);
GetBlockDevices (IN  a{sv} options,
                 OUT ao    block_objects);
ResolveDevice   (IN  a{sv} devspec,
                 IN  a{sv} options,
                 OUT ao    devices);
```

--------------------------------

### UDisks2 NVMe Namespace: Methods Overview

Source: https://storaged.org/doc/udisks2-api/latest/index.html/gdbus-org.freedesktop.UDisks2.NVMe.Namespace

Overview of methods available on the org.freedesktop.UDisks2.NVMe.Namespace D-Bus interface.

```APIDOC
FormatNamespace (IN  a{sv} options);
```

--------------------------------

### Get BTRFS Filesystem Number of Devices (udisks_filesystem_btrfs_get_num_devices)

Source: https://storaged.org/doc/udisks2-api/latest/index.html/UDisksFilesystemBTRFS

Gets the value of the "num_devices" D-Bus property for a UDisksFilesystemBTRFS object. This function is suitable for both client-side and service-side use.

```C
guint64
udisks_filesystem_btrfs_get_num_devices
                               (UDisksFilesystemBTRFS *object);
```

```APIDOC
udisks_filesystem_btrfs_get_num_devices (object: UDisksFilesystemBTRFS*)
  object: A UDisksFilesystemBTRFS.
  Returns: guint64 - The property value.
```

--------------------------------

### Get UDisksDrive SiblingId D-Bus Property

Source: https://storaged.org/doc/udisks2-api/latest/index.html/UDisksDrive

Gets a copy of the "SiblingId" D-Bus property from a UDisksDrive object. This function is usable on both client and service sides as the property is readable.

```C
gchar *
udisks_drive_dup_sibling_id (UDisksDrive *object);
```

```APIDOC
Function: udisks_drive_dup_sibling_id
Description: Gets a copy of the "SiblingId" D-Bus property. Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
Parameters:
  object: A UDisksDrive.
Returns:
  The property value or NULL if the property is not set. The returned value should be freed with g_free().
  Transfer: full
  Nullable: true
```

--------------------------------

### UDisks2.Filesystem Interface Properties Overview

Source: https://storaged.org/doc/udisks2-api/latest/index.html/gdbus-org.freedesktop.UDisks2.Filesystem

Overview of all available properties for the org.freedesktop.UDisks2.Filesystem interface, including MountPoints and Size.

```APIDOC
MountPoints  readable   aay
Size         readable   t
```

--------------------------------

### Get UDisksDrive Id D-Bus Property

Source: https://storaged.org/doc/udisks2-api/latest/index.html/UDisksDrive

Gets a copy of the "Id" D-Bus property from a UDisksDrive object. This function is usable on both client and service sides as the property is readable.

```C
gchar *
udisks_drive_dup_id (UDisksDrive *object);
```

```APIDOC
Function: udisks_drive_dup_id
Description: Gets a copy of the "Id" D-Bus property. Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
Parameters:
  object: A UDisksDrive.
Returns:
  The property value or NULL if the property is not set. The returned value should be freed with g_free().
  Transfer: full
  Nullable: true
```

--------------------------------

### UDisks2 iSCSI Initiator Manager Properties Overview

Source: https://storaged.org/doc/udisks2-api/latest/index.html/gdbus-org.freedesktop.UDisks2.Manager.ISCSI.Initiator

Provides a concise list of all properties available on the org.freedesktop.UDisks2.Manager.ISCSI.Initiator D-Bus interface.

```APIDOC
SessionsSupported  readable   b
```

--------------------------------

### Get UDisksDrive Configuration D-Bus Property

Source: https://storaged.org/doc/udisks2-api/latest/index.html/UDisksDrive

Gets a copy of the "Configuration" D-Bus property from a UDisksDrive object. This function is usable on both client and service sides as the property is readable.

```C
GVariant *
udisks_drive_dup_configuration (UDisksDrive *object);
```

```APIDOC
Function: udisks_drive_dup_configuration
Description: Gets a copy of the "Configuration" D-Bus property. Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
Parameters:
  object: A UDisksDrive.
Returns:
  The property value or NULL if the property is not set. The returned value should be freed with g_variant_unref().
  Transfer: full
  Nullable: true
```

--------------------------------

### UDisks2 BTRFS Filesystem Interface API Reference

Source: https://storaged.org/doc/udisks2-api/latest/index.html/gdbus-org.freedesktop.UDisks2.Filesystem.BTRFS

Detailed API reference for the org.freedesktop.UDisks2.Filesystem.BTRFS D-Bus interface, including its general description, a comprehensive list of methods with their signatures and detailed explanations, and a list of available properties.

```APIDOC
Interface: org.freedesktop.UDisks2.Filesystem.BTRFS
Description: BTRFS filesystem interface exported on block objects.
Since: 2.1.3

Methods Summary:
  AddDevice             (IN  o      device,
                       IN  a{sv}  options);
  RemoveDevice          (IN  o      device,
                       IN  a{sv}  options);
  CreateSubvolume       (IN  s      name,
                       IN  a{sv}  options);
  RemoveSubvolume       (IN  s      name,
                       IN  a{sv}  options);
  GetSubvolumes         (IN  b      snapshots_only,
                       IN  a{sv}  options,
                       OUT a(tts) subvolumes,
                       OUT i      subvolumes_cnt);
  CreateSnapshot        (IN  s      source,
                       IN  s      dest,
                       IN  b      ro,
                       IN  a{sv}  options);
  Repair                (IN  a{sv}  options);
  Resize                (IN  t      size,
                       IN  a{sv}  options);
  SetLabel              (IN  s      label,
                       IN  a{sv}  options);
  GetDefaultSubvolumeID (IN  a{sv}  options,
                       OUT u      id);
  SetDefaultSubvolumeID (IN  u      id,
                       IN  a{sv}  options);
```

```APIDOC
Properties Summary:
  label        readable   s
  uuid         readable   s
  num_devices  readable   t
  used         readable   t
```

```APIDOC
Method Details:

AddDevice:
  Signature: (IN o device, IN a{sv} options)
  Description: Adds the device to the volume. No additional options are currently defined.
  Parameters:
    device (IN o): Object path of a device to be added to BTRFS volume.
    options (IN a{sv}): Additional options.
  Since: 2.3.0
  Changed in version: 2.7.0

RemoveDevice:
  Signature: (IN o device, IN a{sv} options)
  Description: Removes the device from the volume. No additional options are currently defined.
  Parameters:
    device (IN o): Object path of a device to be removed from BTRFS volume.
    options (IN a{sv}): Additional options.
  Since: 2.3.0
  Changed in version: 2.7.0

CreateSubvolume:
  Signature: (IN s name, IN a{sv} options)
  Description: Creates a new subvolume. No additional options are currently defined.
  Parameters:
    name (IN s): Name of a new subvolume.
    options (IN a{sv}): Additional options.
  Since: 2.1.3

RemoveSubvolume:
  Signature: (IN s name, IN a{sv} options)
  Description: Deletes a subvolume. No additional options are currently defined.
  Parameters:
    name (IN s): Name of the subvolume to be deleted.
    options (IN a{sv}): Additional options.
  Since: 2.1.3

GetSubvolumes:
  Signature: (IN b snapshots_only, IN a{sv} options, OUT a(tts) subvolumes, OUT i subvolumes_cnt)
  Description: Returns a list of subvolumes. No additional options are currently defined.
  Parameters:
    snapshots_only (IN b): True if to list only snapshot subvolumes; False otherwise.
    options (IN a{sv}): Additional options.
    subvolumes (OUT a(tts)): Structure containing subvolume id, parent_id and path.
    subvolumes_cnt (OUT i): The number of returned elements.
  Since: 2.1.3

CreateSnapshot:
  Signature: (IN s source, IN s dest, IN b ro, IN a{sv} options)
  Description: Creates a snapshot. No additional options are currently defined.
  Parameters:
    source (IN s): Name of the source subvolume.
    dest (IN s): Name for the new snapshot volume.
    ro (IN b): True if the snapshot should be read-only; False otherwise.
    options (IN a{sv}): Additional options.
  Since: 2.1.3

Repair:
  Signature: (IN a{sv} options)
  Description: Checks and repairs btrfs volume. No additional options are currently defined.
  Parameters:
    options (IN a{sv}): Additional options.
  Since: 2.3.0

Resize:
  Signature: (IN t size, IN a{sv} options)
  Description: (No detailed description provided in source.)
  Parameters:
    size (IN t): (No detailed description provided in source.)
    options (IN a{sv}): (No detailed description provided in source.)

SetLabel:
  Signature: (IN s label, IN a{sv} options)
  Description: (No detailed description provided in source.)
  Parameters:
    label (IN s): (No detailed description provided in source.)
    options (IN a{sv}): (No detailed description provided in source.)

GetDefaultSubvolumeID:
  Signature: (IN a{sv} options, OUT u id)
  Description: (No detailed description provided in source.)
  Parameters:
    options (IN a{sv}): (No detailed description provided in source.)
    id (OUT u): (No detailed description provided in source.)

SetDefaultSubvolumeID:
  Signature: (IN u id, IN a{sv} options)
  Description: (No detailed description provided in source.)
  Parameters:
    id (IN u): (No detailed description provided in source.)
    options (IN a{sv}): (No detailed description provided in source.)
```

--------------------------------

### UDisks2.Manager.NVMe API Methods Overview

Source: https://storaged.org/doc/udisks2-api/latest/index.html/gdbus-org.freedesktop.UDisks2.Manager.NVMe

Overview of methods available for NVMe host management within the UDisks2 Manager API.

```APIDOC
SetHostNQN (IN  ay    hostnqn,
            IN  a{sv} options);
SetHostID  (IN  ay    hostid,
            IN  a{sv} options);
Connect    (IN  ay    subsysnqn,
            IN  s     transport,
            IN  s     transport_addr,
            IN  a{sv} options,
            OUT o     nvme_ctrl);
```

--------------------------------

### Get UDisksDrive SortKey D-Bus Property

Source: https://storaged.org/doc/udisks2-api/latest/index.html/UDisksDrive

Gets a copy of the "SortKey" D-Bus property from a UDisksDrive object. This function is usable on both client and service sides as the property is readable.

```C
gchar *
udisks_drive_dup_sort_key (UDisksDrive *object);
```

```APIDOC
Function: udisks_drive_dup_sort_key
Description: Gets a copy of the "SortKey" D-Bus property. Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
Parameters:
  object: A UDisksDrive.
Returns:
  The property value or NULL if the property is not set. The returned value should be freed with g_free().
  Transfer: full
  Nullable: true
```

--------------------------------

### UDisks2 Block Interface: All Methods

Source: https://storaged.org/doc/udisks2-api/latest/index.html/gdbus-org.freedesktop.UDisks2.Block

Overview of all D-Bus methods available on the org.freedesktop.UDisks2.Block interface, showing their signatures with input and output parameters.

```APIDOC
AddConfigurationItem    (IN  (sa{sv})  item,
                         IN  a{sv}     options);
RemoveConfigurationItem (IN  (sa{sv})  item,
                         IN  a{sv}     options);
UpdateConfigurationItem (IN  (sa{sv})  old_item,
                         IN  (sa{sv})  new_item,
                         IN  a{sv}     options);
GetSecretConfiguration  (IN  a{sv}     options,
                         OUT a(sa{sv}) configuration);
Format                  (IN  s         type,
                         IN  a{sv}     options);
OpenForBackup           (IN  a{sv}     options,
                         OUT h         fd);
OpenForRestore          (IN  a{sv}     options,
                         OUT h         fd);
OpenForBenchmark        (IN  a{sv}     options,
                         OUT h         fd);
OpenDevice              (IN  s         mode,
                         IN  a{sv}     options,
                         OUT h         fd);
Rescan                  (IN  a{sv}     options);
RestoreEncryptedHeader  (IN  s         backup_file,
                         IN  a{sv}     options);
```

--------------------------------

### Get UDisksDrive WWN D-Bus Property

Source: https://storaged.org/doc/udisks2-api/latest/index.html/UDisksDrive

Gets a copy of the "WWN" D-Bus property from a UDisksDrive object. This function is usable on both client and service sides as the property is readable.

```C
gchar *
udisks_drive_dup_wwn (UDisksDrive *object);
```

```APIDOC
Function: udisks_drive_dup_wwn
Description: Gets a copy of the "WWN" D-Bus property. Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
Parameters:
  object: A UDisksDrive.
Returns:
  The property value or NULL if the property is not set. The returned value should be freed with g_free().
  Transfer: full
  Nullable: true
```

--------------------------------

### UDisksBlockLVM2 D-Bus Interface Functions Overview

Source: https://storaged.org/doc/udisks2-api/latest/index.html/UDisksBlockLVM2

A comprehensive list of functions available for interacting with the `org.freedesktop.UDisks2.Block.LVM2` D-Bus interface, including proxy creation, property access, and skeleton management functions.

```APIDOC
udisks_block_lvm2_proxy_new(): void
udisks_block_lvm2_proxy_new_finish(): UDisksBlockLVM2*
udisks_block_lvm2_proxy_new_sync(): UDisksBlockLVM2*
udisks_block_lvm2_proxy_new_for_bus(): void
udisks_block_lvm2_proxy_new_for_bus_finish(): UDisksBlockLVM2*
udisks_block_lvm2_proxy_new_for_bus_sync(): UDisksBlockLVM2*
udisks_block_lvm2_get_logical_volume(): const gchar*
udisks_block_lvm2_dup_logical_volume(): gchar*
udisks_block_lvm2_set_logical_volume(): void
udisks_block_lvm2_skeleton_new(): UDisksBlockLVM2*
```

--------------------------------

### org.freedesktop.UDisks2.NVMe.Controller Interface Methods

Source: https://storaged.org/doc/udisks2-api/latest/index.html/gdbus-org.freedesktop.UDisks2.NVMe.Controller

Overview of all methods available on the org.freedesktop.UDisks2.NVMe.Controller D-Bus interface, showing their input and output parameters.

```APIDOC
SmartUpdate        (IN  a{sv} options);
SmartGetAttributes (IN  a{sv} options,
                    OUT a{sv} attributes);
SmartSelftestStart (IN  s     type,
                    IN  a{sv} options);
SmartSelftestAbort (IN  a{sv} options);
SanitizeStart      (IN  s     action,
                    IN  a{sv} options);
```

--------------------------------

### Complete Start D-Bus Method Invocation (UDisksMDRaid)

Source: https://storaged.org/doc/udisks2-api/latest/index.html/UDisksMDRaid

Provides a helper function for service implementations to finalize the handling of Start() D-Bus method invocations. This function frees the GDBusMethodInvocation object, making it unusable afterwards.

```APIDOC
Function: udisks_mdraid_complete_start
Signature: void udisks_mdraid_complete_start (UDisksMDRaid *object, GDBusMethodInvocation *invocation)
Description: Helper function used in service implementations to finish handling invocations of the Start() D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. This method will free invocation, you cannot use it afterwards.
Parameters:
  object: A UDisksMDRaid.
  invocation: A GDBusMethodInvocation. [transfer full]
Since: 2.0.0
```

```C
void
udisks_mdraid_complete_start (UDisksMDRaid *object,
                              GDBusMethodInvocation *invocation);
```

--------------------------------

### UDisks2 LogicalVolume Interface Properties Overview

Source: https://storaged.org/doc/udisks2-api/latest/index.html/gdbus-org.freedesktop.UDisks2.LogicalVolume

Overview of all properties available on the `org.freedesktop.UDisks2.LogicalVolume` D-Bus interface, including their readability and data types.

```APIDOC
VolumeGroup             readable   o
Name                    readable   s
Active                  readable   b
UUID                    readable   s
Size                    readable   t
DataAllocatedRatio      readable   d
MetadataAllocatedRatio  readable   d
Type                    readable   s
Layout                  readable   s
Structure               readable   a{sv}
SyncRatio               readable   d
ThinPool                readable   o
Origin                  readable   o
ChildConfiguration      readable   a(sa{sv})
BlockDevice             readable   o
```

--------------------------------

### Get Origin Property for UDisksLogicalVolume (C)

Source: https://storaged.org/doc/udisks2-api/latest/index.html/UDisksLogicalVolume

Gets the value of the 'Origin' D-Bus property from a UDisksLogicalVolume object. This function is suitable for both client- and service-side use. The returned value is only valid until the property changes and should not be freed.

```C
const gchar *
udisks_logical_volume_get_origin (UDisksLogicalVolume *object);
```

```APIDOC
Parameters:
  object: A UDisksLogicalVolume.
Returns:
  The property value or NULL if the property is not set. Do not free the returned value, it belongs to object.
Since: 2.0.0
```

--------------------------------

### UDisks2.Partition D-Bus Interface Properties Overview

Source: https://storaged.org/doc/udisks2-api/latest/index.html/gdbus-org.freedesktop.UDisks2.Partition

Overview of the readable properties available on the `org.freedesktop.UDisks2.Partition` D-Bus interface.

```APIDOC
Number       readable   u
Type         readable   s
Flags        readable   t
Offset       readable   t
Size         readable   t
Name         readable   s
UUID         readable   s
Table        readable   o
IsContainer  readable   b
IsContained  readable   b
```

--------------------------------

### UDisksModuleManager Description and Module Activation

Source: https://storaged.org/doc/udisks2-api/latest/index.html/udisks2-UDisksModuleManager

Explains the UDisks2 daemon's modular approach, how modules extend functionality, their design principles, and the process of module activation via D-Bus, including relevant command-line switches and signals.

```APIDOC
UDisks modular approach:
  - Functionality extended by modules, which are carved-out parts of daemon code.
  - No universal module API; limited to initialization functions and stateful objects.
  - Out-of-tree modules and ABI guarantees are not supported.
  - Modules cannot be unloaded once initialized (current design).
  - Motivation: Keep daemon low on resource footprint for basic usage, activate extended functionality as needed.

Modules activation:
  - UDisksModuleManager singleton manages module usage and activation.
  - Default: Modules loaded on request (delayed startup).
  - Overrides: `--force-load-modules` (load on startup), `--disable-modules` (never load).
  - Client interaction: Call `org.freedesktop.UDisks2.Manager.EnableModule()` D-Bus method to request module activation.
  - Error handling: Proper errors reported if module initialization fails or module is unavailable.
  - Post-activation: `modules-activated` signal emitted internally on UDisksModuleManager object; daemon objects perform "coldplug".
```

--------------------------------

### UDisks2 ATA SMART Self-Test Start Operations

Source: https://storaged.org/doc/udisks2-api/latest/index.html/UDisksDriveAta

Functions to initiate a SMART self-test on an ATA drive. This group includes methods for starting the test asynchronously, handling its completion, and performing synchronous test initiation.

```APIDOC
void udisks_drive_ata_call_smart_selftest_start()
```

```APIDOC
gboolean udisks_drive_ata_call_smart_selftest_start_finish()
```

```APIDOC
gboolean udisks_drive_ata_call_smart_selftest_start_sync()
```

```APIDOC
void udisks_drive_ata_complete_smart_selftest_start()
```

--------------------------------

### UDisksMountMonitor Core Functions Overview

Source: https://storaged.org/doc/udisks2-api/latest/index.html/UDisksMountMonitor

Lists the primary functions available for interacting with UDisksMount and UDisksMountMonitor objects, including methods for retrieving device information, mount types, and paths, as well as comparison and monitor creation.

```APIDOC
Functions:
- dev_t udisks_mount_get_dev()
- UDisksMountType udisks_mount_get_mount_type()
- const gchar * udisks_mount_get_mount_path()
- gint udisks_mount_compare()
- UDisksMountMonitor * udisks_mount_monitor_new()
- GList * udisks_mount_monitor_get_mounts_for_dev()
- gboolean udisks_mount_monitor_is_dev_in_use()
```

--------------------------------

### Get UDisksPartition Table Property (udisks_partition_dup_table)

Source: https://storaged.org/doc/udisks2-api/latest/index.html/UDisksPartition

Gets a copy of the "Table" D-Bus property from a UDisksPartition object. This function is suitable for both client- and service-side usage because the property is readable. The returned string must be freed by the caller.

```C
gchar *
udisks_partition_dup_table (UDisksPartition *object);
```

```APIDOC
udisks_partition_dup_table (object: UDisksPartition*): gchar*
  Parameters:
    object: A UDisksPartition object.
  Returns:
    gchar*: The property value or NULL if the property is not set. The returned value should be freed with g_free().
```

--------------------------------

### UDisksSwapspace API Functions

Source: https://storaged.org/doc/udisks2-api/latest/index.html/UDisksSwapspace

Lists the available functions for interacting with UDisksSwapspace, including methods for starting, stopping, setting labels, and managing UUIDs for swap spaces, along with proxy and skeleton creation functions. Each entry specifies the return type and the function signature.

```APIDOC
GDBusInterfaceInfo * udisks_swapspace_interface_info()
guint udisks_swapspace_override_properties()
void udisks_swapspace_call_start()
gboolean udisks_swapspace_call_start_finish()
gboolean udisks_swapspace_call_start_sync()
void udisks_swapspace_complete_start()
void udisks_swapspace_call_stop()
gboolean udisks_swapspace_call_stop_finish()
gboolean udisks_swapspace_call_stop_sync()
void udisks_swapspace_complete_stop()
void udisks_swapspace_call_set_label()
gboolean udisks_swapspace_call_set_label_finish()
gboolean udisks_swapspace_call_set_label_sync()
void udisks_swapspace_complete_set_label()
void udisks_swapspace_call_set_uuid()
gboolean udisks_swapspace_call_set_uuid_finish()
gboolean udisks_swapspace_call_set_uuid_sync()
void udisks_swapspace_complete_set_uuid()
gboolean udisks_swapspace_get_active()
void udisks_swapspace_set_active()
void udisks_swapspace_proxy_new()
UDisksSwapspace * udisks_swapspace_proxy_new_finish()
UDisksSwapspace * udisks_swapspace_proxy_new_sync()
void udisks_swapspace_proxy_new_for_bus()
UDisksSwapspace * udisks_swapspace_proxy_new_for_bus_finish()
UDisksSwapspace * udisks_swapspace_proxy_new_for_bus_sync()
UDisksSwapspace * udisks_swapspace_skeleton_new()
```

--------------------------------

### Get UDisksPartition UUID Property (udisks_partition_dup_uuid)

Source: https://storaged.org/doc/udisks2-api/latest/index.html/UDisksPartition

Gets a copy of the "UUID" D-Bus property from a UDisksPartition object. This function is suitable for both client- and service-side usage because the property is readable. The returned string must be freed by the caller.

```C
gchar *
udisks_partition_dup_uuid (UDisksPartition *object);
```

```APIDOC
udisks_partition_dup_uuid (object: UDisksPartition*): gchar*
  Parameters:
    object: A UDisksPartition object.
  Returns:
    gchar*: The property value or NULL if the property is not set. The returned value should be freed with g_free().
```

--------------------------------

### Complete UDisks2 Swapspace Start Method Invocation (API Documentation)

Source: https://storaged.org/doc/udisks2-api/latest/index.html/UDisksSwapspace

Helper function used in service implementations to finish handling invocations of the Start() D-Bus method. If an error needs to be returned, g_dbus_method_invocation_return_error() should be used instead. This method frees the invocation object.

```C
void
udisks_swapspace_complete_start (UDisksSwapspace *object,
                                 GDBusMethodInvocation *invocation);
```

```APIDOC
Parameters:
  - object (UDisksSwapspace*): A UDisksSwapspace.
  - invocation (GDBusMethodInvocation*): A GDBusMethodInvocation. [transfer full]
```

--------------------------------

### UDisks2 API: State and Configuration Monitoring

Source: https://storaged.org/doc/udisks2-api/latest/index.html/index

Classes for monitoring system state and configuration files like fstab, crypttab, and utab, as well as mounted filesystems and in-use swap devices.

```APIDOC
UDisksMountMonitor: Monitors mounted filesystems or in-use swap devices
UDisksFstabEntry:
UDisksCrypttabMonitor: Monitors entries in the crypttab file
UDisksUtabMonitor: Monitors entries in the utab file
```

--------------------------------

### UDisksFilesystem API Prerequisites

Source: https://storaged.org/doc/udisks2-api/latest/index.html/UDisksFilesystem

Specifies the necessary dependencies for using UDisksFilesystem, indicating that it requires GObject for its functionality.

```APIDOC
UDisksFilesystem requires GObject.
```