blob: f790351b3b2e8f42045f8f09e95eec6e1de6b7ce (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
|
<!DOCTYPE node PUBLIC
"-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
<node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
<interface name="org.freedesktop.UDisks">
<!-- ************************************************************ -->
<method name="EnumerateAdapters">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="devices" direction="out" type="ao">
<doc:doc><doc:summary>An array of object paths for storage adapters.</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Enumerate all storage adapters on the system.
</doc:para>
</doc:description>
</doc:doc>
</method>
<!-- ************************************************************ -->
<method name="EnumerateExpanders">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="devices" direction="out" type="ao">
<doc:doc><doc:summary>An array of object paths for storage expanders.</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Enumerate all storage expanders on the system.
</doc:para>
</doc:description>
</doc:doc>
</method>
<!-- ************************************************************ -->
<method name="EnumeratePorts">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="devices" direction="out" type="ao">
<doc:doc><doc:summary>An array of object paths for ports.</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Enumerate all storage ports on the system.
</doc:para>
</doc:description>
</doc:doc>
</method>
<!-- ************************************************************ -->
<method name="EnumerateDevices">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="devices" direction="out" type="ao">
<doc:doc><doc:summary>An array of object paths for devices.</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Enumerate all disk devices on the system.
</doc:para>
</doc:description>
</doc:doc>
</method>
<!-- ************************************************************ -->
<method name="EnumerateDeviceFiles">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="device_files" direction="out" type="as">
<doc:doc><doc:summary>An array device file names.</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Enumerate all device files (including symlinks) for disk devices on the system.
</doc:para>
</doc:description>
</doc:doc>
</method>
<!-- ************************************************************ -->
<method name="FindDeviceByDeviceFile">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="device_file" direction="in" type="s">
<doc:doc><doc:summary>UNIX special device file</doc:summary></doc:doc>
</arg>
<arg name="device" direction="out" type="o">
<doc:doc><doc:summary>Object path of device</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Finds a device by device path.
</doc:para>
</doc:description>
</doc:doc>
</method>
<!-- ************************************************************ -->
<method name="FindDeviceByMajorMinor">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="device_major" direction="in" type="x">
<doc:doc><doc:summary>Device major</doc:summary></doc:doc>
</arg>
<arg name="device_minor" direction="in" type="x">
<doc:doc><doc:summary>Device minor</doc:summary></doc:doc>
</arg>
<arg name="device" direction="out" type="o">
<doc:doc><doc:summary>Object path of device</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Finds a device by major:minor.
</doc:para>
</doc:description>
</doc:doc>
</method>
<!-- ************************************************************ -->
<method name="DriveInhibitAllPolling">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="options" direction="in" type="as">
<doc:doc><doc:summary>Inhibit options. Currently no options are recognized.</doc:summary></doc:doc>
</arg>
<arg name="cookie" direction="out" type="s">
<doc:doc><doc:summary>
A cookie that can be used in the
<doc:ref type="method" to="Disks.DriveUninhibitAllPolling">DriveUninhibitAllPolling()</doc:ref> method
to stop inhibiting polling of all devices.
</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Inhibits the daemon from polling devices for media changes.
</doc:para>
</doc:description>
<doc:permission>
The caller will need one of the following PolicyKit authorizations:
<doc:list>
<doc:item>
<doc:term>org.freedesktop.udisks.inhibit-polling</doc:term>
<doc:definition>To inhibit polling</doc:definition>
</doc:item>
</doc:list>
</doc:permission>
<doc:errors>
<doc:error name="org.freedesktop.PolicyKit.Error.NotAuthorized">if the caller lacks the appropriate PolicyKit authorization</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Failed">if the operation failed</doc:error>
</doc:errors>
</doc:doc>
</method>
<!-- ************************************************************ -->
<method name="DriveUninhibitAllPolling">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="cookie" direction="in" type="s">
<doc:doc><doc:summary>
A cookie obtained from the
<doc:ref type="method" to="Disks.DriveInhibitAllPolling">DriveInhibitAllPolling()</doc:ref> method.
</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Uninhibits daemon from polling devices for media changes.
</doc:para>
</doc:description>
<doc:errors>
<doc:error name="org.freedesktop.PolicyKit.Error.Failed">if the given cookie is malformed</doc:error>
</doc:errors>
</doc:doc>
</method>
<!-- ************************************************************ -->
<method name="DriveSetAllSpindownTimeouts">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="timeout_seconds" direction="in" type="i">
<doc:doc><doc:summary>
Number of seconds before drives should be spun down.
</doc:summary></doc:doc>
</arg>
<arg name="options" direction="in" type="as">
<doc:doc><doc:summary>
Options related to setting spindown timeouts. Currently no options are recognized.
</doc:summary></doc:doc>
</arg>
<arg name="cookie" direction="out" type="s">
<doc:doc><doc:summary>
A cookie that can be used in the
<doc:ref type="method" to="Drive.DriveUnsetAllSpindownTimeouts">DriveUnsetAllSpindownTimeouts()</doc:ref> method
to unset the spindown timeout for drives.
</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Configures spindown timeout for all drives capable of being spun down.
Caution should be exercised when using this method, see
the SPINNING DOWN DISKS section in the
udisks<doc:tt>(1)</doc:tt> man page before using it.
</doc:para>
</doc:description>
<doc:permission>
The caller will need one of the following PolicyKit authorizations:
<doc:list>
<doc:item>
<doc:term>org.freedesktop.udisks.drive-set-spindown</doc:term>
<doc:definition>To set spindown timeouts</doc:definition>
</doc:item>
</doc:list>
</doc:permission>
<doc:errors>
<doc:error name="org.freedesktop.PolicyKit.Error.NotAuthorized">if the caller lacks the appropriate PolicyKit authorization</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Failed">if the operation failed</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.InvalidOption">if an invalid or malformed option was given</doc:error>
</doc:errors>
</doc:doc>
</method>
<!-- ************************************************************ -->
<method name="DriveUnsetAllSpindownTimeouts">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="cookie" direction="in" type="s">
<doc:doc><doc:summary>
A cookie obtained from the
<doc:ref type="method" to="Device.DriveSetSpindownTimeout">DriveSetSpindownTimeout()</doc:ref> method.
</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Unsets spindown timeout for the drive.
</doc:para>
</doc:description>
<doc:permission>
The caller will need one of the following PolicyKit authorizations:
<doc:list>
<doc:item>
<doc:term>org.freedesktop.udisks.drive-set-spindown</doc:term>
<doc:definition>To set spindown timeouts</doc:definition>
</doc:item>
</doc:list>
</doc:permission>
<doc:errors>
<doc:error name="org.freedesktop.PolicyKit.Error.NotAuthorized">if the caller lacks the appropriate PolicyKit authorization</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Failed">if the operation failed</doc:error>
</doc:errors>
</doc:doc>
</method>
<!-- ************************************************************ -->
<method name="LinuxLvm2VGStart">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="uuid" direction="in" type="s">
<doc:doc><doc:summary>The UUID of the volume group to start.</doc:summary></doc:doc>
</arg>
<arg name="options" direction="in" type="as">
<doc:doc><doc:summary>Options for starting the VG. Currently no options are supported.</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Starts all logical volumes in Linux LVM2 Volume Group.
</doc:para>
</doc:description>
<doc:permission>
The caller will need the following PolicyKit authorization:
<doc:list>
<doc:item>
<doc:term>org.freedesktop.udisks.linux-lvm2</doc:term>
<doc:definition>
Needed to configured Linux LVM2 devices.
</doc:definition>
</doc:item>
</doc:list>
</doc:permission>
<doc:errors>
<doc:error name="org.freedesktop.PolicyKit.Error.NotAuthorized">if the caller lacks the appropriate PolicyKit authorization</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Busy">if one of the given components are busy</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Failed">if the operation failed</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Cancelled">if the job was cancelled</doc:error>
</doc:errors>
</doc:doc>
</method>
<!-- ************************************************************ -->
<method name="LinuxLvm2VGStop">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="uuid" direction="in" type="s">
<doc:doc><doc:summary>The UUID of the volume group to stop.</doc:summary></doc:doc>
</arg>
<arg name="options" direction="in" type="as">
<doc:doc><doc:summary>Options for stopping the VG. Currently no options are supported.</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Stops all logical volumes in Linux LVM2 Volume Group.
</doc:para>
</doc:description>
<doc:permission>
The caller will need the following PolicyKit authorization:
<doc:list>
<doc:item>
<doc:term>org.freedesktop.udisks.linux-lvm2</doc:term>
<doc:definition>
Needed to configured Linux LVM2 devices.
</doc:definition>
</doc:item>
</doc:list>
</doc:permission>
<doc:errors>
<doc:error name="org.freedesktop.PolicyKit.Error.NotAuthorized">if the caller lacks the appropriate PolicyKit authorization</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Busy">if one of the given components are busy</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Failed">if the operation failed</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Cancelled">if the job was cancelled</doc:error>
</doc:errors>
</doc:doc>
</method>
<!-- ************************************************************ -->
<method name="LinuxLvm2VGSetName">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="uuid" direction="in" type="s">
<doc:doc><doc:summary>The UUID of the volume group to set the name for.</doc:summary></doc:doc>
</arg>
<arg name="name" direction="in" type="s">
<doc:doc><doc:summary>The new name for the volume group.</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Sets the name for a volume group.
</doc:para>
</doc:description>
<doc:permission>
The caller will need the following PolicyKit authorization:
<doc:list>
<doc:item>
<doc:term>org.freedesktop.udisks.linux-lvm2</doc:term>
<doc:definition>
Needed to configured Linux LVM2 devices.
</doc:definition>
</doc:item>
</doc:list>
</doc:permission>
<doc:errors>
<doc:error name="org.freedesktop.PolicyKit.Error.NotAuthorized">if the caller lacks the appropriate PolicyKit authorization</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Busy">if one of the given components are busy</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Failed">if the operation failed</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Cancelled">if the job was cancelled</doc:error>
</doc:errors>
</doc:doc>
</method>
<!-- ************************************************************ -->
<method name="LinuxLvm2VGAddPV">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="uuid" direction="in" type="s">
<doc:doc><doc:summary>The UUID of the volume group to add a physical volume to.</doc:summary></doc:doc>
</arg>
<arg name="physical_volume" direction="in" type="o">
<doc:doc><doc:summary>The objcet path of the device to use as a physical volume.</doc:summary></doc:doc>
</arg>
<arg name="options" direction="in" type="as">
<doc:doc><doc:summary>Currently unused.</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Adds a Physical volume to a Linux LVM2 Volume Group. Existing data
on the given device to use for a physical volume will be erased.
</doc:para>
</doc:description>
<doc:permission>
The caller will need the following PolicyKit authorization:
<doc:list>
<doc:item>
<doc:term>org.freedesktop.udisks.linux-lvm2</doc:term>
<doc:definition>
Needed to configured Linux LVM2 devices.
</doc:definition>
</doc:item>
</doc:list>
</doc:permission>
<doc:errors>
<doc:error name="org.freedesktop.PolicyKit.Error.NotAuthorized">if the caller lacks the appropriate PolicyKit authorization</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Busy">if one of the given components are busy</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Failed">if the operation failed</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Cancelled">if the job was cancelled</doc:error>
</doc:errors>
</doc:doc>
</method>
<!-- ************************************************************ -->
<method name="LinuxLvm2VGRemovePV">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="vg_uuid" direction="in" type="s">
<doc:doc><doc:summary>The UUID of the volume group to remove the physical volume from.</doc:summary></doc:doc>
</arg>
<arg name="pv_uuid" direction="in" type="s">
<doc:doc><doc:summary>The UUID of the physical volume to remove from the VG.</doc:summary></doc:doc>
</arg>
<arg name="options" direction="in" type="as">
<doc:doc><doc:summary>Currently unused.</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Removes a Physical volume from a Linux LVM2 Volume Group.
</doc:para>
</doc:description>
<doc:permission>
The caller will need the following PolicyKit authorization:
<doc:list>
<doc:item>
<doc:term>org.freedesktop.udisks.linux-lvm2</doc:term>
<doc:definition>
Needed to configured Linux LVM2 devices.
</doc:definition>
</doc:item>
</doc:list>
</doc:permission>
<doc:errors>
<doc:error name="org.freedesktop.PolicyKit.Error.NotAuthorized">if the caller lacks the appropriate PolicyKit authorization</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Busy">if one of the given components are busy</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Failed">if the operation failed</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Cancelled">if the job was cancelled</doc:error>
</doc:errors>
</doc:doc>
</method>
<!-- ************************************************************ -->
<method name="LinuxLvm2LVSetName">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="group_uuid" direction="in" type="s">
<doc:doc><doc:summary>The UUID of the volume group for the logical volume.</doc:summary></doc:doc>
</arg>
<arg name="uuid" direction="in" type="s">
<doc:doc><doc:summary>The UUID of the logical volume to set the name for.</doc:summary></doc:doc>
</arg>
<arg name="name" direction="in" type="s">
<doc:doc><doc:summary>The new name for the logical volume.</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Sets the name for a logical volume.
</doc:para>
</doc:description>
<doc:permission>
The caller will need the following PolicyKit authorization:
<doc:list>
<doc:item>
<doc:term>org.freedesktop.udisks.linux-lvm2</doc:term>
<doc:definition>
Needed to configured Linux LVM2 devices.
</doc:definition>
</doc:item>
</doc:list>
</doc:permission>
<doc:errors>
<doc:error name="org.freedesktop.PolicyKit.Error.NotAuthorized">if the caller lacks the appropriate PolicyKit authorization</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Busy">if one of the given components are busy</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Failed">if the operation failed</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Cancelled">if the job was cancelled</doc:error>
</doc:errors>
</doc:doc>
</method>
<!-- ************************************************************ -->
<method name="LinuxLvm2LVStart">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="group_uuid" direction="in" type="s">
<doc:doc><doc:summary>The UUID of the volume group of the logical volume to start belongs to.</doc:summary></doc:doc>
</arg>
<arg name="uuid" direction="in" type="s">
<doc:doc><doc:summary>The UUID of the logical volume to start.</doc:summary></doc:doc>
</arg>
<arg name="options" direction="in" type="as">
<doc:doc><doc:summary>Options for starting the logical volume. Currently no options are supported.</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Starts a LVM2 logical volume.
</doc:para>
</doc:description>
<doc:permission>
The caller will need the following PolicyKit authorization:
<doc:list>
<doc:item>
<doc:term>org.freedesktop.udisks.linux-lvm2</doc:term>
<doc:definition>
Needed to configured Linux LVM2 devices.
</doc:definition>
</doc:item>
</doc:list>
</doc:permission>
<doc:errors>
<doc:error name="org.freedesktop.PolicyKit.Error.NotAuthorized">if the caller lacks the appropriate PolicyKit authorization</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Busy">if one of the given components are busy</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Failed">if the operation failed</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Cancelled">if the job was cancelled</doc:error>
</doc:errors>
</doc:doc>
</method>
<!-- ************************************************************ -->
<method name="LinuxLvm2LVRemove">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="group_uuid" direction="in" type="s">
<doc:doc><doc:summary>The UUID of the volume group of the logical volume to start belongs to.</doc:summary></doc:doc>
</arg>
<arg name="uuid" direction="in" type="s">
<doc:doc><doc:summary>The UUID of the logical volume to remove.</doc:summary></doc:doc>
</arg>
<arg name="options" direction="in" type="as">
<doc:doc><doc:summary>Options used for the removal of the logical volume. Currently no options are supported.</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Removes a LVM2 logical volume.
</doc:para>
</doc:description>
<doc:permission>
The caller will need the following PolicyKit authorization:
<doc:list>
<doc:item>
<doc:term>org.freedesktop.udisks.linux-lvm2</doc:term>
<doc:definition>
Needed to configured Linux LVM2 devices.
</doc:definition>
</doc:item>
</doc:list>
</doc:permission>
<doc:errors>
<doc:error name="org.freedesktop.PolicyKit.Error.NotAuthorized">if the caller lacks the appropriate PolicyKit authorization</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Busy">if one of the given components are busy</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Failed">if the operation failed</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Cancelled">if the job was cancelled</doc:error>
</doc:errors>
</doc:doc>
</method>
<!-- ************************************************************ -->
<method name="LinuxLvm2LVCreate">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="group_uuid" direction="in" type="s">
<doc:doc><doc:summary>The UUID of the volume group to create a logical volume in.</doc:summary></doc:doc>
</arg>
<arg name="name" direction="in" type="s">
<doc:doc><doc:summary>The name for the logical volume.</doc:summary></doc:doc>
</arg>
<arg name="size" direction="in" type="t">
<doc:doc><doc:summary>The size of the logical volume, in bytes.</doc:summary></doc:doc>
</arg>
<arg name="num_stripes" direction="in" type="u">
<doc:doc><doc:summary>Number of stripes to use.</doc:summary></doc:doc>
</arg>
<arg name="stripe_size" direction="in" type="t">
<doc:doc><doc:summary>The stripe size to use or 0 if @num_stripes is 0. This must be a power of two.</doc:summary></doc:doc>
</arg>
<arg name="num_mirrors" direction="in" type="u">
<doc:doc><doc:summary>Number of mirrors to use.</doc:summary></doc:doc>
</arg>
<arg name="options" direction="in" type="as">
<doc:doc><doc:summary>Options used when creating the logical volume. Currently no options are supported.</doc:summary></doc:doc>
</arg>
<arg name="fstype" direction="in" type="s">
<doc:doc><doc:summary>
The file system to create in new logical filesystem. Leave
blank to skip creating a file system. See the
<doc:ref type="method" to="Device.FilesystemCreate">Device.FilesystemCreate()</doc:ref> method
for details.
</doc:summary></doc:doc>
</arg>
<arg name="fsoptions" direction="in" type="as">
<doc:doc><doc:summary>
Options to use for file system creation. See the
<doc:ref type="method" to="Device.FilesystemCreate">Device.FilesystemCreate()</doc:ref> method
for details.
</doc:summary></doc:doc>
</arg>
<arg name="created_device" direction="out" type="o">
<doc:doc><doc:summary>The object path of the newly added logical volume.</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Creates a new LVM2 logical volume.
</doc:para>
</doc:description>
<doc:permission>
The caller will need the following PolicyKit authorization:
<doc:list>
<doc:item>
<doc:term>org.freedesktop.udisks.linux-lvm2</doc:term>
<doc:definition>
Needed to configured Linux LVM2 devices.
</doc:definition>
</doc:item>
</doc:list>
</doc:permission>
<doc:errors>
<doc:error name="org.freedesktop.PolicyKit.Error.NotAuthorized">if the caller lacks the appropriate PolicyKit authorization</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Busy">if one of the given components are busy</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Failed">if the operation failed</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Cancelled">if the job was cancelled</doc:error>
</doc:errors>
</doc:doc>
</method>
<!-- ************************************************************ -->
<method name="LinuxMdStart">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="components" direction="in" type="ao">
<doc:doc><doc:summary>The object paths of the components of the array to start.</doc:summary></doc:doc>
</arg>
<arg name="options" direction="in" type="as">
<doc:doc><doc:summary>Options for starting the array. Currently no options are supported.</doc:summary></doc:doc>
</arg>
<arg name="device" direction="out" type="o">
<doc:doc><doc:summary>The object path of the assembled array device.</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Starts an Linux md RAID array. The array will be assembled
and started in degraded mode if an insufficient number of
components are given.
</doc:para>
</doc:description>
<doc:permission>
The caller will need the following PolicyKit authorization:
<doc:list>
<doc:item>
<doc:term>org.freedesktop.udisks.linux-md</doc:term>
<doc:definition>
Needed to configured Linux md Software RAID devices.
</doc:definition>
</doc:item>
</doc:list>
</doc:permission>
<doc:errors>
<doc:error name="org.freedesktop.PolicyKit.Error.NotAuthorized">if the caller lacks the appropriate PolicyKit authorization</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Busy">if one of the given components are busy</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Failed">if the operation failed</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Cancelled">if the job was cancelled</doc:error>
</doc:errors>
</doc:doc>
</method>
<!-- ************************************************************ -->
<method name="LinuxMdCreate">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="components" direction="in" type="ao">
<doc:doc><doc:summary>The object paths of the components to use for the array.</doc:summary></doc:doc>
</arg>
<arg name="level" direction="in" type="s">
<doc:doc><doc:summary>RAID level.</doc:summary></doc:doc>
</arg>
<arg name="stripe_size" direction="in" type="t">
<doc:doc><doc:summary>Stripe Size in bytes, or 0 to use the default stripe size.</doc:summary></doc:doc>
</arg>
<arg name="name" direction="in" type="s">
<doc:doc><doc:summary>Name of the array.</doc:summary></doc:doc>
</arg>
<arg name="options" direction="in" type="as">
<doc:doc><doc:summary>Options for creating the array. Currently no options are supported.</doc:summary></doc:doc>
</arg>
<arg name="device" direction="out" type="o">
<doc:doc><doc:summary>The object path of the created array device.</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Creates a Linux md RAID array. The array will be created and
assembled.
</doc:para>
</doc:description>
<doc:permission>
The caller will need the following PolicyKit authorization:
<doc:list>
<doc:item>
<doc:term>org.freedesktop.udisks.linux-md</doc:term>
<doc:definition>
Needed to configured Linux md Software RAID devices.
</doc:definition>
</doc:item>
</doc:list>
</doc:permission>
<doc:errors>
<doc:error name="org.freedesktop.PolicyKit.Error.NotAuthorized">if the caller lacks the appropriate PolicyKit authorization</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Busy">if one of the given components are busy</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Failed">if the operation failed</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Cancelled">if the job was cancelled</doc:error>
</doc:errors>
</doc:doc>
</method>
<!-- ************************************************************ -->
<method name="Inhibit">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="cookie" direction="out" type="s">
<doc:doc><doc:summary>
A cookie that can be used in the
<doc:ref type="method" to="Disks.Uninhibit">Uninhibit()</doc:ref> method.
to stop inhibiting the daemon.
</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Inhibits clients from invoking methods on the daemon
of the daemon that require authorization (all methods
will return the <doc:tt>org.freedesktop.PolicyKit.Error.Inhibited</doc:tt> error)
if the caller is not the super user.
This is typically used by OS installers and other
programs that expects full control of the system, specifically
to avoid automounting devices.
</doc:para>
</doc:description>
<doc:permission>
Only the super user can invoke this method.
</doc:permission>
<doc:errors>
<doc:error name="org.freedesktop.PolicyKit.Error.NotAuthorized">if the caller is not the super user</doc:error>
</doc:errors>
</doc:doc>
</method>
<!-- ************************************************************ -->
<method name="Uninhibit">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="cookie" direction="in" type="s">
<doc:doc><doc:summary>
A cookie obtained from the
<doc:ref type="method" to="Disks.Inhibit">Inhibit()</doc:ref> method.
</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Uninhibits other clients from using the daemon.
</doc:para>
</doc:description>
<doc:errors>
<doc:error name="org.freedesktop.PolicyKit.Error.Failed">if the given cookie is malformed</doc:error>
</doc:errors>
</doc:doc>
</method>
<!-- ************************************************************ -->
<signal name="DeviceAdded">
<arg name="device" type="o">
<doc:doc><doc:summary>Object path of device that was added.</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Emitted when a device is added.
</doc:para>
</doc:description>
</doc:doc>
</signal>
<!-- ************************************************************ -->
<signal name="DeviceRemoved">
<arg name="device" type="o">
<doc:doc><doc:summary>Object path of device that was removed.</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Emitted when a device is removed.
</doc:para>
</doc:description>
</doc:doc>
</signal>
<!-- ************************************************************ -->
<signal name="DeviceChanged">
<arg name="device" type="o">
<doc:doc><doc:summary>Object path of device that was changed.</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Emitted when a device changed.
</doc:para>
</doc:description>
</doc:doc>
</signal>
<!-- ************************************************************ -->
<signal name="DeviceJobChanged">
<arg name="device" type="o">
<doc:doc><doc:summary>The object path of the device.</doc:summary></doc:doc>
</arg>
<arg name="job_in_progress" type="b">
<doc:doc><doc:summary>Whether a job is currently in progress.</doc:summary></doc:doc>
</arg>
<arg name="job_is_cancellable" type="b">
<doc:doc><doc:summary>Whether the job is cancellable.</doc:summary></doc:doc>
</arg>
<arg name="job_id" type="s">
<doc:doc><doc:summary>The identifier of the job.</doc:summary></doc:doc>
</arg>
<arg name="job_num_tasks" type="i">
<doc:doc><doc:summary>Number of tasks in the job.</doc:summary></doc:doc>
</arg>
<arg name="job_cur_task" type="i">
<doc:doc><doc:summary>Current task number (zero-based offset).</doc:summary></doc:doc>
</arg>
<arg name="job_cur_task_id" type="s">
<doc:doc><doc:summary>Task identifier for current task.</doc:summary></doc:doc>
</arg>
<arg name="job_cur_task_percentage" type="d">
<doc:doc><doc:summary>Percentage completed of current task (between 0 and 100, negative if unknown).</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Emitted when a job on a device changes.
</doc:para>
</doc:description>
</doc:doc>
</signal>
<!-- ************************************************************ -->
<signal name="AdapterAdded">
<arg name="adapter" type="o">
<doc:doc><doc:summary>Object path of adapter that was added.</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Emitted when an adapter is added.
</doc:para>
</doc:description>
</doc:doc>
</signal>
<signal name="AdapterRemoved">
<arg name="adapter" type="o">
<doc:doc><doc:summary>Object path of adapter that was removed.</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Emitted when an adapter is removed.
</doc:para>
</doc:description>
</doc:doc>
</signal>
<signal name="AdapterChanged">
<arg name="adapter" type="o">
<doc:doc><doc:summary>Object path of adapter that was changed.</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Emitted when an adapter changed.
</doc:para>
</doc:description>
</doc:doc>
</signal>
<!-- ************************************************************ -->
<signal name="ExpanderAdded">
<arg name="expander" type="o">
<doc:doc><doc:summary>Object path of expander that was added.</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Emitted when an expander is added.
</doc:para>
</doc:description>
</doc:doc>
</signal>
<signal name="ExpanderRemoved">
<arg name="expander" type="o">
<doc:doc><doc:summary>Object path of expander that was removed.</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Emitted when an expander is removed.
</doc:para>
</doc:description>
</doc:doc>
</signal>
<signal name="ExpanderChanged">
<arg name="expander" type="o">
<doc:doc><doc:summary>Object path of expander that was changed.</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Emitted when an expander changed.
</doc:para>
</doc:description>
</doc:doc>
</signal>
<!-- ************************************************************ -->
<signal name="PortAdded">
<arg name="port" type="o">
<doc:doc><doc:summary>Object path of port that was added.</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Emitted when a port is added.
</doc:para>
</doc:description>
</doc:doc>
</signal>
<signal name="PortRemoved">
<arg name="port" type="o">
<doc:doc><doc:summary>Object path of port that was removed.</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Emitted when a port is removed.
</doc:para>
</doc:description>
</doc:doc>
</signal>
<signal name="PortChanged">
<arg name="port" type="o">
<doc:doc><doc:summary>Object path of port that was changed.</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Emitted when a port changed.
</doc:para>
</doc:description>
</doc:doc>
</signal>
<!-- ************************************************************ -->
<property name="DaemonVersion" type="s" access="read">
<doc:doc><doc:description><doc:para>
The version of the running daemon.
</doc:para></doc:description></doc:doc>
</property>
<property name="DaemonIsInhibited" type="b" access="read">
<doc:doc><doc:description><doc:para>
TRUE only if the daemon is inhibited.
</doc:para></doc:description></doc:doc>
</property>
<property name="SupportsLuksDevices" type="b" access="read">
<doc:doc><doc:description><doc:para>
TRUE only if the daemon can create encrypted LUKS block devices, see the
<doc:ref type="method" to="Device.LuksLock">LuksUnlock()</doc:ref> and
<doc:ref type="method" to="Device.LuksLock">LuksLock()</doc:ref>
methods for details.
</doc:para></doc:description></doc:doc>
</property>
<!-- TODO: maybe this should return a dictionary so we can grow it in the future? -->
<property name="KnownFilesystems" type="a(ssbbbubbbbbbbb)" access="read">
<doc:doc><doc:description><doc:para>
An array of file systems known to the daemon and what features are supported.
Each element in the array contains the following members:
<doc:list>
<doc:item>
<doc:term>id</doc:term>
<doc:definition>
The name / identifier of the file system (such as <doc:tt>ext3</doc:tt> or <doc:tt>vfat</doc:tt>),
similar to the contents of the
<doc:ref type="property" to="Device:IdType">Device:IdType</doc:ref>
property.
</doc:definition>
</doc:item>
<doc:item>
<doc:term>name</doc:term>
<doc:definition>
A human readable name for the file system such as "Linux Ext3".
</doc:definition>
</doc:item>
<doc:item>
<doc:term>supports_unix_owners</doc:term>
<doc:definition>
Whether the file system supports the UNIX owners model (e.g. ext3 does, but vfat doesn't).
</doc:definition>
</doc:item>
<doc:item>
<doc:term>can_mount</doc:term>
<doc:definition>
Whether the file system can be mounted.
</doc:definition>
</doc:item>
<doc:item>
<doc:term>can_create</doc:term>
<doc:definition>
Whether the file system can be created on a device.
</doc:definition>
</doc:item>
<doc:item>
<doc:term>max_label_len</doc:term>
<doc:definition>
The maximum amount of bytes that the file system label can hold. Set to zero if the file
system doesn't support labels.
</doc:definition>
</doc:item>
<doc:item>
<doc:term>supports_label_rename</doc:term>
<doc:definition>
Whether the label of the file system can be changed.
</doc:definition>
</doc:item>
<doc:item>
<doc:term>supports_online_label_rename</doc:term>
<doc:definition>
Whether the label can be changed while the file system is mounted.
</doc:definition>
</doc:item>
<doc:item>
<doc:term>supports_fsck</doc:term>
<doc:definition>
Whether the file system can be checked.
</doc:definition>
</doc:item>
<doc:item>
<doc:term>supports_online_fsck</doc:term>
<doc:definition>
Whether the file system can be checked while mounted.
</doc:definition>
</doc:item>
<doc:item>
<doc:term>supports_resize_enlarge</doc:term>
<doc:definition>
Whether the file system can be enlarged.
</doc:definition>
</doc:item>
<doc:item>
<doc:term>supports_online_resize_enlarge</doc:term>
<doc:definition>
Whether the file system can be enlarged while mounted.
</doc:definition>
</doc:item>
<doc:item>
<doc:term>supports_resize_shrink</doc:term>
<doc:definition>
Whether the file system can be shrunk.
</doc:definition>
</doc:item>
<doc:item>
<doc:term>supports_online_resize_shrink</doc:term>
<doc:definition>
Whether the file system can be shrunk while mounted.
</doc:definition>
</doc:item>
</doc:list>
</doc:para></doc:description></doc:doc>
</property>
<!-- ************************************************************ -->
</interface>
</node>
|
