source4/torture/man/smbtorture.1.xml

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