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

DESCRIPTION

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

COMMANDS

50       status
51           Shows high-level information about disk drives and block devices.
52
53       info
54           Shows detailed information about OBJECT, DEVICE or DRIVE.
55
56       mount
57           Mounts a device. The device will be mounted in a subdirectory in
58           the /run/media hierarchy - upon successful completion, the mount
59           point will be printed to standard output.
60
61           -t, --filesystem-type
62               Filesystem type to use. If not specified, autodetected
63               filesystem type will be used.
64
65           -o, --options
66               The device will be mounted with a safe set of default options.
67               You can influence the options passed to the mount(8) command
68               using this option. Note that only safe options are allowed -
69               requests with inherently unsafe options such as suid or dev
70               that would allow the caller to gain additional privileges, are
71               rejected.
72
73       unmount
74           Unmounts a device. This only works if the device is mounted. The
75           option --force can be used to request that the device is unmounted
76           even if active references exists.
77
78           -f, --force
79               Lazy unmount. Detach the filesystem from the file hierarchy
80               now, and clean up all references to this filesystem as soon as
81               it is not busy anymore.
82
83       unlock
84           Unlocks an encrypted device. The passphrase will be requested from
85           the controlling terminal and upon successful completion, the
86           cleartext device will be printed to standard output.
87
88           --key-file=PATH
89               Read passphrase from the given file.
90
91       lock
92           Locks a device. This only works if the device is a cleartext device
93           backed by a cryptotext device.
94
95       loop-setup
96           Sets up a loop device backed by FILE.
97
98           -f, --file=FILE
99               File to set up a loop device for.
100
101           -r, --read-only
102               Set up a read-only loop device.
103
104           -o, --offset=OFFSET
105               The data start is moved OFFSET bytes into the specified file.
106
107           -s, --size=SIZE
108               The data end is set to no more than SIZE bytes after the data
109               start.
110
111       loop-delete
112           Tears down a loop device.
113
114       power-off
115           Arranges for the drive to be safely removed and powered off. On the
116           OS side this includes ensuring that no process is using the drive,
117           then requesting that in-flight buffers and caches are committed to
118           stable storage. The exact steps for powering off the drive depends
119           on the drive itself and the interconnect used. For drives connected
120           through USB, the effect is that the USB device will be deconfigured
121           followed by disabling the upstream hub port it is connected to.
122
123           Note that as some physical devices contain multiple drives (for
124           example 4-in-1 flash card reader USB devices) powering off one
125           drive may affect other drives. As such there are not a lot of
126           guarantees associated with performing this action. Usually the
127           effect is that the drive disappears as if it was unplugged.
128
129       smart-simulate
130           Sets SMART data from the libatasmart blob given by FILE - see
131           /usr/share/doc/libatasmart-devel-VERSION/ for blobs shipped with
132           libatasmart. This is a debugging feature used to check that
133           applications act correctly when a disk is failing.
134
135           -f, --file=FILE
136               File with the libatasmart blob.
137
138       monitor
139           Monitors the daemon for events.
140
141       dump
142           Prints the current state of the daemon.
143
144       help
145           Prints help and exit.
146

DEVICE SPECIFICATION

148       For commands that require a device as an argument following options can
149       be used to specify it.
150
151       -b, --block-device=DEVICE
152           Specify a device by its device file path. For example /dev/sda.
153
154       -p, --object-path=OBJECT
155           Specify a device by the UDisks internal object path without the
156           /org/freedesktop/UDisks2 prefix. For example block_devices/sda for
157           the /dev/sda disk.
158
159       -d, --drive=DRIVE
160           Specify a drive by name, for example VirtIO_Disk. This can be
161           currently used only together with the info command.
162

COMMON OPTIONS

164       The option --no-user-interaction can be used to request that no
165       interaction (such as the user being presented with an authentication
166       dialog) must occur when checking with polkit(8) whether the caller is
167       authorized to perform the requested action.
168

AUDIENCE

170       This program does not assume that the caller is the super user - it is
171       intended to be used by unprivileged users and authorizations are
172       checked by the udisks daemon using polkit(8). Additionally, this
173       program is not intended to be used by scripts or other programs -
174       options/commands may change in incompatible ways in the future even in
175       maintenance releases. See the “API STABILITY” section of udisks(8) for
176       more information.
177

BASH COMPLETION

179       udisksctl ships with a bash completion script to complete commands,
180       objects, block devices and some options.
181

AUTHOR

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

BUGS

187       Please send bug reports to either the distribution bug tracker or the
188       upstream bug tracker at
189       https://github.com/storaged-project/udisks/issues.
190

SEE ALSO

192       udisks(8), udisksd(8), umount.udisks2(8), polkit(8)
193
194
195
196udisks 2.9.1                      August 2018                     UDISKSCTL(1)
Impressum