udisksctl(1)

1UDISKSCTL(1)                     User Commands                    UDISKSCTL(1)
2
3
4

NAME

6       udisksctl - The udisks command line tool
7

SYNOPSIS

9       udisksctl status
10
11       udisksctl info {--object-path OBJECT | --block-device DEVICE}
12
13       udisksctl mount {--object-path OBJECT | --block-device DEVICE}
14                 [--filesystem-type TYPE] [--options OPTIONS...]
15                 [--no-user-interaction]
16
17       udisksctl unmount {--object-path OBJECT | --block-device DEVICE}
18                 [--force] [--no-user-interaction]
19
20       udisksctl unlock {--object-path OBJECT | --block-device DEVICE}
21                 [--no-user-interaction] [--key-file PATH]
22
23       udisksctl lock {--object-path OBJECT | --block-device DEVICE}
24                 [--no-user-interaction]
25
26       udisksctl loop-setup --file PATH [--read-only] [--offset OFFSET]
27                 [--size SIZE] [--no-user-interaction]
28
29       udisksctl loop-delete {--object-path OBJECT | --block-device DEVICE}
30                 [--no-user-interaction]
31
32       udisksctl power-off {--object-path OBJECT | --block-device DEVICE}
33                 [--no-user-interaction]
34
35       udisksctl smart-simulate --file PATH {--object-path OBJECT |
36                 --block-device DEVICE} [--no-user-interaction]
37
38       udisksctl monitor
39
40       udisksctl dump
41
42       udisksctl help
43

DESCRIPTION

45       udisksctl is a command-line program used to interact with the
46       udisksd(8) daemon process.
47

COMMANDS

49       status
50           Shows high-level information about disk drives and block devices.
51
52       info
53           Shows detailed information about OBJECT or DEVICE.
54
55       mount
56           Mounts a device. The device will be mounted in a subdirectory in
57           the /media hierarchy - upon successful completion, the mount point
58           will be printed to standard output.
59
60           The device will be mounted with a safe set of default options. You
61           can influence the options passed to the mount(8) command with
62           --options. Note that only safe options are allowed - requests with
63           inherently unsafe options such as suid or dev that would allow the
64           caller to gain additional privileges, are rejected.
65
66       unmount
67           Unmounts a device. This only works if the device is mounted. The
68           option --force can be used to request that the device is unmounted
69           even if active references exists.
70
71       unlock
72           Unlocks an encrypted device. The passphrase will be requested from
73           the controlling terminal and upon successful completion, the
74           cleartext device will be printed to standard output.
75
76       lock
77           Locks a device. This only works if the device is a cleartext device
78           backed by a cryptotext device.
79
80       loop-setup
81           Sets up a loop device backed by FILE.
82
83       loop-delete
84           Tears down a loop device.
85
86       power-off
87           Arranges for the drive to be safely removed and powered off. On the
88           OS side this includes ensuring that no process is using the drive,
89           then requesting that in-flight buffers and caches are committed to
90           stable storage. The exact steps for powering off the drive depends
91           on the drive itself and the interconnect used. For drives connected
92           through USB, the effect is that the USB device will be deconfigured
93           followed by disabling the upstream hub port it is connected to.
94
95           Note that as some physical devices contain multiple drives (for
96           example 4-in-1 flash card reader USB devices) powering off one
97           drive may affect other drives. As such there are not a lot of
98           guarantees associated with performing this action. Usually the
99           effect is that the drive disappears as if it was unplugged.
100
101       smart-simulate
102           Sets SMART data from the libatasmart blob given by FILE - see
103           /usr/share/doc/libatasmart-devel-VERSION/ for blobs shipped with
104           libatasmart. This is a debugging feature used to check that
105           applications act correctly when a disk is failing.
106
107       monitor
108           Monitors the daemon for events.
109
110       dump
111           Prints the current state of the daemon.
112
113       help
114           Prints help and exit.
115

COMMON OPTIONS

117       The option --no-user-interaction can be used to request that no
118       interaction (such as the user being presented with an authentication
119       dialog) must occur when checking with polkit(8) whether the caller is
120       authorized to perform the requested action.
121

AUDIENCE

123       This program does not assume that the caller is the super user - it is
124       intended to be used by unprivileged users and authorizations are
125       checked by the udisks daemon using polkit(8). Additionally, this
126       program is not intended to be used by scripts or other programs -
127       options/commands may change in incompatible ways in the future even in
128       maintenance releases. See the “API STABILITY” section of udisks(8) for
129       more information.
130

BASH COMPLETION

132       udisksctl ships with a bash completion script to complete commands,
133       objects, block devices and some options.
134

AUTHOR

136       This man page was originally written for UDisks2 by David Zeuthen
137       <zeuthen@gmail.com> with a lot of help from many others.
138

BUGS

140       Please send bug reports to either the distribution bug tracker or the
141       upstream bug tracker at
142       https://github.com/storaged-project/udisks/issues.
143