]> git.ipfire.org Git - thirdparty/systemd.git/blob - man/udevadm.xml
man: fix link markup
[thirdparty/systemd.git] / man / udevadm.xml
1 <?xml version='1.0'?>
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4 <!-- SPDX-License-Identifier: LGPL-2.1+ -->
5
6 <refentry id="udevadm"
7 xmlns:xi="http://www.w3.org/2001/XInclude">
8
9 <refentryinfo>
10 <title>udevadm</title>
11 <productname>systemd</productname>
12 </refentryinfo>
13
14 <refmeta>
15 <refentrytitle>udevadm</refentrytitle>
16 <manvolnum>8</manvolnum>
17 </refmeta>
18
19 <refnamediv>
20 <refname>udevadm</refname><refpurpose>udev management tool</refpurpose>
21 </refnamediv>
22
23 <refsynopsisdiv>
24 <cmdsynopsis>
25 <command>udevadm</command>
26 <arg><option>--debug</option></arg>
27 <arg><option>--version</option></arg>
28 <arg><option>--help</option></arg>
29 </cmdsynopsis>
30 <cmdsynopsis>
31 <command>udevadm info <optional>options</optional> <optional>devpath</optional></command>
32 </cmdsynopsis>
33 <cmdsynopsis>
34 <command>udevadm trigger <optional>options</optional> <optional>devpath</optional></command>
35 </cmdsynopsis>
36 <cmdsynopsis>
37 <command>udevadm settle <optional>options</optional></command>
38 </cmdsynopsis>
39 <cmdsynopsis>
40 <command>udevadm control <replaceable>option</replaceable></command>
41 </cmdsynopsis>
42 <cmdsynopsis>
43 <command>udevadm monitor <optional>options</optional></command>
44 </cmdsynopsis>
45 <cmdsynopsis>
46 <command>udevadm test <optional>options</optional> <replaceable>devpath</replaceable></command>
47 </cmdsynopsis>
48 <cmdsynopsis>
49 <command>udevadm test-builtin <optional>options</optional> <replaceable>command</replaceable> <replaceable>devpath</replaceable></command>
50 </cmdsynopsis>
51 </refsynopsisdiv>
52
53 <refsect1><title>Description</title>
54 <para><command>udevadm</command> expects a command and command
55 specific options. It controls the runtime behavior of
56 <command>systemd-udevd</command>, requests kernel events, manages
57 the event queue, and provides simple debugging mechanisms.</para>
58 </refsect1>
59
60 <refsect1><title>Options</title>
61 <variablelist>
62 <varlistentry>
63 <term><option>-d</option></term>
64 <term><option>--debug</option></term>
65 <listitem>
66 <para>Print debug messages to standard error. This option is implied in <command>udevadm test</command> and
67 <command>udevadm test-builtin</command> commands.</para>
68 </listitem>
69 </varlistentry>
70
71 <xi:include href="standard-options.xml" xpointer="help" />
72 </variablelist>
73
74 <refsect2><title>udevadm info
75 <arg choice="opt"><replaceable>options</replaceable></arg>
76 <arg choice="opt" rep="repeat"><replaceable>devpath</replaceable>|<replaceable>file</replaceable>|<replaceable>unit</replaceable></arg>
77 </title>
78
79 <para>Query the udev database for device information.</para>
80
81 <para>Positional arguments should be used to specify one or more devices. Each one may be a device name
82 (in which case it must start with <filename>/dev/</filename>), a sys path (in which case it must start
83 with <filename>/sys/</filename>), or a systemd device unit name (in which case it must end with
84 <literal>.device</literal>, see
85 <citerefentry><refentrytitle>systemd.device</refentrytitle><manvolnum>5</manvolnum></citerefentry>).
86 </para>
87
88 <variablelist>
89 <varlistentry>
90 <term><option>-q</option></term>
91 <term><option>--query=<replaceable>TYPE</replaceable></option></term>
92 <listitem>
93 <para>Query the database for the specified type of device data.
94 Valid <replaceable>TYPE</replaceable>s are:
95 <constant>name</constant>, <constant>symlink</constant>,
96 <constant>path</constant>, <constant>property</constant>,
97 <constant>all</constant>.</para>
98 </listitem>
99 </varlistentry>
100
101 <varlistentry>
102 <term><option>-p</option></term>
103 <term><option>--path=<replaceable>DEVPATH</replaceable></option></term>
104 <listitem>
105 <para>The <filename>/sys</filename> path of the device to query, e.g.
106 <filename><optional>/sys</optional>/class/block/sda</filename>. This option is an alternative to
107 the positional argument with a <filename>/sys/</filename> prefix. <command>udevadm info
108 --path=/class/block/sda</command> is equivalent to <command>udevadm info
109 /sys/class/block/sda</command>.</para>
110 </listitem>
111 </varlistentry>
112 <varlistentry>
113 <term><option>-n</option></term>
114 <term><option>--name=<replaceable>FILE</replaceable></option></term>
115 <listitem>
116 <para>The name of the device node or a symlink to query,
117 e.g. <filename><optional>/dev</optional>/sda</filename>. This option is an alternative to the
118 positional argument with a <filename>/dev/</filename> prefix. <command>udevadm info
119 --name=sda</command> is equivalent to <command>udevadm info /dev/sda</command>.</para>
120 </listitem>
121 </varlistentry>
122 <varlistentry>
123 <term><option>-r</option></term>
124 <term><option>--root</option></term>
125 <listitem>
126 <para>Print absolute paths in <command>name</command> or <command>symlink</command>
127 query.</para>
128 </listitem>
129 </varlistentry>
130 <varlistentry>
131 <term><option>-a</option></term>
132 <term><option>--attribute-walk</option></term>
133 <listitem>
134 <para>Print all sysfs properties of the specified device that can be used
135 in udev rules to match the specified device. It prints all devices
136 along the chain, up to the root of sysfs that can be used in udev rules.</para>
137 </listitem>
138 </varlistentry>
139 <varlistentry>
140 <term><option>-x</option></term>
141 <term><option>--export</option></term>
142 <listitem>
143 <para>Print output as key/value pairs. Values are enclosed in single quotes.
144 This takes effects only when <option>--query=property</option> or
145 <option>--device-id-of-file=<replaceable>FILE</replaceable></option> is specified.</para>
146 </listitem>
147 </varlistentry>
148 <varlistentry>
149 <term><option>-P</option></term>
150 <term><option>--export-prefix=<replaceable>NAME</replaceable></option></term>
151 <listitem>
152 <para>Add a prefix to the key name of exported values.
153 This implies <option>--export</option>.</para>
154 </listitem>
155 </varlistentry>
156 <varlistentry>
157 <term><option>-d</option></term>
158 <term><option>--device-id-of-file=<replaceable>FILE</replaceable></option></term>
159 <listitem>
160 <para>Print major/minor numbers of the underlying device, where the file lives on.
161 If this is specified, all positional arguments are ignored.</para>
162 </listitem>
163 </varlistentry>
164 <varlistentry>
165 <term><option>-e</option></term>
166 <term><option>--export-db</option></term>
167 <listitem>
168 <para>Export the content of the udev database.</para>
169 </listitem>
170 </varlistentry>
171 <varlistentry>
172 <term><option>-c</option></term>
173 <term><option>--cleanup-db</option></term>
174 <listitem>
175 <para>Cleanup the udev database.</para>
176 </listitem>
177 </varlistentry>
178 <varlistentry>
179 <term><option>-w<optional>SECONDS</optional></option></term>
180 <term><option>--wait-for-initialization<optional>=SECONDS</optional></option></term>
181 <listitem>
182 <para>Wait for device to be initialized. If argument <replaceable>SECONDS</replaceable>
183 is not specified, the default is to wait forever.</para>
184 </listitem>
185 </varlistentry>
186
187 <xi:include href="standard-options.xml" xpointer="help" />
188 </variablelist>
189 </refsect2>
190
191 <refsect2><title>udevadm trigger
192 <arg choice="opt"><replaceable>options</replaceable></arg>
193 <arg choice="opt"><replaceable>devpath</replaceable>|<replaceable>file</replaceable>|<replaceable>unit</replaceable></arg>
194 </title>
195 <para>Request device events from the kernel. Primarily used to replay events at system coldplug time.</para>
196
197 <para>Takes device specifications as positional arguments. See the description of <command>info</command>
198 above.</para>
199
200 <variablelist>
201 <varlistentry>
202 <term><option>-v</option></term>
203 <term><option>--verbose</option></term>
204 <listitem>
205 <para>Print the list of devices which will be triggered.</para>
206 </listitem>
207 </varlistentry>
208 <varlistentry>
209 <term><option>-n</option></term>
210 <term><option>--dry-run</option></term>
211 <listitem>
212 <para>Do not actually trigger the event.</para>
213 </listitem>
214 </varlistentry>
215 <varlistentry>
216 <term><option>-t</option></term>
217 <term><option>--type=<replaceable>TYPE</replaceable></option></term>
218 <listitem>
219 <para>Trigger a specific type of devices. Valid types are:
220 <command>devices</command>, <command>subsystems</command>.
221 The default value is <command>devices</command>.</para>
222 </listitem>
223 </varlistentry>
224 <varlistentry>
225 <term><option>-c</option></term>
226 <term><option>--action=<replaceable>ACTION</replaceable></option></term>
227 <listitem>
228 <para>Type of event to be triggered. Possible actions are <literal>add</literal>,
229 <literal>remove</literal>, <literal>change</literal>, <literal>move</literal>,
230 <literal>online</literal>, <literal>offline</literal>, <literal>bind</literal>,
231 and <literal>unbind</literal>. Also, the special value <literal>help</literal> can be used
232 to list the possible actions. The default value is <literal>change</literal>.
233 </para>
234 </listitem>
235 </varlistentry>
236 <varlistentry>
237 <term><option>-s</option></term>
238 <term><option>--subsystem-match=<replaceable>SUBSYSTEM</replaceable></option></term>
239 <listitem>
240 <para>Trigger events for devices which belong to a
241 matching subsystem. This option supports shell style pattern matching.
242 When this option is specified more than once, then each matching result is ORed, that is,
243 all the devices in each subsystem are triggered.</para>
244 </listitem>
245 </varlistentry>
246 <varlistentry>
247 <term><option>-S</option></term>
248 <term><option>--subsystem-nomatch=<replaceable>SUBSYSTEM</replaceable></option></term>
249 <listitem>
250 <para>Do not trigger events for devices which belong to a matching subsystem. This option
251 supports shell style pattern matching. When this option is specified more than once,
252 then each matching result is ANDed, that is, devices which do not match all specified
253 subsystems are triggered.</para>
254 </listitem>
255 </varlistentry>
256 <varlistentry>
257 <term><option>-a</option></term>
258 <term><option>--attr-match=<replaceable>ATTRIBUTE</replaceable>=<replaceable>VALUE</replaceable></option></term>
259 <listitem>
260 <para>Trigger events for devices with a matching sysfs attribute. If a value is specified along
261 with the attribute name, the content of the attribute is matched against the given value using
262 shell style pattern matching. If no value is specified, the existence of the sysfs attribute is
263 checked. When this option is specified multiple times, then each matching result is ANDed,
264 that is, only devices which have all specified attributes are triggered.</para>
265 </listitem>
266 </varlistentry>
267 <varlistentry>
268 <term><option>-A</option></term>
269 <term><option>--attr-nomatch=<replaceable>ATTRIBUTE</replaceable>=<replaceable>VALUE</replaceable></option></term>
270 <listitem>
271 <para>Do not trigger events for devices with a matching sysfs attribute. If a value is specified
272 along with the attribute name, the content of the attribute is matched against the given value
273 using shell style pattern matching. If no value is specified, the existence of the sysfs attribute
274 is checked. When this option is specified multiple times, then each matching result is ANDed,
275 that is, only devices which have none of the specified attributes are triggered.</para>
276 </listitem>
277 </varlistentry>
278 <varlistentry>
279 <term><option>-p</option></term>
280 <term><option>--property-match=<replaceable>PROPERTY</replaceable>=<replaceable>VALUE</replaceable></option></term>
281 <listitem>
282 <para>Trigger events for devices with a matching property value. This option supports shell style
283 pattern matching. When this option is specified more than once, then each matching result is ORed,
284 that is, devices which have one of the specified properties are triggered.</para>
285 </listitem>
286 </varlistentry>
287 <varlistentry>
288 <term><option>-g</option></term>
289 <term><option>--tag-match=<replaceable>PROPERTY</replaceable></option></term>
290 <listitem>
291 <para>Trigger events for devices with a matching tag. When this option is specified multiple times,
292 then each matching result is ANDed, that is, devices which have all specified tags are triggered.</para>
293 </listitem>
294 </varlistentry>
295 <varlistentry>
296 <term><option>-y</option></term>
297 <term><option>--sysname-match=<replaceable>NAME</replaceable></option></term>
298 <listitem>
299 <para>Trigger events for devices for which the last component (i.e. the filename) of the
300 <filename>/sys</filename> path matches the specified <replaceable>PATH</replaceable>. This option
301 supports shell style pattern matching. When this option is specified more than once, then each
302 matching result is ORed, that is, all devices which have any of the specified
303 <replaceable>NAME</replaceable> are triggered.</para>
304 </listitem>
305 </varlistentry>
306 <varlistentry>
307 <term><option>--name-match=<replaceable>NAME</replaceable></option></term>
308 <listitem>
309 <para>Trigger events for devices with a matching device path. When this option is specified more than once,
310 then each matching result is ORed, that is, all specified devices are triggered.</para>
311 </listitem>
312 </varlistentry>
313 <varlistentry>
314 <term><option>-b</option></term>
315 <term><option>--parent-match=<replaceable>SYSPATH</replaceable></option></term>
316 <listitem>
317 <para>Trigger events for all children of a given device. When this option is specified more than once,
318 then each matching result is ORed, that is, all children of each specified device are triggered.</para>
319 </listitem>
320 </varlistentry>
321 <varlistentry>
322 <term><option>-w</option></term>
323 <term><option>--settle</option></term>
324 <listitem>
325 <para>Apart from triggering events, also waits for those events to
326 finish. Note that this is different from calling <command>udevadm
327 settle</command>. <command>udevadm settle</command> waits for all
328 events to finish. This option only waits for events triggered by
329 the same command to finish.</para>
330 </listitem>
331 </varlistentry>
332 <varlistentry>
333 <term><option>--wait-daemon[=<replaceable>SECONDS</replaceable>]</option></term>
334 <listitem>
335 <para>Before triggering uevents, wait for systemd-udevd daemon to be initialized.
336 Optionally takes timeout value. Default timeout is 5 seconds. This is equivalent to invoke
337 invoking <command>udevadm control --ping</command> before <command>udevadm trigger</command>.</para>
338 </listitem>
339 </varlistentry>
340
341 <xi:include href="standard-options.xml" xpointer="help" />
342 </variablelist>
343
344 <para>In addition, optional positional arguments can be used
345 to specify device names or sys paths. They must start with
346 <filename>/dev</filename> or <filename>/sys</filename>
347 respectively.</para>
348 </refsect2>
349
350 <refsect2><title>udevadm settle
351 <arg choice="opt"><replaceable>options</replaceable></arg>
352 </title>
353 <para>Watches the udev event queue, and exits if all current events are handled.</para>
354 <variablelist>
355 <varlistentry>
356 <term><option>-t</option></term>
357 <term><option>--timeout=<replaceable>SECONDS</replaceable></option></term>
358 <listitem>
359 <para>Maximum number of seconds to wait for the event
360 queue to become empty. The default value is 120 seconds. A
361 value of 0 will check if the queue is empty and always
362 return immediately. A non-zero value will return an exit
363 code of 0 if queue became empty before timeout was reached,
364 non-zero otherwise.</para>
365 </listitem>
366 </varlistentry>
367 <varlistentry>
368 <term><option>-E</option></term>
369 <term><option>--exit-if-exists=<replaceable>FILE</replaceable></option></term>
370 <listitem>
371 <para>Stop waiting if file exists.</para>
372 </listitem>
373 </varlistentry>
374
375 <xi:include href="standard-options.xml" xpointer="help" />
376 </variablelist>
377
378 <para>See
379 <citerefentry><refentrytitle>systemd-udev-settle.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
380 for more information.</para>
381 </refsect2>
382
383 <refsect2><title>udevadm control <replaceable>option</replaceable></title>
384 <para>Modify the internal state of the running udev daemon.</para>
385 <variablelist>
386 <varlistentry>
387 <term><option>-e</option></term>
388 <term><option>--exit</option></term>
389 <listitem>
390 <para>Signal and wait for systemd-udevd to exit. No option except for
391 <option>--timeout</option> can be specified after this option.
392 Note that <filename>systemd-udevd.service</filename> contains
393 <option>Restart=always</option> and so as a result, this option restarts systemd-udevd.
394 If you want to stop <filename>systemd-udevd.service</filename>, please use the following:
395 <programlisting>systemctl stop systemd-udevd-control.socket systemd-udevd-kernel.socket systemd-udevd.service</programlisting>
396 </para>
397 </listitem>
398 </varlistentry>
399 <varlistentry>
400 <term><option>-l</option></term>
401 <term><option>--log-priority=<replaceable>value</replaceable></option></term>
402 <listitem>
403 <para>Set the internal log level of
404 <filename>systemd-udevd</filename>. Valid values are the
405 numerical syslog priorities or their textual
406 representations: <option>emerg</option>,
407 <option>alert</option>, <option>crit</option>,
408 <option>err</option>, <option>warning</option>,
409 <option>notice</option>, <option>info</option>, and
410 <option>debug</option>.</para>
411 </listitem>
412 </varlistentry>
413 <varlistentry>
414 <term><option>-s</option></term>
415 <term><option>--stop-exec-queue</option></term>
416 <listitem>
417 <para>Signal systemd-udevd to stop executing new events. Incoming events
418 will be queued.</para>
419 </listitem>
420 </varlistentry>
421 <varlistentry>
422 <term><option>-S</option></term>
423 <term><option>--start-exec-queue</option></term>
424 <listitem>
425 <para>Signal systemd-udevd to enable the execution of events.</para>
426 </listitem>
427 </varlistentry>
428 <varlistentry>
429 <term><option>-R</option></term>
430 <term><option>--reload</option></term>
431 <listitem>
432 <para>Signal systemd-udevd to reload the rules files and other databases like the kernel
433 module index. Reloading rules and databases does not apply any changes to already
434 existing devices; the new configuration will only be applied to new events.</para>
435 </listitem>
436 </varlistentry>
437 <varlistentry>
438 <term><option>-p</option></term>
439 <term><option>--property=<replaceable>KEY</replaceable>=<replaceable>value</replaceable></option></term>
440 <listitem>
441 <para>Set a global property for all events.</para>
442 </listitem>
443 </varlistentry>
444 <varlistentry>
445 <term><option>-m</option></term>
446 <term><option>--children-max=</option><replaceable>value</replaceable></term>
447 <listitem>
448 <para>Set the maximum number of events, systemd-udevd will handle at the
449 same time.</para>
450 </listitem>
451 </varlistentry>
452 <varlistentry>
453 <term><option>--ping</option></term>
454 <listitem>
455 <para>Send a ping message to systemd-udevd and wait for the reply. This may be useful to check that
456 systemd-udevd daemon is running.</para>
457 </listitem>
458 </varlistentry>
459 <varlistentry>
460 <term><option>-t</option></term>
461 <term><option>--timeout=</option><replaceable>seconds</replaceable></term>
462 <listitem>
463 <para>The maximum number of seconds to wait for a reply from systemd-udevd.</para>
464 </listitem>
465 </varlistentry>
466
467 <xi:include href="standard-options.xml" xpointer="help" />
468 </variablelist>
469 </refsect2>
470
471 <refsect2><title>udevadm monitor
472 <arg choice="opt"><replaceable>options</replaceable></arg>
473 </title>
474 <para>Listens to the kernel uevents and events sent out by a udev rule
475 and prints the devpath of the event to the console. It can be used to analyze the
476 event timing, by comparing the timestamps of the kernel uevent and the udev event.
477 </para>
478 <variablelist>
479 <varlistentry>
480 <term><option>-k</option></term>
481 <term><option>--kernel</option></term>
482 <listitem>
483 <para>Print the kernel uevents.</para>
484 </listitem>
485 </varlistentry>
486 <varlistentry>
487 <term><option>-u</option></term>
488 <term><option>--udev</option></term>
489 <listitem>
490 <para>Print the udev event after the rule processing.</para>
491 </listitem>
492 </varlistentry>
493 <varlistentry>
494 <term><option>-p</option></term>
495 <term><option>--property</option></term>
496 <listitem>
497 <para>Also print the properties of the event.</para>
498 </listitem>
499 </varlistentry>
500 <varlistentry>
501 <term><option>-s</option></term>
502 <term><option>--subsystem-match=<replaceable>string[/string]</replaceable></option></term>
503 <listitem>
504 <para>Filter kernel uevents and udev events by subsystem[/devtype]. Only events with a matching subsystem value will pass.
505 When this option is specified more than once, then each matching result is ORed, that is, all devices in the specified
506 subsystems are monitored.</para>
507 </listitem>
508 </varlistentry>
509 <varlistentry>
510 <term><option>-t</option></term>
511 <term><option>--tag-match=<replaceable>string</replaceable></option></term>
512 <listitem>
513 <para>Filter udev events by tag. Only udev events with a given tag attached will pass.
514 When this option is specified more than once, then each matching result is ORed, that is, devices which have one of the
515 specified tags are monitored.</para>
516 </listitem>
517 </varlistentry>
518
519 <xi:include href="standard-options.xml" xpointer="help" />
520 </variablelist>
521 </refsect2>
522
523 <refsect2><title>udevadm test
524 <arg choice="opt"><replaceable>options</replaceable></arg>
525 <arg><replaceable>devpath</replaceable></arg>
526 </title>
527 <para>Simulate a udev event run for the given device, and print debug output.</para>
528 <variablelist>
529 <varlistentry>
530 <term><option>-a</option></term>
531 <term><option>--action=<replaceable>ACTION</replaceable></option></term>
532 <listitem>
533 <para>Type of event to be simulated. Possible actions are <literal>add</literal>,
534 <literal>remove</literal>, <literal>change</literal>, <literal>move</literal>,
535 <literal>online</literal>, <literal>offline</literal>, <literal>bind</literal>,
536 and <literal>unbind</literal>. Also, the special value <literal>help</literal> can be used
537 to list the possible actions. The default value is <literal>add</literal>.</para>
538 </listitem>
539 </varlistentry>
540 <varlistentry>
541 <term><option>-N</option></term>
542 <term><option>--resolve-names=<constant>early</constant>|<constant>late</constant>|<constant>never</constant></option></term>
543 <listitem>
544 <para>Specify when udevadm should resolve names of users
545 and groups. When set to <constant>early</constant> (the
546 default), names will be resolved when the rules are
547 parsed. When set to <constant>late</constant>, names will
548 be resolved for every event. When set to
549 <constant>never</constant>, names will never be resolved
550 and all devices will be owned by root.</para>
551 </listitem>
552 </varlistentry>
553
554 <xi:include href="standard-options.xml" xpointer="help" />
555 </variablelist>
556 </refsect2>
557
558 <refsect2><title>udevadm test-builtin
559 <arg choice="opt"><replaceable>options</replaceable></arg>
560 <arg><replaceable>command</replaceable></arg>
561 <arg><replaceable>devpath</replaceable></arg>
562 </title>
563 <para>Run a built-in command <replaceable>COMMAND</replaceable>
564 for device <replaceable>DEVPATH</replaceable>, and print debug
565 output.</para>
566 <variablelist>
567 <xi:include href="standard-options.xml" xpointer="help" />
568 </variablelist>
569 </refsect2>
570 </refsect1>
571
572 <refsect1>
573 <title>See Also</title>
574 <para><citerefentry>
575 <refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum>
576 </citerefentry>,
577 <citerefentry>
578 <refentrytitle>systemd-udevd.service</refentrytitle><manvolnum>8</manvolnum>
579 </citerefentry></para>
580 </refsect1>
581 </refentry>