Debian Codegraph @

modules/iscsi/data/org.freedesktop.UDisks2.iscsi.xml

raw
1 <!DOCTYPE node PUBLIC
2 "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
3 "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
4 <node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
5
6 <!--
7 Copyright (C) 2015 Peter Hatina <[email protected]>
8
9 This library is free software; you can redistribute it and/or
10 modify it under the terms of the GNU Lesser General Public
11 License as published by the Free Software Foundation; either
12 version 2 of the License, or (at your option) any later version.
13
14 This library is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 Lesser General Public License for more details.
18
19 You should have received a copy of the GNU Lesser General
20 Public License along with this library; if not, write to the
21 Free Software Foundation, Inc., 59 Temple Place, Suite 330,
22 Boston, MA 02111-1307, USA.
23 -->
24
25 <!-- ********************************************************************** -->
26
27 <!--
28 org.freedesktop.UDisks2.Manager.ISCSI.Initiator:
29 @short_description: iSCSI add-on to the manager singleton
30 @since: 2.0.1
31
32 Additional interface with iSCSI specifics for top-level manager
33 singleton object located at the object path
34 <literal>/org/freedesktop/UDisks2/Manager</literal>.
35 -->
36 <interface name="org.freedesktop.UDisks2.Manager.ISCSI.Initiator">
37 <!-- prereq: org.freedesktop.UDisks2.Manager -->
38
39 <annotation name="org.gtk.GDBus.C.Name" value="Manager_ISCSI_Initiator"/>
40
41 <!--
42 GetFirmwareInitiatorName:
43 @result: The iSCSI firmware initiator name.
44 @since: 2.4.0
45
46 Returns the iSCSI firmware initiator name.
47 -->
48 <method name="GetFirmwareInitiatorName">
49 <arg name="result" direction="out" type="s"/>
50 </method>
51
52 <!--
53 GetInitiatorName:
54 @result: The iSCSI initiator name.
55 @since: 2.0.1
56
57 Returns a iSCSI initiator name.
58
59 Note: Initiator name can contain non UTF-8 characters. In this case
60 this function will return "Invalid UTF-8" string. Use
61 #org.freedesktop.UDisks2.Manager.ISCSI.Initiator:GetInitiatorNameRaw
62 to get raw, undecoded initiator name.
63 -->
64 <method name="GetInitiatorName">
65 <arg name="result" direction="out" type="s"/>
66 </method>
67
68 <!--
69 GetInitiatorNameRaw:
70 @result: The iSCSI initiator name.
71 @since: 2.8.3
72
73 Returns an iSCSI initiator name as a raw NULL terminated byte array.
74 -->
75 <method name="GetInitiatorNameRaw">
76 <arg name="result" direction="out" type="ay"/>
77 </method>
78
79 <!--
80 SetInitiatorName:
81 @name: The new iSCSI initiator name.
82 @options: Additional options.
83 @since: 2.1.3
84
85 Sets a new iSCSI initiator name. This is typically done by populating the
86 <filename>/etc/iscsi/initiatorname.iscsi</filename> file.
87
88 The iscsid service needs to be restarted afterwards to reflect the change
89 (if running). This is however distribution-specific and not performed
90 by UDisks at this moment.
91
92 No additional options are currently defined.
93 -->
94 <method name="SetInitiatorName">
95 <arg name="name" direction="in" type="s"/>
96 <arg name="options" type="a{sv}" direction="in"/>
97 </method>
98
99 <!--
100 DiscoverSendTargets:
101 @address: Hostname or IP-address to connect to.
102 @port: Port to connect to, or 0 for the default port.
103 @nodes: Discovered nodes.
104 @nodes_cnt: The number of found nodes.
105 @options: Additional options.
106 @since: 2.3.1
107
108 Performs targets' discovery with no authentication data.
109
110 If the option <parameter>username</parameter> is provided, then
111 the <parameter>username</parameter> and <parameter>password</parameter>
112 will be used for CHAP authentication.
113
114 If the option <parameter>reverse-username</parameter> is provided,
115 the the <parameter>reverse-username</parameter> and
116 <parameter>reverse-password</parameter> will be used for CHAP
117 authentication.
118 -->
119 <method name="DiscoverSendTargets">
120 <arg name="address" direction="in" type="s"/>
121 <arg name="port" direction="in" type="q"/>
122 <arg name="nodes" direction="out" type="a(sisis)"/>
123 <arg name="nodes_cnt" direction="out" type="i"/>
124 <arg name="options" type="a{sv}" direction="in"/>
125 </method>
126
127 <!--
128 DiscoverFirmware:
129 @nodes: Structure containing discovered targets (name, tpgt, address, port, iface).
130 @nodes_cnt: The number of found nodes.
131 @options: Additional options.
132 @since: 2.1.3
133
134 Performs targets' discovery using firmware (ppc or ibft).
135
136 No additional options are currently defined.
137 -->
138 <method name="DiscoverFirmware">
139 <arg name="nodes" direction="out" type="a(sisis)"/>
140 <arg name="nodes_cnt" direction="out" type="i"/>
141 <arg name="options" type="a{sv}" direction="in"/>
142 </method>
143
144 <!--
145 Login:
146 @name: iSCSI iqn for the node.
147 @tpgt: Portal group number.
148 @address: Portal hostname or IP-address.
149 @port: Portal port number.
150 @iface: Interface to connect through.
151 @options: Additional options.
152 @since: 2.1.3
153
154 Login to the iSCSI node described by the given node properties.
155
156 If the option <parameter>username</parameter> is provided, then
157 the <parameter>username</parameter> and <parameter>password</parameter>
158 will be used for CHAP authentication.
159
160 If the option <parameter>reverse-username</parameter> is provided,
161 the the <parameter>reverse-username</parameter> and
162 <parameter>reverse-password</parameter> will be used for CHAP
163 authentication.
164
165 Firmware-discovered nodes retain their authentication info unless
166 overriden with specified credentials (see above).
167
168 All the additional options are transformed into the interface
169 parameters. For example, if an automatic node startup is desired, the
170 <parameter>node.startup</parameter> needs to be set to
171 '<emphasis>automatic</emphasis>' (default value is
172 '<emphasis>manual</emphasis>').
173 -->
174 <method name="Login">
175 <arg name="name" direction="in" type="s"/>
176 <arg name="tpgt" direction="in" type="i"/>
177 <arg name="address" direction="in" type="s"/>
178 <arg name="port" direction="in" type="i"/>
179 <arg name="iface" direction="in" type="s"/>
180 <arg name="options" type="a{sv}" direction="in"/>
181 </method>
182
183 <!--
184 Logout:
185 @name: iSCSI iqn for the node.
186 @tpgt: Portal group number.
187 @address: Portal hostname or IP-address.
188 @port: Portal port number.
189 @iface: Interface to logout.
190 @options: Additional options.
191 @since: 2.1.3
192
193 Logout of the iSCSI node described by the given node properties.
194
195 All the additional options are transformed into the interface
196 parameters. For example, if an automatic node startup is not desired,
197 the <parameter>node.startup</parameter> needs to be set to
198 '<emphasis>manual</emphasis>'.
199 -->
200 <method name="Logout">
201 <arg name="name" direction="in" type="s"/>
202 <arg name="tpgt" direction="in" type="i"/>
203 <arg name="address" direction="in" type="s"/>
204 <arg name="port" direction="in" type="i"/>
205 <arg name="iface" direction="in" type="s"/>
206 <arg name="options" type="a{sv}" direction="in"/>
207 </method>
208
209 <!--
210 SessionsSupported: Whether or not this version of Udisks
211 supports ISCSI.Session objects.
212 -->
213 <property name="SessionsSupported" type="b" access="read"/>
214
215 </interface>
216
217 <!--
218 org.freedesktop.UDisks2.ISCSI.Session:
219 @short_description: iSCSI session.
220
221 This interface should appear on a separate object exported on the master
222 Udisks root.
223 -->
224 <interface name="org.freedesktop.UDisks2.ISCSI.Session">
225 <annotation name="org.gtk.GDBus.C.Name" value="ISCSI_Session"/>
226
227 <!--
228 Logout:
229 @options: Additional options.
230 @since: 2.1.3
231
232 Logout iSCSI node in this session; default interface is used.
233
234 All the additional options are transformed into the interface
235 parameters. For example, if an automatic node startup is not desired,
236 the <parameter>node.startup</parameter> needs to be set to
237 '<emphasis>manual</emphasis>'.
238 -->
239 <method name="Logout">
240 <arg name="options" type="a{sv}" direction="in"/>
241 </method>
242
243 <!--
244 LogoutInterface:
245 @iface: Interface to logout.
246 @options: Additional options.
247 @since: 2.1.3
248
249 Logout iSCSI node in this session; @iface is used.
250
251 All the additional options are transformed into the interface
252 parameters. For example, if an automatic node startup is not desired,
253 the <parameter>node.startup</parameter> needs to be set to
254 '<emphasis>manual</emphasis>'.
255 -->
256 <method name="LogoutInterface">
257 <arg name="iface" direction="in" type="s"/>
258 <arg name="options" type="a{sv}" direction="in"/>
259 </method>
260
261 <property name="target_name" type="s" access="read"/>
262 <property name="tpgt" type="i" access="read"/>
263 <property name="address" type="s" access="read"/>
264 <property name="port" type="i" access="read"/>
265 <property name="persistent_address" type="s" access="read"/>
266 <property name="persistent_port" type="i" access="read"/>
267
268 <!-- timeouts -->
269 <property name="abort_timeout" type="i" access="read"/>
270 <property name="lu_reset_timeout" type="i" access="read"/>
271 <property name="recovery_timeout" type="i" access="read"/>
272 <property name="tgt_reset_timeout" type="i" access="read"/>
273 </interface>
274
275 <!-- ********************************************************************** -->
276
277 </node>