Debian Codegraph @

doc/html/gdbus-org.freedesktop.UDisks2.NVMe.Fabrics.html

raw
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html>
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>org.freedesktop.UDisks2.NVMe.Fabrics: UDisks Reference Manual</title>
6 <meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
7 <link rel="home" href="index.html" title="UDisks Reference Manual">
8 <link rel="up" href="ch03.html" title="D-Bus Interfaces">
9 <link rel="prev" href="gdbus-org.freedesktop.UDisks2.Manager.NVMe.html" title="org.freedesktop.UDisks2.Manager.NVMe">
10 <link rel="next" href="gdbus-org.freedesktop.UDisks2.Drive.LSM.html" title="org.freedesktop.UDisks2.Drive.LSM">
11 <meta name="generator" content="GTK-Doc V1.35.1 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
13 </head>
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
16 <td width="100%" align="left" class="shortcuts">
17 <a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
18 <a href="#gdbus-org.freedesktop.UDisks2.NVMe.Fabrics.description" class="shortcut">Description</a></span><span id="nav_properties">  <span class="dim">|</span> 
19 <a href="#gdbus-org.freedesktop.UDisks2.NVMe.Fabrics.properties" class="shortcut">Properties</a></span>
20 </td>
21 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
22 <td><a accesskey="u" href="ch03.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
23 <td><a accesskey="p" href="gdbus-org.freedesktop.UDisks2.Manager.NVMe.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
24 <td><a accesskey="n" href="gdbus-org.freedesktop.UDisks2.Drive.LSM.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
25 </tr></table>
26 <div class="refentry">
27 <a name="gdbus-org.freedesktop.UDisks2.NVMe.Fabrics"></a><div class="titlepage"></div>
28 <div class="refnamediv"><table width="100%"><tr>
29 <td valign="top">
30 <h2><span class="refentrytitle"><a name="gdbus-interface-org-freedesktop-UDisks2-NVMe-Fabrics.top_of_page"></a>org.freedesktop.UDisks2.NVMe.Fabrics</span></h2>
31 <p>org.freedesktop.UDisks2.NVMe.Fabrics — NVMe over Fabrics control interface</p>
32 </td>
33 <td class="gallery_image" valign="top" align="right"></td>
34 </tr></table></div>
35 <div class="refsynopsisdiv">
36 <h2>Methods</h2>
37 <pre class="synopsis">
38 <a class="link" href="gdbus-org.freedesktop.UDisks2.NVMe.Fabrics.html#gdbus-method-org-freedesktop-UDisks2-NVMe-Fabrics.Disconnect" title="The Disconnect() method">Disconnect</a> (IN a{sv} options);
39 </pre>
40 </div>
41 <div class="refsect1">
42 <a name="id-1.3.3.17.4"></a><h2>Properties</h2>
43 <pre class="synopsis">
44 <a class="link" href="gdbus-org.freedesktop.UDisks2.NVMe.Fabrics.html#gdbus-property-org-freedesktop-UDisks2-NVMe-Fabrics.HostNQN" title='The "HostNQN" property'>HostNQN</a> readable ay
45 <a class="link" href="gdbus-org.freedesktop.UDisks2.NVMe.Fabrics.html#gdbus-property-org-freedesktop-UDisks2-NVMe-Fabrics.HostID" title='The "HostID" property'>HostID</a> readable ay
46 <a class="link" href="gdbus-org.freedesktop.UDisks2.NVMe.Fabrics.html#gdbus-property-org-freedesktop-UDisks2-NVMe-Fabrics.Transport" title='The "Transport" property'>Transport</a> readable s
47 <a class="link" href="gdbus-org.freedesktop.UDisks2.NVMe.Fabrics.html#gdbus-property-org-freedesktop-UDisks2-NVMe-Fabrics.TransportAddress" title='The "TransportAddress" property'>TransportAddress</a> readable ay
48 </pre>
49 </div>
50 <div class="refsect1">
51 <a name="gdbus-interface-org-freedesktop-UDisks2-NVMe-Fabrics"></a><h2>Description</h2>
52 <p>
53 Control interface for NVMe over Fabrics connected controllers.
54 </p>
55 </div>
56 <div class="refsect1">
57 <a name="gdbus-methods-org.freedesktop.UDisks2.NVMe.Fabrics"></a><h2>Method Details</h2>
58 <div class="refsect2">
59 <a name="gdbus-method-org-freedesktop-UDisks2-NVMe-Fabrics.Disconnect"></a><h3>The Disconnect() method</h3>
60 <pre class="programlisting">
61 Disconnect (IN a{sv} options);
62 </pre>
63 <p>
64 Disconnects and removes the NVMe over Fabrics controller.
65 </p>
66 <div class="variablelist"><table border="0" class="variablelist">
67 <colgroup>
68 <col align="left" valign="top">
69 <col>
70 </colgroup>
71 <tbody><tr>
72 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
73 <td><p>
74 Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).
75 </p></td>
76 </tr></tbody>
77 </table></div>
78 <p class="since">Since 2.10.0</p>
79 </div>
80 </div>
81 <div class="refsect1">
82 <a name="gdbus-properties-org.freedesktop.UDisks2.NVMe.Fabrics"></a><h2>Property Details</h2>
83 <div class="refsect2">
84 <a name="gdbus-property-org-freedesktop-UDisks2-NVMe-Fabrics.HostNQN"></a><h3>The "HostNQN" property</h3>
85 <pre class="programlisting">
86 HostNQN readable ay
87 </pre>
88 <p>
89 </p>
90 <p>
91 <em class="parameter"><code>since</code></em>: 2.10.0
92 </p>
93 <p>
94 The actual Host NQN used for the connection.
95 </p>
96 </div>
97 <hr>
98 <div class="refsect2">
99 <a name="gdbus-property-org-freedesktop-UDisks2-NVMe-Fabrics.HostID"></a><h3>The "HostID" property</h3>
100 <pre class="programlisting">
101 HostID readable ay
102 </pre>
103 <p>
104 </p>
105 <p>
106 <em class="parameter"><code>since</code></em>: 2.10.0
107 </p>
108 <p>
109 The actual Host UUID used for the connection.
110 </p>
111 </div>
112 <hr>
113 <div class="refsect2">
114 <a name="gdbus-property-org-freedesktop-UDisks2-NVMe-Fabrics.Transport"></a><h3>The "Transport" property</h3>
115 <pre class="programlisting">
116 Transport readable s
117 </pre>
118 <p>
119 </p>
120 <p>
121 <em class="parameter"><code>since</code></em>: 2.10.0
122 </p>
123 <p>
124 The transport type the device is connected with.
125 </p>
126 <p>
127 Known values include:
128 </p>
129 <div class="variablelist"><table border="0" class="variablelist">
130 <colgroup>
131 <col align="left" valign="top">
132 <col>
133 </colgroup>
134 <tbody>
135 <tr>
136 <td><p><span class="term">pcie</span></p></td>
137 <td><p>PCI Express Transport</p></td>
138 </tr>
139 <tr>
140 <td><p><span class="term">rdma</span></p></td>
141 <td><p>RDMA Transport</p></td>
142 </tr>
143 <tr>
144 <td><p><span class="term">fc</span></p></td>
145 <td><p>Fibre Channel Transport</p></td>
146 </tr>
147 <tr>
148 <td><p><span class="term">tcp</span></p></td>
149 <td><p>TCP Transport</p></td>
150 </tr>
151 <tr>
152 <td><p><span class="term">loop</span></p></td>
153 <td><p>Intra-host Transport (i.e., loopback)</p></td>
154 </tr>
155 </tbody>
156 </table></div>
157 <p>
158 </p>
159 </div>
160 <hr>
161 <div class="refsect2">
162 <a name="gdbus-property-org-freedesktop-UDisks2-NVMe-Fabrics.TransportAddress"></a><h3>The "TransportAddress" property</h3>
163 <pre class="programlisting">
164 TransportAddress readable ay
165 </pre>
166 <p>
167 </p>
168 <p>
169 <em class="parameter"><code>since</code></em>: 2.10.0
170 </p>
171 <p>
172 The network address of the controller. For transports using IP addressing (e.g. <code class="literal">rdma</code>)
173 this should be an IP-based address (e.g. IPv4).
174 </p>
175 </div>
176 </div>
177 </div>
178 <div class="footer">
179 <hr>Generated by GTK-Doc V1.35.1</div>
180 </body>
181 </html>