Debian Codegraph @

source4/torture/man/smbtorture.1.xml

raw
1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
3 <refentry id="smbtorture.1">
4
5 <refmeta>
6 <refentrytitle>smbtorture</refentrytitle>
7 <manvolnum>1</manvolnum>
8 <refmiscinfo class="source">Samba</refmiscinfo>
9 <refmiscinfo class="manual">Test Suite</refmiscinfo>
10 <refmiscinfo class="version">4.0</refmiscinfo>
11 </refmeta>
12
13
14 <refnamediv>
15 <refname>smbtorture</refname>
16 <refpurpose>Run a series of tests against a SMB server</refpurpose>
17 </refnamediv>
18
19 <refsynopsisdiv>
20 <cmdsynopsis>
21 <command>smbtorture</command>
22 <arg choice="req">//server/share</arg>
23 <arg choice="opt">-d debuglevel</arg>
24 <arg choice="opt">-U user%pass</arg>
25 <arg choice="opt">-k</arg>
26 <arg choice="opt">-N numprocs</arg>
27 <arg choice="opt">-n netbios_name</arg>
28 <arg choice="opt">-W workgroup</arg>
29 <arg choice="opt">-e num files(entries)</arg>
30 <arg choice="opt">-O socket_options</arg>
31 <arg choice="opt">-m maximum_protocol</arg>
32 <arg choice="opt">-L</arg>
33 <arg choice="opt">-c CLIENT.TXT</arg>
34 <arg choice="opt">-t timelimit</arg>
35 <arg choice="opt">-C filename</arg>
36 <arg choice="opt">-A</arg>
37 <arg choice="opt">-p port</arg>
38 <arg choice="opt">-s seed</arg>
39 <arg choice="opt">-f max_failures</arg>
40 <arg choice="opt">-X</arg>
41 <arg choice="req">BINDING-STRING|UNC</arg>
42 <arg choice="req">TEST1</arg>
43 <arg choice="opt">TEST2</arg>
44 <arg choice="opt">...</arg>
45 </cmdsynopsis>
46
47 </refsynopsisdiv>
48
49 <refsect1>
50 <title>DESCRIPTION</title>
51
52 <para>smbtorture is a testsuite that runs several tests
53 against a SMB server. All tests are known to succeed
54 against a Windows 2003 server (?). Smbtorture's primary
55 goal is finding differences in implementations of the SMB protocol
56 and testing SMB servers.
57 </para>
58
59 <para>Any number of tests can be specified
60 on the command-line. If no tests are specified, all tests
61 are run. </para>
62
63 <para>If no arguments are specified at all, all available options
64 and tests are listed.</para>
65
66 <refsect2>
67 <title>Binding string format</title>
68
69 <para>The binding string format is:</para>
70
71 <para>TRANSPORT:host[flags]</para>
72
73 <para>Where TRANSPORT is either ncacn_np for SMB, ncacn_ip_tcp for RPC/TCP or ncalrpc for local connections.
74 </para>
75
76 <para>
77 'host' is an IP or hostname or netbios name. If the binding string
78 identifies the server side of an endpoint, 'host' may be an empty
79 string.
80 </para>
81
82 <para>
83 'flags' can include a SMB pipe name if using the ncacn_np transport or
84 a TCP port number if using the ncacn_ip_tcp transport, otherwise they
85 will be auto-determined.
86 </para>
87
88 <para>
89 other recognised flags are:
90 </para>
91
92 <variablelist>
93 <varlistentry><term>sign</term>
94 <listitem><para>enable ntlmssp signing</para></listitem>
95 </varlistentry>
96
97 <varlistentry><term>seal</term>
98 <listitem><para>enable ntlmssp sealing</para></listitem>
99 </varlistentry>
100
101 <varlistentry><term>connect</term>
102 <listitem><para>enable rpc connect level auth (auth, but no sign or seal)</para></listitem>
103 </varlistentry>
104
105 <varlistentry><term>validate</term>
106 <listitem><para>enable the NDR validator</para></listitem>
107 </varlistentry>
108
109 <varlistentry><term>print</term>
110 <listitem><para>enable debugging of the packets</para></listitem>
111 </varlistentry>
112
113 <varlistentry><term>bigendian</term>
114 <listitem><para>use bigendian RPC</para></listitem>
115 </varlistentry>
116
117 <varlistentry><term>padcheck</term>
118 <listitem><para>check reply data for non-zero pad bytes</para></listitem>
119 </varlistentry>
120 </variablelist>
121
122 <para>For example, these all connect to the samr pipe:</para>
123
124 <itemizedlist>
125 <listitem><para>ncacn_np:myserver</para></listitem>
126 <listitem><para>ncacn_np:myserver[samr]</para></listitem>
127 <listitem><para>ncacn_np:myserver[\\pipe\\samr]</para></listitem>
128 <listitem><para>ncacn_np:myserver[/pipe/samr]</para></listitem>
129 <listitem><para>ncacn_np:myserver[samr,sign,print]</para></listitem>
130 <listitem><para>ncacn_np:myserver[\\pipe\\samr,sign,seal,bigendian]</para></listitem>
131 <listitem><para>ncacn_np:myserver[/pipe/samr,seal,validate]</para></listitem>
132 <listitem><para>ncacn_np:</para></listitem>
133 <listitem><para>ncacn_np:[/pipe/samr]</para></listitem>
134 <listitem><para>ncacn_ip_tcp:myserver</para></listitem>
135 <listitem><para>ncacn_ip_tcp:myserver[1024]</para></listitem>
136 <listitem><para>ncacn_ip_tcp:myserver[1024,sign,seal]</para></listitem>
137 <listitem><para>ncalrpc:</para></listitem>
138 </itemizedlist>
139
140 </refsect2>
141
142 <refsect2>
143 <title>UNC Format</title>
144
145 <para>The UNC format is:</para>
146
147 <para>//server/share</para>
148 </refsect2>
149
150 </refsect1>
151
152
153 <refsect1>
154 <title>OPTIONS</title>
155
156 <variablelist>
157 <varlistentry><term>-d debuglevel</term>
158 <listitem><para>Use the specified Samba debug level. A higher debug level
159 means more output.</para></listitem>
160 </varlistentry>
161 <varlistentry><term>-U user%pass</term>
162 <listitem><para>Use the specified username/password combination when logging in to a remote server.</para></listitem>
163 </varlistentry>
164 <varlistentry><term>-k</term>
165 <listitem><para>Use kerberos when authenticating.</para></listitem>
166 </varlistentry>
167 <varlistentry><term>-W workgroup</term>
168 <listitem><para>Use specified name as our workgroup name.</para></listitem>
169 </varlistentry>
170 <varlistentry><term>-n netbios_name</term>
171 <listitem><para>Use specified name as our NetBIOS name.</para></listitem>
172 </varlistentry>
173
174 <varlistentry><term>-O socket_options</term>
175 <listitem><para>Use specified socket options, equivalent of the smb.conf option <quote>socket options</quote>. See the smb.conf(5) manpage for details.</para></listitem>
176 </varlistentry>
177
178 <varlistentry><term>-m max_protocol</term>
179 <listitem><para>Specify the maximum SMB dialect that should be used. Possible values are: CORE, COREPLUS, LANMAN1, LANMAN2, NT1</para></listitem>
180 </varlistentry>
181
182 <varlistentry><term>-s seed</term>
183 <listitem><para>Initialize the randomizer using <replaceable>seed</replaceable> as seed.</para></listitem>
184 </varlistentry>
185
186 <varlistentry><term>-L</term>
187 <listitem><para>Use oplocks.</para></listitem>
188 </varlistentry>
189
190 <varlistentry><term>-X</term>
191 <listitem><para>Enable dangerous tests. Use with care! This might crash your server...</para></listitem>
192 </varlistentry>
193
194 <varlistentry><term>-t timelimit</term>
195 <listitem><para>Specify the NBENCH time limit in seconds. Defaults to 600.</para></listitem>
196 </varlistentry>
197
198 <varlistentry><term>-p ports</term>
199 <listitem><para>Specify ports to connect to.</para></listitem>
200 </varlistentry>
201
202 <varlistentry><term>-c file</term>
203 <listitem><para>Read NBENCH commands from <replaceable>file</replaceable> instead of from CLIENT.TXT.</para></listitem>
204 </varlistentry>
205
206 <varlistentry><term>-A</term>
207 <listitem><para>Show not just OK or FAILED but more detailed
208 output. Used only by DENY test at the moment.</para></listitem>
209 </varlistentry>
210
211 <varlistentry><term>-C filename</term>
212 <listitem><para>Load a list of UNC names from the specified filename. Smbtorture instances will connect to a random host from this list.</para></listitem>
213 </varlistentry>
214
215 <varlistentry><term>-N numprocs</term>
216 <listitem><para>Specify number of smbtorture processes to launch.</para></listitem>
217 </varlistentry>
218
219 <varlistentry><term>-e num_files</term>
220 <listitem><para>Number of entries to use in certain tests (such as creating X files) (default: 1000).</para></listitem>
221 </varlistentry>
222
223 <varlistentry><term>-f max_failures</term>
224 <listitem><para>Number of failures before aborting a test (default: 1).</para></listitem>
225 </varlistentry>
226 </variablelist>
227 </refsect1>
228
229 <refsect1>
230 <title>VERSION</title>
231
232 <para>This man page is correct for version 4.0 of the Samba suite.</para>
233 </refsect1>
234
235 <refsect1>
236 <title>SEE ALSO</title>
237
238 <para>Samba</para>
239
240 </refsect1>
241
242 <refsect1>
243 <title>AUTHOR</title>
244
245 <para>This utility is part of the <ulink url="http://www.samba.org/">Samba</ulink> suite, which is developed by the global <ulink url="http://www.samba.org/samba/team/">Samba Team</ulink>.</para>
246
247 <para>smbtorture was written by Andrew Tridgell.</para>
248
249 <para>This manpage was written by Jelmer Vernooij.</para>
250
251 </refsect1>
252
253 </refentry>