File: gdbus-org.freedesktop.UDisks2.NVMe.Fabrics.html

package info (click to toggle)
udisks2 2.11.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 23,612 kB
  • sloc: ansic: 49,035; python: 8,537; sh: 5,574; xml: 1,490; makefile: 1,232; sed: 85
file content (181 lines) | stat: -rw-r--r-- 7,089 bytes parent folder | download
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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.freedesktop.UDisks2.NVMe.Fabrics: UDisks Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="UDisks Reference Manual">
<link rel="up" href="ch03.html" title="D-Bus Interfaces">
<link rel="prev" href="gdbus-org.freedesktop.UDisks2.Manager.NVMe.html" title="org.freedesktop.UDisks2.Manager.NVMe">
<link rel="next" href="gdbus-org.freedesktop.UDisks2.Drive.LSM.html" title="org.freedesktop.UDisks2.Drive.LSM">
<meta name="generator" content="GTK-Doc V1.35.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#gdbus-org.freedesktop.UDisks2.NVMe.Fabrics.description" class="shortcut">Description</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#gdbus-org.freedesktop.UDisks2.NVMe.Fabrics.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch03.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<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>
<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>
</tr></table>
<div class="refentry">
<a name="gdbus-org.freedesktop.UDisks2.NVMe.Fabrics"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gdbus-interface-org-freedesktop-UDisks2-NVMe-Fabrics.top_of_page"></a>org.freedesktop.UDisks2.NVMe.Fabrics</span></h2>
<p>org.freedesktop.UDisks2.NVMe.Fabrics — NVMe over Fabrics control interface</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Methods</h2>
<pre class="synopsis">
<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);
</pre>
</div>
<div class="refsect1">
<a name="id-1.3.3.17.4"></a><h2>Properties</h2>
<pre class="synopsis">
<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
<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
<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
<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
</pre>
</div>
<div class="refsect1">
<a name="gdbus-interface-org-freedesktop-UDisks2-NVMe-Fabrics"></a><h2>Description</h2>
<p>
Control interface for NVMe over Fabrics connected controllers.
</p>
</div>
<div class="refsect1">
<a name="gdbus-methods-org.freedesktop.UDisks2.NVMe.Fabrics"></a><h2>Method Details</h2>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-NVMe-Fabrics.Disconnect"></a><h3>The Disconnect() method</h3>
<pre class="programlisting">
Disconnect (IN  a{sv} options);
</pre>
<p>
Disconnects and removes the NVMe over Fabrics controller.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
<td><p>
Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).
</p></td>
</tr></tbody>
</table></div>
<p class="since">Since 2.10.0</p>
</div>
</div>
<div class="refsect1">
<a name="gdbus-properties-org.freedesktop.UDisks2.NVMe.Fabrics"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-NVMe-Fabrics.HostNQN"></a><h3>The "HostNQN" property</h3>
<pre class="programlisting">
HostNQN  readable   ay
</pre>
<p>
</p>
<p>
<em class="parameter"><code>since</code></em>: 2.10.0
</p>
<p>
The actual Host NQN used for the connection.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-NVMe-Fabrics.HostID"></a><h3>The "HostID" property</h3>
<pre class="programlisting">
HostID  readable   ay
</pre>
<p>
</p>
<p>
<em class="parameter"><code>since</code></em>: 2.10.0
</p>
<p>
The actual Host UUID used for the connection.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-NVMe-Fabrics.Transport"></a><h3>The "Transport" property</h3>
<pre class="programlisting">
Transport  readable   s
</pre>
<p>
</p>
<p>
<em class="parameter"><code>since</code></em>: 2.10.0
</p>
<p>
The transport type the device is connected with.
</p>
<p>
Known values include:
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">pcie</span></p></td>
<td><p>PCI Express Transport</p></td>
</tr>
<tr>
<td><p><span class="term">rdma</span></p></td>
<td><p>RDMA Transport</p></td>
</tr>
<tr>
<td><p><span class="term">fc</span></p></td>
<td><p>Fibre Channel Transport</p></td>
</tr>
<tr>
<td><p><span class="term">tcp</span></p></td>
<td><p>TCP Transport</p></td>
</tr>
<tr>
<td><p><span class="term">loop</span></p></td>
<td><p>Intra-host Transport (i.e., loopback)</p></td>
</tr>
</tbody>
</table></div>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-NVMe-Fabrics.TransportAddress"></a><h3>The "TransportAddress" property</h3>
<pre class="programlisting">
TransportAddress  readable   ay
</pre>
<p>
</p>
<p>
<em class="parameter"><code>since</code></em>: 2.10.0
</p>
<p>
The network address of the controller. For transports using IP addressing (e.g. <code class="literal">rdma</code>)
this should be an IP-based address (e.g. IPv4).
</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.35.1</div>
</body>
</html>