~veger/ubuntu/precise/samba/fix-for-902339

The file consists of sections and parameters\&. A section begins with the name of the section in square brackets and continues until the next section begins\&. Sections contain parameters of the form:

.sp

.if n \{\

.RS 4

.\}

.nf

\fIname\fR = \fIvalue \fR

.fi

.if n \{\

.RE

.\}

.PP

The file is line\-based \- that is, each newline\-terminated line represents either a comment, a section name or a parameter\&.

.PP

Section and parameter names are not case sensitive\&.

.PP

Only the first equals sign in a parameter is significant\&. Whitespace before or after the first equals sign is discarded\&. Leading, trailing and internal whitespace in section and parameter names is irrelevant\&. Leading and trailing whitespace in a parameter value is discarded\&. Internal whitespace within a parameter value is retained verbatim\&.

.PP

Any line beginning with a semicolon (\(lq;\(rq) or a hash (\(lq#\(rq) character is ignored, as are lines containing only whitespace\&.

.PP

Any line ending in a

\(lq\e\(rq

is continued on the next line in the customary UNIX fashion\&.

.PP

The values following the equals sign in parameters are all either a string (no quotes needed) or a boolean, which may be given as yes/no, 1/0 or true/false\&. Case is not significant in boolean values, but is preserved in string values\&. Some items such as create masks are numeric\&.

.SH "SECTION DESCRIPTIONS"

.PP

Each section in the configuration file (except for the [global] section) describes a shared resource (known as a

\(lqshare\(rq)\&. The section name is the name of the shared resource and the parameters within the section define the shares attributes\&.

.PP

There are three special sections, [global], [homes] and [printers], which are described under

\fIspecial sections\fR\&. The following notes apply to ordinary section descriptions\&.

.PP

A share consists of a directory to which access is being given plus a description of the access rights which are granted to the user of the service\&. Some housekeeping options are also specifiable\&.

.PP

Sections are either file share services (used by the client as an extension of their native file systems) or printable services (used by the client to access print services on the host running the server)\&.

.PP

Sections may be designated

\fIguest\fR

services, in which case no password is required to access them\&. A specified UNIX

\fIguest account\fR

is used to define access privileges in this case\&.

.PP

Sections other than guest services will require a password to access them\&. The client provides the username\&. As older clients only provide passwords and not usernames, you may specify a list of usernames to check against the password using the

user =

option in the share definition\&. For modern clients such as Windows 95/98/ME/NT/2000, this should not be necessary\&.

.PP

The access rights granted by the server are masked by the access rights granted to the specified or guest UNIX user by the host system\&. The server does not grant more access than the host system grants\&.

.PP

The following sample section defines a file space share\&. The user has write access to the path

/home/bar\&. The share is accessed via the share name

foo:

.sp

.if n \{\

.RS 4

.\}

.nf

\fI[foo]\fR

\m[blue]\fBpath = /home/bar\fR\m[]

\m[blue]\fBread only = no\fR\m[]

.fi

.if n \{\

.RE

.\}

100

.PP

101

The following sample section defines a printable share\&. The share is read\-only, but printable\&. That is, the only write access permitted is via calls to open, write to and close a spool file\&. The

102

\fIguest ok\fR

103

parameter means access will be permitted as the default guest user (specified elsewhere):

104

.sp

105

.if n \{\

106

.RS 4

107

.\}

108

.nf

109

\fI[aprinter]\fR

110

\m[blue]\fBpath = /usr/spool/public\fR\m[]

111

\m[blue]\fBread only = yes\fR\m[]

112

\m[blue]\fBprintable = yes\fR\m[]

113

\m[blue]\fBguest ok = yes\fR\m[]

114

.fi

115

.if n \{\

116

.RE

117

.\}

118

.sp

119

.SH "SPECIAL SECTIONS"

120

.SS "The [global] section"

121

.PP

122

Parameters in this section apply to the server as a whole, or are defaults for sections that do not specifically define certain items\&. See the notes under PARAMETERS for more information\&.

123

.SS "The [homes] section"

124

.PP

125

If a section called [homes] is included in the configuration file, services connecting clients to their home directories can be created on the fly by the server\&.

126

.PP

127

When the connection request is made, the existing sections are scanned\&. If a match is found, it is used\&. If no match is found, the requested section name is treated as a username and looked up in the local password file\&. If the name exists and the correct password has been given, a share is created by cloning the [homes] section\&.

128

.PP

129

Some modifications are then made to the newly created share:

130

.sp

131

.RS 4

132

.ie n \{\

133

\h'-04'\(bu\h'+03'\c

134

.\}

135

.el \{\

136

.sp -1

137

.IP \(bu 2.3

138

.\}

139

The share name is changed from homes to the located username\&.

140

.RE

141

.sp

142

.RS 4

143

.ie n \{\

144

\h'-04'\(bu\h'+03'\c

145

.\}

146

.el \{\

147

.sp -1

148

.IP \(bu 2.3

149

.\}

150

If no path was given, the path is set to the user\'s home directory\&.

151

.RE

152

.sp

153

.RE

154

.PP

155

If you decide to use a

156

\fIpath =\fR

157

line in your [homes] section, it may be useful to use the %S macro\&. For example:

158

.sp

159

.if n \{\

160

.RS 4

161

.\}

162

.nf

163

\fBpath = /data/pchome/%S\fR

164

.fi

165

.if n \{\

166

.RE

167

.\}

168

.sp

169

is useful if you have different home directories for your PCs than for UNIX access\&.

170

.PP

171

This is a fast and simple way to give a large number of clients access to their home directories with a minimum of fuss\&.

172

.PP

173

A similar process occurs if the requested section name is

174

\(lqhomes\(rq, except that the share name is not changed to that of the requesting user\&. This method of using the [homes] section works well if different users share a client PC\&.

175

.PP

176

The [homes] section can specify all the parameters a normal service section can specify, though some make more sense than others\&. The following is a typical and suitable [homes] section:

177

.sp

178

.if n \{\

179

.RS 4

180

.\}

181

.nf

182

\fI[homes]\fR

183

\m[blue]\fBread only = no\fR\m[]

184

.fi

185

.if n \{\

186

.RE

187

.\}

188

.PP

189

An important point is that if guest access is specified in the [homes] section, all home directories will be visible to all clients

190

\fIwithout a password\fR\&. In the very unlikely event that this is actually desirable, it is wise to also specify

191

\fIread only access\fR\&.

192

.PP

193

The

194

\fIbrowseable\fR

195

flag for auto home directories will be inherited from the global browseable flag, not the [homes] browseable flag\&. This is useful as it means setting

196

\fIbrowseable = no\fR

197

in the [homes] section will hide the [homes] share but make any auto home directories visible\&.

198

.SS "The [printers] section"

199

.PP

200

This section works like [homes], but for printers\&.

201

.PP

202

If a [printers] section occurs in the configuration file, users are able to connect to any printer specified in the local host\'s printcap file\&.

203

.PP

204

When a connection request is made, the existing sections are scanned\&. If a match is found, it is used\&. If no match is found, but a [homes] section exists, it is used as described above\&. Otherwise, the requested section name is treated as a printer name and the appropriate printcap file is scanned to see if the requested section name is a valid printer share name\&. If a match is found, a new printer share is created by cloning the [printers] section\&.

205

.PP

206

A few modifications are then made to the newly created share:

207

.sp

208

.RS 4

209

.ie n \{\

210

\h'-04'\(bu\h'+03'\c

211

.\}

212

.el \{\

213

.sp -1

214

.IP \(bu 2.3

215

.\}

216

The share name is set to the located printer name

217

.RE

218

.sp

219

.RS 4

220

.ie n \{\

221

\h'-04'\(bu\h'+03'\c

222

.\}

223

.el \{\

224

.sp -1

225

.IP \(bu 2.3

226

.\}

227

If no printer name was given, the printer name is set to the located printer name

228

.RE

229

.sp

230

.RS 4

231

.ie n \{\

232

\h'-04'\(bu\h'+03'\c

233

.\}

234

.el \{\

235

.sp -1

236

.IP \(bu 2.3

237

.\}

238

If the share does not permit guest access and no username was given, the username is set to the located printer name\&.

239

.RE

240

.sp

241

.RE

242

.PP

243

The [printers] service MUST be printable \- if you specify otherwise, the server will refuse to load the configuration file\&.

244

.PP

245

Typically the path specified is that of a world\-writeable spool directory with the sticky bit set on it\&. A typical [printers] entry looks like this:

246

.sp

247

.if n \{\

248

.RS 4

249

.\}

250

.nf

251

\fI[printers]\fR

252

\m[blue]\fBpath = /usr/spool/public\fR\m[]

253

\m[blue]\fBguest ok = yes\fR\m[]

254

\m[blue]\fBprintable = yes\fR\m[]

255

.fi

256

.if n \{\

257

.RE

258

.\}

259

.PP

260

All aliases given for a printer in the printcap file are legitimate printer names as far as the server is concerned\&. If your printing subsystem doesn\'t work like that, you will have to set up a pseudo\-printcap\&. This is a file consisting of one or more lines like this:

261

.sp

262

.if n \{\

263

.RS 4

264

.\}

265

.nf

266

alias|alias|alias|alias\&.\&.\&.

267

.fi

268

.if n \{\

269

.RE

270

.\}

271

.PP

272

Each alias should be an acceptable printer name for your printing subsystem\&. In the [global] section, specify the new file as your printcap\&. The server will only recognize names found in your pseudo\-printcap, which of course can contain whatever aliases you like\&. The same technique could be used simply to limit access to a subset of your local printers\&.

273

.PP

274

An alias, by the way, is defined as any component of the first entry of a printcap record\&. Records are separated by newlines, components (if there are more than one) are separated by vertical bar symbols (|)\&.

275

.if n \{\

276

.sp

277

.\}

278

.RS 4

279

.it 1 an-trap

280

.nr an-no-space-flag 1

281

.nr an-break-flag 1

282

.br

283

.ps +1

284

\fBNote\fR

285

.ps -1

286

.br

287

.PP

288

On SYSV systems which use lpstat to determine what printers are defined on the system you may be able to use

289

printcap name = lpstat

290

to automatically obtain a list of printers\&. See the

291

printcap name

292

option for more details\&.

293

.sp .5v

294

.RE

295

.SH "USERSHARES"

296

.PP

297

Starting with Samba version 3\&.0\&.23 the capability for non\-root users to add, modify, and delete their own share definitions has been added\&. This capability is called

298

\fIusershares\fR

299

and is controlled by a set of parameters in the [global] section of the smb\&.conf\&. The relevant parameters are :

300

.PP

301

usershare allow guests

302

.RS 4

303

Controls if usershares can permit guest access\&.

304

.RE

305

.PP

306

usershare max shares

307

.RS 4

308

Maximum number of user defined shares allowed\&.

309

.RE

310

.PP

311

usershare owner only

312

.RS 4

313

If set only directories owned by the sharing user can be shared\&.

314

.RE

315

.PP

316

usershare path

317

.RS 4

318

Points to the directory containing the user defined share definitions\&. The filesystem permissions on this directory control who can create user defined shares\&.

319

.RE

320

.PP

321

usershare prefix allow list

322

.RS 4

323

Comma\-separated list of absolute pathnames restricting what directories can be shared\&. Only directories below the pathnames in this list are permitted\&.

324

.RE

325

.PP

326

usershare prefix deny list

327

.RS 4

328

Comma\-separated list of absolute pathnames restricting what directories can be shared\&. Directories below the pathnames in this list are prohibited\&.

329

.RE

330

.PP

331

usershare template share

332

.RS 4

333

Names a pre\-existing share used as a template for creating new usershares\&. All other share parameters not specified in the user defined share definition are copied from this named share\&.

334

.RE

335

.PP

336

To allow members of the UNIX group

337

foo

338

to create user defined shares, create the directory to contain the share definitions as follows:

339

.PP

340

Become root:

341

.sp

342

.if n \{\

343

.RS 4

344

.\}

345

.nf

346

mkdir /usr/local/samba/lib/usershares

347

chgrp foo /usr/local/samba/lib/usershares

348

chmod 1770 /usr/local/samba/lib/usershares

349

.fi

350

.if n \{\

351

.RE

352

.\}

353

.PP

354

Then add the parameters

355

.sp

356

.if n \{\

357

.RS 4

358

.\}

359

.nf

360

\m[blue]\fBusershare path = /usr/local/samba/lib/usershares\fR\m[]

361

\m[blue]\fBusershare max shares = 10\fR\m[] # (or the desired number of shares)

362

.fi

363

.if n \{\

364

.RE

365

.\}

366

.sp

367

to the global section of your

368

smb\&.conf\&. Members of the group foo may then manipulate the user defined shares using the following commands\&.

369

.PP

370

net usershare add sharename path [comment] [acl] [guest_ok=[y|n]]

371

.RS 4

372

To create or modify (overwrite) a user defined share\&.

373

.RE

374

.PP

375

net usershare delete sharename

376

.RS 4

377

To delete a user defined share\&.

378

.RE

379

.PP

380

net usershare list wildcard\-sharename

381

.RS 4

382

To list user defined shares\&.

383

.RE

384

.PP

385

net usershare info wildcard\-sharename

386

.RS 4

387

To print information about user defined shares\&.

388

.RE

389

.SH "PARAMETERS"

390

.PP

391

Parameters define the specific attributes of sections\&.

392

.PP

393

Some parameters are specific to the [global] section (e\&.g\&.,

394

\fIsecurity\fR)\&. Some parameters are usable in all sections (e\&.g\&.,

395

\fIcreate mask\fR)\&. All others are permissible only in normal sections\&. For the purposes of the following descriptions the [homes] and [printers] sections will be considered normal\&. The letter

396

\fIG\fR

397

in parentheses indicates that a parameter is specific to the [global] section\&. The letter

398

\fIS\fR

399

indicates that a parameter can be specified in a service specific section\&. All

400

\fIS\fR

401

parameters can also be specified in the [global] section \- in which case they will define the default behavior for all services\&.

402

.PP

403

Parameters are arranged here in alphabetical order \- this may not create best bedfellows, but at least you can find them! Where there are synonyms, the preferred synonym is described, others refer to the preferred synonym\&.

404

.SH "VARIABLE SUBSTITUTIONS"

405

.PP

406

Many of the strings that are settable in the config file can take substitutions\&. For example the option

407

\(lqpath = /tmp/%u\(rq

408

is interpreted as

409

\(lqpath = /tmp/john\(rq

410

if the user connected with the username john\&.

411

.PP

412

These substitutions are mostly noted in the descriptions below, but there are some general substitutions which apply whenever they might be relevant\&. These are:

413

.PP

414

415

.RS 4

416

session username (the username that the client wanted, not necessarily the same as the one they got)\&.

417

.RE

418

.PP

419

420

.RS 4

421

primary group name of %U\&.

422

.RE

423

.PP

424

425

.RS 4

426

the Internet hostname that Samba is running on\&.

427

.RE

428

.PP

429

430

.RS 4

431

the NetBIOS name of the client machine (very useful)\&.

432

.sp

433

This parameter is not available when Samba listens on port 445, as clients no longer send this information\&. If you use this macro in an include statement on a domain that has a Samba domain controller be sure to set in the [global] section

434

\fIsmb ports = 139\fR\&. This will cause Samba to not listen on port 445 and will permit include functionality to function as it did with Samba 2\&.x\&.

435

.RE

436

.PP

437

438

.RS 4

439

the NetBIOS name of the server\&. This allows you to change your config based on what the client calls you\&. Your server can have a

440

\(lqdual personality\(rq\&.

441

.RE

442

.PP

443

444

.RS 4

445

the Internet name of the client machine\&.

446

.RE

447

.PP

448

449

.RS 4

450

the selected protocol level after protocol negotiation\&. It can be one of CORE, COREPLUS, LANMAN1, LANMAN2 or NT1\&.

451

.RE

452

.PP

453

454

.RS 4

455

the process id of the current server process\&.

456

.RE

457

.PP

458

459

.RS 4

460

The architecture of the remote machine\&. It currently recognizes Samba (\fBSamba\fR), the Linux CIFS file system (\fBCIFSFS\fR), OS/2, (\fBOS2\fR), Mac OS X (\fBOSX\fR), Windows for Workgroups (\fBWfWg\fR), Windows 9x/ME (\fBWin95\fR), Windows NT (\fBWinNT\fR), Windows 2000 (\fBWin2K\fR), Windows XP (\fBWinXP\fR), Windows XP 64\-bit(\fBWinXP64\fR), Windows 2003 including 2003R2 (\fBWin2K3\fR), and Windows Vista (\fBVista\fR)\&. Anything else will be known as

461

\fBUNKNOWN\fR\&.

462

.RE

463

.PP

464

465

.RS 4

466

the IP address of the client machine\&.

467

.sp

468

Before 3\&.6\&.0 it could contain IPv4 mapped IPv6 addresses, now it only contains IPv4 or IPv6 addresses\&.

469

.RE

470

.PP

471

472

.RS 4

473

the local IP address to which a client connected\&.

474

.sp

475

Before 3\&.6\&.0 it could contain IPv4 mapped IPv6 addresses, now it only contains IPv4 or IPv6 addresses\&.

476

.RE

477

.PP

478

479

.RS 4

480

the current date and time\&.

481

.RE

482

.PP

483

484

.RS 4

485

name of the domain or workgroup of the current user\&.

486

.RE

487

.PP

488

489

.RS 4

490

the winbind separator\&.

491

.RE

492

.PP

493

%$(\fIenvvar\fR)

494

.RS 4

495

the value of the environment variable

496

\fIenvar\fR\&.

497

.RE

498

.PP

499

The following substitutes apply only to some configuration options (only those that are used when a connection has been established):

500

.PP

501

502

.RS 4

503

the name of the current service, if any\&.

504

.RE

505

.PP

506

507

.RS 4

508

the root directory of the current service, if any\&.

509

.RE

510

.PP

511

512

.RS 4

513

username of the current service, if any\&.

514

.RE

515

.PP

516

517

.RS 4

518

primary group name of %u\&.

519

.RE

520

.PP

521

522

.RS 4

523

the home directory of the user given by %u\&.

524

.RE

525

.PP

526

527

.RS 4

528

the name of your NIS home directory server\&. This is obtained from your NIS auto\&.map entry\&. If you have not compiled Samba with the

529

\fI\-\-with\-automount\fR

530

option, this value will be the same as %L\&.

531

.RE

532

.PP

533

534

.RS 4

535

the path of the service\'s home directory, obtained from your NIS auto\&.map entry\&. The NIS auto\&.map entry is split up as

536

%N:%p\&.

537

.RE

538

.PP

539

There are some quite creative things that can be done with these substitutions and other

540

smb\&.conf

541

options\&.

542

.SH "NAME MANGLING"

543

.PP

544

Samba supports

545

name mangling

546

so that DOS and Windows clients can use files that don\'t conform to the 8\&.3 format\&. It can also be set to adjust the case of 8\&.3 format filenames\&.

547

.PP

548

There are several options that control the way mangling is performed, and they are grouped here rather than listed separately\&. For the defaults look at the output of the testparm program\&.

549

.PP

550

These options can be set separately for each service\&.

551

.PP

552

The options are:

553

.PP

554

case sensitive = yes/no/auto

555

.RS 4

556

controls whether filenames are case sensitive\&. If they aren\'t, Samba must do a filename search and match on passed names\&. The default setting of auto allows clients that support case sensitive filenames (Linux CIFSVFS and smbclient 3\&.0\&.5 and above currently) to tell the Samba server on a per\-packet basis that they wish to access the file system in a case\-sensitive manner (to support UNIX case sensitive semantics)\&. No Windows or DOS system supports case\-sensitive filename so setting this option to auto is that same as setting it to no for them\&. Default

557

\fIauto\fR\&.

558

.RE

559

.PP

560

default case = upper/lower

561

.RS 4

562

controls what the default case is for new filenames (ie\&. files that don\'t currently exist in the filesystem)\&. Default

563

\fIlower\fR\&. IMPORTANT NOTE: As part of the optimizations for directories containing large numbers of files, the following special case applies\&. If the options

564

\m[blue]\fBcase sensitive = yes\fR\m[],

565

\m[blue]\fBpreserve case = No\fR\m[], and

566

\m[blue]\fBshort preserve case = No\fR\m[]

567

are set, then the case of

568

\fIall\fR

569

incoming client filenames, not just new filenames, will be modified\&. See additional notes below\&.

570

.RE

571

.PP

572

preserve case = yes/no

573

.RS 4

574

controls whether new files (ie\&. files that don\'t currently exist in the filesystem) are created with the case that the client passes, or if they are forced to be the

575

default

576

case\&. Default

577

\fIyes\fR\&.

578

.RE

579

.PP

580

short preserve case = yes/no

581

.RS 4

582

controls if new files (ie\&. files that don\'t currently exist in the filesystem) which conform to 8\&.3 syntax, that is all in upper case and of suitable length, are created upper case, or if they are forced to be the

583

default

584

case\&. This option can be used with

585

preserve case = yes

586

to permit long filenames to retain their case, while short names are lowercased\&. Default

587

\fIyes\fR\&.

588

.RE

589

.PP

590

By default, Samba 3\&.0 has the same semantics as a Windows NT server, in that it is case insensitive but case preserving\&. As a special case for directories with large numbers of files, if the case options are set as follows, "case sensitive = yes", "case preserve = no", "short preserve case = no" then the "default case" option will be applied and will modify all filenames sent from the client when accessing this share\&.

591

.SH "NOTE ABOUT USERNAME/PASSWORD VALIDATION"

592

.PP

593

There are a number of ways in which a user can connect to a service\&. The server uses the following steps in determining if it will allow a connection to a specified service\&. If all the steps fail, the connection request is rejected\&. However, if one of the steps succeeds, the following steps are not checked\&.

594

.PP

595

If the service is marked

596

\(lqguest only = yes\(rq

597

and the server is running with share\-level security (\(lqsecurity = share\(rq, steps 1 to 5 are skipped\&.

598

.sp

599

.RS 4

600

.ie n \{\

601

\h'-04' 1.\h'+01'\c

602

.\}

603

.el \{\

604

.sp -1

605

.IP " 1." 4.2

606

.\}

607

If the client has passed a username/password pair and that username/password pair is validated by the UNIX system\'s password programs, the connection is made as that username\&. This includes the

608

\e\eserver\eservice%\fIusername\fR

609

method of passing a username\&.

610

.RE

611

.sp

612

.RS 4

613

.ie n \{\

614

\h'-04' 2.\h'+01'\c

615

.\}

616

.el \{\

617

.sp -1

618

.IP " 2." 4.2

619

.\}

620

If the client has previously registered a username with the system and now supplies a correct password for that username, the connection is allowed\&.

621

.RE

622

.sp

623

.RS 4

624

.ie n \{\

625

\h'-04' 3.\h'+01'\c

626

.\}

627

.el \{\

628

.sp -1

629

.IP " 3." 4.2

630

.\}

631

The client\'s NetBIOS name and any previously used usernames are checked against the supplied password\&. If they match, the connection is allowed as the corresponding user\&.

632

.RE

633

.sp

634

.RS 4

635

.ie n \{\

636

\h'-04' 4.\h'+01'\c

637

.\}

638

.el \{\

639

.sp -1

640

.IP " 4." 4.2

641

.\}

642

If the client has previously validated a username/password pair with the server and the client has passed the validation token, that username is used\&.

643

.RE

644

.sp

645

.RS 4

646

.ie n \{\

647

\h'-04' 5.\h'+01'\c

648

.\}

649

.el \{\

650

.sp -1

651

.IP " 5." 4.2

652

.\}

653

If a

654

user =

655

field is given in the

656

smb\&.conf

657

file for the service and the client has supplied a password, and that password matches (according to the UNIX system\'s password checking) with one of the usernames from the

658

user =

659

field, the connection is made as the username in the

660

user =

661

line\&. If one of the usernames in the

662

user =

663

list begins with a

664

@, that name expands to a list of names in the group of the same name\&.

665

.RE

666

.sp

667

.RS 4

668

.ie n \{\

669

\h'-04' 6.\h'+01'\c

670

.\}

671

.el \{\

672

.sp -1

673

.IP " 6." 4.2

674

.\}

675

If the service is a guest service, a connection is made as the username given in the

676

guest account =

677

for the service, irrespective of the supplied password\&.

678

.RE

679

.SH "REGISTRY-BASED CONFIGURATION"

680

.PP

681

Starting with Samba version 3\&.2\&.0, the capability to store Samba configuration in the registry is available\&. The configuration is stored in the registry key

682

\fIHKLM\eSoftware\eSamba\esmbconf\fR\&. There are two levels of registry configuration:

683

.sp

684

.RS 4

685

.ie n \{\

686

\h'-04' 1.\h'+01'\c

687

.\}

688

.el \{\

689

.sp -1

690

.IP " 1." 4.2

691

.\}

692

Share definitions stored in registry are used\&. This is triggered by setting the global parameter

693

\fIregistry shares\fR

694

695

\(lqyes\(rq

696

697

\fIsmb\&.conf\fR\&.

698

.sp

699

The registry shares are loaded not at startup but on demand at runtime by

700

\fIsmbd\fR\&. Shares defined in

701

\fIsmb\&.conf\fR

702

take priority over shares of the same name defined in registry\&.

703

.RE

704

.sp

705

.RS 4

706

.ie n \{\

707

\h'-04' 2.\h'+01'\c

708

.\}

709

.el \{\

710

.sp -1

711

.IP " 2." 4.2

712

.\}

713

Global

714

\fIsmb\&.conf\fR

715

options stored in registry are used\&. This can be activated in two different ways:

716

.sp

717

Firstly, a registry only configuration is triggered by setting

718

\m[blue]\fBconfig backend = registry\fR\m[]

719

in the [global] section of

720

\fIsmb\&.conf\fR\&. This resets everything that has been read from config files to this point and reads the content of the global configuration section from the registry\&. This is the recommended method of using registry based configuration\&.

721

.sp

722

Secondly, a mixed configuration can be activated by a special new meaning of the parameter

723

\m[blue]\fBinclude = registry\fR\m[]

724

in the [global] section of

725

\fIsmb\&.conf\fR\&. This reads the global options from registry with the same priorities as for an include of a text file\&. This may be especially useful in cases where an initial configuration is needed to access the registry\&.

726

.sp

727

Activation of global registry options automatically activates registry shares\&. So in the registry only case, shares are loaded on demand only\&.

728

.RE

729

.sp

730

.RE

731

.PP

732

Note: To make registry\-based configurations foolproof at least to a certain extent, the use of

733

\fIlock directory\fR

734

and

735

\fIconfig backend\fR

736

inside the registry configuration has been disabled: Especially by changing the

737

\fIlock directory\fR

738

inside the registry configuration, one would create a broken setup where the daemons do not see the configuration they loaded once it is active\&.

739

.PP

740

The registry configuration can be accessed with tools like

741

\fIregedit\fR

742

743

\fInet (rpc) registry\fR

744

in the key

745

\fIHKLM\eSoftware\eSamba\esmbconf\fR\&. More conveniently, the

746

\fIconf\fR

747

subcommand of the

748

\fBnet\fR(8)

749

utility offers a dedicated interface to read and write the registry based configuration locally, i\&.e\&. directly accessing the database file, circumventing the server\&.

750

.SH "EXPLANATION OF EACH PARAMETER"

751

752

753

abort shutdown script (G)

754

.\" abort shutdown script

755

.PP

756

.RS 4

757

This a full path name to a script called by

758

\fBsmbd\fR(8)

759

that should stop a shutdown procedure issued by the

760

\m[blue]\fBshutdown script\fR\m[]\&.

761

.sp

762

If the connected user posseses the

763

\fBSeRemoteShutdownPrivilege\fR, right, this command will be run as root\&.

764

.sp

765

Default:

766

\fI\fIabort shutdown script\fR\fR\fI = \fR\fI""\fR\fI \fR

767

.sp

768

Example:

769

\fI\fIabort shutdown script\fR\fR\fI = \fR\fI/sbin/shutdown \-c\fR\fI \fR

770

.RE

771

772

access based share enum (S)

773

.\" access based share enum

774

.PP

775

.RS 4

776

If this parameter is

777

\fByes\fR

778

for a service, then the share hosted by the service will only be visible to users who have read or write access to the share during share enumeration (for example net view \e\esambaserver)\&. This has parallels to access based enumeration, the main difference being that only share permissions are evaluated, and security descriptors on files contained on the share are not used in computing enumeration access rights\&.

779

.sp

780

Default:

781

\fI\fIaccess based share enum\fR\fR\fI = \fR\fIno\fR\fI \fR

782

.RE

783

784

acl check permissions (S)

785

.\" acl check permissions

786

.PP

787

.RS 4

788

This boolean parameter controls what

789

\fBsmbd\fR(8)does on receiving a protocol request of "open for delete" from a Windows client\&. If a Windows client doesn\'t have permissions to delete a file then they expect this to be denied at open time\&. POSIX systems normally only detect restrictions on delete by actually attempting to delete the file or directory\&. As Windows clients can (and do) "back out" a delete request by unsetting the "delete on close" bit Samba cannot delete the file immediately on "open for delete" request as we cannot restore such a deleted file\&. With this parameter set to true (the default) then smbd checks the file system permissions directly on "open for delete" and denies the request without actually deleting the file if the file system permissions would seem to deny it\&. This is not perfect, as it\'s possible a user could have deleted a file without Samba being able to check the permissions correctly, but it is close enough to Windows semantics for mostly correct behaviour\&. Samba will correctly check POSIX ACL semantics in this case\&.

790

.sp

791

If this parameter is set to "false" Samba doesn\'t check permissions on "open for delete" and allows the open\&. If the user doesn\'t have permission to delete the file this will only be discovered at close time, which is too late for the Windows user tools to display an error message to the user\&. The symptom of this is files that appear to have been deleted "magically" re\-appearing on a Windows explorer refresh\&. This is an extremely advanced protocol option which should not need to be changed\&. This parameter was introduced in its final form in 3\&.0\&.21, an earlier version with slightly different semantics was introduced in 3\&.0\&.20\&. That older version is not documented here\&.

792

.sp

793

Default:

794

\fI\fIacl check permissions\fR\fR\fI = \fR\fITrue\fR\fI \fR

795

.RE

796

797

acl compatibility (G)

798

.\" acl compatibility

799

.PP

800

.RS 4

801

This parameter specifies what OS ACL semantics should be compatible with\&. Possible values are

802

\fIwinnt\fR

803

for Windows NT 4,

804

\fIwin2k\fR

805

for Windows 2000 and above and

806

\fIauto\fR\&. If you specify

807

\fIauto\fR, the value for this parameter will be based upon the version of the client\&. There should be no reason to change this parameter from the default\&.

808

.sp

809

Default:

810

\fI\fIacl compatibility\fR\fR\fI = \fR\fIAuto\fR\fI \fR

811

.sp

812

Example:

813

\fI\fIacl compatibility\fR\fR\fI = \fR\fIwin2k\fR\fI \fR

814

.RE

815

816

acl group control (S)

817

.\" acl group control

818

.PP

819

.RS 4

820

In a POSIX filesystem, only the owner of a file or directory and the superuser can modify the permissions and ACLs on a file\&. If this parameter is set, then Samba overrides this restriction, and also allows the

821

\fIprimary group owner\fR

822

of a file or directory to modify the permissions and ACLs on that file\&.

823

.sp

824

On a Windows server, groups may be the owner of a file or directory \- thus allowing anyone in that group to modify the permissions on it\&. This allows the delegation of security controls on a point in the filesystem to the group owner of a directory and anything below it also owned by that group\&. This means there are multiple people with permissions to modify ACLs on a file or directory, easing managability\&.

825

.sp

826

This parameter allows Samba to also permit delegation of the control over a point in the exported directory hierarchy in much the same way as Windows\&. This allows all members of a UNIX group to control the permissions on a file or directory they have group ownership on\&.

827

.sp

828

This parameter is best used with the

829

\m[blue]\fBinherit owner\fR\m[]

830

option and also on on a share containing directories with the UNIX

831

\fIsetgid bit\fR

832

set on them, which causes new files and directories created within it to inherit the group ownership from the containing directory\&.

833

.sp

834

This is parameter has been was deprecated in Samba 3\&.0\&.23, but re\-activated in Samba 3\&.0\&.31 and above, as it now only controls permission changes if the user is in the owning primary group\&. It is now no longer equivalent to the

835

\fIdos filemode\fR

836

option\&.

837

.sp

838

Default:

839

\fI\fIacl group control\fR\fR\fI = \fR\fIno\fR\fI \fR

840

.RE

841

842

acl map full control (S)

843

.\" acl map full control

844

.PP

845

.RS 4

846

This boolean parameter controls whether

847

\fBsmbd\fR(8)

848

maps a POSIX ACE entry of "rwx" (read/write/execute), the maximum allowed POSIX permission set, into a Windows ACL of "FULL CONTROL"\&. If this parameter is set to true any POSIX ACE entry of "rwx" will be returned in a Windows ACL as "FULL CONTROL", is this parameter is set to false any POSIX ACE entry of "rwx" will be returned as the specific Windows ACL bits representing read, write and execute\&.

849

.sp

850

Default:

851

\fI\fIacl map full control\fR\fR\fI = \fR\fITrue\fR\fI \fR

852

.RE

853

854

add group script (G)

855

.\" add group script

856

.PP

857

.RS 4

858

This is the full pathname to a script that will be run

859

\fIAS ROOT\fR

860

861

\fBsmbd\fR(8)

862

when a new group is requested\&. It will expand any

863

\fI%g\fR

864

to the group name passed\&. This script is only useful for installations using the Windows NT domain administration tools\&. The script is free to create a group with an arbitrary name to circumvent unix group name restrictions\&. In that case the script must print the numeric gid of the created group on stdout\&.

865

.sp

866

Default:

867

\fI\fIadd group script\fR\fR\fI = \fR\fI\fR\fI \fR

868

.sp

869

Example:

870

\fI\fIadd group script\fR\fR\fI = \fR\fI/usr/sbin/groupadd %g\fR\fI \fR

871

.RE

872

873

add machine script (G)

874

.\" add machine script

875

.PP

876

.RS 4

877

This is the full pathname to a script that will be run by

878

\fBsmbd\fR(8)

879

when a machine is added to Samba\'s domain and a Unix account matching the machine\'s name appended with a "$" does not already exist\&.

880

.sp

881

This option is very similar to the

882

\m[blue]\fBadd user script\fR\m[], and likewise uses the %u substitution for the account name\&. Do not use the %m substitution\&.

883

.sp

884

Default:

885

\fI\fIadd machine script\fR\fR\fI = \fR\fI\fR\fI \fR

886

.sp

887

Example:

888

\fI\fIadd machine script\fR\fR\fI = \fR\fI/usr/sbin/adduser \-n \-g machines \-c Machine \-d /var/lib/nobody \-s /bin/false %u\fR\fI \fR

889

.RE

890

891

add port command (G)

892

.\" add port command

893

.PP

894

.RS 4

895

Samba 3\&.0\&.23 introduced support for adding printer ports remotely using the Windows "Add Standard TCP/IP Port Wizard"\&. This option defines an external program to be executed when smbd receives a request to add a new Port to the system\&. The script is passed two parameters:

896

.sp

897

.RS 4

898

.ie n \{\

899

\h'-04'\(bu\h'+03'\c

900

.\}

901

.el \{\

902

.sp -1

903

.IP \(bu 2.3

904

.\}

905

\fIport name\fR

906

.RE

907

.sp

908

.RS 4

909

.ie n \{\

910

\h'-04'\(bu\h'+03'\c

911

.\}

912

.el \{\

913

.sp -1

914

.IP \(bu 2.3

915

.\}

916

\fIdevice URI\fR

917

.RE

918

.sp

919

.RE

920

The deviceURI is in the format of socket://<hostname>[:<portnumber>] or lpd://<hostname>/<queuename>\&.

921

.sp

922

Default:

923

\fI\fIadd port command\fR\fR\fI = \fR\fI\fR\fI \fR

924

.sp

925

Example:

926

\fI\fIadd port command\fR\fR\fI = \fR\fI/etc/samba/scripts/addport\&.sh\fR\fI \fR

927

.RE

928

929

addprinter command (G)

930

.\" addprinter command

931

.PP

932

.RS 4

933

With the introduction of MS\-RPC based printing support for Windows NT/2000 clients in Samba 2\&.2, The MS Add Printer Wizard (APW) icon is now also available in the "Printers\&.\&.\&." folder displayed a share listing\&. The APW allows for printers to be add remotely to a Samba or Windows NT/2000 print server\&.

934

.sp

935

For a Samba host this means that the printer must be physically added to the underlying printing system\&. The

936

\fIaddprinter command\fR

937

defines a script to be run which will perform the necessary operations for adding the printer to the print system and to add the appropriate service definition to the

938

smb\&.conf

939

file in order that it can be shared by

940

\fBsmbd\fR(8)\&.

941

.sp

942

The

943

\fIaddprinter command\fR

944

is automatically invoked with the following parameter (in order):

945

.sp

946

.RS 4

947

.ie n \{\

948

\h'-04'\(bu\h'+03'\c

949

.\}

950

.el \{\

951

.sp -1

952

.IP \(bu 2.3

953

.\}

954

\fIprinter name\fR

955

.RE

956

.sp

957

.RS 4

958

.ie n \{\

959

\h'-04'\(bu\h'+03'\c

960

.\}

961

.el \{\

962

.sp -1

963

.IP \(bu 2.3

964

.\}

965

\fIshare name\fR

966

.RE

967

.sp

968

.RS 4

969

.ie n \{\

970

\h'-04'\(bu\h'+03'\c

971

.\}

972

.el \{\

973

.sp -1

974

.IP \(bu 2.3

975

.\}

976

\fIport name\fR

977

.RE

978

.sp

979

.RS 4

980

.ie n \{\

981

\h'-04'\(bu\h'+03'\c

982

.\}

983

.el \{\

984

.sp -1

985

.IP \(bu 2.3

986

.\}

987

\fIdriver name\fR

988

.RE

989

.sp

990

.RS 4

991

.ie n \{\

992

\h'-04'\(bu\h'+03'\c

993

.\}

994

.el \{\

995

.sp -1

996

.IP \(bu 2.3

997

.\}

998

\fIlocation\fR

999

.RE

1000

.sp

1001

.RS 4

1002

.ie n \{\

1003

\h'-04'\(bu\h'+03'\c

1004

.\}

1005

.el \{\

1006

.sp -1

1007

.IP \(bu 2.3

1008

.\}

1009

\fIWindows 9x driver location\fR

1010

.RE

1011

.sp

1012

.RE

1013

All parameters are filled in from the PRINTER_INFO_2 structure sent by the Windows NT/2000 client with one exception\&. The "Windows 9x driver location" parameter is included for backwards compatibility only\&. The remaining fields in the structure are generated from answers to the APW questions\&.

1014

.sp

1015

Once the

1016

\fIaddprinter command\fR

1017

has been executed,

1018

smbd

1019

will reparse the

1020

smb\&.conf

1021

to determine if the share defined by the APW exists\&. If the sharename is still invalid, then

1022

smbd

1023

will return an ACCESS_DENIED error to the client\&.

1024

.sp

1025

The

1026

\fIaddprinter command\fR

1027

program can output a single line of text, which Samba will set as the port the new printer is connected to\&. If this line isn\'t output, Samba won\'t reload its printer shares\&.

1028

.sp

1029

Default:

1030

\fI\fIaddprinter command\fR\fR\fI = \fR\fI\fR\fI \fR

1031

.sp

1032

Example:

1033

\fI\fIaddprinter command\fR\fR\fI = \fR\fI/usr/bin/addprinter\fR\fI \fR

1034

.RE

1035

1036

add share command (G)

1037

.\" add share command

1038

.PP

1039

.RS 4

1040

Samba 2\&.2\&.0 introduced the ability to dynamically add and delete shares via the Windows NT 4\&.0 Server Manager\&. The

1041

\fIadd share command\fR

1042

is used to define an external program or script which will add a new service definition to

1043

smb\&.conf\&.

1044

.sp

1045

In order to successfully execute the

1046

\fIadd share command\fR,

1047

smbd

1048

requires that the administrator connects using a root account (i\&.e\&. uid == 0) or has the

1049

SeDiskOperatorPrivilege\&. Scripts defined in the

1050

\fIadd share command\fR

1051

parameter are executed as root\&.

1052

.sp

1053

When executed,

1054

smbd

1055

will automatically invoke the

1056

\fIadd share command\fR

1057

with five parameters\&.

1058

.sp

1059

.RS 4

1060

.ie n \{\

1061

\h'-04'\(bu\h'+03'\c

1062

.\}

1063

.el \{\

1064

.sp -1

1065

.IP \(bu 2.3

1066

.\}

1067

\fIconfigFile\fR

1068

\- the location of the global

1069

smb\&.conf

1070

file\&.

1071

.RE

1072

.sp

1073

.RS 4

1074

.ie n \{\

1075

\h'-04'\(bu\h'+03'\c

1076

.\}

1077

.el \{\

1078

.sp -1

1079

.IP \(bu 2.3

1080

.\}

1081

\fIshareName\fR

1082

\- the name of the new share\&.

1083

.RE

1084

.sp

1085

.RS 4

1086

.ie n \{\

1087

\h'-04'\(bu\h'+03'\c

1088

.\}

1089

.el \{\

1090

.sp -1

1091

.IP \(bu 2.3

1092

.\}

1093

\fIpathName\fR

1094

\- path to an **existing** directory on disk\&.

1095

.RE

1096

.sp

1097

.RS 4

1098

.ie n \{\

1099

\h'-04'\(bu\h'+03'\c

1100

.\}

1101

.el \{\

1102

.sp -1

1103

.IP \(bu 2.3

1104

.\}

1105

\fIcomment\fR

1106

\- comment string to associate with the new share\&.

1107

.RE

1108

.sp

1109

.RS 4

1110

.ie n \{\

1111

\h'-04'\(bu\h'+03'\c

1112

.\}

1113

.el \{\

1114

.sp -1

1115

.IP \(bu 2.3

1116

.\}

1117

\fImax connections\fR

1118

Number of maximum simultaneous connections to this share\&.

1119

.RE

1120

.sp

1121

.RE

1122

This parameter is only used to add file shares\&. To add printer shares, see the

1123

\m[blue]\fBaddprinter command\fR\m[]\&.

1124

.sp

1125

Default:

1126

\fI\fIadd share command\fR\fR\fI = \fR\fI\fR\fI \fR

1127

.sp

1128

Example:

1129

\fI\fIadd share command\fR\fR\fI = \fR\fI/usr/local/bin/addshare\fR\fI \fR

1130

.RE

1131

1132

add user script (G)

1133

.\" add user script

1134

.PP

1135

.RS 4

1136

This is the full pathname to a script that will be run

1137

\fIAS ROOT\fR

1138

1139

\fBsmbd\fR(8)

1140

under special circumstances described below\&.

1141

.sp

1142

Normally, a Samba server requires that UNIX users are created for all users accessing files on this server\&. For sites that use Windows NT account databases as their primary user database creating these users and keeping the user list in sync with the Windows NT PDC is an onerous task\&. This option allows smbd to create the required UNIX users

1143

\fION DEMAND\fR

1144

when a user accesses the Samba server\&.

1145

.sp

1146

In order to use this option,

1147

\fBsmbd\fR(8)

1148

must

1149

\fINOT\fR

1150

be set to

1151

\m[blue]\fBsecurity = share\fR\m[]

1152

and

1153

\m[blue]\fBadd user script\fR\m[]

1154

must be set to a full pathname for a script that will create a UNIX user given one argument of

1155

\fI%u\fR, which expands into the UNIX user name to create\&.

1156

.sp

1157

When the Windows user attempts to access the Samba server, at login (session setup in the SMB protocol) time,

1158

\fBsmbd\fR(8)

1159

contacts the

1160

\m[blue]\fBpassword server\fR\m[]

1161

and attempts to authenticate the given user with the given password\&. If the authentication succeeds then

1162

smbd

1163

attempts to find a UNIX user in the UNIX password database to map the Windows user into\&. If this lookup fails, and

1164

\m[blue]\fBadd user script\fR\m[]

1165

is set then

1166

smbd

1167

will call the specified script

1168

\fIAS ROOT\fR, expanding any

1169

\fI%u\fR

1170

argument to be the user name to create\&.

1171

.sp

1172

If this script successfully creates the user then

1173

smbd

1174

will continue on as though the UNIX user already existed\&. In this way, UNIX users are dynamically created to match existing Windows NT accounts\&.

1175

.sp

1176

See also

1177

\m[blue]\fBsecurity\fR\m[],

1178

\m[blue]\fBpassword server\fR\m[],

1179

\m[blue]\fBdelete user script\fR\m[]\&.

1180

.sp

1181

Default:

1182

\fI\fIadd user script\fR\fR\fI = \fR\fI\fR\fI \fR

1183

.sp

1184

Example:

1185

\fI\fIadd user script\fR\fR\fI = \fR\fI/usr/local/samba/bin/add_user %u\fR\fI \fR

1186

.RE

1187

1188

add user to group script (G)

1189

.\" add user to group script

1190

.PP

1191

.RS 4

1192

Full path to the script that will be called when a user is added to a group using the Windows NT domain administration tools\&. It will be run by

1193

\fBsmbd\fR(8)

1194

\fIAS ROOT\fR\&. Any

1195

\fI%g\fR

1196

will be replaced with the group name and any

1197

\fI%u\fR

1198

will be replaced with the user name\&.

1199

.sp

1200

Note that the

1201

adduser

1202

command used in the example below does not support the used syntax on all systems\&.

1203

.sp

1204

Default:

1205

\fI\fIadd user to group script\fR\fR\fI = \fR\fI\fR\fI \fR

1206

.sp

1207

Example:

1208

\fI\fIadd user to group script\fR\fR\fI = \fR\fI/usr/sbin/adduser %u %g\fR\fI \fR

1209

.RE

1210

1211

administrative share (S)

1212

.\" administrative share

1213

.PP

1214

.RS 4

1215

If this parameter is set to

1216

\fByes\fR

1217

for a share, then the share will be an administrative share\&. The Administrative Shares are the default network shares created by all Windows NT\-based operating systems\&. These are shares like C$, D$ or ADMIN$\&. The type of these shares is STYPE_DISKTREE_HIDDEN\&.

1218

.sp

1219

See the section below on

1220

\m[blue]\fBsecurity\fR\m[]

1221

for more information about this option\&.

1222

.sp

1223

Default:

1224

\fI\fIadministrative share\fR\fR\fI = \fR\fIno\fR\fI \fR

1225

.RE

1226

1227

admin users (S)

1228

.\" admin users

1229

.PP

1230

.RS 4

1231

This is a list of users who will be granted administrative privileges on the share\&. This means that they will do all file operations as the super\-user (root)\&.

1232

.sp

1233

You should use this option very carefully, as any user in this list will be able to do anything they like on the share, irrespective of file permissions\&.

1234

.sp

1235

This parameter will not work with the

1236

\m[blue]\fBsecurity = share\fR\m[]

1237

in Samba 3\&.0\&. This is by design\&.

1238

.sp

1239

Default:

1240

\fI\fIadmin users\fR\fR\fI = \fR\fI\fR\fI \fR

1241

.sp

1242

Example:

1243

\fI\fIadmin users\fR\fR\fI = \fR\fIjason\fR\fI \fR

1244

.RE

1245

1246

afs share (S)

1247

.\" afs share

1248

.PP

1249

.RS 4

1250

This parameter controls whether special AFS features are enabled for this share\&. If enabled, it assumes that the directory exported via the

1251

\fIpath\fR

1252

parameter is a local AFS import\&. The special AFS features include the attempt to hand\-craft an AFS token if you enabled \-\-with\-fake\-kaserver in configure\&.

1253

.sp

1254

Default:

1255

\fI\fIafs share\fR\fR\fI = \fR\fIno\fR\fI \fR

1256

.RE

1257

1258

afs username map (G)

1259

.\" afs username map

1260

.PP

1261

.RS 4

1262

If you are using the fake kaserver AFS feature, you might want to hand\-craft the usernames you are creating tokens for\&. For example this is necessary if you have users from several domain in your AFS Protection Database\&. One possible scheme to code users as DOMAIN+User as it is done by winbind with the + as a separator\&.

1263

.sp

1264

The mapped user name must contain the cell name to log into, so without setting this parameter there will be no token\&.

1265

.sp

1266

Default:

1267

\fI\fIafs username map\fR\fR\fI = \fR\fI\fR\fI \fR

1268

.sp

1269

Example:

1270

\fI\fIafs username map\fR\fR\fI = \fR\fI%u@afs\&.samba\&.org\fR\fI \fR

1271

.RE

1272

1273

aio read size (S)

1274

.\" aio read size

1275

.PP

1276

.RS 4

1277

If Samba has been built with asynchronous I/O support and this integer parameter is set to non\-zero value, Samba will read from file asynchronously when size of request is bigger than this value\&. Note that it happens only for non\-chained and non\-chaining reads and when not using write cache\&.

1278

.sp

1279

Current implementation of asynchronous I/O in Samba 3\&.0 does support only up to 10 outstanding asynchronous requests, read and write combined\&.

1280

.sp

1281

Related command:

1282

\m[blue]\fBwrite cache size\fR\m[]

1283

.sp

1284

Related command:

1285

\m[blue]\fBaio write size\fR\m[]

1286

.sp

1287

Default:

1288

\fI\fIaio read size\fR\fR\fI = \fR\fI0\fR\fI \fR

1289

.sp

1290

Example:

1291

\fI\fIaio read size\fR\fR\fI = \fR\fI16384 # Use asynchronous I/O for reads bigger than 16KB request size\fR\fI \fR

1292

.RE

1293

1294

aio write behind (S)

1295

.\" aio write behind

1296

.PP

1297

.RS 4

1298

If Samba has been built with asynchronous I/O support, Samba will not wait until write requests are finished before returning the result to the client for files listed in this parameter\&. Instead, Samba will immediately return that the write request has been finished successfully, no matter if the operation will succeed or not\&. This might speed up clients without aio support, but is really dangerous, because data could be lost and files could be damaged\&.

1299

.sp

1300

The syntax is identical to the

1301

\m[blue]\fBveto files\fR\m[]

1302

parameter\&.

1303

.sp

1304

Default:

1305

\fI\fIaio write behind\fR\fR\fI = \fR\fI\fR\fI \fR

1306

.sp

1307

Example:

1308

\fI\fIaio write behind\fR\fR\fI = \fR\fI/*\&.tmp/\fR\fI \fR

1309

.RE

1310

1311

aio write size (S)

1312

.\" aio write size

1313

.PP

1314

.RS 4

1315

If Samba has been built with asynchronous I/O support and this integer parameter is set to non\-zero value, Samba will write to file asynchronously when size of request is bigger than this value\&. Note that it happens only for non\-chained and non\-chaining reads and when not using write cache\&.

1316

.sp

1317

Current implementation of asynchronous I/O in Samba 3\&.0 does support only up to 10 outstanding asynchronous requests, read and write combined\&.

1318

.sp

1319

Related command:

1320

\m[blue]\fBwrite cache size\fR\m[]

1321

.sp

1322

Related command:

1323

\m[blue]\fBaio read size\fR\m[]

1324

.sp

1325

Default:

1326

\fI\fIaio write size\fR\fR\fI = \fR\fI0\fR\fI \fR

1327

.sp

1328

Example:

1329

\fI\fIaio write size\fR\fR\fI = \fR\fI16384 # Use asynchronous I/O for writes bigger than 16KB request size\fR\fI \fR

1330

.RE

1331

1332

algorithmic rid base (G)

1333

.\" algorithmic rid base

1334

.PP

1335

.RS 4

1336

This determines how Samba will use its algorithmic mapping from uids/gid to the RIDs needed to construct NT Security Identifiers\&.

1337

.sp

1338

Setting this option to a larger value could be useful to sites transitioning from WinNT and Win2k, as existing user and group rids would otherwise clash with sytem users etc\&.

1339

.sp

1340

All UIDs and GIDs must be able to be resolved into SIDs for the correct operation of ACLs on the server\&. As such the algorithmic mapping can\'t be \'turned off\', but pushing it \'out of the way\' should resolve the issues\&. Users and groups can then be assigned \'low\' RIDs in arbitrary\-rid supporting backends\&.

1341

.sp

1342

Default:

1343

\fI\fIalgorithmic rid base\fR\fR\fI = \fR\fI1000\fR\fI \fR

1344

.sp

1345

Example:

1346

\fI\fIalgorithmic rid base\fR\fR\fI = \fR\fI100000\fR\fI \fR

1347

.RE

1348

1349

allocation roundup size (S)

1350

.\" allocation roundup size

1351

.PP

1352

.RS 4

1353

This parameter allows an administrator to tune the allocation size reported to Windows clients\&. The default size of 1Mb generally results in improved Windows client performance\&. However, rounding the allocation size may cause difficulties for some applications, e\&.g\&. MS Visual Studio\&. If the MS Visual Studio compiler starts to crash with an internal error, set this parameter to zero for this share\&.

1354

.sp

1355

The integer parameter specifies the roundup size in bytes\&.

1356

.sp

1357

Default:

1358

\fI\fIallocation roundup size\fR\fR\fI = \fR\fI1048576\fR\fI \fR

1359

.sp

1360

Example:

1361

\fI\fIallocation roundup size\fR\fR\fI = \fR\fI0 # (to disable roundups)\fR\fI \fR

1362

.RE

1363

1364

allow insecure wide links (G)

1365

.\" allow insecure wide links

1366

.PP

1367

.RS 4

1368

In normal operation the option

1369

\m[blue]\fBwide links\fR\m[]

1370

which allows the server to follow symlinks outside of a share path is automatically disabled when

1371

\m[blue]\fBunix extensions\fR\m[]

1372

are enabled on a Samba server\&. This is done for security purposes to prevent UNIX clients creating symlinks to areas of the server file system that the administrator does not wish to export\&.

1373

.sp

1374

Setting

1375

\m[blue]\fBallow insecure wide links\fR\m[]

1376

to true disables the link between these two parameters, removing this protection and allowing a site to configure the server to follow symlinks (by setting

1377

\m[blue]\fBwide links\fR\m[]

1378

to "true") even when

1379

\m[blue]\fBunix extensions\fR\m[]

1380

is turned on\&.

1381

.sp

1382

If is not recommended to enable this option unless you fully understand the implications of allowing the server to follow symbolic links created by UNIX clients\&. For most normal Samba configurations this would be considered a security hole and setting this parameter is not recommended\&.

1383

.sp

1384

This option was added at the request of sites who had deliberately set Samba up in this way and needed to continue supporting this functionality without having to patch the Samba code\&.

1385

.sp

1386

Default:

1387

\fI\fIallow insecure wide links\fR\fR\fI = \fR\fIno\fR\fI \fR

1388

.RE

1389

1390

allow trusted domains (G)

1391

.\" allow trusted domains

1392

.PP

1393

.RS 4

1394

This option only takes effect when the

1395

\m[blue]\fBsecurity\fR\m[]

1396

option is set to

1397

\fBserver\fR,

1398

\fBdomain\fR

1399

1400

\fBads\fR\&. If it is set to no, then attempts to connect to a resource from a domain or workgroup other than the one which smbd is running in will fail, even if that domain is trusted by the remote server doing the authentication\&.

1401

.sp

1402

This is useful if you only want your Samba server to serve resources to users in the domain it is a member of\&. As an example, suppose that there are two domains DOMA and DOMB\&. DOMB is trusted by DOMA, which contains the Samba server\&. Under normal circumstances, a user with an account in DOMB can then access the resources of a UNIX account with the same account name on the Samba server even if they do not have an account in DOMA\&. This can make implementing a security boundary difficult\&.

1403

.sp

1404

Default:

1405

\fI\fIallow trusted domains\fR\fR\fI = \fR\fIyes\fR\fI \fR

1406

.RE

1407

1408

announce as (G)

1409

.\" announce as

1410

.PP

1411

.RS 4

1412

This specifies what type of server

1413

\fBnmbd\fR(8)

1414

will announce itself as, to a network neighborhood browse list\&. By default this is set to Windows NT\&. The valid options are : "NT Server" (which can also be written as "NT"), "NT Workstation", "Win95" or "WfW" meaning Windows NT Server, Windows NT Workstation, Windows 95 and Windows for Workgroups respectively\&. Do not change this parameter unless you have a specific need to stop Samba appearing as an NT server as this may prevent Samba servers from participating as browser servers correctly\&.

1415

.sp

1416

Default:

1417

\fI\fIannounce as\fR\fR\fI = \fR\fINT Server\fR\fI \fR

1418

.sp

1419

Example:

1420

\fI\fIannounce as\fR\fR\fI = \fR\fIWin95\fR\fI \fR

1421

.RE

1422

1423

announce version (G)

1424

.\" announce version

1425

.PP

1426

.RS 4

1427

This specifies the major and minor version numbers that nmbd will use when announcing itself as a server\&. The default is 4\&.9\&. Do not change this parameter unless you have a specific need to set a Samba server to be a downlevel server\&.

1428

.sp

1429

Default:

1430

\fI\fIannounce version\fR\fR\fI = \fR\fI4\&.9\fR\fI \fR

1431

.sp

1432

Example:

1433

\fI\fIannounce version\fR\fR\fI = \fR\fI2\&.0\fR\fI \fR

1434

.RE

1435

1436

async smb echo handler (G)

1437

.\" async smb echo handler

1438

.PP

1439

.RS 4

1440

This parameter specifies whether Samba should fork the async smb echo handler\&. It can be beneficial if your file system can block syscalls for a very long time\&. In some circumstances, it prolongs the timeout that Windows uses to determine whether a connection is dead\&.

1441

.sp

1442

Default:

1443

\fI\fIasync smb echo handler\fR\fR\fI = \fR\fIno\fR\fI \fR

1444

.RE

1445

1446

auth methods (G)

1447

.\" auth methods

1448

.PP

1449

.RS 4

1450

This option allows the administrator to chose what authentication methods

1451

smbd

1452

will use when authenticating a user\&. This option defaults to sensible values based on

1453

\m[blue]\fBsecurity\fR\m[]\&. This should be considered a developer option and used only in rare circumstances\&. In the majority (if not all) of production servers, the default setting should be adequate\&.

1454

.sp

1455

Each entry in the list attempts to authenticate the user in turn, until the user authenticates\&. In practice only one method will ever actually be able to complete the authentication\&.

1456

.sp

1457

Possible options include

1458

\fBguest\fR

1459

(anonymous access),

1460

\fBsam\fR

1461

(lookups in local list of accounts based on netbios name or domain name),

1462

\fBwinbind\fR

1463

(relay authentication requests for remote users through winbindd),

1464

\fBntdomain\fR

1465

(pre\-winbindd method of authentication for remote domain users; deprecated in favour of winbind method),

1466

\fBtrustdomain\fR

1467

(authenticate trusted users by contacting the remote DC directly from smbd; deprecated in favour of winbind method)\&.

1468

.sp

1469

Default:

1470

\fI\fIauth methods\fR\fR\fI = \fR\fI\fR\fI \fR

1471

.sp

1472

Example:

1473

\fI\fIauth methods\fR\fR\fI = \fR\fIguest sam winbind\fR\fI \fR

1474

.RE

1475

1476

available (S)

1477

.\" available

1478

.PP

1479

.RS 4

1480

This parameter lets you "turn off" a service\&. If

1481

\fIavailable = no\fR, then

1482

\fIALL\fR

1483

attempts to connect to the service will fail\&. Such failures are logged\&.

1484

.sp

1485

Default:

1486

\fI\fIavailable\fR\fR\fI = \fR\fIyes\fR\fI \fR

1487

.RE

1488

1489

bind interfaces only (G)

1490

.\" bind interfaces only

1491

.PP

1492

.RS 4

1493

This global parameter allows the Samba admin to limit what interfaces on a machine will serve SMB requests\&. It affects file service

1494

\fBsmbd\fR(8)

1495

and name service

1496

\fBnmbd\fR(8)

1497

in a slightly different ways\&.

1498

.sp

1499

For name service it causes

1500

nmbd

1501

to bind to ports 137 and 138 on the interfaces listed in the

1502

\m[blue]\fBinterfaces\fR\m[]

1503

parameter\&.

1504

nmbd

1505

also binds to the "all addresses" interface (0\&.0\&.0\&.0) on ports 137 and 138 for the purposes of reading broadcast messages\&. If this option is not set then

1506

nmbd

1507

will service name requests on all of these sockets\&. If

1508

\m[blue]\fBbind interfaces only\fR\m[]

1509

is set then

1510

nmbd

1511

will check the source address of any packets coming in on the broadcast sockets and discard any that don\'t match the broadcast addresses of the interfaces in the

1512

\m[blue]\fBinterfaces\fR\m[]

1513

parameter list\&. As unicast packets are received on the other sockets it allows

1514

nmbd

1515

to refuse to serve names to machines that send packets that arrive through any interfaces not listed in the

1516

\m[blue]\fBinterfaces\fR\m[]

1517

list\&. IP Source address spoofing does defeat this simple check, however, so it must not be used seriously as a security feature for

1518

nmbd\&.

1519

.sp

1520

For file service it causes

1521

\fBsmbd\fR(8)

1522

to bind only to the interface list given in the

1523

\m[blue]\fBinterfaces\fR\m[]

1524

parameter\&. This restricts the networks that

1525

smbd

1526

will serve, to packets coming in on those interfaces\&. Note that you should not use this parameter for machines that are serving PPP or other intermittent or non\-broadcast network interfaces as it will not cope with non\-permanent interfaces\&.

1527

.sp

1528

1529

\m[blue]\fBbind interfaces only\fR\m[]

1530

is set and the network address

1531

\fI127\&.0\&.0\&.1\fR

1532

is not added to the

1533

\m[blue]\fBinterfaces\fR\m[]

1534

parameter list

1535

\fBsmbpasswd\fR(8)

1536

and

1537

\fBswat\fR(8)

1538

may not work as expected due to the reasons covered below\&.

1539

.sp

1540

To change a users SMB password, the

1541

smbpasswd

1542

by default connects to the

1543

\fIlocalhost \- 127\&.0\&.0\&.1\fR

1544

address as an SMB client to issue the password change request\&. If

1545

\m[blue]\fBbind interfaces only\fR\m[]

1546

is set then unless the network address

1547

\fI127\&.0\&.0\&.1\fR

1548

is added to the

1549

\m[blue]\fBinterfaces\fR\m[]

1550

parameter list then

1551

smbpasswd

1552

will fail to connect in it\'s default mode\&.

1553

smbpasswd

1554

can be forced to use the primary IP interface of the local host by using its

1555

\fBsmbpasswd\fR(8)

1556

\fI\-r \fR\fI\fIremote machine\fR\fR

1557

parameter, with

1558

\fIremote machine\fR

1559

set to the IP name of the primary interface of the local host\&.

1560

.sp

1561

The

1562

swat

1563

status page tries to connect with

1564

smbd

1565

and

1566

nmbd

1567

at the address

1568

\fI127\&.0\&.0\&.1\fR

1569

to determine if they are running\&. Not adding

1570

\fI127\&.0\&.0\&.1\fR

1571

will cause

1572

smbd

1573

and

1574

nmbd

1575

to always show "not running" even if they really are\&. This can prevent

1576

swat

1577

from starting/stopping/restarting

1578

smbd

1579

and

1580

nmbd\&.

1581

.sp

1582

Default:

1583

\fI\fIbind interfaces only\fR\fR\fI = \fR\fIno\fR\fI \fR

1584

.RE

1585

1586

blocking locks (S)

1587

.\" blocking locks

1588

.PP

1589

.RS 4

1590

This parameter controls the behavior of

1591

\fBsmbd\fR(8)

1592

when given a request by a client to obtain a byte range lock on a region of an open file, and the request has a time limit associated with it\&.

1593

.sp

1594

If this parameter is set and the lock range requested cannot be immediately satisfied, samba will internally queue the lock request, and periodically attempt to obtain the lock until the timeout period expires\&.

1595

.sp

1596

If this parameter is set to

1597

\fBno\fR, then samba will behave as previous versions of Samba would and will fail the lock request immediately if the lock range cannot be obtained\&.

1598

.sp

1599

Default:

1600

\fI\fIblocking locks\fR\fR\fI = \fR\fIyes\fR\fI \fR

1601

.RE

1602

1603

block size (S)

1604

.\" block size

1605

.PP

1606

.RS 4

1607

This parameter controls the behavior of

1608

\fBsmbd\fR(8)

1609

when reporting disk free sizes\&. By default, this reports a disk block size of 1024 bytes\&.

1610

.sp

1611

Changing this parameter may have some effect on the efficiency of client writes, this is not yet confirmed\&. This parameter was added to allow advanced administrators to change it (usually to a higher value) and test the effect it has on client write performance without re\-compiling the code\&. As this is an experimental option it may be removed in a future release\&.

1612

.sp

1613

Changing this option does not change the disk free reporting size, just the block size unit reported to the client\&.

1614

.sp

1615

Default:

1616

\fI\fIblock size\fR\fR\fI = \fR\fI1024\fR\fI \fR

1617

.sp

1618

Example:

1619

\fI\fIblock size\fR\fR\fI = \fR\fI4096\fR\fI \fR

1620

.RE

1621

1622

browsable

1623

.\" browsable

1624

.PP

1625

.RS 4

1626

This parameter is a synonym for

1627

browseable\&.

1628

.RE

1629

1630

browseable (S)

1631

.\" browseable

1632

.PP

1633

.RS 4

1634

This controls whether this share is seen in the list of available shares in a net view and in the browse list\&.

1635

.sp

1636

Default:

1637

\fI\fIbrowseable\fR\fR\fI = \fR\fIyes\fR\fI \fR

1638

.RE

1639

1640

browse list (G)

1641

.\" browse list

1642

.PP

1643

.RS 4

1644

This controls whether

1645

\fBsmbd\fR(8)

1646

will serve a browse list to a client doing a

1647

NetServerEnum

1648

call\&. Normally set to

1649

\fByes\fR\&. You should never need to change this\&.

1650

.sp

1651

Default:

1652

\fI\fIbrowse list\fR\fR\fI = \fR\fIyes\fR\fI \fR

1653

.RE

1654

1655

cache directory (G)

1656

.\" cache directory

1657

.PP

1658

.RS 4

1659

Usually, most of the TDB files are stored in the

1660

\fIlock directory\fR\&. Since Samba 3\&.4\&.0, it is possible to differentiate between TDB files with persistent data and TDB files with non\-persistent data using the

1661

\fIstate directory\fR

1662

and the

1663

\fIcache directory\fR

1664

options\&.

1665

.sp

1666

This option specifies the directory where TDB files containing non\-persistent data will be stored\&.

1667

.sp

1668

Default:

1669

\fI\fIcache directory\fR\fR\fI = \fR\fI${prefix}/var/locks\fR\fI \fR

1670

.sp

1671

Example:

1672

\fI\fIcache directory\fR\fR\fI = \fR\fI/var/run/samba/locks/cache\fR\fI \fR

1673

.RE

1674

1675

casesignames

1676

.\" casesignames

1677

.PP

1678

.RS 4

1679

This parameter is a synonym for

1680

case sensitive\&.

1681

.RE

1682

1683

case sensitive (S)

1684

.\" case sensitive

1685

.PP

1686

.RS 4

1687

See the discussion in the section

1688

\m[blue]\fBname mangling\fR\m[]\&.

1689

.sp

1690

Default:

1691

\fI\fIcase sensitive\fR\fR\fI = \fR\fIno\fR\fI \fR

1692

.RE

1693

1694

change notify (S)

1695

.\" change notify

1696

.PP

1697

.RS 4

1698

This parameter specifies whether Samba should reply to a client\'s file change notify requests\&.

1699

.sp

1700

You should never need to change this parameter

1701

.sp

1702

Default:

1703

\fI\fIchange notify\fR\fR\fI = \fR\fIyes\fR\fI \fR

1704

.RE

1705

1706

change share command (G)

1707

.\" change share command

1708

.PP

1709

.RS 4

1710

Samba 2\&.2\&.0 introduced the ability to dynamically add and delete shares via the Windows NT 4\&.0 Server Manager\&. The

1711

\fIchange share command\fR

1712

is used to define an external program or script which will modify an existing service definition in

1713

smb\&.conf\&.

1714

.sp

1715

In order to successfully execute the

1716

\fIchange share command\fR,

1717

smbd

1718

requires that the administrator connects using a root account (i\&.e\&. uid == 0) or has the

1719

SeDiskOperatorPrivilege\&. Scripts defined in the

1720

\fIchange share command\fR

1721

parameter are executed as root\&.

1722

.sp

1723

When executed,

1724

smbd

1725

will automatically invoke the

1726

\fIchange share command\fR

1727

with five parameters\&.

1728

.sp

1729

.RS 4

1730

.ie n \{\

1731

\h'-04'\(bu\h'+03'\c

1732

.\}

1733

.el \{\

1734

.sp -1

1735

.IP \(bu 2.3

1736

.\}

1737

\fIconfigFile\fR

1738

\- the location of the global

1739

smb\&.conf

1740

file\&.

1741

.RE

1742

.sp

1743

.RS 4

1744

.ie n \{\

1745

\h'-04'\(bu\h'+03'\c

1746

.\}

1747

.el \{\

1748

.sp -1

1749

.IP \(bu 2.3

1750

.\}

1751

\fIshareName\fR

1752

\- the name of the new share\&.

1753

.RE

1754

.sp

1755

.RS 4

1756

.ie n \{\

1757

\h'-04'\(bu\h'+03'\c

1758

.\}

1759

.el \{\

1760

.sp -1

1761

.IP \(bu 2.3

1762

.\}

1763

\fIpathName\fR

1764

\- path to an **existing** directory on disk\&.

1765

.RE

1766

.sp

1767

.RS 4

1768

.ie n \{\

1769

\h'-04'\(bu\h'+03'\c

1770

.\}

1771

.el \{\

1772

.sp -1

1773

.IP \(bu 2.3

1774

.\}

1775

\fIcomment\fR

1776

\- comment string to associate with the new share\&.

1777

.RE

1778

.sp

1779

.RS 4

1780

.ie n \{\

1781

\h'-04'\(bu\h'+03'\c

1782

.\}

1783

.el \{\

1784

.sp -1

1785

.IP \(bu 2.3

1786

.\}

1787

\fImax connections\fR

1788

Number of maximum simultaneous connections to this share\&.

1789

.RE

1790

.sp

1791

.RE

1792

This parameter is only used to modify existing file share definitions\&. To modify printer shares, use the "Printers\&.\&.\&." folder as seen when browsing the Samba host\&.

1793

.sp

1794

Default:

1795

\fI\fIchange share command\fR\fR\fI = \fR\fI\fR\fI \fR

1796

.sp

1797

Example:

1798

\fI\fIchange share command\fR\fR\fI = \fR\fI/usr/local/bin/changeshare\fR\fI \fR

1799

.RE

1800

1801

check password script (G)

1802

.\" check password script

1803

.PP

1804

.RS 4

1805

The name of a program that can be used to check password complexity\&. The password is sent to the program\'s standard input\&.

1806

.sp

1807

The program must return 0 on a good password, or any other value if the password is bad\&. In case the password is considered weak (the program does not return 0) the user will be notified and the password change will fail\&.

1808

.sp

1809

Note: In the example directory is a sample program called

1810

crackcheck

1811

that uses cracklib to check the password quality\&.

1812

.sp

1813

Default:

1814

\fI\fIcheck password script\fR\fR\fI = \fR\fIDisabled\fR\fI \fR

1815

.sp

1816

Example:

1817

\fI\fIcheck password script\fR\fR\fI = \fR\fI/usr/local/sbin/crackcheck\fR\fI \fR

1818

.RE

1819

1820

client lanman auth (G)

1821

.\" client lanman auth

1822

.PP

1823

.RS 4

1824

This parameter determines whether or not

1825

\fBsmbclient\fR(8)

1826

and other samba client tools will attempt to authenticate itself to servers using the weaker LANMAN password hash\&. If disabled, only server which support NT password hashes (e\&.g\&. Windows NT/2000, Samba, etc\&.\&.\&. but not Windows 95/98) will be able to be connected from the Samba client\&.

1827

.sp

1828

The LANMAN encrypted response is easily broken, due to its case\-insensitive nature, and the choice of algorithm\&. Clients without Windows 95/98 servers are advised to disable this option\&.

1829

.sp

1830

Disabling this option will also disable the

1831

client plaintext auth

1832

option\&.

1833

.sp

1834

Likewise, if the

1835

client ntlmv2 auth

1836

parameter is enabled, then only NTLMv2 logins will be attempted\&.

1837

.sp

1838

Default:

1839

\fI\fIclient lanman auth\fR\fR\fI = \fR\fIno\fR\fI \fR

1840

.RE

1841

1842

client ldap sasl wrapping (G)

1843

.\" client ldap sasl wrapping

1844

.PP

1845

.RS 4

1846

The

1847

\m[blue]\fBclient ldap sasl wrapping\fR\m[]

1848

defines whether ldap traffic will be signed or signed and encrypted (sealed)\&. Possible values are

1849

\fIplain\fR,

1850

\fIsign\fR

1851

and

1852

\fIseal\fR\&.

1853

.sp

1854

The values

1855

\fIsign\fR

1856

and

1857

\fIseal\fR

1858

are only available if Samba has been compiled against a modern OpenLDAP version (2\&.3\&.x or higher)\&.

1859

.sp

1860

This option is needed in the case of Domain Controllers enforcing the usage of signed LDAP connections (e\&.g\&. Windows 2000 SP3 or higher)\&. LDAP sign and seal can be controlled with the registry key "HKLM\eSystem\eCurrentControlSet\eServices\e

1861

NTDS\eParameters\eLDAPServerIntegrity" on the Windows server side\&.

1862

.sp

1863

Depending on the used KRB5 library (MIT and older Heimdal versions) it is possible that the message "integrity only" is not supported\&. In this case,

1864

\fIsign\fR

1865

is just an alias for

1866

\fIseal\fR\&.

1867

.sp

1868

The default value is

1869

\fIplain\fR

1870

which is not irritable to KRB5 clock skew errors\&. That implies synchronizing the time with the KDC in the case of using

1871

\fIsign\fR

1872

1873

\fIseal\fR\&.

1874

.sp

1875

Default:

1876

\fI\fIclient ldap sasl wrapping\fR\fR\fI = \fR\fIplain\fR\fI \fR

1877

.RE

1878

1879

client ntlmv2 auth (G)

1880

.\" client ntlmv2 auth

1881

.PP

1882

.RS 4

1883

This parameter determines whether or not

1884

\fBsmbclient\fR(8)

1885

will attempt to authenticate itself to servers using the NTLMv2 encrypted password response\&.

1886

.sp

1887

If enabled, only an NTLMv2 and LMv2 response (both much more secure than earlier versions) will be sent\&. Older servers (including NT4 < SP4, Win9x and Samba 2\&.2) are not compatible with NTLMv2 when not in an NTLMv2 supporting domain

1888

.sp

1889

Similarly, if enabled, NTLMv1,

1890

client lanman auth

1891

and

1892

client plaintext auth

1893

authentication will be disabled\&. This also disables share\-level authentication\&.

1894

.sp

1895

If disabled, an NTLM response (and possibly a LANMAN response) will be sent by the client, depending on the value of

1896

client lanman auth\&.

1897

.sp

1898

Note that Windows Vista and later versions already use NTLMv2 by default, and some sites (particularly those following \'best practice\' security polices) only allow NTLMv2 responses, and not the weaker LM or NTLM\&.

1899

.sp

1900

Default:

1901

\fI\fIclient ntlmv2 auth\fR\fR\fI = \fR\fIyes\fR\fI \fR

1902

.RE

1903

1904

client plaintext auth (G)

1905

.\" client plaintext auth

1906

.PP

1907

.RS 4

1908

Specifies whether a client should send a plaintext password if the server does not support encrypted passwords\&.

1909

.sp

1910

Default:

1911

\fI\fIclient plaintext auth\fR\fR\fI = \fR\fIno\fR\fI \fR

1912

.RE

1913

1914

client schannel (G)

1915

.\" client schannel

1916

.PP

1917

.RS 4

1918

This controls whether the client offers or even demands the use of the netlogon schannel\&.

1919

\m[blue]\fBclient schannel = no\fR\m[]

1920

does not offer the schannel,

1921

\m[blue]\fBclient schannel = auto\fR\m[]

1922

offers the schannel but does not enforce it, and

1923

\m[blue]\fBclient schannel = yes\fR\m[]

1924

denies access if the server is not able to speak netlogon schannel\&.

1925

.sp

1926

Default:

1927

\fI\fIclient schannel\fR\fR\fI = \fR\fIauto\fR\fI \fR

1928

.sp

1929

Example:

1930

\fI\fIclient schannel\fR\fR\fI = \fR\fIyes\fR\fI \fR

1931

.RE

1932

1933

client signing (G)

1934

.\" client signing

1935

.PP

1936

.RS 4

1937

This controls whether the client is allowed or required to use SMB signing\&. Possible values are

1938

\fIauto\fR,

1939

\fImandatory\fR

1940

and

1941

\fIdisabled\fR\&.

1942

.sp

1943

When set to auto, SMB signing is offered, but not enforced\&. When set to mandatory, SMB signing is required and if set to disabled, SMB signing is not offered either\&.

1944

.sp

1945

Default:

1946

\fI\fIclient signing\fR\fR\fI = \fR\fIauto\fR\fI \fR

1947

.RE

1948

1949

client use spnego principal (G)

1950

.\" client use spnego principal

1951

.PP

1952

.RS 4

1953

This parameter determines whether or not

1954

\fBsmbclient\fR(8)

1955

and other samba components acting as a client will attempt to use the server\-supplied principal sometimes given in the SPNEGO exchange\&.

1956

.sp

1957

If enabled, Samba can attempt to use Kerberos to contact servers known only by IP address\&. Kerberos relies on names, so ordinarily cannot function in this situation\&.

1958

.sp

1959

If disabled, Samba will use the name used to look up the server when asking the KDC for a ticket\&. This avoids situations where a server may impersonate another, soliciting authentication as one principal while being known on the network as another\&.

1960

.sp

1961

Note that Windows XP SP2 and later versions already follow this behaviour, and Windows Vista and later servers no longer supply this \'rfc4178 hint\' principal on the server side\&.

1962

.sp

1963

Default:

1964

\fI\fIclient use spnego principal\fR\fR\fI = \fR\fIno\fR\fI \fR

1965

.RE

1966

1967

client use spnego (G)

1968

.\" client use spnego

1969

.PP

1970

.RS 4

1971

This variable controls whether Samba clients will try to use Simple and Protected NEGOciation (as specified by rfc2478) with supporting servers (including WindowsXP, Windows2000 and Samba 3\&.0) to agree upon an authentication mechanism\&. This enables Kerberos authentication in particular\&.

1972

.sp

1973

Default:

1974

\fI\fIclient use spnego\fR\fR\fI = \fR\fIyes\fR\fI \fR

1975

.RE

1976

1977

cluster addresses (G)

1978

.\" cluster addresses

1979

.PP

1980

.RS 4

1981

With this parameter you can add additional addresses nmbd will register with a WINS server\&. These addresses are not necessarily present on all nodes simultaneously, but they will be registered with the WINS server so that clients can contact any of the nodes\&.

1982

.sp

1983

Default:

1984

\fI\fIcluster addresses\fR\fR\fI = \fR\fI\fR\fI \fR

1985

.sp

1986

Example:

1987

\fI\fIcluster addresses\fR\fR\fI = \fR\fI10\&.0\&.0\&.1 10\&.0\&.0\&.2 10\&.0\&.0\&.3\fR\fI \fR

1988

.RE

1989

1990

clustering (G)

1991

.\" clustering

1992

.PP

1993

.RS 4

1994

This parameter specifies whether Samba should contact ctdb for accessing its tdb files and use ctdb as a backend for its messaging backend\&.

1995

.sp

1996

Set this parameter to

1997

yes

1998

only if you have a cluster setup with ctdb running\&.

1999

.sp

2000

Default:

2001

\fI\fIclustering\fR\fR\fI = \fR\fIno\fR\fI \fR

2002

.RE

2003

2004

comment (S)

2005

.\" comment

2006

.PP

2007

.RS 4

2008

This is a text field that is seen next to a share when a client does a queries the server, either via the network neighborhood or via

2009

net view

2010

to list what shares are available\&.

2011

.sp

2012

If you want to set the string that is displayed next to the machine name then see the

2013

\m[blue]\fBserver string\fR\m[]

2014

parameter\&.

2015

.sp

2016

Default:

2017

\fI\fIcomment\fR\fR\fI = \fR\fI # No comment\fR\fI \fR

2018

.sp

2019

Example:

2020

\fI\fIcomment\fR\fR\fI = \fR\fIFred\'s Files\fR\fI \fR

2021

.RE

2022

2023

config backend (G)

2024

.\" config backend

2025

.PP

2026

.RS 4

2027

This controls the backend for storing the configuration\&. Possible values are

2028

\fIfile\fR

2029

(the default) and

2030

\fIregistry\fR\&. When

2031

\m[blue]\fBconfig backend = registry\fR\m[]

2032

is encountered while loading

2033

\fIsmb\&.conf\fR, the configuration read so far is dropped and the global options are read from registry instead\&. So this triggers a registry only configuration\&. Share definitions are not read immediately but instead

2034

\fIregistry shares\fR

2035

is set to

2036

\fIyes\fR\&.

2037

.sp

2038

Note: This option can not be set inside the registry configuration itself\&.

2039

.sp

2040

Default:

2041

\fI\fIconfig backend\fR\fR\fI = \fR\fIfile\fR\fI \fR

2042

.sp

2043

Example:

2044

\fI\fIconfig backend\fR\fR\fI = \fR\fIregistry\fR\fI \fR

2045

.RE

2046

2047

config file (G)

2048

.\" config file

2049

.PP

2050

.RS 4

2051

This allows you to override the config file to use, instead of the default (usually

2052

smb\&.conf)\&. There is a chicken and egg problem here as this option is set in the config file!

2053

.sp

2054

For this reason, if the name of the config file has changed when the parameters are loaded then it will reload them from the new config file\&.

2055

.sp

2056

This option takes the usual substitutions, which can be very useful\&.

2057

.sp

2058

If the config file doesn\'t exist then it won\'t be loaded (allowing you to special case the config files of just a few clients)\&.

2059

.sp

2060

\fINo default\fR

2061

.sp

2062

Example:

2063

\fI\fIconfig file\fR\fR\fI = \fR\fI/usr/local/samba/lib/smb\&.conf\&.%m\fR\fI \fR

2064

.RE

2065

2066

copy (S)

2067

.\" copy

2068

.PP

2069

.RS 4

2070

This parameter allows you to "clone" service entries\&. The specified service is simply duplicated under the current service\'s name\&. Any parameters specified in the current section will override those in the section being copied\&.

2071

.sp

2072

This feature lets you set up a \'template\' service and create similar services easily\&. Note that the service being copied must occur earlier in the configuration file than the service doing the copying\&.

2073

.sp

2074

Default:

2075

\fI\fIcopy\fR\fR\fI = \fR\fI\fR\fI \fR

2076

.sp

2077

Example:

2078

\fI\fIcopy\fR\fR\fI = \fR\fIotherservice\fR\fI \fR

2079

.RE

2080

2081

create krb5 conf (G)

2082

.\" create krb5 conf

2083

.PP

2084

.RS 4

2085

Setting this paramter to

2086

2087

prevents winbind from creating custom krb5\&.conf files\&. Winbind normally does this because the krb5 libraries are not AD\-site\-aware and thus would pick any domain controller out of potentially very many\&. Winbind is site\-aware and makes the krb5 libraries use a local DC by creating its own krb5\&.conf files\&.

2088

.sp

2089

Preventing winbind from doing this might become necessary if you have to add special options into your system\-krb5\&.conf that winbind does not see\&.

2090

.sp

2091

Default:

2092

\fI\fIcreate krb5 conf\fR\fR\fI = \fR\fIyes\fR\fI \fR

2093

.RE

2094

2095

create mode

2096

.\" create mode

2097

.PP

2098

.RS 4

2099

This parameter is a synonym for

2100

create mask\&.

2101

.RE

2102

2103

create mask (S)

2104

.\" create mask

2105

.PP

2106

.RS 4

2107

When a file is created, the necessary permissions are calculated according to the mapping from DOS modes to UNIX permissions, and the resulting UNIX mode is then bit\-wise \'AND\'ed with this parameter\&. This parameter may be thought of as a bit\-wise MASK for the UNIX modes of a file\&. Any bit

2108

\fInot\fR

2109

set here will be removed from the modes set on a file when it is created\&.

2110

.sp

2111

The default value of this parameter removes the

2112

group

2113

and

2114

other

2115

write and execute bits from the UNIX modes\&.

2116

.sp

2117

Following this Samba will bit\-wise \'OR\' the UNIX mode created from this parameter with the value of the

2118

\m[blue]\fBforce create mode\fR\m[]

2119

parameter which is set to 000 by default\&.

2120

.sp

2121

This parameter does not affect directory masks\&. See the parameter

2122

\m[blue]\fBdirectory mask\fR\m[]

2123

for details\&.

2124

.sp

2125

Note that this parameter does not apply to permissions set by Windows NT/2000 ACL editors\&. If the administrator wishes to enforce a mask on access control lists also, they need to set the

2126

\m[blue]\fBsecurity mask\fR\m[]\&.

2127

.sp

2128

Default:

2129

\fI\fIcreate mask\fR\fR\fI = \fR\fI0744\fR\fI \fR

2130

.sp

2131

Example:

2132

\fI\fIcreate mask\fR\fR\fI = \fR\fI0775\fR\fI \fR

2133

.RE

2134

2135

csc policy (S)

2136

.\" csc policy

2137

.PP

2138

.RS 4

2139

This stands for

2140

\fIclient\-side caching policy\fR, and specifies how clients capable of offline caching will cache the files in the share\&. The valid values are: manual, documents, programs, disable\&.

2141

.sp

2142

These values correspond to those used on Windows servers\&.

2143

.sp

2144

For example, shares containing roaming profiles can have offline caching disabled using

2145

\m[blue]\fBcsc policy = disable\fR\m[]\&.

2146

.sp

2147

Default:

2148

\fI\fIcsc policy\fR\fR\fI = \fR\fImanual\fR\fI \fR

2149

.sp

2150

Example:

2151

\fI\fIcsc policy\fR\fR\fI = \fR\fIprograms\fR\fI \fR

2152

.RE

2153

2154

ctdbd socket (G)

2155

.\" ctdbd socket

2156

.PP

2157

.RS 4

2158

If you set

2159

clustering=yes, you need to tell Samba where ctdbd listens on its unix domain socket\&. The default path as of ctdb 1\&.0 is /tmp/ctdb\&.socket which you have to explicitly set for Samba in smb\&.conf\&.

2160

.sp

2161

Default:

2162

\fI\fIctdbd socket\fR\fR\fI = \fR\fI\fR\fI \fR

2163

.sp

2164

Example:

2165

\fI\fIctdbd socket\fR\fR\fI = \fR\fI/tmp/ctdb\&.socket\fR\fI \fR

2166

.RE

2167

2168

ctdb locktime warn threshold (G)

2169

.\" ctdb locktime warn threshold

2170

.PP

2171

.RS 4

2172

In a cluster environment using Samba and ctdb it is critical that locks on central ctdb\-hosted databases like locking\&.tdb are not held for long\&. With the current Samba architecture it happens that Samba takes a lock and while holding that lock makes file system calls into the shared cluster file system\&. This option makes Samba warn if it detects that it has held locks for the specified number of milliseconds\&. If this happens,

2173

\fIsmbd\fR

2174

will emit a debug level 0 message into its logs and potentially into syslog\&. The most likely reason for such a log message is that an operation of the cluster file system Samba exports is taking longer than expected\&. The messages are meant as a debugging aid for potential cluster problems\&.

2175

.sp

2176

The default value of 0 disables this logging\&.

2177

.sp

2178

Default:

2179

\fI\fIctdb locktime warn threshold\fR\fR\fI = \fR\fI0\fR\fI \fR

2180

.RE

2181

2182

ctdb timeout (G)

2183

.\" ctdb timeout

2184

.PP

2185

.RS 4

2186

This parameter specifies a timeout in seconds for the connection between Samba and ctdb\&. It is only valid if you have compiled Samba with clustering and if you have set

2187

\fIclustering=yes\fR\&.

2188

.sp

2189

When something in the cluster blocks, it can happen that we wait indefinitely long for ctdb, just adding to the blocking condition\&. In a well\-running cluster this should never happen, but there are too many components in a cluster that might have hickups\&. Choosing the right balance for this value is very tricky, because on a busy cluster long service times to transfer something across the cluster might be valid\&. Setting it too short will degrade the service your cluster presents, setting it too long might make the cluster itself not recover from something severely broken for too long\&.

2190

.sp

2191

Be aware that if you set this parameter, this needs to be in the file smb\&.conf, it is not really helpful to put this into a registry configuration (typical on a cluster), because to access the registry contact to ctdb is requred\&.

2192

.sp

2193

Setting

2194

\fIctdb timeout\fR

2195

to n makes any process waiting longer than n seconds for a reply by the cluster panic\&. Setting it to 0 (the default) makes Samba block forever, which is the highly recommended default\&.

2196

.sp

2197

Default:

2198

\fI\fIctdb timeout\fR\fR\fI = \fR\fI0\fR\fI \fR

2199

.RE

2200

2201

cups connection timeout (G)

2202

.\" cups connection timeout

2203

.PP

2204

.RS 4

2205

This parameter is only applicable if

2206

\m[blue]\fBprinting\fR\m[]

2207

is set to

2208

\fBcups\fR\&.

2209

.sp

2210

If set, this option specifies the number of seconds that smbd will wait whilst trying to contact to the CUPS server\&. The connection will fail if it takes longer than this number of seconds\&.

2211

.sp

2212

Default:

2213

\fI\fIcups connection timeout\fR\fR\fI = \fR\fI30\fR\fI \fR

2214

.sp

2215

Example:

2216

\fI\fIcups connection timeout\fR\fR\fI = \fR\fI60\fR\fI \fR

2217

.RE

2218

2219

cups encrypt (G)

2220

.\" cups encrypt

2221

.PP

2222

.RS 4

2223

This parameter is only applicable if

2224

\m[blue]\fBprinting\fR\m[]

2225

is set to

2226

\fBcups\fR

2227

and if you use CUPS newer than 1\&.0\&.x\&.It is used to define whether or not Samba should use encryption when talking to the CUPS server\&. Possible values are

2228

\fIauto\fR,

2229

\fIyes\fR

2230

and

2231

\fIno\fR

2232

.sp

2233

When set to auto we will try to do a TLS handshake on each CUPS connection setup\&. If that fails, we will fall back to unencrypted operation\&.

2234

.sp

2235

Default:

2236

\fI\fIcups encrypt\fR\fR\fI = \fR\fI"no"\fR\fI \fR

2237

.RE

2238

2239

cups options (S)

2240

.\" cups options

2241

.PP

2242

.RS 4

2243

This parameter is only applicable if

2244

\m[blue]\fBprinting\fR\m[]

2245

is set to

2246

\fBcups\fR\&. Its value is a free form string of options passed directly to the cups library\&.

2247

.sp

2248

You can pass any generic print option known to CUPS (as listed in the CUPS "Software Users\' Manual")\&. You can also pass any printer specific option (as listed in "lpoptions \-d printername \-l") valid for the target queue\&. Multiple parameters should be space\-delimited name/value pairs according to the PAPI text option ABNF specification\&. Collection values ("name={a=\&.\&.\&. b=\&.\&.\&. c=\&.\&.\&.}") are stored with the curley brackets intact\&.

2249

.sp

2250

You should set this parameter to

2251

\fBraw\fR

2252

if your CUPS server

2253

error_log

2254

file contains messages such as "Unsupported format \'application/octet\-stream\'" when printing from a Windows client through Samba\&. It is no longer necessary to enable system wide raw printing in

2255

/etc/cups/mime\&.{convs,types}\&.

2256

.sp

2257

Default:

2258

\fI\fIcups options\fR\fR\fI = \fR\fI""\fR\fI \fR

2259

.sp

2260

Example:

2261

\fI\fIcups options\fR\fR\fI = \fR\fI"raw media=a4"\fR\fI \fR

2262

.RE

2263

2264

cups server (G)

2265

.\" cups server

2266

.PP

2267

.RS 4

2268

This parameter is only applicable if

2269

\m[blue]\fBprinting\fR\m[]

2270

is set to

2271

\fBcups\fR\&.

2272

.sp

2273

If set, this option overrides the ServerName option in the CUPS

2274

client\&.conf\&. This is necessary if you have virtual samba servers that connect to different CUPS daemons\&.

2275

.sp

2276

Optionally, a port can be specified by separating the server name and port number with a colon\&. If no port was specified, the default port for IPP (631) will be used\&.

2277

.sp

2278

Default:

2279

\fI\fIcups server\fR\fR\fI = \fR\fI""\fR\fI \fR

2280

.sp

2281

Example:

2282

\fI\fIcups server\fR\fR\fI = \fR\fImycupsserver\fR\fI \fR

2283

.sp

2284

Example:

2285

\fI\fIcups server\fR\fR\fI = \fR\fImycupsserver:1631\fR\fI \fR

2286

.RE

2287

2288

deadtime (G)

2289

.\" deadtime

2290

.PP

2291

.RS 4

2292

The value of the parameter (a decimal integer) represents the number of minutes of inactivity before a connection is considered dead, and it is disconnected\&. The deadtime only takes effect if the number of open files is zero\&.

2293

.sp

2294

This is useful to stop a server\'s resources being exhausted by a large number of inactive connections\&.

2295

.sp

2296

Most clients have an auto\-reconnect feature when a connection is broken so in most cases this parameter should be transparent to users\&.

2297

.sp

2298

Using this parameter with a timeout of a few minutes is recommended for most systems\&.

2299

.sp

2300

A deadtime of zero indicates that no auto\-disconnection should be performed\&.

2301

.sp

2302

Default:

2303

\fI\fIdeadtime\fR\fR\fI = \fR\fI0\fR\fI \fR

2304

.sp

2305

Example:

2306

\fI\fIdeadtime\fR\fR\fI = \fR\fI15\fR\fI \fR

2307

.RE

2308

2309

debug class (G)

2310

.\" debug class

2311

.PP

2312

.RS 4

2313

With this boolean parameter enabled, the debug class (DBGC_CLASS) will be displayed in the debug header\&.

2314

.sp

2315

For more information about currently available debug classes, see section about

2316

\m[blue]\fBlog level\fR\m[]\&.

2317

.sp

2318

Default:

2319

\fI\fIdebug class\fR\fR\fI = \fR\fIno\fR\fI \fR

2320

.RE

2321

2322

debug hires timestamp (G)

2323

.\" debug hires timestamp

2324

.PP

2325

.RS 4

2326

Sometimes the timestamps in the log messages are needed with a resolution of higher that seconds, this boolean parameter adds microsecond resolution to the timestamp message header when turned on\&.

2327

.sp

2328

Note that the parameter

2329

\m[blue]\fBdebug timestamp\fR\m[]

2330

must be on for this to have an effect\&.

2331

.sp

2332

Default:

2333

\fI\fIdebug hires timestamp\fR\fR\fI = \fR\fIyes\fR\fI \fR

2334

.RE

2335

2336

debug pid (G)

2337

.\" debug pid

2338

.PP

2339

.RS 4

2340

When using only one log file for more then one forked

2341

\fBsmbd\fR(8)\-process there may be hard to follow which process outputs which message\&. This boolean parameter is adds the process\-id to the timestamp message headers in the logfile when turned on\&.

2342

.sp

2343

Note that the parameter

2344

\m[blue]\fBdebug timestamp\fR\m[]

2345

must be on for this to have an effect\&.

2346

.sp

2347

Default:

2348

\fI\fIdebug pid\fR\fR\fI = \fR\fIno\fR\fI \fR

2349

.RE

2350

2351

debug prefix timestamp (G)

2352

.\" debug prefix timestamp

2353

.PP

2354

.RS 4

2355

With this option enabled, the timestamp message header is prefixed to the debug message without the filename and function information that is included with the

2356

\m[blue]\fBdebug timestamp\fR\m[]

2357

parameter\&. This gives timestamps to the messages without adding an additional line\&.

2358

.sp

2359

Note that this parameter overrides the

2360

\m[blue]\fBdebug timestamp\fR\m[]

2361

parameter\&.

2362

.sp

2363

Default:

2364

\fI\fIdebug prefix timestamp\fR\fR\fI = \fR\fIno\fR\fI \fR

2365

.RE

2366

2367

timestamp logs

2368

.\" timestamp logs

2369

.PP

2370

.RS 4

2371

This parameter is a synonym for

2372

debug timestamp\&.

2373

.RE

2374

2375

debug timestamp (G)

2376

.\" debug timestamp

2377

.PP

2378

.RS 4

2379

Samba debug log messages are timestamped by default\&. If you are running at a high

2380

\m[blue]\fBdebug level\fR\m[]

2381

these timestamps can be distracting\&. This boolean parameter allows timestamping to be turned off\&.

2382

.sp

2383

Default:

2384

\fI\fIdebug timestamp\fR\fR\fI = \fR\fIyes\fR\fI \fR

2385

.RE

2386

2387

debug uid (G)

2388

.\" debug uid

2389

.PP

2390

.RS 4

2391

Samba is sometimes run as root and sometime run as the connected user, this boolean parameter inserts the current euid, egid, uid and gid to the timestamp message headers in the log file if turned on\&.

2392

.sp

2393

Note that the parameter

2394

\m[blue]\fBdebug timestamp\fR\m[]

2395

must be on for this to have an effect\&.

2396

.sp

2397

Default:

2398

\fI\fIdebug uid\fR\fR\fI = \fR\fIno\fR\fI \fR

2399

.RE

2400

2401

dedicated keytab file (G)

2402

.\" dedicated keytab file

2403

.PP

2404

.RS 4

2405

Specifies the path to the kerberos keytab file when

2406

\m[blue]\fBkerberos method\fR\m[]

2407

is set to "dedicated keytab"\&.

2408

.sp

2409

Default:

2410

\fI\fIdedicated keytab file\fR\fR\fI = \fR\fI\fR\fI \fR

2411

.sp

2412

Example:

2413

\fI\fIdedicated keytab file\fR\fR\fI = \fR\fI/usr/local/etc/krb5\&.keytab\fR\fI \fR

2414

.RE

2415

2416

default case (S)

2417

.\" default case

2418

.PP

2419

.RS 4

2420

See the section on

2421

\m[blue]\fBname mangling\fR\m[]\&. Also note the

2422

\m[blue]\fBshort preserve case\fR\m[]

2423

parameter\&.

2424

.sp

2425

Default:

2426

\fI\fIdefault case\fR\fR\fI = \fR\fIlower\fR\fI \fR

2427

.RE

2428

2429

default devmode (S)

2430

.\" default devmode

2431

.PP

2432

.RS 4

2433

This parameter is only applicable to

2434

\m[blue]\fBprintable\fR\m[]

2435

services\&. When smbd is serving Printer Drivers to Windows NT/2k/XP clients, each printer on the Samba server has a Device Mode which defines things such as paper size and orientation and duplex settings\&. The device mode can only correctly be generated by the printer driver itself (which can only be executed on a Win32 platform)\&. Because smbd is unable to execute the driver code to generate the device mode, the default behavior is to set this field to NULL\&.

2436

.sp

2437

Most problems with serving printer drivers to Windows NT/2k/XP clients can be traced to a problem with the generated device mode\&. Certain drivers will do things such as crashing the client\'s Explorer\&.exe with a NULL devmode\&. However, other printer drivers can cause the client\'s spooler service (spoolsv\&.exe) to die if the devmode was not created by the driver itself (i\&.e\&. smbd generates a default devmode)\&.

2438

.sp

2439

This parameter should be used with care and tested with the printer driver in question\&. It is better to leave the device mode to NULL and let the Windows client set the correct values\&. Because drivers do not do this all the time, setting

2440

default devmode = yes

2441

will instruct smbd to generate a default one\&.

2442

.sp

2443

For more information on Windows NT/2k printing and Device Modes, see the

2444

MSDN documentation\&.

2445

.sp

2446

Default:

2447

\fI\fIdefault devmode\fR\fR\fI = \fR\fIyes\fR\fI \fR

2448

.RE

2449

2450

default

2451

.\" default

2452

.PP

2453

.RS 4

2454

This parameter is a synonym for

2455

default service\&.

2456

.RE

2457

2458

default service (G)

2459

.\" default service

2460

.PP

2461

.RS 4

2462

This parameter specifies the name of a service which will be connected to if the service actually requested cannot be found\&. Note that the square brackets are

2463

\fINOT\fR

2464

given in the parameter value (see example below)\&.

2465

.sp

2466

There is no default value for this parameter\&. If this parameter is not given, attempting to connect to a nonexistent service results in an error\&.

2467

.sp

2468

Typically the default service would be a

2469

\m[blue]\fBguest ok\fR\m[],

2470

\m[blue]\fBread\-only\fR\m[]

2471

service\&.

2472

.sp

2473

Also note that the apparent service name will be changed to equal that of the requested service, this is very useful as it allows you to use macros like

2474

\fI%S\fR

2475

to make a wildcard service\&.

2476

.sp

2477

Note also that any "_" characters in the name of the service used in the default service will get mapped to a "/"\&. This allows for interesting things\&.

2478

.sp

2479

Default:

2480

\fI\fIdefault service\fR\fR\fI = \fR\fI\fR\fI \fR

2481

.sp

2482

Example:

2483

\fI\fIdefault service\fR\fR\fI = \fR\fIpub\fR\fI \fR

2484

.RE

2485

2486

defer sharing violations (G)

2487

.\" defer sharing violations

2488

.PP

2489

.RS 4

2490

Windows allows specifying how a file will be shared with other processes when it is opened\&. Sharing violations occur when a file is opened by a different process using options that violate the share settings specified by other processes\&. This parameter causes smbd to act as a Windows server does, and defer returning a "sharing violation" error message for up to one second, allowing the client to close the file causing the violation in the meantime\&.

2491

.sp

2492

UNIX by default does not have this behaviour\&.

2493

.sp

2494

There should be no reason to turn off this parameter, as it is designed to enable Samba to more correctly emulate Windows\&.

2495

.sp

2496

Default:

2497

\fI\fIdefer sharing violations\fR\fR\fI = \fR\fITrue\fR\fI \fR

2498

.RE

2499

2500

delete group script (G)

2501

.\" delete group script

2502

.PP

2503

.RS 4

2504

This is the full pathname to a script that will be run

2505

\fIAS ROOT\fR

2506

\fBsmbd\fR(8)

2507

when a group is requested to be deleted\&. It will expand any

2508

\fI%g\fR

2509

to the group name passed\&. This script is only useful for installations using the Windows NT domain administration tools\&.

2510

.sp

2511

Default:

2512

\fI\fIdelete group script\fR\fR\fI = \fR\fI\fR\fI \fR

2513

.RE

2514

2515

deleteprinter command (G)

2516

.\" deleteprinter command

2517

.PP

2518

.RS 4

2519

With the introduction of MS\-RPC based printer support for Windows NT/2000 clients in Samba 2\&.2, it is now possible to delete a printer at run time by issuing the DeletePrinter() RPC call\&.

2520

.sp

2521

For a Samba host this means that the printer must be physically deleted from the underlying printing system\&. The

2522

\m[blue]\fBdeleteprinter command\fR\m[]

2523

defines a script to be run which will perform the necessary operations for removing the printer from the print system and from

2524

smb\&.conf\&.

2525

.sp

2526

The

2527

\m[blue]\fBdeleteprinter command\fR\m[]

2528

is automatically called with only one parameter:

2529

\m[blue]\fBprinter name\fR\m[]\&.

2530

.sp

2531

Once the

2532

\m[blue]\fBdeleteprinter command\fR\m[]

2533

has been executed,

2534

smbd

2535

will reparse the

2536

smb\&.conf

2537

to check that the associated printer no longer exists\&. If the sharename is still valid, then

2538

smbd

2539

will return an ACCESS_DENIED error to the client\&.

2540

.sp

2541

Default:

2542

\fI\fIdeleteprinter command\fR\fR\fI = \fR\fI\fR\fI \fR

2543

.sp

2544

Example:

2545

\fI\fIdeleteprinter command\fR\fR\fI = \fR\fI/usr/bin/removeprinter\fR\fI \fR

2546

.RE

2547

2548

delete readonly (S)

2549

.\" delete readonly

2550

.PP

2551

.RS 4

2552

This parameter allows readonly files to be deleted\&. This is not normal DOS semantics, but is allowed by UNIX\&.

2553

.sp

2554

This option may be useful for running applications such as rcs, where UNIX file ownership prevents changing file permissions, and DOS semantics prevent deletion of a read only file\&.

2555

.sp

2556

Default:

2557

\fI\fIdelete readonly\fR\fR\fI = \fR\fIno\fR\fI \fR

2558

.RE

2559

2560

delete share command (G)

2561

.\" delete share command

2562

.PP

2563

.RS 4

2564

Samba 2\&.2\&.0 introduced the ability to dynamically add and delete shares via the Windows NT 4\&.0 Server Manager\&. The

2565

\fIdelete share command\fR

2566

is used to define an external program or script which will remove an existing service definition from

2567

smb\&.conf\&.

2568

.sp

2569

In order to successfully execute the

2570

\fIdelete share command\fR,

2571

smbd

2572

requires that the administrator connects using a root account (i\&.e\&. uid == 0) or has the

2573

SeDiskOperatorPrivilege\&. Scripts defined in the

2574

\fIdelete share command\fR

2575

parameter are executed as root\&.

2576

.sp

2577

When executed,

2578

smbd

2579

will automatically invoke the

2580

\fIdelete share command\fR

2581

with two parameters\&.

2582

.sp

2583

.RS 4

2584

.ie n \{\

2585

\h'-04'\(bu\h'+03'\c

2586

.\}

2587

.el \{\

2588

.sp -1

2589

.IP \(bu 2.3

2590

.\}

2591

\fIconfigFile\fR

2592

\- the location of the global

2593

smb\&.conf

2594

file\&.

2595

.RE

2596

.sp

2597

.RS 4

2598

.ie n \{\

2599

\h'-04'\(bu\h'+03'\c

2600

.\}

2601

.el \{\

2602

.sp -1

2603

.IP \(bu 2.3

2604

.\}

2605

\fIshareName\fR

2606

\- the name of the existing service\&.

2607

.RE

2608

.sp

2609

.RE

2610

This parameter is only used to remove file shares\&. To delete printer shares, see the

2611

\m[blue]\fBdeleteprinter command\fR\m[]\&.

2612

.sp

2613

Default:

2614

\fI\fIdelete share command\fR\fR\fI = \fR\fI\fR\fI \fR

2615

.sp

2616

Example:

2617

\fI\fIdelete share command\fR\fR\fI = \fR\fI/usr/local/bin/delshare\fR\fI \fR

2618

.RE

2619

2620

delete user from group script (G)

2621

.\" delete user from group script

2622

.PP

2623

.RS 4

2624

Full path to the script that will be called when a user is removed from a group using the Windows NT domain administration tools\&. It will be run by

2625

\fBsmbd\fR(8)

2626

\fIAS ROOT\fR\&. Any

2627

\fI%g\fR

2628

will be replaced with the group name and any

2629

\fI%u\fR

2630

will be replaced with the user name\&.

2631

.sp

2632

Default:

2633

\fI\fIdelete user from group script\fR\fR\fI = \fR\fI\fR\fI \fR

2634

.sp

2635

Example:

2636

\fI\fIdelete user from group script\fR\fR\fI = \fR\fI/usr/sbin/deluser %u %g\fR\fI \fR

2637

.RE

2638

2639

delete user script (G)

2640

.\" delete user script

2641

.PP

2642

.RS 4

2643

This is the full pathname to a script that will be run by

2644

\fBsmbd\fR(8)

2645

when managing users with remote RPC (NT) tools\&.

2646

.sp

2647

This script is called when a remote client removes a user from the server, normally using \'User Manager for Domains\' or

2648

rpcclient\&.

2649

.sp

2650

This script should delete the given UNIX username\&.

2651

.sp

2652

Default:

2653

\fI\fIdelete user script\fR\fR\fI = \fR\fI\fR\fI \fR

2654

.sp

2655

Example:

2656

\fI\fIdelete user script\fR\fR\fI = \fR\fI/usr/local/samba/bin/del_user %u\fR\fI \fR

2657

.RE

2658

2659

delete veto files (S)

2660

.\" delete veto files

2661

.PP

2662

.RS 4

2663

This option is used when Samba is attempting to delete a directory that contains one or more vetoed directories (see the

2664

\m[blue]\fBveto files\fR\m[]

2665

option)\&. If this option is set to

2666

\fBno\fR

2667

(the default) then if a vetoed directory contains any non\-vetoed files or directories then the directory delete will fail\&. This is usually what you want\&.

2668

.sp

2669

If this option is set to

2670

\fByes\fR, then Samba will attempt to recursively delete any files and directories within the vetoed directory\&. This can be useful for integration with file serving systems such as NetAtalk which create meta\-files within directories you might normally veto DOS/Windows users from seeing (e\&.g\&.

2671

\&.AppleDouble)

2672

.sp

2673

Setting

2674

\m[blue]\fBdelete veto files = yes\fR\m[]

2675

allows these directories to be transparently deleted when the parent directory is deleted (so long as the user has permissions to do so)\&.

2676

.sp

2677

Default:

2678

\fI\fIdelete veto files\fR\fR\fI = \fR\fIno\fR\fI \fR

2679

.RE

2680

2681

dfree cache time (S)

2682

.\" dfree cache time

2683

.PP

2684

.RS 4

2685

The

2686

\fIdfree cache time\fR

2687

should only be used on systems where a problem occurs with the internal disk space calculations\&. This has been known to happen with Ultrix, but may occur with other operating systems\&. The symptom that was seen was an error of "Abort Retry Ignore" at the end of each directory listing\&.

2688

.sp

2689

This is a new parameter introduced in Samba version 3\&.0\&.21\&. It specifies in seconds the time that smbd will cache the output of a disk free query\&. If set to zero (the default) no caching is done\&. This allows a heavily loaded server to prevent rapid spawning of

2690

\m[blue]\fBdfree command\fR\m[]

2691

scripts increasing the load\&.

2692

.sp

2693

By default this parameter is zero, meaning no caching will be done\&.

2694

.sp

2695

\fINo default\fR

2696

.sp

2697

Example:

2698

\fI\fIdfree cache time\fR\fR\fI = \fR\fIdfree cache time = 60\fR\fI \fR

2699

.RE

2700

2701

dfree command (S)

2702

.\" dfree command

2703

.PP

2704

.RS 4

2705

The

2706

\fIdfree command\fR

2707

setting should only be used on systems where a problem occurs with the internal disk space calculations\&. This has been known to happen with Ultrix, but may occur with other operating systems\&. The symptom that was seen was an error of "Abort Retry Ignore" at the end of each directory listing\&.

2708

.sp

2709

This setting allows the replacement of the internal routines to calculate the total disk space and amount available with an external routine\&. The example below gives a possible script that might fulfill this function\&.

2710

.sp

2711

In Samba version 3\&.0\&.21 this parameter has been changed to be a per\-share parameter, and in addition the parameter

2712

\m[blue]\fBdfree cache time\fR\m[]

2713

was added to allow the output of this script to be cached for systems under heavy load\&.

2714

.sp

2715

The external program will be passed a single parameter indicating a directory in the filesystem being queried\&. This will typically consist of the string

2716

\&./\&. The script should return two integers in ASCII\&. The first should be the total disk space in blocks, and the second should be the number of available blocks\&. An optional third return value can give the block size in bytes\&. The default blocksize is 1024 bytes\&.

2717

.sp

2718

Note: Your script should

2719

\fINOT\fR

2720

be setuid or setgid and should be owned by (and writeable only by) root!

2721

.sp

2722

Where the script dfree (which must be made executable) could be:

2723

.sp

2724

.if n \{\

2725

.RS 4

2726

.\}

2727

.nf

2728

2729

#!/bin/sh

2730

df $1 | tail \-1 | awk \'{print $(NF\-4),$(NF\-2)}\'

2731

.fi

2732

.if n \{\

2733

.RE

2734

.\}

2735

.sp

2736

or perhaps (on Sys V based systems):

2737

.sp

2738

.if n \{\

2739

.RS 4

2740

.\}

2741

.nf

2742

2743

#!/bin/sh

2744

/usr/bin/df \-k $1 | tail \-1 | awk \'{print $3" "$5}\'

2745

.fi

2746

.if n \{\

2747

.RE

2748

.\}

2749

.sp

2750

Note that you may have to replace the command names with full path names on some systems\&.

2751

.sp

2752

By default internal routines for determining the disk capacity and remaining space will be used\&.

2753

.sp

2754

\fINo default\fR

2755

.sp

2756

Example:

2757

\fI\fIdfree command\fR\fR\fI = \fR\fI/usr/local/samba/bin/dfree\fR\fI \fR

2758

.RE

2759

2760

directory mode

2761

.\" directory mode

2762

.PP

2763

.RS 4

2764

This parameter is a synonym for

2765

directory mask\&.

2766

.RE

2767

2768

directory mask (S)

2769

.\" directory mask

2770

.PP

2771

.RS 4

2772

This parameter is the octal modes which are used when converting DOS modes to UNIX modes when creating UNIX directories\&.

2773

.sp

2774

When a directory is created, the necessary permissions are calculated according to the mapping from DOS modes to UNIX permissions, and the resulting UNIX mode is then bit\-wise \'AND\'ed with this parameter\&. This parameter may be thought of as a bit\-wise MASK for the UNIX modes of a directory\&. Any bit

2775

\fInot\fR

2776

set here will be removed from the modes set on a directory when it is created\&.

2777

.sp

2778

The default value of this parameter removes the \'group\' and \'other\' write bits from the UNIX mode, allowing only the user who owns the directory to modify it\&.

2779

.sp

2780

Following this Samba will bit\-wise \'OR\' the UNIX mode created from this parameter with the value of the

2781

\m[blue]\fBforce directory mode\fR\m[]

2782

parameter\&. This parameter is set to 000 by default (i\&.e\&. no extra mode bits are added)\&.

2783

.sp

2784

Note that this parameter does not apply to permissions set by Windows NT/2000 ACL editors\&. If the administrator wishes to enforce a mask on access control lists also, they need to set the

2785

\m[blue]\fBdirectory security mask\fR\m[]\&.

2786

.sp

2787

Default:

2788

\fI\fIdirectory mask\fR\fR\fI = \fR\fI0755\fR\fI \fR

2789

.sp

2790

Example:

2791

\fI\fIdirectory mask\fR\fR\fI = \fR\fI0775\fR\fI \fR

2792

.RE

2793

2794

directory name cache size (S)

2795

.\" directory name cache size

2796

.PP

2797

.RS 4

2798

This parameter specifies the the size of the directory name cache\&. It will be needed to turn this off for *BSD systems\&.

2799

.sp

2800

Default:

2801

\fI\fIdirectory name cache size\fR\fR\fI = \fR\fI100\fR\fI \fR

2802

.RE

2803

2804

directory security mask (S)

2805

.\" directory security mask

2806

.PP

2807

.RS 4

2808

This parameter controls what UNIX permission bits will be set when a Windows NT client is manipulating the UNIX permission on a directory using the native NT security dialog box\&.

2809

.sp

2810

This parameter is applied as a mask (AND\'ed with) to the incoming permission bits, thus resetting any bits not in this mask\&. Make sure not to mix up this parameter with

2811

\m[blue]\fBforce directory security mode\fR\m[], which works similar like this one but uses logical OR instead of AND\&. Essentially, zero bits in this mask are a set of bits that will always be set to zero\&.

2812

.sp

2813

Essentially, all bits set to zero in this mask will result in setting to zero the corresponding bits on the file permissions regardless of the previous status of this bits on the file\&.

2814

.sp

2815

If not set explicitly this parameter is set to 0777 meaning a user is allowed to set all the user/group/world permissions on a directory\&.

2816

.sp

2817

\fINote\fR

2818

that users who can access the Samba server through other means can easily bypass this restriction, so it is primarily useful for standalone "appliance" systems\&. Administrators of most normal systems will probably want to leave it as the default of

2819

\fB0777\fR\&.

2820

.sp

2821

Default:

2822

\fI\fIdirectory security mask\fR\fR\fI = \fR\fI0777\fR\fI \fR

2823

.sp

2824

Example:

2825

\fI\fIdirectory security mask\fR\fR\fI = \fR\fI0700\fR\fI \fR

2826

.RE

2827

2828

disable netbios (G)

2829

.\" disable netbios

2830

.PP

2831

.RS 4

2832

Enabling this parameter will disable netbios support in Samba\&. Netbios is the only available form of browsing in all windows versions except for 2000 and XP\&.

2833

.if n \{\

2834

.sp

2835

.\}

2836

.RS 4

2837

.it 1 an-trap

2838

.nr an-no-space-flag 1

2839

.nr an-break-flag 1

2840

.br

2841

.ps +1

2842

\fBNote\fR

2843

.ps -1

2844

.br

2845

Clients that only support netbios won\'t be able to see your samba server when netbios support is disabled\&.

2846

.sp .5v

2847

.RE

2848

Default:

2849

\fI\fIdisable netbios\fR\fR\fI = \fR\fIno\fR\fI \fR

2850

.RE

2851

2852

disable spoolss (G)

2853

.\" disable spoolss

2854

.PP

2855

.RS 4

2856

Enabling this parameter will disable Samba\'s support for the SPOOLSS set of MS\-RPC\'s and will yield identical behavior as Samba 2\&.0\&.x\&. Windows NT/2000 clients will downgrade to using Lanman style printing commands\&. Windows 9x/ME will be unaffected by the parameter\&. However, this will also disable the ability to upload printer drivers to a Samba server via the Windows NT Add Printer Wizard or by using the NT printer properties dialog window\&. It will also disable the capability of Windows NT/2000 clients to download print drivers from the Samba host upon demand\&.

2857

\fIBe very careful about enabling this parameter\&.\fR

2858

.sp

2859

Default:

2860

\fI\fIdisable spoolss\fR\fR\fI = \fR\fIno\fR\fI \fR

2861

.RE

2862

2863

display charset (G)

2864

.\" display charset

2865

.PP

2866

.RS 4

2867

Specifies the charset that samba will use to print messages to stdout and stderr\&. The default value is "LOCALE", which means automatically set, depending on the current locale\&. The value should generally be the same as the value of the parameter

2868

\m[blue]\fBunix charset\fR\m[]\&.

2869

.sp

2870

Default:

2871

\fI\fIdisplay charset\fR\fR\fI = \fR\fI"LOCALE" or "ASCII" (depending on the system)\fR\fI \fR

2872

.sp

2873

Example:

2874

\fI\fIdisplay charset\fR\fR\fI = \fR\fIUTF8\fR\fI \fR

2875

.RE

2876

2877

dmapi support (S)

2878

.\" dmapi support

2879

.PP

2880

.RS 4

2881

This parameter specifies whether Samba should use DMAPI to determine whether a file is offline or not\&. This would typically be used in conjunction with a hierarchical storage system that automatically migrates files to tape\&.

2882

.sp

2883

Note that Samba infers the status of a file by examining the events that a DMAPI application has registered interest in\&. This heuristic is satisfactory for a number of hierarchical storage systems, but there may be system for which it will fail\&. In this case, Samba may erroneously report files to be offline\&.

2884

.sp

2885

This parameter is only available if a supported DMAPI implementation was found at compilation time\&. It will only be used if DMAPI is found to enabled on the system at run time\&.

2886

.sp

2887

Default:

2888

\fI\fIdmapi support\fR\fR\fI = \fR\fIno\fR\fI \fR

2889

.RE

2890

2891

dns proxy (G)

2892

.\" dns proxy

2893

.PP

2894

.RS 4

2895

Specifies that

2896

\fBnmbd\fR(8)

2897

when acting as a WINS server and finding that a NetBIOS name has not been registered, should treat the NetBIOS name word\-for\-word as a DNS name and do a lookup with the DNS server for that name on behalf of the name\-querying client\&.

2898

.sp

2899

Note that the maximum length for a NetBIOS name is 15 characters, so the DNS name (or DNS alias) can likewise only be 15 characters, maximum\&.

2900

.sp

2901

nmbd

2902

spawns a second copy of itself to do the DNS name lookup requests, as doing a name lookup is a blocking action\&.

2903

.sp

2904

Default:

2905

\fI\fIdns proxy\fR\fR\fI = \fR\fIyes\fR\fI \fR

2906

.RE

2907

2908

domain logons (G)

2909

.\" domain logons

2910

.PP

2911

.RS 4

2912

If set to

2913

\fByes\fR, the Samba server will provide the netlogon service for Windows 9X network logons for the

2914

\m[blue]\fBworkgroup\fR\m[]

2915

it is in\&. This will also cause the Samba server to act as a domain controller for NT4 style domain services\&. For more details on setting up this feature see the Domain Control chapter of the Samba HOWTO Collection\&.

2916

.sp

2917

Default:

2918

\fI\fIdomain logons\fR\fR\fI = \fR\fIno\fR\fI \fR

2919

.RE

2920

2921

domain master (G)

2922

.\" domain master

2923

.PP

2924

.RS 4

2925

Tell

2926

\fBsmbd\fR(8)

2927

to enable WAN\-wide browse list collation\&. Setting this option causes

2928

nmbd

2929

to claim a special domain specific NetBIOS name that identifies it as a domain master browser for its given

2930

\m[blue]\fBworkgroup\fR\m[]\&. Local master browsers in the same

2931

\m[blue]\fBworkgroup\fR\m[]

2932

on broadcast\-isolated subnets will give this

2933

nmbd

2934

their local browse lists, and then ask

2935

\fBsmbd\fR(8)

2936

for a complete copy of the browse list for the whole wide area network\&. Browser clients will then contact their local master browser, and will receive the domain\-wide browse list, instead of just the list for their broadcast\-isolated subnet\&.

2937

.sp

2938

Note that Windows NT Primary Domain Controllers expect to be able to claim this

2939

\m[blue]\fBworkgroup\fR\m[]

2940

specific special NetBIOS name that identifies them as domain master browsers for that

2941

\m[blue]\fBworkgroup\fR\m[]

2942

by default (i\&.e\&. there is no way to prevent a Windows NT PDC from attempting to do this)\&. This means that if this parameter is set and

2943

nmbd

2944

claims the special name for a

2945

\m[blue]\fBworkgroup\fR\m[]

2946

before a Windows NT PDC is able to do so then cross subnet browsing will behave strangely and may fail\&.

2947

.sp

2948

2949

\m[blue]\fBdomain logons = yes\fR\m[], then the default behavior is to enable the

2950

\m[blue]\fBdomain master\fR\m[]

2951

parameter\&. If

2952

\m[blue]\fBdomain logons\fR\m[]

2953

is not enabled (the default setting), then neither will

2954

\m[blue]\fBdomain master\fR\m[]

2955

be enabled by default\&.

2956

.sp

2957

When

2958

\m[blue]\fBdomain logons = Yes\fR\m[]

2959

the default setting for this parameter is Yes, with the result that Samba will be a PDC\&. If

2960

\m[blue]\fBdomain master = No\fR\m[], Samba will function as a BDC\&. In general, this parameter should be set to \'No\' only on a BDC\&.

2961

.sp

2962

Default:

2963

\fI\fIdomain master\fR\fR\fI = \fR\fIauto\fR\fI \fR

2964

.RE

2965

2966

dont descend (S)

2967

.\" dont descend

2968

.PP

2969

.RS 4

2970

There are certain directories on some systems (e\&.g\&., the

2971

/proc

2972

tree under Linux) that are either not of interest to clients or are infinitely deep (recursive)\&. This parameter allows you to specify a comma\-delimited list of directories that the server should always show as empty\&.

2973

.sp

2974

Note that Samba can be very fussy about the exact format of the "dont descend" entries\&. For example you may need

2975

\&./proc

2976

instead of just

2977

/proc\&. Experimentation is the best policy :\-)

2978

.sp

2979

Default:

2980

\fI\fIdont descend\fR\fR\fI = \fR\fI\fR\fI \fR

2981

.sp

2982

Example:

2983

\fI\fIdont descend\fR\fR\fI = \fR\fI/proc,/dev\fR\fI \fR

2984

.RE

2985

2986

dos charset (G)

2987

.\" dos charset

2988

.PP

2989

.RS 4

2990

DOS SMB clients assume the server has the same charset as they do\&. This option specifies which charset Samba should talk to DOS clients\&.

2991

.sp

2992

The default depends on which charsets you have installed\&. Samba tries to use charset 850 but falls back to ASCII in case it is not available\&. Run

2993

\fBtestparm\fR(1)

2994

to check the default on your system\&.

2995

.sp

2996

\fINo default\fR

2997

.RE

2998

2999

dos filemode (S)

3000

.\" dos filemode

3001

.PP

3002

.RS 4

3003

The default behavior in Samba is to provide UNIX\-like behavior where only the owner of a file/directory is able to change the permissions on it\&. However, this behavior is often confusing to DOS/Windows users\&. Enabling this parameter allows a user who has write access to the file (by whatever means, including an ACL permission) to modify the permissions (including ACL) on it\&. Note that a user belonging to the group owning the file will not be allowed to change permissions if the group is only granted read access\&. Ownership of the file/directory may also be changed\&. Note that using the VFS modules acl_xattr or acl_tdb which store native Windows as meta\-data will automatically turn this option on for any share for which they are loaded, as they require this option to emulate Windows ACLs correctly\&.

3004

.sp

3005

Default:

3006

\fI\fIdos filemode\fR\fR\fI = \fR\fIno\fR\fI \fR

3007

.RE

3008

3009

dos filetime resolution (S)

3010

.\" dos filetime resolution

3011

.PP

3012

.RS 4

3013

Under the DOS and Windows FAT filesystem, the finest granularity on time resolution is two seconds\&. Setting this parameter for a share causes Samba to round the reported time down to the nearest two second boundary when a query call that requires one second resolution is made to

3014

\fBsmbd\fR(8)\&.

3015

.sp

3016

This option is mainly used as a compatibility option for Visual C++ when used against Samba shares\&. If oplocks are enabled on a share, Visual C++ uses two different time reading calls to check if a file has changed since it was last read\&. One of these calls uses a one\-second granularity, the other uses a two second granularity\&. As the two second call rounds any odd second down, then if the file has a timestamp of an odd number of seconds then the two timestamps will not match and Visual C++ will keep reporting the file has changed\&. Setting this option causes the two timestamps to match, and Visual C++ is happy\&.

3017

.sp

3018

Default:

3019

\fI\fIdos filetime resolution\fR\fR\fI = \fR\fIno\fR\fI \fR

3020

.RE

3021

3022

dos filetimes (S)

3023

.\" dos filetimes

3024

.PP

3025

.RS 4

3026

Under DOS and Windows, if a user can write to a file they can change the timestamp on it\&. Under POSIX semantics, only the owner of the file or root may change the timestamp\&. By default, Samba emulates the DOS semantics and allows to change the timestamp on a file if the user

3027

smbd

3028

is acting on behalf has write permissions\&. Due to changes in Microsoft Office 2000 and beyond, the default for this parameter has been changed from "no" to "yes" in Samba 3\&.0\&.14 and above\&. Microsoft Excel will display dialog box warnings about the file being changed by another user if this parameter is not set to "yes" and files are being shared between users\&.

3029

.sp

3030

Default:

3031

\fI\fIdos filetimes\fR\fR\fI = \fR\fIyes\fR\fI \fR

3032

.RE

3033

3034

ea support (S)

3035

.\" ea support

3036

.PP

3037

.RS 4

3038

This boolean parameter controls whether

3039

\fBsmbd\fR(8)

3040

will allow clients to attempt to store OS/2 style Extended attributes on a share\&. In order to enable this parameter the underlying filesystem exported by the share must support extended attributes (such as provided on XFS and EXT3 on Linux, with the correct kernel patches)\&. On Linux the filesystem must have been mounted with the mount option user_xattr in order for extended attributes to work, also extended attributes must be compiled into the Linux kernel\&.

3041

.sp

3042

Default:

3043

\fI\fIea support\fR\fR\fI = \fR\fIno\fR\fI \fR

3044

.RE

3045

3046

enable asu support (G)

3047

.\" enable asu support

3048

.PP

3049

.RS 4

3050

Hosts running the "Advanced Server for Unix (ASU)" product require some special accomodations such as creating a builtin [ADMIN$] share that only supports IPC connections\&. The has been the default behavior in smbd for many years\&. However, certain Microsoft applications such as the Print Migrator tool require that the remote server support an [ADMIN$} file share\&. Disabling this parameter allows for creating an [ADMIN$] file share in smb\&.conf\&.

3051

.sp

3052

Default:

3053

\fI\fIenable asu support\fR\fR\fI = \fR\fIno\fR\fI \fR

3054

.RE

3055

3056

enable core files (G)

3057

.\" enable core files

3058

.PP

3059

.RS 4

3060

This parameter specifies whether core dumps should be written on internal exits\&. Normally set to

3061

\fByes\fR\&. You should never need to change this\&.

3062

.sp

3063

Default:

3064

\fI\fIenable core files\fR\fR\fI = \fR\fIyes\fR\fI \fR

3065

.sp

3066

Example:

3067

\fI\fIenable core files\fR\fR\fI = \fR\fIno\fR\fI \fR

3068

.RE

3069

3070

enable privileges (G)

3071

.\" enable privileges

3072

.PP

3073

.RS 4

3074

This deprecated parameter controls whether or not smbd will honor privileges assigned to specific SIDs via either

3075

net rpc rights

3076

or one of the Windows user and group manager tools\&. This parameter is enabled by default\&. It can be disabled to prevent members of the Domain Admins group from being able to assign privileges to users or groups which can then result in certain smbd operations running as root that would normally run under the context of the connected user\&.

3077

.sp

3078

An example of how privileges can be used is to assign the right to join clients to a Samba controlled domain without providing root access to the server via smbd\&.

3079

.sp

3080

Please read the extended description provided in the Samba HOWTO documentation\&.

3081

.sp

3082

Default:

3083

\fI\fIenable privileges\fR\fR\fI = \fR\fIyes\fR\fI \fR

3084

.RE

3085

3086

enable spoolss (G)

3087

.\" enable spoolss

3088

.PP

3089

.RS 4

3090

Inverted synonym for

3091

\m[blue]\fBdisable spoolss\fR\m[]\&.

3092

.sp

3093

Default:

3094

\fI\fIenable spoolss\fR\fR\fI = \fR\fIyes\fR\fI \fR

3095

.RE

3096

3097

encrypt passwords (G)

3098

.\" encrypt passwords

3099

.PP

3100

.RS 4

3101

This boolean controls whether encrypted passwords will be negotiated with the client\&. Note that Windows NT 4\&.0 SP3 and above and also Windows 98 will by default expect encrypted passwords unless a registry entry is changed\&. To use encrypted passwords in Samba see the chapter "User Database" in the Samba HOWTO Collection\&.

3102

.sp

3103

MS Windows clients that expect Microsoft encrypted passwords and that do not have plain text password support enabled will be able to connect only to a Samba server that has encrypted password support enabled and for which the user accounts have a valid encrypted password\&. Refer to the smbpasswd command man page for information regarding the creation of encrypted passwords for user accounts\&.

3104

.sp

3105

The use of plain text passwords is NOT advised as support for this feature is no longer maintained in Microsoft Windows products\&. If you want to use plain text passwords you must set this parameter to no\&.

3106

.sp

3107

In order for encrypted passwords to work correctly

3108

\fBsmbd\fR(8)

3109

must either have access to a local

3110

\fBsmbpasswd\fR(5)

3111

file (see the

3112

\fBsmbpasswd\fR(8)

3113

program for information on how to set up and maintain this file), or set the

3114

\m[blue]\fBsecurity = [server|domain|ads]\fR\m[]

3115

parameter which causes

3116

smbd

3117

to authenticate against another server\&.

3118

.sp

3119

Default:

3120

\fI\fIencrypt passwords\fR\fR\fI = \fR\fIyes\fR\fI \fR

3121

.RE

3122

3123

enhanced browsing (G)

3124

.\" enhanced browsing

3125

.PP

3126

.RS 4

3127

This option enables a couple of enhancements to cross\-subnet browse propagation that have been added in Samba but which are not standard in Microsoft implementations\&.

3128

.sp

3129

The first enhancement to browse propagation consists of a regular wildcard query to a Samba WINS server for all Domain Master Browsers, followed by a browse synchronization with each of the returned DMBs\&. The second enhancement consists of a regular randomised browse synchronization with all currently known DMBs\&.

3130

.sp

3131

You may wish to disable this option if you have a problem with empty workgroups not disappearing from browse lists\&. Due to the restrictions of the browse protocols, these enhancements can cause a empty workgroup to stay around forever which can be annoying\&.

3132

.sp

3133

In general you should leave this option enabled as it makes cross\-subnet browse propagation much more reliable\&.

3134

.sp

3135

Default:

3136

\fI\fIenhanced browsing\fR\fR\fI = \fR\fIyes\fR\fI \fR

3137

.RE

3138

3139

enumports command (G)

3140

.\" enumports command

3141

.PP

3142

.RS 4

3143

The concept of a "port" is fairly foreign to UNIX hosts\&. Under Windows NT/2000 print servers, a port is associated with a port monitor and generally takes the form of a local port (i\&.e\&. LPT1:, COM1:, FILE:) or a remote port (i\&.e\&. LPD Port Monitor, etc\&.\&.\&.)\&. By default, Samba has only one port defined\-\-\fB"Samba Printer Port"\fR\&. Under Windows NT/2000, all printers must have a valid port name\&. If you wish to have a list of ports displayed (smbd

3144

does not use a port name for anything) other than the default

3145

\fB"Samba Printer Port"\fR, you can define

3146

\fIenumports command\fR

3147

to point to a program which should generate a list of ports, one per line, to standard output\&. This listing will then be used in response to the level 1 and 2 EnumPorts() RPC\&.

3148

.sp

3149

Default:

3150

\fI\fIenumports command\fR\fR\fI = \fR\fI\fR\fI \fR

3151

.sp

3152

Example:

3153

\fI\fIenumports command\fR\fR\fI = \fR\fI/usr/bin/listports\fR\fI \fR

3154

.RE

3155

3156

eventlog list (G)

3157

.\" eventlog list

3158

.PP

3159

.RS 4

3160

This option defines a list of log names that Samba will report to the Microsoft EventViewer utility\&. The listed eventlogs will be associated with tdb file on disk in the

3161

$(lockdir)/eventlog\&.

3162

.sp

3163

The administrator must use an external process to parse the normal Unix logs such as

3164

/var/log/messages

3165

and write then entries to the eventlog tdb files\&. Refer to the eventlogadm(8) utility for how to write eventlog entries\&.

3166

.sp

3167

Default:

3168

\fI\fIeventlog list\fR\fR\fI = \fR\fI\fR\fI \fR

3169

.sp

3170

Example:

3171

\fI\fIeventlog list\fR\fR\fI = \fR\fISecurity Application Syslog Apache\fR\fI \fR

3172

.RE

3173

3174

fake directory create times (S)

3175

.\" fake directory create times

3176

.PP

3177

.RS 4

3178

NTFS and Windows VFAT file systems keep a create time for all files and directories\&. This is not the same as the ctime \- status change time \- that Unix keeps, so Samba by default reports the earliest of the various times Unix does keep\&. Setting this parameter for a share causes Samba to always report midnight 1\-1\-1980 as the create time for directories\&.

3179

.sp

3180

This option is mainly used as a compatibility option for Visual C++ when used against Samba shares\&. Visual C++ generated makefiles have the object directory as a dependency for each object file, and a make rule to create the directory\&. Also, when NMAKE compares timestamps it uses the creation time when examining a directory\&. Thus the object directory will be created if it does not exist, but once it does exist it will always have an earlier timestamp than the object files it contains\&.

3181

.sp

3182

However, Unix time semantics mean that the create time reported by Samba will be updated whenever a file is created or or deleted in the directory\&. NMAKE finds all object files in the object directory\&. The timestamp of the last one built is then compared to the timestamp of the object directory\&. If the directory\'s timestamp if newer, then all object files will be rebuilt\&. Enabling this option ensures directories always predate their contents and an NMAKE build will proceed as expected\&.

3183

.sp

3184

Default:

3185

\fI\fIfake directory create times\fR\fR\fI = \fR\fIno\fR\fI \fR

3186

.RE

3187

3188

fake oplocks (S)

3189

.\" fake oplocks

3190

.PP

3191

.RS 4

3192

Oplocks are the way that SMB clients get permission from a server to locally cache file operations\&. If a server grants an oplock (opportunistic lock) then the client is free to assume that it is the only one accessing the file and it will aggressively cache file data\&. With some oplock types the client may even cache file open/close operations\&. This can give enormous performance benefits\&.

3193

.sp

3194

When you set

3195

fake oplocks = yes,

3196

\fBsmbd\fR(8)

3197

will always grant oplock requests no matter how many clients are using the file\&.

3198

.sp

3199

It is generally much better to use the real

3200

\m[blue]\fBoplocks\fR\m[]

3201

support rather than this parameter\&.

3202

.sp

3203

If you enable this option on all read\-only shares or shares that you know will only be accessed from one client at a time such as physically read\-only media like CDROMs, you will see a big performance improvement on many operations\&. If you enable this option on shares where multiple clients may be accessing the files read\-write at the same time you can get data corruption\&. Use this option carefully!

3204

.sp

3205

Default:

3206

\fI\fIfake oplocks\fR\fR\fI = \fR\fIno\fR\fI \fR

3207

.RE

3208

3209

follow symlinks (S)

3210

.\" follow symlinks

3211

.PP

3212

.RS 4

3213

This parameter allows the Samba administrator to stop

3214

\fBsmbd\fR(8)

3215

from following symbolic links in a particular share\&. Setting this parameter to

3216

\fBno\fR

3217

prevents any file or directory that is a symbolic link from being followed (the user will get an error)\&. This option is very useful to stop users from adding a symbolic link to

3218

/etc/passwd

3219

in their home directory for instance\&. However it will slow filename lookups down slightly\&.

3220

.sp

3221

This option is enabled (i\&.e\&.

3222

smbd

3223

will follow symbolic links) by default\&.

3224

.sp

3225

Default:

3226

\fI\fIfollow symlinks\fR\fR\fI = \fR\fIyes\fR\fI \fR

3227

.RE

3228

3229

force create mode (S)

3230

.\" force create mode

3231

.PP

3232

.RS 4

3233

This parameter specifies a set of UNIX mode bit permissions that will

3234

\fIalways\fR

3235

be set on a file created by Samba\&. This is done by bitwise \'OR\'ing these bits onto the mode bits of a file that is being created\&. The default for this parameter is (in octal) 000\&. The modes in this parameter are bitwise \'OR\'ed onto the file mode after the mask set in the

3236

\fIcreate mask\fR

3237

parameter is applied\&.

3238

.sp

3239

The example below would force all newly created files to have read and execute permissions set for \'group\' and \'other\' as well as the read/write/execute bits set for the \'user\'\&.

3240

.sp

3241

Default:

3242

\fI\fIforce create mode\fR\fR\fI = \fR\fI000\fR\fI \fR

3243

.sp

3244

Example:

3245

\fI\fIforce create mode\fR\fR\fI = \fR\fI0755\fR\fI \fR

3246

.RE

3247

3248

force directory mode (S)

3249

.\" force directory mode

3250

.PP

3251

.RS 4

3252

This parameter specifies a set of UNIX mode bit permissions that will

3253

\fIalways\fR

3254

be set on a directory created by Samba\&. This is done by bitwise \'OR\'ing these bits onto the mode bits of a directory that is being created\&. The default for this parameter is (in octal) 0000 which will not add any extra permission bits to a created directory\&. This operation is done after the mode mask in the parameter

3255

\fIdirectory mask\fR

3256

is applied\&.

3257

.sp

3258

The example below would force all created directories to have read and execute permissions set for \'group\' and \'other\' as well as the read/write/execute bits set for the \'user\'\&.

3259

.sp

3260

Default:

3261

\fI\fIforce directory mode\fR\fR\fI = \fR\fI000\fR\fI \fR

3262

.sp

3263

Example:

3264

\fI\fIforce directory mode\fR\fR\fI = \fR\fI0755\fR\fI \fR

3265

.RE

3266

3267

force directory security mode (S)

3268

.\" force directory security mode

3269

.PP

3270

.RS 4

3271

This parameter controls what UNIX permission bits can be modified when a Windows NT client is manipulating the UNIX permission on a directory using the native NT security dialog box\&.

3272

.sp

3273

This parameter is applied as a mask (OR\'ed with) to the changed permission bits, thus forcing any bits in this mask that the user may have modified to be on\&. Make sure not to mix up this parameter with

3274

\m[blue]\fBdirectory security mask\fR\m[], which works in a similar manner to this one, but uses a logical AND instead of an OR\&.

3275

.sp

3276

Essentially, this mask may be treated as a set of bits that, when modifying security on a directory, to will enable (1) any flags that are off (0) but which the mask has set to on (1)\&.

3277

.sp

3278

If not set explicitly this parameter is 0000, which allows a user to modify all the user/group/world permissions on a directory without restrictions\&.

3279

.if n \{\

3280

.sp

3281

.\}

3282

.RS 4

3283

.it 1 an-trap

3284

.nr an-no-space-flag 1

3285

.nr an-break-flag 1

3286

.br

3287

.ps +1

3288

\fBNote\fR

3289

.ps -1

3290

.br

3291

Users who can access the Samba server through other means can easily bypass this restriction, so it is primarily useful for standalone "appliance" systems\&. Administrators of most normal systems will probably want to leave it set as 0000\&.

3292

.sp .5v

3293

.RE

3294

Default:

3295

\fI\fIforce directory security mode\fR\fR\fI = \fR\fI0\fR\fI \fR

3296

.sp

3297

Example:

3298

\fI\fIforce directory security mode\fR\fR\fI = \fR\fI700\fR\fI \fR

3299

.RE

3300

3301

group

3302

.\" group

3303

.PP

3304

.RS 4

3305

This parameter is a synonym for

3306

force group\&.

3307

.RE

3308

3309

force group (S)

3310

.\" force group

3311

.PP

3312

.RS 4

3313

This specifies a UNIX group name that will be assigned as the default primary group for all users connecting to this service\&. This is useful for sharing files by ensuring that all access to files on service will use the named group for their permissions checking\&. Thus, by assigning permissions for this group to the files and directories within this service the Samba administrator can restrict or allow sharing of these files\&.

3314

.sp

3315

In Samba 2\&.0\&.5 and above this parameter has extended functionality in the following way\&. If the group name listed here has a \'+\' character prepended to it then the current user accessing the share only has the primary group default assigned to this group if they are already assigned as a member of that group\&. This allows an administrator to decide that only users who are already in a particular group will create files with group ownership set to that group\&. This gives a finer granularity of ownership assignment\&. For example, the setting

3316

force group = +sys

3317

means that only users who are already in group sys will have their default primary group assigned to sys when accessing this Samba share\&. All other users will retain their ordinary primary group\&.

3318

.sp

3319

If the

3320

\m[blue]\fBforce user\fR\m[]

3321

parameter is also set the group specified in

3322

\fIforce group\fR

3323

will override the primary group set in

3324

\fIforce user\fR\&.

3325

.sp

3326

Default:

3327

\fI\fIforce group\fR\fR\fI = \fR\fI\fR\fI \fR

3328

.sp

3329

Example:

3330

\fI\fIforce group\fR\fR\fI = \fR\fIagroup\fR\fI \fR

3331

.RE

3332

3333

force printername (S)

3334

.\" force printername

3335

.PP

3336

.RS 4

3337

When printing from Windows NT (or later), each printer in

3338

smb\&.conf

3339

has two associated names which can be used by the client\&. The first is the sharename (or shortname) defined in smb\&.conf\&. This is the only printername available for use by Windows 9x clients\&. The second name associated with a printer can be seen when browsing to the "Printers" (or "Printers and Faxes") folder on the Samba server\&. This is referred to simply as the printername (not to be confused with the

3340

\fIprinter name\fR

3341

option)\&.

3342

.sp

3343

When assigning a new driver to a printer on a remote Windows compatible print server such as Samba, the Windows client will rename the printer to match the driver name just uploaded\&. This can result in confusion for users when multiple printers are bound to the same driver\&. To prevent Samba from allowing the printer\'s printername to differ from the sharename defined in smb\&.conf, set

3344

\fIforce printername = yes\fR\&.

3345

.sp

3346

Be aware that enabling this parameter may affect migrating printers from a Windows server to Samba since Windows has no way to force the sharename and printername to match\&.

3347

.sp

3348

It is recommended that this parameter\'s value not be changed once the printer is in use by clients as this could cause a user not be able to delete printer connections from their local Printers folder\&.

3349

.sp

3350

Default:

3351

\fI\fIforce printername\fR\fR\fI = \fR\fIno\fR\fI \fR

3352

.RE

3353

3354

force security mode (S)

3355

.\" force security mode

3356

.PP

3357

.RS 4

3358

This parameter controls what UNIX permission bits can be modified when a Windows NT client is manipulating the UNIX permission on a file using the native NT security dialog box\&.

3359

.sp

3360

3361

\m[blue]\fBsecurity mask\fR\m[], which works similar like this one but uses logical AND instead of OR\&.

3362

.sp

3363

Essentially, one bits in this mask may be treated as a set of bits that, when modifying security on a file, the user has always set to be on\&.

3364

.sp

3365

If not set explicitly this parameter is set to 0, and allows a user to modify all the user/group/world permissions on a file, with no restrictions\&.

3366

.sp

3367

\fI Note\fR

3368

3369

.sp

3370

Default:

3371

\fI\fIforce security mode\fR\fR\fI = \fR\fI0\fR\fI \fR

3372

.sp

3373

Example:

3374

\fI\fIforce security mode\fR\fR\fI = \fR\fI700\fR\fI \fR

3375

.RE

3376

3377

force unknown acl user (S)

3378

.\" force unknown acl user

3379

.PP

3380

.RS 4

3381

If this parameter is set, a Windows NT ACL that contains an unknown SID (security descriptor, or representation of a user or group id) as the owner or group owner of the file will be silently mapped into the current UNIX uid or gid of the currently connected user\&.

3382

.sp

3383

This is designed to allow Windows NT clients to copy files and folders containing ACLs that were created locally on the client machine and contain users local to that machine only (no domain users) to be copied to a Samba server (usually with XCOPY /O) and have the unknown userid and groupid of the file owner map to the current connected user\&. This can only be fixed correctly when winbindd allows arbitrary mapping from any Windows NT SID to a UNIX uid or gid\&.

3384

.sp

3385

Try using this parameter when XCOPY /O gives an ACCESS_DENIED error\&.

3386

.sp

3387

Default:

3388

\fI\fIforce unknown acl user\fR\fR\fI = \fR\fIno\fR\fI \fR

3389

.RE

3390

3391

force user (S)

3392

.\" force user

3393

.PP

3394

.RS 4

3395

This specifies a UNIX user name that will be assigned as the default user for all users connecting to this service\&. This is useful for sharing files\&. You should also use it carefully as using it incorrectly can cause security problems\&.

3396

.sp

3397

This user name only gets used once a connection is established\&. Thus clients still need to connect as a valid user and supply a valid password\&. Once connected, all file operations will be performed as the "forced user", no matter what username the client connected as\&. This can be very useful\&.

3398

.sp

3399

In Samba 2\&.0\&.5 and above this parameter also causes the primary group of the forced user to be used as the primary group for all file activity\&. Prior to 2\&.0\&.5 the primary group was left as the primary group of the connecting user (this was a bug)\&.

3400

.sp

3401

Default:

3402

\fI\fIforce user\fR\fR\fI = \fR\fI\fR\fI \fR

3403

.sp

3404

Example:

3405

\fI\fIforce user\fR\fR\fI = \fR\fIauser\fR\fI \fR

3406

.RE

3407

3408

fstype (S)

3409

.\" fstype

3410

.PP

3411

.RS 4

3412

This parameter allows the administrator to configure the string that specifies the type of filesystem a share is using that is reported by

3413

\fBsmbd\fR(8)

3414

when a client queries the filesystem type for a share\&. The default type is

3415

\fBNTFS\fR

3416

for compatibility with Windows NT but this can be changed to other strings such as

3417

\fBSamba\fR

3418

3419

\fBFAT\fR

3420

if required\&.

3421

.sp

3422

Default:

3423

\fI\fIfstype\fR\fR\fI = \fR\fINTFS\fR\fI \fR

3424

.sp

3425

Example:

3426

\fI\fIfstype\fR\fR\fI = \fR\fISamba\fR\fI \fR

3427

.RE

3428

3429

get quota command (G)

3430

.\" get quota command

3431

.PP

3432

.RS 4

3433

The

3434

get quota command

3435

should only be used whenever there is no operating system API available from the OS that samba can use\&.

3436

.sp

3437

This option is only available you have compiled Samba with the

3438

\-\-with\-sys\-quotas

3439

option or on Linux with

3440

\-\-with\-quotas

3441

and a working quota api was found in the system\&.

3442

.sp

3443

This parameter should specify the path to a script that queries the quota information for the specified user/group for the partition that the specified directory is on\&.

3444

.sp

3445

Such a script should take 3 arguments:

3446

.sp

3447

.RS 4

3448

.ie n \{\

3449

\h'-04'\(bu\h'+03'\c

3450

.\}

3451

.el \{\

3452

.sp -1

3453

.IP \(bu 2.3

3454

.\}

3455

See also the

3845

\m[blue]\fBmsdfs root\fR\m[]

3846

share level parameter\&. For more information on setting up a Dfs tree on Samba, refer to the MSFDS chapter in the book Samba3\-HOWTO\&.

3847

.sp

3848

Default:

3849

\fI\fIhost msdfs\fR\fR\fI = \fR\fIyes\fR\fI \fR

3850

.RE

3851

3852

hostname lookups (G)

3853

.\" hostname lookups

3854

.PP

3855

.RS 4

3856

Specifies whether samba should use (expensive) hostname lookups or use the ip addresses instead\&. An example place where hostname lookups are currently used is when checking the

3857

hosts deny

3858

and

3859

hosts allow\&.

3860

.sp

3861

Default:

3862

\fI\fIhostname lookups\fR\fR\fI = \fR\fIno\fR\fI \fR

3863

.sp

3864

Example:

3865

\fI\fIhostname lookups\fR\fR\fI = \fR\fIyes\fR\fI \fR

3866

.RE

3867

3868

allow hosts

3869

.\" allow hosts

3870

.PP

3871

.RS 4

3872

This parameter is a synonym for

3873

hosts allow\&.

3874

.RE

3875

3876

hosts allow (S)

3877

.\" hosts allow

3878

.PP

3879

.RS 4

3880

A synonym for this parameter is

3881

\m[blue]\fBallow hosts\fR\m[]\&.

3882

.sp

3883

This parameter is a comma, space, or tab delimited set of hosts which are permitted to access a service\&.

3884

.sp

3885

If specified in the [global] section then it will apply to all services, regardless of whether the individual service has a different setting\&.

3886

.sp

3887

You can specify the hosts by name or IP number\&. For example, you could restrict access to only the hosts on a Class C subnet with something like

3888

allow hosts = 150\&.203\&.5\&.\&. The full syntax of the list is described in the man page

3889

hosts_access(5)\&. Note that this man page may not be present on your system, so a brief description will be given here also\&.

3890

.sp

3891

Note that the localhost address 127\&.0\&.0\&.1 will always be allowed access unless specifically denied by a

3892

\m[blue]\fBhosts deny\fR\m[]

3893

option\&.

3894

.sp

3895

You can also specify hosts by network/netmask pairs and by netgroup names if your system supports netgroups\&. The

3896

\fIEXCEPT\fR

3897

keyword can also be used to limit a wildcard list\&. The following examples may provide some help:

3898

.sp

3899

Example 1: allow all IPs in 150\&.203\&.*\&.*; except one

3900

.sp

3901

hosts allow = 150\&.203\&. EXCEPT 150\&.203\&.6\&.66

3902

.sp

3903

Example 2: allow hosts that match the given network/netmask

3904

.sp

3905

hosts allow = 150\&.203\&.15\&.0/255\&.255\&.255\&.0

3906

.sp

3907

Example 3: allow a couple of hosts

3908

.sp

3909

hosts allow = lapland, arvidsjaur

3910

.sp

3911

Example 4: allow only hosts in NIS netgroup "foonet", but deny access from one particular host

3912

.sp

3913

hosts allow = @foonet

3914

.sp

3915

hosts deny = pirate

3916

.if n \{\

3917

.sp

3918

.\}

3919

.RS 4

3920

.it 1 an-trap

3921

.nr an-no-space-flag 1

3922

.nr an-break-flag 1

3923

.br

3924

.ps +1

3925

\fBNote\fR

3926

.ps -1

3927

.br

3928

Note that access still requires suitable user\-level passwords\&.

3929

.sp .5v

3930

.RE

3931

See

3932

\fBtestparm\fR(1)

3933

for a way of testing your host access to see if it does what you expect\&.

3934

.sp

3935

Default:

3936

\fI\fIhosts allow\fR\fR\fI = \fR\fI # none (i\&.e\&., all hosts permitted access)\fR\fI \fR

3937

.sp

3938

Example:

3939

\fI\fIhosts allow\fR\fR\fI = \fR\fI150\&.203\&.5\&. myhost\&.mynet\&.edu\&.au\fR\fI \fR

3940

.RE

3941

3942

deny hosts

3943

.\" deny hosts

3944

.PP

3945

.RS 4

3946

This parameter is a synonym for

3947

hosts deny\&.

3948

.RE

3949

3950

hosts deny (S)

3951

.\" hosts deny

3952

.PP

3953

.RS 4

3954

The opposite of

3955

\fIhosts allow\fR

3956

\- hosts listed here are

3957

\fINOT\fR

3958

permitted access to services unless the specific services have their own lists to override this one\&. Where the lists conflict, the

3959

\fIallow\fR

3960

list takes precedence\&.

3961

.sp

3962

In the event that it is necessary to deny all by default, use the keyword ALL (or the netmask

3963

0\&.0\&.0\&.0/0) and then explicitly specify to the

3964

\m[blue]\fBhosts allow = hosts allow\fR\m[]

3965

parameter those hosts that should be permitted access\&.

3966

.sp

3967

Default:

3968

\fI\fIhosts deny\fR\fR\fI = \fR\fI # none (i\&.e\&., no hosts specifically excluded)\fR\fI \fR

3969

.sp

3970

Example:

3971

\fI\fIhosts deny\fR\fR\fI = \fR\fI150\&.203\&.4\&. badhost\&.mynet\&.edu\&.au\fR\fI \fR

3972

.RE

3973

3974

idmap backend (G)

3975

.\" idmap backend

3976

.PP

3977

.RS 4

3978

The idmap backend provides a plugin interface for Winbind to use varying backends to store SID/uid/gid mapping tables\&.

3979

.sp

3980

This option specifies the default backend that is used when no special configuration set, but it is now deprecated in favour of the new spelling

3981

\m[blue]\fBidmap config * : backend\fR\m[]\&.

3982

.sp

3983

Default:

3984

\fI\fIidmap backend\fR\fR\fI = \fR\fItdb\fR\fI \fR

3985

.RE

3986

3987

idmap cache time (G)

3988

.\" idmap cache time

3989

.PP

3990

.RS 4

3991

This parameter specifies the number of seconds that Winbind\'s idmap interface will cache positive SID/uid/gid query results\&.

3992

.sp

3993

Default:

3994

\fI\fIidmap cache time\fR\fR\fI = \fR\fI604800 (one week)\fR\fI \fR

3995

.RE

3996

3997

idmap config (G)

3998

.\" idmap config

3999

.PP

4000

.RS 4

4001

ID mapping in Samba is the mapping between Windows SIDs and Unix user and group IDs\&. This is performed by Winbindd with a configurable plugin interface\&. Samba\'s ID mapping is configured by options starting with the

4002

\m[blue]\fBidmap config\fR\m[]

4003

prefix\&. An idmap option consists of the

4004

\m[blue]\fBidmap config\fR\m[]

4005

prefix, followed by a domain name or the asterisk character (*), a colon, and the name of an idmap setting for the chosen domain\&.

4006

.sp

4007

The idmap configuration is hence divided into groups, one group for each domain to be configured, and one group with the the asterisk instead of a proper domain name, which speifies the default configuration that is used to catch all domains that do not have an explicit idmap configuration of their own\&.

4008

.sp

4009

There are three general options available:

4010

.PP

4011

backend = backend_name

4012

.RS 4

4013

This specifies the name of the idmap plugin to use as the SID/uid/gid backend for this domain\&. The standard backends are tdb (\fBidmap_tdb\fR(8)), tdb2 (\fBidmap_tdb2\fR(8)), ldap (\fBidmap_ldap\fR(8)), , rid (\fBidmap_rid\fR(8)), , hash (\fBidmap_hash\fR(8)), , autorid (\fBidmap_autorid\fR(8)), , ad (\fBidmap_ad\fR(8)), , adex (\fBidmap_adex\fR(8)), , and nss\&. (\fBidmap_nss\fR(8)), The corresponding manual pages contain the details, but here is a summary\&.

4014

.sp

4015

The first three of these create mappings of their own using internal unixid counters and store the mappings in a database\&. These are suitable for use in the default idmap configuration\&. The rid and hash backends use a pure algorithmic calculation to determine the unixid for a SID\&. The autorid module is a mixture of the tdb and rid backend\&. It creates ranges for each domain encountered and then uses the rid algorithm for each of these automatically configured domains individually\&. The ad and adex backends both use unix IDs stored in Active Directory via the standard schema extensions\&. The nss backend reverses the standard winbindd setup and gets the unixids via names from nsswitch which can be useful in an ldap setup\&.

4016

.RE

4017

.PP

4018

range = low \- high

4019

.RS 4

4020

Defines the available matching uid and gid range for which the backend is authoritative\&. For allocating backends, this also defines the start and the end of the range for allocating new unid IDs\&.

4021

.sp

4022

winbind uses this parameter to find the backend that is authoritative for a unix ID to SID mapping, so it must be set for each individually configured domain and for the default configuration\&. The configured ranges must be mutually disjoint\&.

4023

.RE

4024

.PP

4025

read only = yes|no

4026

.RS 4

4027

This option can be used to turn the writing backends tdb, tdb2, and ldap into read only mode\&. This can be useful e\&.g\&. in cases where a pre\-filled database exists that should not be extended automatically\&.

4028

.RE

4029

.sp

4030

The following example illustrates how to configure the

4031

\fBidmap_ad\fR(8)

4032

backend for the CORP domain and the

4033

\fBidmap_tdb\fR(8)

4034

backend for all other domains\&. This configuration assumes that the admin of CORP assigns unix ids below 1000000 via the SFU extensions, and winbind is supposed to use the next million entries for its own mappings from trusted domains and for local groups for example\&.

4035

.sp

4036

.if n \{\

4037

.RS 4

4038

.\}

4039

.nf

4040

idmap config * : backend = tdb

4041

idmap config * : range = 1000000\-1999999

4042

4043

idmap config CORP : backend = ad

4044

idmap config CORP : range = 1000\-999999

4045

4046

.fi

4047

.if n \{\

4048

.RE

4049

.\}

4050

.sp

4051

\fINo default\fR

4052

.RE

4053

4054

winbind gid

4055

.\" winbind gid

4056

.PP

4057

.RS 4

4058

This parameter is a synonym for

4059

idmap gid\&.

4060

.RE

4061

4062

idmap gid (G)

4063

.\" idmap gid

4064

.PP

4065

.RS 4

4066

The idmap gid parameter specifies the range of group ids for the default idmap configuration\&. It is now deprecated in favour of

4067

\m[blue]\fBidmap config * : range\fR\m[]\&.

4068

.sp

4069

See the

4070

\m[blue]\fBidmap config\fR\m[]

4071

option\&.

4072

.sp

4073

Default:

4074

\fI\fIidmap gid\fR\fR\fI = \fR\fI\fR\fI \fR

4075

.sp

4076

Example:

4077

\fI\fIidmap gid\fR\fR\fI = \fR\fI10000\-20000\fR\fI \fR

4078

.RE

4079

4080

idmap negative cache time (G)

4081

.\" idmap negative cache time

4082

.PP

4083

.RS 4

4084

This parameter specifies the number of seconds that Winbind\'s idmap interface will cache negative SID/uid/gid query results\&.

4085

.sp

4086

Default:

4087

\fI\fIidmap negative cache time\fR\fR\fI = \fR\fI120\fR\fI \fR

4088

.RE

4089

4090

winbind uid

4091

.\" winbind uid

4092

.PP

4093

.RS 4

4094

This parameter is a synonym for

4095

idmap uid\&.

4096

.RE

4097

4098

idmap uid (G)

4099

.\" idmap uid

4100

.PP

4101

.RS 4

4102

The idmap uid parameter specifies the range of user ids for the default idmap configuration\&. It is now deprecated in favour of

4103

\m[blue]\fBidmap config * : range\fR\m[]\&.

4104

.sp

4105

See the

4106

\m[blue]\fBidmap config\fR\m[]

4107

option\&.

4108

.sp

4109

Default:

4110

\fI\fIidmap uid\fR\fR\fI = \fR\fI\fR\fI \fR

4111

.sp

4112

Example:

4113

\fI\fIidmap uid\fR\fR\fI = \fR\fI10000\-20000\fR\fI \fR

4114

.RE

4115

4116

include (G)

4117

.\" include

4118

.PP

4119

.RS 4

4120

This allows you to include one config file inside another\&. The file is included literally, as though typed in place\&.

4121

.sp

4122

It takes the standard substitutions, except

4123

\fI%u\fR,

4124

\fI%P\fR

4125

and

4126

\fI%S\fR\&.

4127

.sp

4128

The parameter

4129

\fIinclude = registry\fR

4130

has a special meaning: It does

4131

\fInot\fR

4132

include a file named

4133

\fIregistry\fR

4134

from the current working directory, but instead reads the global configuration options from the registry\&. See the section on registry\-based configuration for details\&. Note that this option automatically activates registry shares\&.

4135

.sp

4136

Default:

4137

\fI\fIinclude\fR\fR\fI = \fR\fI\fR\fI \fR

4138

.sp

4139

Example:

4140

\fI\fIinclude\fR\fR\fI = \fR\fI/usr/local/samba/lib/admin_smb\&.conf\fR\fI \fR

4141

.RE

4142

4143

inherit acls (S)

4144

.\" inherit acls

4145

.PP

4146

.RS 4

4147

This parameter can be used to ensure that if default acls exist on parent directories, they are always honored when creating a new file or subdirectory in these parent directories\&. The default behavior is to use the unix mode specified when creating the directory\&. Enabling this option sets the unix mode to 0777, thus guaranteeing that default directory acls are propagated\&. Note that using the VFS modules acl_xattr or acl_tdb which store native Windows as meta\-data will automatically turn this option on for any share for which they are loaded, as they require this option to emulate Windows ACLs correctly\&.

4148

.sp

4149

Default:

4150

\fI\fIinherit acls\fR\fR\fI = \fR\fIno\fR\fI \fR

4151

.RE

4152

4153

inherit owner (S)

4154

.\" inherit owner

4155

.PP

4156

.RS 4

4157

The ownership of new files and directories is normally governed by effective uid of the connected user\&. This option allows the Samba administrator to specify that the ownership for new files and directories should be controlled by the ownership of the parent directory\&.

4158

.sp

4159

Common scenarios where this behavior is useful is in implementing drop\-boxes where users can create and edit files but not delete them and to ensure that newly create files in a user\'s roaming profile directory are actually owner by the user\&.

4160

.sp

4161

Default:

4162

\fI\fIinherit owner\fR\fR\fI = \fR\fIno\fR\fI \fR

4163

.RE

4164

4165

inherit permissions (S)

4166

.\" inherit permissions

4167

.PP

4168

.RS 4

4169

The permissions on new files and directories are normally governed by

4170

\m[blue]\fBcreate mask\fR\m[],

4171

\m[blue]\fBdirectory mask\fR\m[],

4172

\m[blue]\fBforce create mode\fR\m[]

4173

and

4174

\m[blue]\fBforce directory mode\fR\m[]

4175

but the boolean inherit permissions parameter overrides this\&.

4176

.sp

4177

New directories inherit the mode of the parent directory, including bits such as setgid\&.

4178

.sp

4179

New files inherit their read/write bits from the parent directory\&. Their execute bits continue to be determined by

4180

\m[blue]\fBmap archive\fR\m[],

4181

\m[blue]\fBmap hidden\fR\m[]

4182

and

4183

\m[blue]\fBmap system\fR\m[]

4184

as usual\&.

4185

.sp

4186

Note that the setuid bit is

4187

\fInever\fR

4188

set via inheritance (the code explicitly prohibits this)\&.

4189

.sp

4190

This can be particularly useful on large systems with many users, perhaps several thousand, to allow a single [homes] share to be used flexibly by each user\&.

4191

.sp

4192

Default:

4193

\fI\fIinherit permissions\fR\fR\fI = \fR\fIno\fR\fI \fR

4194

.RE

4195

4196

init logon delayed hosts (G)

4197

.\" init logon delayed hosts

4198

.PP

4199

.RS 4

4200

This parameter takes a list of host names, addresses or networks for which the initial samlogon reply should be delayed (so other DCs get preferred by XP workstations if there are any)\&.

4201

.sp

4202

The length of the delay can be specified with the

4203

\m[blue]\fBinit logon delay\fR\m[]

4204

parameter\&.

4205

.sp

4206

Default:

4207

\fI\fIinit logon delayed hosts\fR\fR\fI = \fR\fI\fR\fI \fR

4208

.sp

4209

Example:

4210

\fI\fIinit logon delayed hosts\fR\fR\fI = \fR\fI150\&.203\&.5\&. myhost\&.mynet\&.de\fR\fI \fR

4211

.RE

4212

4213

init logon delay (G)

4214

.\" init logon delay

4215

.PP

4216

.RS 4

4217

This parameter specifies a delay in milliseconds for the hosts configured for delayed initial samlogon with

4218

\m[blue]\fBinit logon delayed hosts\fR\m[]\&.

4219

.sp

4220

Default:

4221

\fI\fIinit logon delay\fR\fR\fI = \fR\fI100\fR\fI \fR

4222

.RE

4223

4224

interfaces (G)

4225

.\" interfaces

4226

.PP

4227

.RS 4

4228

This option allows you to override the default network interfaces list that Samba will use for browsing, name registration and other NetBIOS over TCP/IP (NBT) traffic\&. By default Samba will query the kernel for the list of all active interfaces and use any interfaces except 127\&.0\&.0\&.1 that are broadcast capable\&.

4229

.sp

4230

The option takes a list of interface strings\&. Each string can be in any of the following forms:

4231

.sp

4232

.RS 4

4233

.ie n \{\

4234

\h'-04'\(bu\h'+03'\c

4235

.\}

4236

.el \{\

4237

.sp -1

4238

.IP \(bu 2.3

4239

.\}

4240

a network interface name (such as eth0)\&. This may include shell\-like wildcards so eth* will match any interface starting with the substring "eth"

4241

.RE

4242

.sp

4243

.RS 4

4244

.ie n \{\

4245

\h'-04'\(bu\h'+03'\c

4246

.\}

4247

.el \{\

4248

.sp -1

4249

.IP \(bu 2.3

4250

.\}

4251

an IP address\&. In this case the netmask is determined from the list of interfaces obtained from the kernel

4252

.RE

4253

.sp

4254

.RS 4

4255

.ie n \{\

4256

\h'-04'\(bu\h'+03'\c

4257

.\}

4258

.el \{\

4259

.sp -1

4260

.IP \(bu 2.3

4261

.\}

4262

an IP/mask pair\&.

4263

.RE

4264

.sp

4265

.RS 4

4266

.ie n \{\

4267

\h'-04'\(bu\h'+03'\c

4268

.\}

4269

.el \{\

4270

.sp -1

4271

.IP \(bu 2.3

4272

.\}

4273

a broadcast/mask pair\&.

4274

.RE

4275

.sp

4276

.RE

4277

The "mask" parameters can either be a bit length (such as 24 for a C class network) or a full netmask in dotted decimal form\&.

4278

.sp

4279

The "IP" parameters above can either be a full dotted decimal IP address or a hostname which will be looked up via the OS\'s normal hostname resolution mechanisms\&.

4280

.sp

4281

By default Samba enables all active interfaces that are broadcast capable except the loopback adaptor (IP address 127\&.0\&.0\&.1)\&.

4282

.sp

4283

The example below configures three network interfaces corresponding to the eth0 device and IP addresses 192\&.168\&.2\&.10 and 192\&.168\&.3\&.10\&. The netmasks of the latter two interfaces would be set to 255\&.255\&.255\&.0\&.

4284

.sp

4285

Default:

4286

\fI\fIinterfaces\fR\fR\fI = \fR\fI\fR\fI \fR

4287

.sp

4288

Example:

4289

\fI\fIinterfaces\fR\fR\fI = \fR\fIeth0 192\&.168\&.2\&.10/24 192\&.168\&.3\&.10/255\&.255\&.255\&.0\fR\fI \fR

4290

.RE

4291

4292

invalid users (S)

4293

.\" invalid users

4294

.PP

4295

.RS 4

4296

This is a list of users that should not be allowed to login to this service\&. This is really a

4297

\fIparanoid\fR

4298

check to absolutely ensure an improper setting does not breach your security\&.

4299

.sp

4300

A name starting with a \'@\' is interpreted as an NIS netgroup first (if your system supports NIS), and then as a UNIX group if the name was not found in the NIS netgroup database\&.

4301

.sp

4302

A name starting with \'+\' is interpreted only by looking in the UNIX group database via the NSS getgrnam() interface\&. A name starting with \'&\' is interpreted only by looking in the NIS netgroup database (this requires NIS to be working on your system)\&. The characters \'+\' and \'&\' may be used at the start of the name in either order so the value

4303

\fI+&group\fR

4304

means check the UNIX group database, followed by the NIS netgroup database, and the value

4305

\fI&+group\fR

4306

means check the NIS netgroup database, followed by the UNIX group database (the same as the \'@\' prefix)\&.

4307

.sp

4308

The current servicename is substituted for

4309

\fI%S\fR\&. This is useful in the [homes] section\&.

4310

.sp

4311

Default:

4312

\fI\fIinvalid users\fR\fR\fI = \fR\fI # no invalid users\fR\fI \fR

4313

.sp

4314

Example:

4315

\fI\fIinvalid users\fR\fR\fI = \fR\fIroot fred admin @wheel\fR\fI \fR

4316

.RE

4317

4318

iprint server (G)

4319

.\" iprint server

4320

.PP

4321

.RS 4

4322

This parameter is only applicable if

4323

\m[blue]\fBprinting\fR\m[]

4324

is set to

4325

\fBiprint\fR\&.

4326

.sp

4327

If set, this option overrides the ServerName option in the CUPS

4328

client\&.conf\&. This is necessary if you have virtual samba servers that connect to different CUPS daemons\&.

4329

.sp

4330

Default:

4331

\fI\fIiprint server\fR\fR\fI = \fR\fI""\fR\fI \fR

4332

.sp

4333

Example:

4334

\fI\fIiprint server\fR\fR\fI = \fR\fIMYCUPSSERVER\fR\fI \fR

4335

.RE

4336

4337

keepalive (G)

4338

.\" keepalive

4339

.PP

4340

.RS 4

4341

The value of the parameter (an integer) represents the number of seconds between

4342

\fIkeepalive\fR

4343

packets\&. If this parameter is zero, no keepalive packets will be sent\&. Keepalive packets, if sent, allow the server to tell whether a client is still present and responding\&.

4344

.sp

4345

Keepalives should, in general, not be needed if the socket has the SO_KEEPALIVE attribute set on it by default\&. (see

4346

\m[blue]\fBsocket options\fR\m[])\&. Basically you should only use this option if you strike difficulties\&.

4347

.sp

4348

Default:

4349

\fI\fIkeepalive\fR\fR\fI = \fR\fI300\fR\fI \fR

4350

.sp

4351

Example:

4352

\fI\fIkeepalive\fR\fR\fI = \fR\fI600\fR\fI \fR

4353

.RE

4354

4355

kerberos method (G)

4356

.\" kerberos method

4357

.PP

4358

.RS 4

4359

Controls how kerberos tickets are verified\&.

4360

.sp

4361

Valid options are:

4362

.sp

4363

.RS 4

4364

.ie n \{\

4365

\h'-04'\(bu\h'+03'\c

4366

.\}

4367

.el \{\

4368

.sp -1

4369

.IP \(bu 2.3

4370

.\}

4371

secrets only \- use only the secrets\&.tdb for ticket verification (default)

4372

.RE

4373

.sp

4374

.RS 4

4375

.ie n \{\

4376

\h'-04'\(bu\h'+03'\c

4377

.\}

4378

.el \{\

4379

.sp -1

4380

.IP \(bu 2.3

4381

.\}

4382

system keytab \- use only the system keytab for ticket verification

4383

.RE

4384

.sp

4385

.RS 4

4386

.ie n \{\

4387

\h'-04'\(bu\h'+03'\c

4388

.\}

4389

.el \{\

4390

.sp -1

4391

.IP \(bu 2.3

4392

.\}

4393

dedicated keytab \- use a dedicated keytab for ticket verification

4394

.RE

4395

.sp

4396

.RS 4

4397

.ie n \{\

4398

\h'-04'\(bu\h'+03'\c

4399

.\}

4400

.el \{\

4401

.sp -1

4402

.IP \(bu 2.3

4403

.\}

4404

secrets and keytab \- use the secrets\&.tdb first, then the system keytab

4405

.RE

4406

.sp

4407

.RE

4408

The major difference between "system keytab" and "dedicated keytab" is that the latter method relies on kerberos to find the correct keytab entry instead of filtering based on expected principals\&.

4409

.sp

4410

When the kerberos method is in "dedicated keytab" mode,

4411

\m[blue]\fBdedicated keytab file\fR\m[]

4412

must be set to specify the location of the keytab file\&.

4413

.sp

4414

Default:

4415

\fI\fIkerberos method\fR\fR\fI = \fR\fIsecrets only\fR\fI \fR

4416

.RE

4417

4418

kernel change notify (S)

4419

.\" kernel change notify

4420

.PP

4421

.RS 4

4422

This parameter specifies whether Samba should ask the kernel for change notifications in directories so that SMB clients can refresh whenever the data on the server changes\&.

4423

.sp

4424

This parameter is only used when your kernel supports change notification to user programs using the inotify interface\&.

4425

.sp

4426

Default:

4427

\fI\fIkernel change notify\fR\fR\fI = \fR\fIyes\fR\fI \fR

4428

.RE

4429

4430

kernel oplocks (G)

4431

.\" kernel oplocks

4432

.PP

4433

.RS 4

4434

For UNIXes that support kernel based

4435

\m[blue]\fBoplocks\fR\m[]

4436

(currently only IRIX and the Linux 2\&.4 kernel), this parameter allows the use of them to be turned on or off\&.

4437

.sp

4438

Kernel oplocks support allows Samba

4439

\fIoplocks \fR

4440

to be broken whenever a local UNIX process or NFS operation accesses a file that

4441

\fBsmbd\fR(8)

4442

has oplocked\&. This allows complete data consistency between SMB/CIFS, NFS and local file access (and is a

4443

\fIvery\fR

4444

cool feature :\-)\&.

4445

.sp

4446

This parameter defaults to

4447

\fBon\fR, but is translated to a no\-op on systems that no not have the necessary kernel support\&. You should never need to touch this parameter\&.

4448

.sp

4449

Default:

4450

\fI\fIkernel oplocks\fR\fR\fI = \fR\fIyes\fR\fI \fR

4451

.RE

4452

4453

lanman auth (G)

4454

.\" lanman auth

4455

.PP

4456

.RS 4

4457

This parameter determines whether or not

4458

\fBsmbd\fR(8)

4459

will attempt to authenticate users or permit password changes using the LANMAN password hash\&. If disabled, only clients which support NT password hashes (e\&.g\&. Windows NT/2000 clients, smbclient, but not Windows 95/98 or the MS DOS network client) will be able to connect to the Samba host\&.

4460

.sp

4461

The LANMAN encrypted response is easily broken, due to its case\-insensitive nature, and the choice of algorithm\&. Servers without Windows 95/98/ME or MS DOS clients are advised to disable this option\&.

4462

.sp

4463

When this parameter is set to

4464

4465

this will also result in sambaLMPassword in Samba\'s passdb being blanked after the next password change\&. As a result of that lanman clients won\'t be able to authenticate, even if lanman auth is reenabled later on\&.

4466

.sp

4467

Unlike the

4468

encrypt passwords

4469

option, this parameter cannot alter client behaviour, and the LANMAN response will still be sent over the network\&. See the

4470

client lanman auth

4471

to disable this for Samba\'s clients (such as smbclient)

4472

.sp

4473

If this option, and

4474

ntlm auth

4475

are both disabled, then only NTLMv2 logins will be permited\&. Not all clients support NTLMv2, and most will require special configuration to use it\&.

4476

.sp

4477

Default:

4478

\fI\fIlanman auth\fR\fR\fI = \fR\fIno\fR\fI \fR

4479

.RE

4480

4481

large readwrite (G)

4482

.\" large readwrite

4483

.PP

4484

.RS 4

4485

This parameter determines whether or not

4486

\fBsmbd\fR(8)

4487

supports the new 64k streaming read and write variant SMB requests introduced with Windows 2000\&. Note that due to Windows 2000 client redirector bugs this requires Samba to be running on a 64\-bit capable operating system such as IRIX, Solaris or a Linux 2\&.4 kernel\&. Can improve performance by 10% with Windows 2000 clients\&. Defaults to on\&. Not as tested as some other Samba code paths\&.

4488

.sp

4489

Default:

4490

\fI\fIlarge readwrite\fR\fR\fI = \fR\fIyes\fR\fI \fR

4491

.RE

4492

4493

ldap admin dn (G)

4494

.\" ldap admin dn

4495

.PP

4496

.RS 4

4497

The

4498

\m[blue]\fBldap admin dn\fR\m[]

4499

defines the Distinguished Name (DN) name used by Samba to contact the ldap server when retreiving user account information\&. The

4500

\m[blue]\fBldap admin dn\fR\m[]

4501

is used in conjunction with the admin dn password stored in the

4502

private/secrets\&.tdb

4503

file\&. See the

4504

\fBsmbpasswd\fR(8)

4505

man page for more information on how to accomplish this\&.

4506

.sp

4507

The

4508

\m[blue]\fBldap admin dn\fR\m[]

4509

requires a fully specified DN\&. The

4510

\m[blue]\fBldap suffix\fR\m[]

4511

is not appended to the

4512

\m[blue]\fBldap admin dn\fR\m[]\&.

4513

.sp

4514

\fINo default\fR

4515

.RE

4516

4517

ldap connection timeout (G)

4518

.\" ldap connection timeout

4519

.PP

4520

.RS 4

4521

This parameter tells the LDAP library calls which timeout in seconds they should honor during initial connection establishments to LDAP servers\&. It is very useful in failover scenarios in particular\&. If one or more LDAP servers are not reachable at all, we do not have to wait until TCP timeouts are over\&. This feature must be supported by your LDAP library\&.

4522

.sp

4523

This parameter is different from

4524

\m[blue]\fBldap timeout\fR\m[]

4525

which affects operations on LDAP servers using an existing connection and not establishing an initial connection\&.

4526

.sp

4527

Default:

4528

\fI\fIldap connection timeout\fR\fR\fI = \fR\fI2\fR\fI \fR

4529

.RE

4530

4531

ldap debug level (G)

4532

.\" ldap debug level

4533

.PP

4534

.RS 4

4535

This parameter controls the debug level of the LDAP library calls\&. In the case of OpenLDAP, it is the same bit\-field as understood by the server and documented in the

4536

\fBslapd.conf\fR(5)

4537

manpage\&. A typical useful value will be

4538

\fI1\fR

4539

for tracing function calls\&.

4540

.sp

4541

The debug ouput from the LDAP libraries appears with the prefix [LDAP] in Samba\'s logging output\&. The level at which LDAP logging is printed is controlled by the parameter

4542

\fIldap debug threshold\fR\&.

4543

.sp

4544

Default:

4545

\fI\fIldap debug level\fR\fR\fI = \fR\fI0\fR\fI \fR

4546

.sp

4547

Example:

4548

\fI\fIldap debug level\fR\fR\fI = \fR\fI1\fR\fI \fR

4549

.RE

4550

4551

ldap debug threshold (G)

4552

.\" ldap debug threshold

4553

.PP

4554

.RS 4

4555

This parameter controls the Samba debug level at which the ldap library debug output is printed in the Samba logs\&. See the description of

4556

\fIldap debug level\fR

4557

for details\&.

4558

.sp

4559

Default:

4560

\fI\fIldap debug threshold\fR\fR\fI = \fR\fI10\fR\fI \fR

4561

.sp

4562

Example:

4563

\fI\fIldap debug threshold\fR\fR\fI = \fR\fI5\fR\fI \fR

4564

.RE

4565

4566

ldap delete dn (G)

4567

.\" ldap delete dn

4568

.PP

4569

.RS 4

4570

This parameter specifies whether a delete operation in the ldapsam deletes the complete entry or only the attributes specific to Samba\&.

4571

.sp

4572

Default:

4573

\fI\fIldap delete dn\fR\fR\fI = \fR\fIno\fR\fI \fR

4574

.RE

4575

4576

ldap deref (G)

4577

.\" ldap deref

4578

.PP

4579

.RS 4

4580

This option controls whether Samba should tell the LDAP library to use a certain alias dereferencing method\&. The default is

4581

\fIauto\fR, which means that the default setting of the ldap client library will be kept\&. Other possible values are

4582

\fInever\fR,

4583

\fIfinding\fR,

4584

\fIsearching\fR

4585

and

4586

\fIalways\fR\&. Grab your LDAP manual for more information\&.

4587

.sp

4588

Default:

4589

\fI\fIldap deref\fR\fR\fI = \fR\fIauto\fR\fI \fR

4590

.sp

4591

Example:

4592

\fI\fIldap deref\fR\fR\fI = \fR\fIsearching\fR\fI \fR

4593

.RE

4594

4595

ldap follow referral (G)

4596

.\" ldap follow referral

4597

.PP

4598

.RS 4

4599

This option controls whether to follow LDAP referrals or not when searching for entries in the LDAP database\&. Possible values are

4600

\fIon\fR

4601

to enable following referrals,

4602

\fIoff\fR

4603

to disable this, and

4604

\fIauto\fR, to use the libldap default settings\&. libldap\'s choice of following referrals or not is set in /etc/openldap/ldap\&.conf with the REFERRALS parameter as documented in ldap\&.conf(5)\&.

4605

.sp

4606

Default:

4607

\fI\fIldap follow referral\fR\fR\fI = \fR\fIauto\fR\fI \fR

4608

.sp

4609

Example:

4610

\fI\fIldap follow referral\fR\fR\fI = \fR\fIoff\fR\fI \fR

4611

.RE

4612

4613

ldap group suffix (G)

4614

.\" ldap group suffix

4615

.PP

4616

.RS 4

4617

This parameter specifies the suffix that is used for groups when these are added to the LDAP directory\&. If this parameter is unset, the value of

4618

\m[blue]\fBldap suffix\fR\m[]

4619

will be used instead\&. The suffix string is pre\-pended to the

4620

\m[blue]\fBldap suffix\fR\m[]

4621

string so use a partial DN\&.

4622

.sp

4623

Default:

4624

\fI\fIldap group suffix\fR\fR\fI = \fR\fI\fR\fI \fR

4625

.sp

4626

Example:

4627

\fI\fIldap group suffix\fR\fR\fI = \fR\fIou=Groups\fR\fI \fR

4628

.RE

4629

4630

ldap idmap suffix (G)

4631

.\" ldap idmap suffix

4632

.PP

4633

.RS 4

4634

This parameters specifies the suffix that is used when storing idmap mappings\&. If this parameter is unset, the value of

4635

\m[blue]\fBldap suffix\fR\m[]

4636

will be used instead\&. The suffix string is pre\-pended to the

4637

\m[blue]\fBldap suffix\fR\m[]

4638

string so use a partial DN\&.

4639

.sp

4640

Default:

4641

\fI\fIldap idmap suffix\fR\fR\fI = \fR\fI\fR\fI \fR

4642

.sp

4643

Example:

4644

\fI\fIldap idmap suffix\fR\fR\fI = \fR\fIou=Idmap\fR\fI \fR

4645

.RE

4646

4647

ldap machine suffix (G)

4648

.\" ldap machine suffix

4649

.PP

4650

.RS 4

4651

It specifies where machines should be added to the ldap tree\&. If this parameter is unset, the value of

4652

\m[blue]\fBldap suffix\fR\m[]

4653

will be used instead\&. The suffix string is pre\-pended to the

4654

\m[blue]\fBldap suffix\fR\m[]

4655

string so use a partial DN\&.

4656

.sp

4657

Default:

4658

\fI\fIldap machine suffix\fR\fR\fI = \fR\fI\fR\fI \fR

4659

.sp

4660

Example:

4661

\fI\fIldap machine suffix\fR\fR\fI = \fR\fIou=Computers\fR\fI \fR

4662

.RE

4663

4664

ldap page size (G)

4665

.\" ldap page size

4666

.PP

4667

.RS 4

4668

This parameter specifies the number of entries per page\&.

4669

.sp

4670

If the LDAP server supports paged results, clients can request subsets of search results (pages) instead of the entire list\&. This parameter specifies the size of these pages\&.

4671

.sp

4672

Default:

4673

\fI\fIldap page size\fR\fR\fI = \fR\fI1024\fR\fI \fR

4674

.sp

4675

Example:

4676

\fI\fIldap page size\fR\fR\fI = \fR\fI512\fR\fI \fR

4677

.RE

4678

4679

ldap passwd sync (G)

4680

.\" ldap passwd sync

4681

.PP

4682

.RS 4

4683

This option is used to define whether or not Samba should sync the LDAP password with the NT and LM hashes for normal accounts (NOT for workstation, server or domain trusts) on a password change via SAMBA\&.

4684

.sp

4685

The

4686

\m[blue]\fBldap passwd sync\fR\m[]

4687

can be set to one of three values:

4688

.sp

4689

.RS 4

4690

.ie n \{\

4691

\h'-04'\(bu\h'+03'\c

4692

.\}

4693

.el \{\

4694

.sp -1

4695

.IP \(bu 2.3

4696

.\}

4697

\fIYes\fR

4698

= Try to update the LDAP, NT and LM passwords and update the pwdLastSet time\&.

4699

.RE

4700

.sp

4701

.RS 4

4702

.ie n \{\

4703

\h'-04'\(bu\h'+03'\c

4704

.\}

4705

.el \{\

4706

.sp -1

4707

.IP \(bu 2.3

4708

.\}

4709

\fINo\fR

4710

= Update NT and LM passwords and update the pwdLastSet time\&.

4711

.RE

4712

.sp

4713

.RS 4

4714

.ie n \{\

4715

\h'-04'\(bu\h'+03'\c

4716

.\}

4717

.el \{\

4718

.sp -1

4719

.IP \(bu 2.3

4720

.\}

4721

\fIOnly\fR

4722

= Only update the LDAP password and let the LDAP server do the rest\&.

4723

.RE

4724

.sp

4725

.RE

4726

Default:

4727

\fI\fIldap passwd sync\fR\fR\fI = \fR\fIno\fR\fI \fR

4728

.RE

4729

4730

ldap replication sleep (G)

4731

.\" ldap replication sleep

4732

.PP

4733

.RS 4

4734

When Samba is asked to write to a read\-only LDAP replica, we are redirected to talk to the read\-write master server\&. This server then replicates our changes back to the \'local\' server, however the replication might take some seconds, especially over slow links\&. Certain client activities, particularly domain joins, can become confused by the \'success\' that does not immediately change the LDAP back\-end\'s data\&.

4735

.sp

4736

This option simply causes Samba to wait a short time, to allow the LDAP server to catch up\&. If you have a particularly high\-latency network, you may wish to time the LDAP replication with a network sniffer, and increase this value accordingly\&. Be aware that no checking is performed that the data has actually replicated\&.

4737

.sp

4738

The value is specified in milliseconds, the maximum value is 5000 (5 seconds)\&.

4739

.sp

4740

Default:

4741

\fI\fIldap replication sleep\fR\fR\fI = \fR\fI1000\fR\fI \fR

4742

.RE

4743

4744

ldapsam:editposix (G)

4745

.\" ldapsam:editposix

4746

.PP

4747

.RS 4

4748

Editposix is an option that leverages ldapsam:trusted to make it simpler to manage a domain controller eliminating the need to set up custom scripts to add and manage the posix users and groups\&. This option will instead directly manipulate the ldap tree to create, remove and modify user and group entries\&. This option also requires a running winbindd as it is used to allocate new uids/gids on user/group creation\&. The allocation range must be therefore configured\&.

4749

.sp

4750

To use this option, a basic ldap tree must be provided and the ldap suffix parameters must be properly configured\&. On virgin servers the default users and groups (Administrator, Guest, Domain Users, Domain Admins, Domain Guests) can be precreated with the command

4751

net sam provision\&. To run this command the ldap server must be running, Winindd must be running and the smb\&.conf ldap options must be properly configured\&. The typical ldap setup used with the

4752

\m[blue]\fBldapsam:trusted = yes\fR\m[]

4753

option is usually sufficient to use

4754

\m[blue]\fBldapsam:editposix = yes\fR\m[]

4755

as well\&.

4756

.sp

4757

An example configuration can be the following:

4758

.sp

4759

.if n \{\

4760

.RS 4

4761

.\}

4762

.nf

4763

encrypt passwords = true

4764

passdb backend = ldapsam

4765

4766

ldapsam:trusted=yes

4767

ldapsam:editposix=yes

4768

4769

ldap admin dn = cn=admin,dc=samba,dc=org

4770

ldap delete dn = yes

4771

ldap group suffix = ou=groups

4772

ldap idmap suffix = ou=idmap

4773

ldap machine suffix = ou=computers

4774

ldap user suffix = ou=users

4775

ldap suffix = dc=samba,dc=org

4776

4777

idmap backend = ldap:"ldap://localhost"

4778

4779

idmap uid = 5000\-50000

4780

idmap gid = 5000\-50000

4781

4782

.fi

4783

.if n \{\

4784

.RE

4785

.\}

4786

.sp

4787

This configuration assumes a directory layout like described in the following ldif:

4788

.sp

4789

.if n \{\

4790

.RS 4

4791

.\}

4792

.nf

4793

dn: dc=samba,dc=org

4794

objectClass: top

4795

objectClass: dcObject

4796

objectClass: organization

4797

o: samba\&.org

4798

dc: samba

4799

4800

dn: cn=admin,dc=samba,dc=org

4801

objectClass: simpleSecurityObject

4802

objectClass: organizationalRole

4803

cn: admin

4804

description: LDAP administrator

4805

userPassword: secret

4806

4807

dn: ou=users,dc=samba,dc=org

4808

objectClass: top

4809

objectClass: organizationalUnit

4810

ou: users

4811

4812

dn: ou=groups,dc=samba,dc=org

4813

objectClass: top

4814

objectClass: organizationalUnit

4815

ou: groups

4816

4817

dn: ou=idmap,dc=samba,dc=org

4818

objectClass: top

4819

objectClass: organizationalUnit

4820

ou: idmap

4821

4822

dn: ou=computers,dc=samba,dc=org

4823

objectClass: top

4824

objectClass: organizationalUnit

4825

ou: computers

4826

4827

.fi

4828

.if n \{\

4829

.RE

4830

.\}

4831

.sp

4832

Default:

4833

\fI\fIldapsam:editposix\fR\fR\fI = \fR\fIno\fR\fI \fR

4834

.RE

4835

4836

ldapsam:trusted (G)

4837

.\" ldapsam:trusted

4838

.PP

4839

.RS 4

4840

By default, Samba as a Domain Controller with an LDAP backend needs to use the Unix\-style NSS subsystem to access user and group information\&. Due to the way Unix stores user information in /etc/passwd and /etc/group this inevitably leads to inefficiencies\&. One important question a user needs to know is the list of groups he is member of\&. The plain UNIX model involves a complete enumeration of the file /etc/group and its NSS counterparts in LDAP\&. UNIX has optimized functions to enumerate group membership\&. Sadly, other functions that are used to deal with user and group attributes lack such optimization\&.

4841

.sp

4842

To make Samba scale well in large environments, the

4843

\m[blue]\fBldapsam:trusted = yes\fR\m[]

4844

option assumes that the complete user and group database that is relevant to Samba is stored in LDAP with the standard posixAccount/posixGroup attributes\&. It further assumes that the Samba auxiliary object classes are stored together with the POSIX data in the same LDAP object\&. If these assumptions are met,

4845

\m[blue]\fBldapsam:trusted = yes\fR\m[]

4846

can be activated and Samba can bypass the NSS system to query user group memberships\&. Optimized LDAP queries can greatly speed up domain logon and administration tasks\&. Depending on the size of the LDAP database a factor of 100 or more for common queries is easily achieved\&.

4847

.sp

4848

Default:

4849

\fI\fIldapsam:trusted\fR\fR\fI = \fR\fIno\fR\fI \fR

4850

.RE

4851

4852

ldap ssl ads (G)

4853

.\" ldap ssl ads

4854

.PP

4855

.RS 4

4856

This option is used to define whether or not Samba should use SSL when connecting to the ldap server using

4857

\fIads\fR

4858

methods\&. Rpc methods are not affected by this parameter\&. Please note, that this parameter won\'t have any effect if

4859

\m[blue]\fBldap ssl\fR\m[]

4860

is set to

4861

\fIno\fR\&.

4862

.sp

4863

See

4864

smb\&.conf(5)

4865

for more information on

4866

\m[blue]\fBldap ssl\fR\m[]\&.

4867

.sp

4868

Default:

4869

\fI\fIldap ssl ads\fR\fR\fI = \fR\fIno\fR\fI \fR

4870

.RE

4871

4872

ldap ssl (G)

4873

.\" ldap ssl

4874

.PP

4875

.RS 4

4876

This option is used to define whether or not Samba should use SSL when connecting to the ldap server This is

4877

\fINOT\fR

4878

related to Samba\'s previous SSL support which was enabled by specifying the

4879

\-\-with\-ssl

4880

option to the

4881

configure

4882

script\&.

4883

.sp

4884

LDAP connections should be secured where possible\&. This may be done setting

4885

\fIeither\fR

4886

this parameter to

4887

\fIStart_tls\fR

4888

\fIor\fR

4889

by specifying

4890

\fIldaps://\fR

4891

in the URL argument of

4892

\m[blue]\fBpassdb backend\fR\m[]\&.

4893

.sp

4894

The

4895

\m[blue]\fBldap ssl\fR\m[]

4896

can be set to one of two values:

4897

.sp

4898

.RS 4

4899

.ie n \{\

4900

\h'-04'\(bu\h'+03'\c

4901

.\}

4902

.el \{\

4903

.sp -1

4904

.IP \(bu 2.3

4905

.\}

4906

\fIOff\fR

4907

= Never use SSL when querying the directory\&.

4908

.RE

4909

.sp

4910

.RS 4

4911

.ie n \{\

4912

\h'-04'\(bu\h'+03'\c

4913

.\}

4914

.el \{\

4915

.sp -1

4916

.IP \(bu 2.3

4917

.\}

4918

\fIstart tls\fR

4919

= Use the LDAPv3 StartTLS extended operation (RFC2830) for communicating with the directory server\&.

4920

.RE

4921

.sp

4922

.RE

4923

Please note that this parameter does only affect

4924

\fIrpc\fR

4925

methods\&. To enable the LDAPv3 StartTLS extended operation (RFC2830) for

4926

\fIads\fR, set

4927

\m[blue]\fBldap ssl = yes\fR\m[]

4928

\fIand\fR

4929

\m[blue]\fBldap ssl ads = yes\fR\m[]\&. See

4930

smb\&.conf(5)

4931

for more information on

4932

\m[blue]\fBldap ssl ads\fR\m[]\&.

4933

.sp

4934

Default:

4935

\fI\fIldap ssl\fR\fR\fI = \fR\fIstart tls\fR\fI \fR

4936

.RE

4937

4938

ldap suffix (G)

4939

.\" ldap suffix

4940

.PP

4941

.RS 4

4942

Specifies the base for all ldap suffixes and for storing the sambaDomain object\&.

4943

.sp

4944

The ldap suffix will be appended to the values specified for the

4945

\m[blue]\fBldap user suffix\fR\m[],

4946

\m[blue]\fBldap group suffix\fR\m[],

4947

\m[blue]\fBldap machine suffix\fR\m[], and the

4948

\m[blue]\fBldap idmap suffix\fR\m[]\&. Each of these should be given only a DN relative to the

4949

\m[blue]\fBldap suffix\fR\m[]\&.

4950

.sp

4951

Default:

4952

\fI\fIldap suffix\fR\fR\fI = \fR\fI\fR\fI \fR

4953

.sp

4954

Example:

4955

\fI\fIldap suffix\fR\fR\fI = \fR\fIdc=samba,dc=org\fR\fI \fR

4956

.RE

4957

4958

ldap timeout (G)

4959

.\" ldap timeout

4960

.PP

4961

.RS 4

4962

This parameter defines the number of seconds that Samba should use as timeout for LDAP operations\&.

4963

.sp

4964

Default:

4965

\fI\fIldap timeout\fR\fR\fI = \fR\fI15\fR\fI \fR

4966

.RE

4967

4968

ldap user suffix (G)

4969

.\" ldap user suffix

4970

.PP

4971

.RS 4

4972

This parameter specifies where users are added to the tree\&. If this parameter is unset, the value of

4973

\m[blue]\fBldap suffix\fR\m[]

4974

will be used instead\&. The suffix string is pre\-pended to the

4975

\m[blue]\fBldap suffix\fR\m[]

4976

string so use a partial DN\&.

4977

.sp

4978

Default:

4979

\fI\fIldap user suffix\fR\fR\fI = \fR\fI\fR\fI \fR

4980

.sp

4981

Example:

4982

\fI\fIldap user suffix\fR\fR\fI = \fR\fIou=people\fR\fI \fR

4983

.RE

4984

4985

level2 oplocks (S)

4986

.\" level2 oplocks

4987

.PP

4988

.RS 4

4989

This parameter controls whether Samba supports level2 (read\-only) oplocks on a share\&.

4990

.sp

4991

Level2, or read\-only oplocks allow Windows NT clients that have an oplock on a file to downgrade from a read\-write oplock to a read\-only oplock once a second client opens the file (instead of releasing all oplocks on a second open, as in traditional, exclusive oplocks)\&. This allows all openers of the file that support level2 oplocks to cache the file for read\-ahead only (ie\&. they may not cache writes or lock requests) and increases performance for many accesses of files that are not commonly written (such as application \&.EXE files)\&.

4992

.sp

4993

Once one of the clients which have a read\-only oplock writes to the file all clients are notified (no reply is needed or waited for) and told to break their oplocks to "none" and delete any read\-ahead caches\&.

4994

.sp

4995

It is recommended that this parameter be turned on to speed access to shared executables\&.

4996

.sp

4997

For more discussions on level2 oplocks see the CIFS spec\&.

4998

.sp

4999

Currently, if

5000

\m[blue]\fBkernel oplocks\fR\m[]

5001

are supported then level2 oplocks are not granted (even if this parameter is set to

5002

\fByes\fR)\&. Note also, the

5003

\m[blue]\fBoplocks\fR\m[]

5004

parameter must be set to

5005

\fByes\fR

5006

on this share in order for this parameter to have any effect\&.

5007

.sp

5008

Default:

5009

\fI\fIlevel2 oplocks\fR\fR\fI = \fR\fIyes\fR\fI \fR

5010

.RE

5011

5012

lm announce (G)

5013

.\" lm announce

5014

.PP

5015

.RS 4

5016

This parameter determines if

5017

\fBnmbd\fR(8)

5018

will produce Lanman announce broadcasts that are needed by OS/2 clients in order for them to see the Samba server in their browse list\&. This parameter can have three values,

5019

\fByes\fR,

5020

\fBno\fR, or

5021

\fBauto\fR\&. The default is

5022

\fBauto\fR\&. If set to

5023

\fBno\fR

5024

Samba will never produce these broadcasts\&. If set to

5025

\fByes\fR

5026

Samba will produce Lanman announce broadcasts at a frequency set by the parameter

5027

\m[blue]\fBlm interval\fR\m[]\&. If set to

5028

\fBauto\fR

5029

Samba will not send Lanman announce broadcasts by default but will listen for them\&. If it hears such a broadcast on the wire it will then start sending them at a frequency set by the parameter

5030

\m[blue]\fBlm interval\fR\m[]\&.

5031

.sp

5032

Default:

5033

\fI\fIlm announce\fR\fR\fI = \fR\fIauto\fR\fI \fR

5034

.sp

5035

Example:

5036

\fI\fIlm announce\fR\fR\fI = \fR\fIyes\fR\fI \fR

5037

.RE

5038

5039

lm interval (G)

5040

.\" lm interval

5041

.PP

5042

.RS 4

5043

If Samba is set to produce Lanman announce broadcasts needed by OS/2 clients (see the

5044

\m[blue]\fBlm announce\fR\m[]

5045

parameter) then this parameter defines the frequency in seconds with which they will be made\&. If this is set to zero then no Lanman announcements will be made despite the setting of the

5046

\m[blue]\fBlm announce\fR\m[]

5047

parameter\&.

5048

.sp

5049

Default:

5050

\fI\fIlm interval\fR\fR\fI = \fR\fI60\fR\fI \fR

5051

.sp

5052

Example:

5053

\fI\fIlm interval\fR\fR\fI = \fR\fI120\fR\fI \fR

5054

.RE

5055

5056

load printers (G)

5057

.\" load printers

5058

.PP

5059

.RS 4

5060

A boolean variable that controls whether all printers in the printcap will be loaded for browsing by default\&. See the

5061

\m[blue]\fBprinters\fR\m[]

5062

section for more details\&.

5063

.sp

5064

Default:

5065

\fI\fIload printers\fR\fR\fI = \fR\fIyes\fR\fI \fR

5066

.RE

5067

5068

local master (G)

5069

.\" local master

5070

.PP

5071

.RS 4

5072

This option allows

5073

\fBnmbd\fR(8)

5074

to try and become a local master browser on a subnet\&. If set to

5075

\fBno\fR

5076

then

5077

nmbd

5078

will not attempt to become a local master browser on a subnet and will also lose in all browsing elections\&. By default this value is set to

5079

\fByes\fR\&. Setting this value to

5080

\fByes\fR

5081

doesn\'t mean that Samba will

5082

\fIbecome\fR

5083

the local master browser on a subnet, just that

5084

nmbd

5085

will

5086

\fIparticipate\fR

5087

in elections for local master browser\&.

5088

.sp

5089

Setting this value to

5090

\fBno\fR

5091

will cause

5092

nmbd

5093

\fInever\fR

5094

to become a local master browser\&.

5095

.sp

5096

Default:

5097

\fI\fIlocal master\fR\fR\fI = \fR\fIyes\fR\fI \fR

5098

.RE

5099

5100

lock dir

5101

.\" lock dir

5102

.PP

5103

.RS 4

5104

This parameter is a synonym for

5105

lock directory\&.

5106

.RE

5107

5108

lock directory (G)

5109

.\" lock directory

5110

.PP

5111

.RS 4

5112

This option specifies the directory where lock files will be placed\&. The lock files are used to implement the

5113

\m[blue]\fBmax connections\fR\m[]

5114

option\&.

5115

.sp

5116

Note: This option can not be set inside registry configurations\&.

5117

.sp

5118

Default:

5119

\fI\fIlock directory\fR\fR\fI = \fR\fI${prefix}/var/locks\fR\fI \fR

5120

.sp

5121

Example:

5122

\fI\fIlock directory\fR\fR\fI = \fR\fI/var/run/samba/locks\fR\fI \fR

5123

.RE

5124

5125

locking (S)

5126

.\" locking

5127

.PP

5128

.RS 4

5129

This controls whether or not locking will be performed by the server in response to lock requests from the client\&.

5130

.sp

5131

5132

locking = no, all lock and unlock requests will appear to succeed and all lock queries will report that the file in question is available for locking\&.

5133

.sp

5134

5135

locking = yes, real locking will be performed by the server\&.

5136

.sp

5137

This option

5138

\fImay\fR

5139

be useful for read\-only filesystems which

5140

\fImay\fR

5141

not need locking (such as CDROM drives), although setting this parameter of

5142

\fBno\fR

5143

is not really recommended even in this case\&.

5144

.sp

5145

Be careful about disabling locking either globally or in a specific service, as lack of locking may result in data corruption\&. You should never need to set this parameter\&.

5146

.sp

5147

\fINo default\fR

5148

.RE

5149

5150

lock spin count (G)

5151

.\" lock spin count

5152

.PP

5153

.RS 4

5154

This parameter has been made inoperative in Samba 3\&.0\&.24\&. The functionality it contolled is now controlled by the parameter

5155

\m[blue]\fBlock spin time\fR\m[]\&.

5156

.sp

5157

Default:

5158

\fI\fIlock spin count\fR\fR\fI = \fR\fI0\fR\fI \fR

5159

.RE

5160

5161

lock spin time (G)

5162

.\" lock spin time

5163

.PP

5164

.RS 4

5165

The time in milliseconds that smbd should keep waiting to see if a failed lock request can be granted\&. This parameter has changed in default value from Samba 3\&.0\&.23 from 10 to 200\&. The associated

5166

\m[blue]\fBlock spin count\fR\m[]

5167

parameter is no longer used in Samba 3\&.0\&.24\&. You should not need to change the value of this parameter\&.

5168

.sp

5169

Default:

5170

\fI\fIlock spin time\fR\fR\fI = \fR\fI200\fR\fI \fR

5171

.RE

5172

5173

log file (G)

5174

.\" log file

5175

.PP

5176

.RS 4

5177

This option allows you to override the name of the Samba log file (also known as the debug file)\&.

5178

.sp

5179

This option takes the standard substitutions, allowing you to have separate log files for each user or machine\&.

5180

.sp

5181

\fINo default\fR

5182

.sp

5183

Example:

5184

\fI\fIlog file\fR\fR\fI = \fR\fI/usr/local/samba/var/log\&.%m\fR\fI \fR

5185

.RE

5186

5187

debuglevel

5188

.\" debuglevel

5189

.PP

5190

.RS 4

5191

This parameter is a synonym for

5192

log level\&.

5193

.RE

5194

5195

log level (G)

5196

.\" log level

5197

.PP

5198

.RS 4

5199

The value of the parameter (a astring) allows the debug level (logging level) to be specified in the

5200

smb\&.conf

5201

file\&.

5202

.sp

5203

This parameter has been extended since the 2\&.2\&.x series, now it allows to specify the debug level for multiple debug classes\&. This is to give greater flexibility in the configuration of the system\&. The following debug classes are currently implemented:

5204

.sp

5205

.RS 4

5206

.ie n \{\

5207

\h'-04'\(bu\h'+03'\c

5208

.\}

5209

.el \{\

5210

.sp -1

5211

.IP \(bu 2.3

5212

.\}

5213

\fIall\fR

5214

.RE

5215

.sp

5216

.RS 4

5217

.ie n \{\

5218

\h'-04'\(bu\h'+03'\c

5219

.\}

5220

.el \{\

5221

.sp -1

5222

.IP \(bu 2.3

5223

.\}

5224

\fItdb\fR

5225

.RE

5226

.sp

5227

.RS 4

5228

.ie n \{\

5229

\h'-04'\(bu\h'+03'\c

5230

.\}

5231

.el \{\

5232

.sp -1

5233

.IP \(bu 2.3

5234

.\}

5235

\fIprintdrivers\fR

5236

.RE

5237

.sp

5238

.RS 4

5239

.ie n \{\

5240

\h'-04'\(bu\h'+03'\c

5241

.\}

5242

.el \{\

5243

.sp -1

5244

.IP \(bu 2.3

5245

.\}

5246

\fIlanman\fR

5247

.RE

5248

.sp

5249

.RS 4

5250

.ie n \{\

5251

\h'-04'\(bu\h'+03'\c

5252

.\}

5253

.el \{\

5254

.sp -1

5255

.IP \(bu 2.3

5256

.\}

5257

\fIsmb\fR

5258

.RE

5259

.sp

5260

.RS 4

5261

.ie n \{\

5262

\h'-04'\(bu\h'+03'\c

5263

.\}

5264

.el \{\

5265

.sp -1

5266

.IP \(bu 2.3

5267

.\}

5268

\fIrpc_parse\fR

5269

.RE

5270

.sp

5271

.RS 4

5272

.ie n \{\

5273

\h'-04'\(bu\h'+03'\c

5274

.\}

5275

.el \{\

5276

.sp -1

5277

.IP \(bu 2.3

5278

.\}

5279

\fIrpc_srv\fR

5280

.RE

5281

.sp

5282

.RS 4

5283

.ie n \{\

5284

\h'-04'\(bu\h'+03'\c

5285

.\}

5286

.el \{\

5287

.sp -1

5288

.IP \(bu 2.3

5289

.\}

5290

\fIrpc_cli\fR

5291

.RE

5292

.sp

5293

.RS 4

5294

.ie n \{\

5295

\h'-04'\(bu\h'+03'\c

5296

.\}

5297

.el \{\

5298

.sp -1

5299

.IP \(bu 2.3

5300

.\}

5301

\fIpassdb\fR

5302

.RE

5303

.sp

5304

.RS 4

5305

.ie n \{\

5306

\h'-04'\(bu\h'+03'\c

5307

.\}

5308

.el \{\

5309

.sp -1

5310

.IP \(bu 2.3

5311

.\}

5312

\fIsam\fR

5313

.RE

5314

.sp

5315

.RS 4

5316

.ie n \{\

5317

\h'-04'\(bu\h'+03'\c

5318

.\}

5319

.el \{\

5320

.sp -1

5321

.IP \(bu 2.3

5322

.\}

5323

\fIauth\fR

5324

.RE

5325

.sp

5326

.RS 4

5327

.ie n \{\

5328

\h'-04'\(bu\h'+03'\c

5329

.\}

5330

.el \{\

5331

.sp -1

5332

.IP \(bu 2.3

5333

.\}

5334

\fIwinbind\fR

5335

.RE

5336

.sp

5337

.RS 4

5338

.ie n \{\

5339

\h'-04'\(bu\h'+03'\c

5340

.\}

5341

.el \{\

5342

.sp -1

5343

.IP \(bu 2.3

5344

.\}

5345

\fIvfs\fR

5346

.RE

5347

.sp

5348

.RS 4

5349

.ie n \{\

5350

\h'-04'\(bu\h'+03'\c

5351

.\}

5352

.el \{\

5353

.sp -1

5354

.IP \(bu 2.3

5355

.\}

5356

\fIidmap\fR

5357

.RE

5358

.sp

5359

.RS 4

5360

.ie n \{\

5361

\h'-04'\(bu\h'+03'\c

5362

.\}

5363

.el \{\

5364

.sp -1

5365

.IP \(bu 2.3

5366

.\}

5367

\fIquota\fR

5368

.RE

5369

.sp

5370

.RS 4

5371

.ie n \{\

5372

\h'-04'\(bu\h'+03'\c

5373

.\}

5374

.el \{\

5375

.sp -1

5376

.IP \(bu 2.3

5377

.\}

5378

\fIacls\fR

5379

.RE

5380

.sp

5381

.RS 4

5382

.ie n \{\

5383

\h'-04'\(bu\h'+03'\c

5384

.\}

5385

.el \{\

5386

.sp -1

5387

.IP \(bu 2.3

5388

.\}

5389

\fIlocking\fR

5390

.RE

5391

.sp

5392

.RS 4

5393

.ie n \{\

5394

\h'-04'\(bu\h'+03'\c

5395

.\}

5396

.el \{\

5397

.sp -1

5398

.IP \(bu 2.3

5399

.\}

5400

\fImsdfs\fR

5401

.RE

5402

.sp

5403

.RS 4

5404

.ie n \{\

5405

\h'-04'\(bu\h'+03'\c

5406

.\}

5407

.el \{\

5408

.sp -1

5409

.IP \(bu 2.3

5410

.\}

5411

\fIdmapi\fR

5412

.RE

5413

.sp

5414

.RS 4

5415

.ie n \{\

5416

\h'-04'\(bu\h'+03'\c

5417

.\}

5418

.el \{\

5419

.sp -1

5420

.IP \(bu 2.3

5421

.\}

5422

\fIregistry\fR

5423

.RE

5424

.sp

5425

.RE

5426

Default:

5427

\fI\fIlog level\fR\fR\fI = \fR\fI0\fR\fI \fR

5428

.sp

5429

Example:

5430

\fI\fIlog level\fR\fR\fI = \fR\fI3 passdb:5 auth:10 winbind:2\fR\fI \fR

5431

.RE

5432

5433

logon drive (G)

5434

.\" logon drive

5435

.PP

5436

.RS 4

5437

This parameter specifies the local path to which the home directory will be connected (see

5438

\m[blue]\fBlogon home\fR\m[]) and is only used by NT Workstations\&.

5439

.sp

5440

Note that this option is only useful if Samba is set up as a logon server\&.

5441

.sp

5442

Default:

5443

\fI\fIlogon drive\fR\fR\fI = \fR\fI\fR\fI \fR

5444

.sp

5445

Example:

5446

\fI\fIlogon drive\fR\fR\fI = \fR\fIh:\fR\fI \fR

5447

.RE

5448

5449

logon home (G)

5450

.\" logon home

5451

.PP

5452

.RS 4

5453

This parameter specifies the home directory location when a Win95/98 or NT Workstation logs into a Samba PDC\&. It allows you to do

5454

.sp

5455

5456

C:\e>\fBNET USE H: /HOME\fR

5457

.sp

5458

from a command prompt, for example\&.

5459

.sp

5460

This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine\&.

5461

.sp

5462

This parameter can be used with Win9X workstations to ensure that roaming profiles are stored in a subdirectory of the user\'s home directory\&. This is done in the following way:

5463

.sp

5464

5465

logon home = \e\e%N\e%U\eprofile

5466

.sp

5467

This tells Samba to return the above string, with substitutions made when a client requests the info, generally in a NetUserGetInfo request\&. Win9X clients truncate the info to \e\eserver\eshare when a user does

5468

net use /home

5469

but use the whole string when dealing with profiles\&.

5470

.sp

5471

Note that in prior versions of Samba, the

5472

\m[blue]\fBlogon path\fR\m[]

5473

was returned rather than

5474

\fIlogon home\fR\&. This broke

5475

net use /home

5476

but allowed profiles outside the home directory\&. The current implementation is correct, and can be used for profiles if you use the above trick\&.

5477

.sp

5478

Disable this feature by setting

5479

\m[blue]\fBlogon home = ""\fR\m[]

5480

\- using the empty string\&.

5481

.sp

5482

This option is only useful if Samba is set up as a logon server\&.

5483

.sp

5484

Default:

5485

\fI\fIlogon home\fR\fR\fI = \fR\fI\e\e%N\e%U\fR\fI \fR

5486

.sp

5487

Example:

5488

\fI\fIlogon home\fR\fR\fI = \fR\fI\e\eremote_smb_server\e%U\fR\fI \fR

5489

.RE

5490

5491

logon path (G)

5492

.\" logon path

5493

.PP

5494

.RS 4

5495

This parameter specifies the directory where roaming profiles (Desktop, NTuser\&.dat, etc) are stored\&. Contrary to previous versions of these manual pages, it has nothing to do with Win 9X roaming profiles\&. To find out how to handle roaming profiles for Win 9X system, see the

5496

\m[blue]\fBlogon home\fR\m[]

5497

parameter\&.

5498

.sp

5499

This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine\&. It also specifies the directory from which the "Application Data",

5500

desktop,

5501

start menu,

5502

network neighborhood,

5503

programs

5504

and other folders, and their contents, are loaded and displayed on your Windows NT client\&.

5505

.sp

5506

The share and the path must be readable by the user for the preferences and directories to be loaded onto the Windows NT client\&. The share must be writeable when the user logs in for the first time, in order that the Windows NT client can create the NTuser\&.dat and other directories\&. Thereafter, the directories and any of the contents can, if required, be made read\-only\&. It is not advisable that the NTuser\&.dat file be made read\-only \- rename it to NTuser\&.man to achieve the desired effect (a

5507

\fIMAN\fRdatory profile)\&.

5508

.sp

5509

Windows clients can sometimes maintain a connection to the [homes] share, even though there is no user logged in\&. Therefore, it is vital that the logon path does not include a reference to the homes share (i\&.e\&. setting this parameter to \e\e%N\ehomes\eprofile_path will cause problems)\&.

5510

.sp

5511

This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine\&.

5512

.if n \{\

5513

.sp

5514

.\}

5515

.RS 4

5516

.it 1 an-trap

5517

.nr an-no-space-flag 1

5518

.nr an-break-flag 1

5519

.br

5520

.ps +1

5521

\fBWarning\fR

5522

.ps -1

5523

.br

5524

Do not quote the value\&. Setting this as

5525

\(lq\e\e%N\eprofile\e%U\(rq

5526

will break profile handling\&. Where the tdbsam or ldapsam passdb backend is used, at the time the user account is created the value configured for this parameter is written to the passdb backend and that value will over\-ride the parameter value present in the smb\&.conf file\&. Any error present in the passdb backend account record must be editted using the appropriate tool (pdbedit on the command\-line, or any other locally provided system tool)\&.

5527

.sp .5v

5528

.RE

5529

Note that this option is only useful if Samba is set up as a domain controller\&.

5530

.sp

5531

Disable the use of roaming profiles by setting the value of this parameter to the empty string\&. For example,

5532

\m[blue]\fBlogon path = ""\fR\m[]\&. Take note that even if the default setting in the smb\&.conf file is the empty string, any value specified in the user account settings in the passdb backend will over\-ride the effect of setting this parameter to null\&. Disabling of all roaming profile use requires that the user account settings must also be blank\&.

5533

.sp

5534

An example of use is:

5535

.sp

5536

.if n \{\

5537

.RS 4

5538

.\}

5539

.nf

5540

logon path = \e\ePROFILESERVER\ePROFILE\e%U

5541

.fi

5542

.if n \{\

5543

.RE

5544

.\}

5545

.sp

5546

Default:

5547

\fI\fIlogon path\fR\fR\fI = \fR\fI\e\e%N\e%U\eprofile\fR\fI \fR

5548

.RE

5549

5550

logon script (G)

5551

.\" logon script

5552

.PP

5553

.RS 4

5554

This parameter specifies the batch file (\&.bat) or NT command file (\&.cmd) to be downloaded and run on a machine when a user successfully logs in\&. The file must contain the DOS style CR/LF line endings\&. Using a DOS\-style editor to create the file is recommended\&.

5555

.sp

5556

The script must be a relative path to the

5557

\fI[netlogon]\fR

5558

service\&. If the [netlogon] service specifies a

5559

\m[blue]\fBpath\fR\m[]

5560

5561

/usr/local/samba/netlogon, and

5562

\m[blue]\fBlogon script = STARTUP\&.BAT\fR\m[], then the file that will be downloaded is:

5563

.sp

5564

.if n \{\

5565

.RS 4

5566

.\}

5567

.nf

5568

/usr/local/samba/netlogon/STARTUP\&.BAT

5569

.fi

5570

.if n \{\

5571

.RE

5572

.\}

5573

.sp

5574

The contents of the batch file are entirely your choice\&. A suggested command would be to add

5575

NET TIME \e\eSERVER /SET /YES, to force every machine to synchronize clocks with the same time server\&. Another use would be to add

5576

NET USE U: \e\eSERVER\eUTILS

5577

for commonly used utilities, or

5578

.sp

5579

.if n \{\

5580

.RS 4

5581

.\}

5582

.nf

5583

\fBNET USE Q: \e\eSERVER\eISO9001_QA\fR

5584

.fi

5585

.if n \{\

5586

.RE

5587

.\}

5588

.sp

5589

for example\&.

5590

.sp

5591

Note that it is particularly important not to allow write access to the [netlogon] share, or to grant users write permission on the batch files in a secure environment, as this would allow the batch files to be arbitrarily modified and security to be breached\&.

5592

.sp

5593

This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine\&.

5594

.sp

5595

This option is only useful if Samba is set up as a logon server\&.

5596

.sp

5597

Default:

5598

\fI\fIlogon script\fR\fR\fI = \fR\fI\fR\fI \fR

5599

.sp

5600

Example:

5601

\fI\fIlogon script\fR\fR\fI = \fR\fIscripts\e%U\&.bat\fR\fI \fR

5602

.RE

5603

5604

log writeable files on exit (G)

5605

.\" log writeable files on exit

5606

.PP

5607

.RS 4

5608

When the network connection between a CIFS client and Samba dies, Samba has no option but to simply shut down the server side of the network connection\&. If this happens, there is a risk of data corruption because the Windows client did not complete all write operations that the Windows application requested\&. Setting this option to "yes" makes smbd log with a level 0 message a list of all files that have been opened for writing when the network connection died\&. Those are the files that are potentially corrupted\&. It is meant as an aid for the administrator to give him a list of files to do consistency checks on\&.

5609

.sp

5610

Default:

5611

\fI\fIlog writeable files on exit\fR\fR\fI = \fR\fIno\fR\fI \fR

5612

.RE

5613

5614

lppause command (S)

5615

.\" lppause command

5616

.PP

5617

.RS 4

5618

This parameter specifies the command to be executed on the server host in order to stop printing or spooling a specific print job\&.

5619

.sp

5620

This command should be a program or script which takes a printer name and job number to pause the print job\&. One way of implementing this is by using job priorities, where jobs having a too low priority won\'t be sent to the printer\&.

5621

.sp

5622

If a

5623

\fI%p\fR

5624

is given then the printer name is put in its place\&. A

5625

\fI%j\fR

5626

is replaced with the job number (an integer)\&. On HPUX (see

5627

\fIprinting=hpux \fR), if the

5628

\fI\-p%p\fR

5629

option is added to the lpq command, the job will show up with the correct status, i\&.e\&. if the job priority is lower than the set fence priority it will have the PAUSED status, whereas if the priority is equal or higher it will have the SPOOLED or PRINTING status\&.

5630

.sp

5631

Note that it is good practice to include the absolute path in the lppause command as the PATH may not be available to the server\&.

5632

.sp

5633

Default:

5634

\fI\fIlppause command\fR\fR\fI = \fR\fI # Currently no default value is given to this string, unless the value of the \m[blue]\fBprinting\fR\m[] parameter is \fBSYSV\fR, in which case the default is : lp \-i %p\-%j \-H hold or if the value of the \fIprinting\fR parameter is \fBSOFTQ\fR, then the default is: qstat \-s \-j%j \-h\&. \fR\fI \fR

5635

.sp

5636

Example:

5637

\fI\fIlppause command\fR\fR\fI = \fR\fI/usr/bin/lpalt %p\-%j \-p0\fR\fI \fR

5638

.RE

5639

5640

lpq cache time (G)

5641

.\" lpq cache time

5642

.PP

5643

.RS 4

5644

This controls how long lpq info will be cached for to prevent the

5645

lpq

5646

command being called too often\&. A separate cache is kept for each variation of the

5647

lpq

5648

command used by the system, so if you use different

5649

lpq

5650

commands for different users then they won\'t share cache information\&.

5651

.sp

5652

The cache files are stored in

5653

/tmp/lpq\&.xxxx

5654

where xxxx is a hash of the

5655

lpq

5656

command in use\&.

5657

.sp

5658

The default is 30 seconds, meaning that the cached results of a previous identical

5659

lpq

5660

command will be used if the cached data is less than 30 seconds old\&. A large value may be advisable if your

5661

lpq

5662

command is very slow\&.

5663

.sp

5664

A value of 0 will disable caching completely\&.

5665

.sp

5666

Default:

5667

\fI\fIlpq cache time\fR\fR\fI = \fR\fI30\fR\fI \fR

5668

.sp

5669

Example:

5670

\fI\fIlpq cache time\fR\fR\fI = \fR\fI10\fR\fI \fR

5671

.RE

5672

5673

lpq command (S)

5674

.\" lpq command

5675

.PP

5676

.RS 4

5677

This parameter specifies the command to be executed on the server host in order to obtain

5678

lpq\-style printer status information\&.

5679

.sp

5680

This command should be a program or script which takes a printer name as its only parameter and outputs printer status information\&.

5681

.sp

5682

Currently nine styles of printer status information are supported; BSD, AIX, LPRNG, PLP, SYSV, HPUX, QNX, CUPS, and SOFTQ\&. This covers most UNIX systems\&. You control which type is expected using the

5683

\fIprinting =\fR

5684

option\&.

5685

.sp

5686

Some clients (notably Windows for Workgroups) may not correctly send the connection number for the printer they are requesting status information about\&. To get around this, the server reports on the first printer service connected to by the client\&. This only happens if the connection number sent is invalid\&.

5687

.sp

5688

If a

5689

\fI%p\fR

5690

is given then the printer name is put in its place\&. Otherwise it is placed at the end of the command\&.

5691

.sp

5692

Note that it is good practice to include the absolute path in the

5693

\fIlpq command\fR

5694

as the

5695

\fB$PATH \fR

5696

may not be available to the server\&. When compiled with the CUPS libraries, no

5697

\fIlpq command\fR

5698

is needed because smbd will make a library call to obtain the print queue listing\&.

5699

.sp

5700

Default:

5701

\fI\fIlpq command\fR\fR\fI = \fR\fI\fR\fI \fR

5702

.sp

5703

Example:

5704

\fI\fIlpq command\fR\fR\fI = \fR\fI/usr/bin/lpq \-P%p\fR\fI \fR

5705

.RE

5706

5707

lpresume command (S)

5708

.\" lpresume command

5709

.PP

5710

.RS 4

5711

This parameter specifies the command to be executed on the server host in order to restart or continue printing or spooling a specific print job\&.

5712

.sp

5713

This command should be a program or script which takes a printer name and job number to resume the print job\&. See also the

5714

\m[blue]\fBlppause command\fR\m[]

5715

parameter\&.

5716

.sp

5717

If a

5718

\fI%p\fR

5719

is given then the printer name is put in its place\&. A

5720

\fI%j\fR

5721

is replaced with the job number (an integer)\&.

5722

.sp

5723

Note that it is good practice to include the absolute path in the

5724

\fIlpresume command\fR

5725

as the PATH may not be available to the server\&.

5726

.sp

5727

See also the

5728

\m[blue]\fBprinting\fR\m[]

5729

parameter\&.

5730

.sp

5731

Default: Currently no default value is given to this string, unless the value of the

5732

\fIprinting\fR

5733

parameter is

5734

\fBSYSV\fR, in which case the default is:

5735

.sp

5736

lp \-i %p\-%j \-H resume

5737

.sp

5738

or if the value of the

5739

\fIprinting\fR

5740

parameter is

5741

\fBSOFTQ\fR, then the default is:

5742

.sp

5743

qstat \-s \-j%j \-r

5744

.sp

5745

\fINo default\fR

5746

.sp

5747

Example:

5748

\fI\fIlpresume command\fR\fR\fI = \fR\fI/usr/bin/lpalt %p\-%j \-p2\fR\fI \fR

5749

.RE

5750

5751

lprm command (S)

5752

.\" lprm command

5753

.PP

5754

.RS 4

5755

This parameter specifies the command to be executed on the server host in order to delete a print job\&.

5756

.sp

5757

This command should be a program or script which takes a printer name and job number, and deletes the print job\&.

5758

.sp

5759

If a

5760

\fI%p\fR

5761

is given then the printer name is put in its place\&. A

5762

\fI%j\fR

5763

is replaced with the job number (an integer)\&.

5764

.sp

5765

Note that it is good practice to include the absolute path in the

5766

\fIlprm command\fR

5767

as the PATH may not be available to the server\&.

5768

.sp

5769

Examples of use are:

5770

.sp

5771

.if n \{\

5772

.RS 4

5773

.\}

5774

.nf

5775

lprm command = /usr/bin/lprm \-P%p %j

5776

5777

5778

5779

lprm command = /usr/bin/cancel %p\-%j

5780

.fi

5781

.if n \{\

5782

.RE

5783

.\}

5784

.sp

5785

Default:

5786

\fI\fIlprm command\fR\fR\fI = \fR\fI determined by printing parameter\fR\fI \fR

5787

.RE

5788

5789

machine password timeout (G)

5790

.\" machine password timeout

5791

.PP

5792

.RS 4

5793

If a Samba server is a member of a Windows NT Domain (see the

5794

\m[blue]\fBsecurity = domain\fR\m[]

5795

parameter) then periodically a running smbd process will try and change the MACHINE ACCOUNT PASSWORD stored in the TDB called

5796

private/secrets\&.tdb\&. This parameter specifies how often this password will be changed, in seconds\&. The default is one week (expressed in seconds), the same as a Windows NT Domain member server\&.

5797

.sp

5798

See also

5799

\fBsmbpasswd\fR(8), and the

5800

\m[blue]\fBsecurity = domain\fR\m[]

5801

parameter\&.

5802

.sp

5803

Default:

5804

\fI\fImachine password timeout\fR\fR\fI = \fR\fI604800\fR\fI \fR

5805

.RE

5806

5807

magic output (S)

5808

.\" magic output

5809

.PP

5810

.RS 4

5811

This parameter specifies the name of a file which will contain output created by a magic script (see the

5812

\m[blue]\fBmagic script\fR\m[]

5813

parameter below)\&.

5814

.if n \{\

5815

.sp

5816

.\}

5817

.RS 4

5818

.it 1 an-trap

5819

.nr an-no-space-flag 1

5820

.nr an-break-flag 1

5821

.br

5822

.ps +1

5823

\fBWarning\fR

5824

.ps -1

5825

.br

5826

If two clients use the same

5827

\fImagic script \fR

5828

in the same directory the output file content is undefined\&.

5829

.sp .5v

5830

.RE

5831

Default:

5832

\fI\fImagic output\fR\fR\fI = \fR\fI<magic script name>\&.out\fR\fI \fR

5833

.sp

5834

Example:

5835

\fI\fImagic output\fR\fR\fI = \fR\fImyfile\&.txt\fR\fI \fR

5836

.RE

5837

5838

magic script (S)

5839

.\" magic script

5840

.PP

5841

.RS 4

5842

This parameter specifies the name of a file which, if opened, will be executed by the server when the file is closed\&. This allows a UNIX script to be sent to the Samba host and executed on behalf of the connected user\&.

5843

.sp

5844

Scripts executed in this way will be deleted upon completion assuming that the user has the appropriate level of privilege and the file permissions allow the deletion\&.

5845

.sp

5846

If the script generates output, output will be sent to the file specified by the

5847

\m[blue]\fBmagic output\fR\m[]

5848

parameter (see above)\&.

5849

.sp

5850

Note that some shells are unable to interpret scripts containing CR/LF instead of CR as the end\-of\-line marker\&. Magic scripts must be executable

5851

\fIas is\fR

5852

on the host, which for some hosts and some shells will require filtering at the DOS end\&.

5853

.sp

5854

Magic scripts are

5855

\fIEXPERIMENTAL\fR

5856

and should

5857

\fINOT\fR

5858

be relied upon\&.

5859

.sp

5860

Default:

5861

\fI\fImagic script\fR\fR\fI = \fR\fI\fR\fI \fR

5862

.sp

5863

Example:

5864

\fI\fImagic script\fR\fR\fI = \fR\fIuser\&.csh\fR\fI \fR

5865

.RE

5866

5867

mangled names (S)

5868

.\" mangled names

5869

.PP

5870

.RS 4

5871

This controls whether non\-DOS names under UNIX should be mapped to DOS\-compatible names ("mangled") and made visible, or whether non\-DOS names should simply be ignored\&.

5872

.sp

5873

See the section on

5874

\m[blue]\fBname mangling\fR\m[]

5875

for details on how to control the mangling process\&.

5876

.sp

5877

If mangling is used then the mangling method is as follows:

5878

.sp

5879

.RS 4

5880

.ie n \{\

5881

\h'-04'\(bu\h'+03'\c

5882

.\}

5883

.el \{\

5884

.sp -1

5885

.IP \(bu 2.3

5886

.\}

5887

The first (up to) five alphanumeric characters before the rightmost dot of the filename are preserved, forced to upper case, and appear as the first (up to) five characters of the mangled name\&.

5888

.RE

5889

.sp

5890

.RS 4

5891

.ie n \{\

5892

\h'-04'\(bu\h'+03'\c

5893

.\}

5894

.el \{\

5895

.sp -1

5896

.IP \(bu 2.3

5897

.\}

5898

A tilde "~" is appended to the first part of the mangled name, followed by a two\-character unique sequence, based on the original root name (i\&.e\&., the original filename minus its final extension)\&. The final extension is included in the hash calculation only if it contains any upper case characters or is longer than three characters\&.

5899

.sp

5900

Note that the character to use may be specified using the

5901

\m[blue]\fBmangling char\fR\m[]

5902

option, if you don\'t like \'~\'\&.

5903

.RE

5904

.sp

5905

.RS 4

5906

.ie n \{\

5907

\h'-04'\(bu\h'+03'\c

5908

.\}

5909

.el \{\

5910

.sp -1

5911

.IP \(bu 2.3

5912

.\}

5913

Files whose UNIX name begins with a dot will be presented as DOS hidden files\&. The mangled name will be created as for other filenames, but with the leading dot removed and "___" as its extension regardless of actual original extension (that\'s three underscores)\&.

5914

.RE

5915

.sp

5916

.RE

5917

The two\-digit hash value consists of upper case alphanumeric characters\&.

5918

.sp

5919

This algorithm can cause name collisions only if files in a directory share the same first five alphanumeric characters\&. The probability of such a clash is 1/1300\&.

5920

.sp

5921

The name mangling (if enabled) allows a file to be copied between UNIX directories from Windows/DOS while retaining the long UNIX filename\&. UNIX files can be renamed to a new extension from Windows/DOS and will retain the same basename\&. Mangled names do not change between sessions\&.

5922

.sp

5923

Default:

5924

\fI\fImangled names\fR\fR\fI = \fR\fIyes\fR\fI \fR

5925

.RE

5926

5927

mangle prefix (G)

5928

.\" mangle prefix

5929

.PP

5930

.RS 4

5931

controls the number of prefix characters from the original name used when generating the mangled names\&. A larger value will give a weaker hash and therefore more name collisions\&. The minimum value is 1 and the maximum value is 6\&.

5932

.sp

5933

mangle prefix is effective only when mangling method is hash2\&.

5934

.sp

5935

Default:

5936

\fI\fImangle prefix\fR\fR\fI = \fR\fI1\fR\fI \fR

5937

.sp

5938

Example:

5939

\fI\fImangle prefix\fR\fR\fI = \fR\fI4\fR\fI \fR

5940

.RE

5941

5942

mangling char (S)

5943

.\" mangling char

5944

.PP

5945

.RS 4

5946

This controls what character is used as the

5947

\fImagic\fR

5948

character in

5949

\m[blue]\fBname mangling\fR\m[]\&. The default is a \'~\' but this may interfere with some software\&. Use this option to set it to whatever you prefer\&. This is effective only when mangling method is hash\&.

5950

.sp

5951

Default:

5952

\fI\fImangling char\fR\fR\fI = \fR\fI~\fR\fI \fR

5953

.sp

5954

Example:

5955

\fI\fImangling char\fR\fR\fI = \fR\fI^\fR\fI \fR

5956

.RE

5957

5958

mangling method (G)

5959

.\" mangling method

5960

.PP

5961

.RS 4

5962

controls the algorithm used for the generating the mangled names\&. Can take two different values, "hash" and "hash2"\&. "hash" is the algorithm that was used used in Samba for many years and was the default in Samba 2\&.2\&.x "hash2" is now the default and is newer and considered a better algorithm (generates less collisions) in the names\&. Many Win32 applications store the mangled names and so changing to algorithms must not be done lightly as these applications may break unless reinstalled\&.

5963

.sp

5964

Default:

5965

\fI\fImangling method\fR\fR\fI = \fR\fIhash2\fR\fI \fR

5966

.sp

5967

Example:

5968

\fI\fImangling method\fR\fR\fI = \fR\fIhash\fR\fI \fR

5969

.RE

5970

5971

map acl inherit (S)

5972

.\" map acl inherit

5973

.PP

5974

.RS 4

5975

This boolean parameter controls whether

5976

\fBsmbd\fR(8)

5977

will attempt to map the \'inherit\' and \'protected\' access control entry flags stored in Windows ACLs into an extended attribute called user\&.SAMBA_PAI\&. This parameter only takes effect if Samba is being run on a platform that supports extended attributes (Linux and IRIX so far) and allows the Windows 2000 ACL editor to correctly use inheritance with the Samba POSIX ACL mapping code\&.

5978

.sp

5979

Default:

5980

\fI\fImap acl inherit\fR\fR\fI = \fR\fIno\fR\fI \fR

5981

.RE

5982

5983

map archive (S)

5984

.\" map archive

5985

.PP

5986

.RS 4

5987

This controls whether the DOS archive attribute should be mapped to the UNIX owner execute bit\&. The DOS archive bit is set when a file has been modified since its last backup\&. One motivation for this option is to keep Samba/your PC from making any file it touches from becoming executable under UNIX\&. This can be quite annoying for shared source code, documents, etc\&.\&.\&.

5988

.sp

5989

Note that this requires the

5990

\m[blue]\fBcreate mask\fR\m[]

5991

parameter to be set such that owner execute bit is not masked out (i\&.e\&. it must include 100)\&. See the parameter

5992

\m[blue]\fBcreate mask\fR\m[]

5993

for details\&.

5994

.sp

5995

Default:

5996

\fI\fImap archive\fR\fR\fI = \fR\fIyes\fR\fI \fR

5997

.RE

5998

5999

map hidden (S)

6000

.\" map hidden

6001

.PP

6002

.RS 4

6003

This controls whether DOS style hidden files should be mapped to the UNIX world execute bit\&.

6004

.sp

6005

Note that this requires the

6006

\m[blue]\fBcreate mask\fR\m[]

6007

to be set such that the world execute bit is not masked out (i\&.e\&. it must include 001)\&. See the parameter

6008

\m[blue]\fBcreate mask\fR\m[]

6009

for details\&.

6010

.sp

6011

\fINo default\fR

6012

.RE

6013

6014

map readonly (S)

6015

.\" map readonly

6016

.PP

6017

.RS 4

6018

This controls how the DOS read only attribute should be mapped from a UNIX filesystem\&.

6019

.sp

6020

This parameter can take three different values, which tell

6021

\fBsmbd\fR(8)

6022

how to display the read only attribute on files, where either

6023

\m[blue]\fBstore dos attributes\fR\m[]

6024

is set to

6025

\fBNo\fR, or no extended attribute is present\&. If

6026

\m[blue]\fBstore dos attributes\fR\m[]

6027

is set to

6028

\fByes\fR

6029

then this parameter is

6030

\fIignored\fR\&. This is a new parameter introduced in Samba version 3\&.0\&.21\&.

6031

.sp

6032

The three settings are :

6033

.sp

6034

.RS 4

6035

.ie n \{\

6036

\h'-04'\(bu\h'+03'\c

6037

.\}

6038

.el \{\

6039

.sp -1

6040

.IP \(bu 2.3

6041

.\}

6042

6043

\fBYes\fR

6044

\- The read only DOS attribute is mapped to the inverse of the user or owner write bit in the unix permission mode set\&. If the owner write bit is not set, the read only attribute is reported as being set on the file\&. If the read only DOS attribute is set, Samba sets the owner, group and others write bits to zero\&. Write bits set in an ACL are ignored by Samba\&. If the read only DOS attribute is unset, Samba simply sets the write bit of the owner to one\&.

6045

.RE

6046

.sp

6047

.RS 4

6048

.ie n \{\

6049

\h'-04'\(bu\h'+03'\c

6050

.\}

6051

.el \{\

6052

.sp -1

6053

.IP \(bu 2.3

6054

.\}

6055

6056

\fBPermissions\fR

6057

\- The read only DOS attribute is mapped to the effective permissions of the connecting user, as evaluated by

6058

\fBsmbd\fR(8)

6059

by reading the unix permissions and POSIX ACL (if present)\&. If the connecting user does not have permission to modify the file, the read only attribute is reported as being set on the file\&.

6060

.RE

6061

.sp

6062

.RS 4

6063

.ie n \{\

6064

\h'-04'\(bu\h'+03'\c

6065

.\}

6066

.el \{\

6067

.sp -1

6068

.IP \(bu 2.3

6069

.\}

6070

6071

\fBNo\fR

6072

\- The read only DOS attribute is unaffected by permissions, and can only be set by the

6073

\m[blue]\fBstore dos attributes\fR\m[]

6074

method\&. This may be useful for exporting mounted CDs\&.

6075

.RE

6076

.sp

6077

.RE

6078

Default:

6079

\fI\fImap readonly\fR\fR\fI = \fR\fIyes\fR\fI \fR

6080

.RE

6081

6082

map system (S)

6083

.\" map system

6084

.PP

6085

.RS 4

6086

This controls whether DOS style system files should be mapped to the UNIX group execute bit\&.

6087

.sp

6088

Note that this requires the

6089

\m[blue]\fBcreate mask\fR\m[]

6090

to be set such that the group execute bit is not masked out (i\&.e\&. it must include 010)\&. See the parameter

6091

\m[blue]\fBcreate mask\fR\m[]

6092

for details\&.

6093

.sp

6094

Default:

6095

\fI\fImap system\fR\fR\fI = \fR\fIno\fR\fI \fR

6096

.RE

6097

6098

map to guest (G)

6099

.\" map to guest

6100

.PP

6101

.RS 4

6102

This parameter is only useful in

6103

\m[blue]\fBSECURITY = security\fR\m[]

6104

modes other than

6105

\fIsecurity = share\fR

6106

and

6107

\fIsecurity = server\fR

6108

\- i\&.e\&.

6109

\fBuser\fR, and

6110

\fBdomain\fR\&.

6111

.sp

6112

This parameter can take four different values, which tell

6113

\fBsmbd\fR(8)

6114

what to do with user login requests that don\'t match a valid UNIX user in some way\&.

6115

.sp

6116

The four settings are :

6117

.sp

6118

.RS 4

6119

.ie n \{\

6120

\h'-04'\(bu\h'+03'\c

6121

.\}

6122

.el \{\

6123

.sp -1

6124

.IP \(bu 2.3

6125

.\}

6126

\fBNever\fR

6127

\- Means user login requests with an invalid password are rejected\&. This is the default\&.

6128

.RE

6129

.sp

6130

.RS 4

6131

.ie n \{\

6132

\h'-04'\(bu\h'+03'\c

6133

.\}

6134

.el \{\

6135

.sp -1

6136

.IP \(bu 2.3

6137

.\}

6138

\fBBad User\fR

6139

\- Means user logins with an invalid password are rejected, unless the username does not exist, in which case it is treated as a guest login and mapped into the

6140

\m[blue]\fBguest account\fR\m[]\&.

6141

.RE

6142

.sp

6143

.RS 4

6144

.ie n \{\

6145

\h'-04'\(bu\h'+03'\c

6146

.\}

6147

.el \{\

6148

.sp -1

6149

.IP \(bu 2.3

6150

.\}

6151

\fBBad Password\fR

6152

\- Means user logins with an invalid password are treated as a guest login and mapped into the

6153

\m[blue]\fBguest account\fR\m[]\&. Note that this can cause problems as it means that any user incorrectly typing their password will be silently logged on as "guest" \- and will not know the reason they cannot access files they think they should \- there will have been no message given to them that they got their password wrong\&. Helpdesk services will

6154

\fIhate\fR

6155

you if you set the

6156

\fImap to guest\fR

6157

parameter this way :\-)\&.

6158

.RE

6159

.sp

6160

.RS 4

6161

.ie n \{\

6162

\h'-04'\(bu\h'+03'\c

6163

.\}

6164

.el \{\

6165

.sp -1

6166

.IP \(bu 2.3

6167

.\}

6168

\fBBad Uid\fR

6169

\- Is only applicable when Samba is configured in some type of domain mode security (security = {domain|ads}) and means that user logins which are successfully authenticated but which have no valid Unix user account (and smbd is unable to create one) should be mapped to the defined guest account\&. This was the default behavior of Samba 2\&.x releases\&. Note that if a member server is running winbindd, this option should never be required because the nss_winbind library will export the Windows domain users and groups to the underlying OS via the Name Service Switch interface\&.

6170

.RE

6171

.sp

6172

.RE

6173

Note that this parameter is needed to set up "Guest" share services when using

6174

\fIsecurity\fR

6175

modes other than share and server\&. This is because in these modes the name of the resource being requested is

6176

\fInot\fR

6177

sent to the server until after the server has successfully authenticated the client so the server cannot make authentication decisions at the correct time (connection to the share) for "Guest" shares\&. This parameter is not useful with

6178

\fIsecurity = server\fR

6179

as in this security mode no information is returned about whether a user logon failed due to a bad username or bad password, the same error is returned from a modern server in both cases\&.

6180

.sp

6181

For people familiar with the older Samba releases, this parameter maps to the old compile\-time setting of the

6182

\fB GUEST_SESSSETUP\fR

6183

value in local\&.h\&.

6184

.sp

6185

Default:

6186

\fI\fImap to guest\fR\fR\fI = \fR\fINever\fR\fI \fR

6187

.sp

6188

Example:

6189

\fI\fImap to guest\fR\fR\fI = \fR\fIBad User\fR\fI \fR

6190

.RE

6191

6192

map untrusted to domain (G)

6193

.\" map untrusted to domain

6194

.PP

6195

.RS 4

6196

If a client connects to smbd using an untrusted domain name, such as BOGUS\euser, smbd replaces the BOGUS domain with it\'s SAM name before attempting to authenticate that user\&. In the case where smbd is acting as a PDC this will be DOMAIN\euser\&. In the case where smbd is acting as a domain member server or a standalone server this will be WORKSTATION\euser\&.

6197

.sp

6198

In previous versions of Samba (pre 3\&.4), if smbd was acting as a domain member server, the BOGUS domain name would instead be replaced by the primary domain which smbd was a member of\&. In this case authentication would be deferred off to a DC using the credentials DOMAIN\euser\&.

6199

.sp

6200

When this parameter is set to

6201

\fByes\fR

6202

smbd provides the legacy behavior of mapping untrusted domain names to the primary domain\&. When smbd is not acting as a domain member server, this parameter has no effect\&.

6203

.sp

6204

Default:

6205

\fI\fImap untrusted to domain\fR\fR\fI = \fR\fIno\fR\fI \fR

6206

.RE

6207

6208

max connections (S)

6209

.\" max connections

6210

.PP

6211

.RS 4

6212

This option allows the number of simultaneous connections to a service to be limited\&. If

6213

\fImax connections\fR

6214

is greater than 0 then connections will be refused if this number of connections to the service are already open\&. A value of zero mean an unlimited number of connections may be made\&.

6215

.sp

6216

Record lock files are used to implement this feature\&. The lock files will be stored in the directory specified by the

6217

\m[blue]\fBlock directory\fR\m[]

6218

option\&.

6219

.sp

6220

Default:

6221

\fI\fImax connections\fR\fR\fI = \fR\fI0\fR\fI \fR

6222

.sp

6223

Example:

6224

\fI\fImax connections\fR\fR\fI = \fR\fI10\fR\fI \fR

6225

.RE

6226

6227

max disk size (G)

6228

.\" max disk size

6229

.PP

6230

.RS 4

6231

This option allows you to put an upper limit on the apparent size of disks\&. If you set this option to 100 then all shares will appear to be not larger than 100 MB in size\&.

6232

.sp

6233

Note that this option does not limit the amount of data you can put on the disk\&. In the above case you could still store much more than 100 MB on the disk, but if a client ever asks for the amount of free disk space or the total disk size then the result will be bounded by the amount specified in

6234

\fImax disk size\fR\&.

6235

.sp

6236

This option is primarily useful to work around bugs in some pieces of software that can\'t handle very large disks, particularly disks over 1GB in size\&.

6237

.sp

6238

6239

\fImax disk size\fR

6240

of 0 means no limit\&.

6241

.sp

6242

Default:

6243

\fI\fImax disk size\fR\fR\fI = \fR\fI0\fR\fI \fR

6244

.sp

6245

Example:

6246

\fI\fImax disk size\fR\fR\fI = \fR\fI1000\fR\fI \fR

6247

.RE

6248

6249

max log size (G)

6250

.\" max log size

6251

.PP

6252

.RS 4

6253

This option (an integer in kilobytes) specifies the max size the log file should grow to\&. Samba periodically checks the size and if it is exceeded it will rename the file, adding a

6254

\&.old

6255

extension\&.

6256

.sp

6257

A size of 0 means no limit\&.

6258

.sp

6259

Default:

6260

\fI\fImax log size\fR\fR\fI = \fR\fI5000\fR\fI \fR

6261

.sp

6262

Example:

6263

\fI\fImax log size\fR\fR\fI = \fR\fI1000\fR\fI \fR

6264

.RE

6265

6266

max mux (G)

6267

.\" max mux

6268

.PP

6269

.RS 4

6270

This option controls the maximum number of outstanding simultaneous SMB operations that Samba tells the client it will allow\&. You should never need to set this parameter\&.

6271

.sp

6272

Default:

6273

\fI\fImax mux\fR\fR\fI = \fR\fI50\fR\fI \fR

6274

.RE

6275

6276

max open files (G)

6277

.\" max open files

6278

.PP

6279

.RS 4

6280

This parameter limits the maximum number of open files that one

6281

\fBsmbd\fR(8)

6282

file serving process may have open for a client at any one time\&. The This parameter can be set very high (16404) as Samba uses only one bit per unopened file\&. Setting this parameter lower than 16404 will cause Samba to complain and set this value back to the minimum of 16404, as Windows 7 depends on this number of open file handles being available\&.

6283

.sp

6284

The limit of the number of open files is usually set by the UNIX per\-process file descriptor limit rather than this parameter so you should never need to touch this parameter\&.

6285

.sp

6286

Default:

6287

\fI\fImax open files\fR\fR\fI = \fR\fI16404\fR\fI \fR

6288

.RE

6289

6290

max print jobs (S)

6291

.\" max print jobs

6292

.PP

6293

.RS 4

6294

This parameter limits the maximum number of jobs allowable in a Samba printer queue at any given moment\&. If this number is exceeded,

6295

\fBsmbd\fR(8)

6296

will remote "Out of Space" to the client\&.

6297

.sp

6298

Default:

6299

\fI\fImax print jobs\fR\fR\fI = \fR\fI1000\fR\fI \fR

6300

.sp

6301

Example:

6302

\fI\fImax print jobs\fR\fR\fI = \fR\fI5000\fR\fI \fR

6303

.RE

6304

6305

protocol

6306

.\" protocol

6307

.PP

6308

.RS 4

6309

This parameter is a synonym for

6310

max protocol\&.

6311

.RE

6312

6313

max protocol (G)

6314

.\" max protocol

6315

.PP

6316

.RS 4

6317

The value of the parameter (a string) is the highest protocol level that will be supported by the server\&.

6318

.sp

6319

Possible values are :

6320

.sp

6321

.RS 4

6322

.ie n \{\

6323

\h'-04'\(bu\h'+03'\c

6324

.\}

6325

.el \{\

6326

.sp -1

6327

.IP \(bu 2.3

6328

.\}

6329

\fBCORE\fR: Earliest version\&. No concept of user names\&.

6330

.RE

6331

.sp

6332

.RS 4

6333

.ie n \{\

6334

\h'-04'\(bu\h'+03'\c

6335

.\}

6336

.el \{\

6337

.sp -1

6338

.IP \(bu 2.3

6339

.\}

6340

\fBCOREPLUS\fR: Slight improvements on CORE for efficiency\&.

6341

.RE

6342

.sp

6343

.RS 4

6344

.ie n \{\

6345

\h'-04'\(bu\h'+03'\c

6346

.\}

6347

.el \{\

6348

.sp -1

6349

.IP \(bu 2.3

6350

.\}

6351

\fBLANMAN1\fR: First

6352

\fI modern\fR

6353

version of the protocol\&. Long filename support\&.

6354

.RE

6355

.sp

6356

.RS 4

6357

.ie n \{\

6358

\h'-04'\(bu\h'+03'\c

6359

.\}

6360

.el \{\

6361

.sp -1

6362

.IP \(bu 2.3

6363

.\}

6364

\fBLANMAN2\fR: Updates to Lanman1 protocol\&.

6365

.RE

6366

.sp

6367

.RS 4

6368

.ie n \{\

6369

\h'-04'\(bu\h'+03'\c

6370

.\}

6371

.el \{\

6372

.sp -1

6373

.IP \(bu 2.3

6374

.\}

6375

\fBNT1\fR: Current up to date version of the protocol\&. Used by Windows NT\&. Known as CIFS\&.

6376

.RE

6377

.sp

6378

.RS 4

6379

.ie n \{\

6380

\h'-04'\(bu\h'+03'\c

6381

.\}

6382

.el \{\

6383

.sp -1

6384

.IP \(bu 2.3

6385

.\}

6386

\fBSMB2\fR: Re\-implementation of the SMB protocol\&. Used by Windows Vista and newer\&. The Samba implementation of SMB2 is currently marked experimental!

6387

.RE

6388

.sp

6389

.RE

6390

Normally this option should not be set as the automatic negotiation phase in the SMB protocol takes care of choosing the appropriate protocol\&.

6391

.sp

6392

Default:

6393

\fI\fImax protocol\fR\fR\fI = \fR\fINT1\fR\fI \fR

6394

.sp

6395

Example:

6396

\fI\fImax protocol\fR\fR\fI = \fR\fILANMAN1\fR\fI \fR

6397

.RE

6398

6399

max reported print jobs (S)

6400

.\" max reported print jobs

6401

.PP

6402

.RS 4

6403

This parameter limits the maximum number of jobs displayed in a port monitor for Samba printer queue at any given moment\&. If this number is exceeded, the excess jobs will not be shown\&. A value of zero means there is no limit on the number of print jobs reported\&.

6404

.sp

6405

Default:

6406

\fI\fImax reported print jobs\fR\fR\fI = \fR\fI0\fR\fI \fR

6407

.sp

6408

Example:

6409

\fI\fImax reported print jobs\fR\fR\fI = \fR\fI1000\fR\fI \fR

6410

.RE

6411

6412

max smbd processes (G)

6413

.\" max smbd processes

6414

.PP

6415

.RS 4

6416

This parameter limits the maximum number of

6417

\fBsmbd\fR(8)

6418

processes concurrently running on a system and is intended as a stopgap to prevent degrading service to clients in the event that the server has insufficient resources to handle more than this number of connections\&. Remember that under normal operating conditions, each user will have an

6419

\fBsmbd\fR(8)

6420

associated with him or her to handle connections to all shares from a given host\&.

6421

.sp

6422

Default:

6423

\fI\fImax smbd processes\fR\fR\fI = \fR\fI0\fR\fI \fR

6424

.sp

6425

Example:

6426

\fI\fImax smbd processes\fR\fR\fI = \fR\fI1000\fR\fI \fR

6427

.RE

6428

6429

max stat cache size (G)

6430

.\" max stat cache size

6431

.PP

6432

.RS 4

6433

This parameter limits the size in memory of any

6434

\fIstat cache\fR

6435

being used to speed up case insensitive name mappings\&. It represents the number of kilobyte (1024) units the stat cache can use\&. A value of zero, meaning unlimited, is not advisable due to increased memory useage\&. You should not need to change this parameter\&.

6436

.sp

6437

Default:

6438

\fI\fImax stat cache size\fR\fR\fI = \fR\fI256\fR\fI \fR

6439

.sp

6440

Example:

6441

\fI\fImax stat cache size\fR\fR\fI = \fR\fI100\fR\fI \fR

6442

.RE

6443

6444

max ttl (G)

6445

.\" max ttl

6446

.PP

6447

.RS 4

6448

This option tells

6449

\fBnmbd\fR(8)

6450

what the default \'time to live\' of NetBIOS names should be (in seconds) when

6451

nmbd

6452

is requesting a name using either a broadcast packet or from a WINS server\&. You should never need to change this parameter\&. The default is 3 days\&.

6453

.sp

6454

Default:

6455

\fI\fImax ttl\fR\fR\fI = \fR\fI259200\fR\fI \fR

6456

.RE

6457

6458

max wins ttl (G)

6459

.\" max wins ttl

6460

.PP

6461

.RS 4

6462

This option tells

6463

\fBsmbd\fR(8)

6464

when acting as a WINS server (\m[blue]\fBwins support = yes\fR\m[]) what the maximum \'time to live\' of NetBIOS names that

6465

nmbd

6466

will grant will be (in seconds)\&. You should never need to change this parameter\&. The default is 6 days (518400 seconds)\&.

6467

.sp

6468

Default:

6469

\fI\fImax wins ttl\fR\fR\fI = \fR\fI518400\fR\fI \fR

6470

.RE

6471

6472

max xmit (G)

6473

.\" max xmit

6474

.PP

6475

.RS 4

6476

This option controls the maximum packet size that will be negotiated by Samba\&. The default is 16644, which matches the behavior of Windows 2000\&. A value below 2048 is likely to cause problems\&. You should never need to change this parameter from its default value\&.

6477

.sp

6478

Default:

6479

\fI\fImax xmit\fR\fR\fI = \fR\fI16644\fR\fI \fR

6480

.sp

6481

Example:

6482

\fI\fImax xmit\fR\fR\fI = \fR\fI8192\fR\fI \fR

6483

.RE

6484

6485

message command (G)

6486

.\" message command

6487

.PP

6488

.RS 4

6489

This specifies what command to run when the server receives a WinPopup style message\&.

6490

.sp

6491

This would normally be a command that would deliver the message somehow\&. How this is to be done is up to your imagination\&.

6492

.sp

6493

An example is:

6494

.sp

6495

.if n \{\

6496

.RS 4

6497

.\}

6498

.nf

6499

message command = csh \-c \'xedit %s;rm %s\' &

6500

.fi

6501

.if n \{\

6502

.RE

6503

.\}

6504

.sp

6505

This delivers the message using

6506

xedit, then removes it afterwards\&.

6507

\fINOTE THAT IT IS VERY IMPORTANT THAT THIS COMMAND RETURN IMMEDIATELY\fR\&. That\'s why I have the \'&\' on the end\&. If it doesn\'t return immediately then your PCs may freeze when sending messages (they should recover after 30 seconds, hopefully)\&.

6508

.sp

6509

All messages are delivered as the global guest user\&. The command takes the standard substitutions, although

6510

\fI %u\fR

6511

won\'t work (\fI%U\fR

6512

may be better in this case)\&.

6513

.sp

6514

Apart from the standard substitutions, some additional ones apply\&. In particular:

6515

.sp

6516

.RS 4

6517

.ie n \{\

6518

\h'-04'\(bu\h'+03'\c

6519

.\}

6520

.el \{\

6521

.sp -1

6522

.IP \(bu 2.3

6523

.\}

6524

\fI%s\fR

6525

= the filename containing the message\&.

6526

.RE

6527

.sp

6528

.RS 4

6529

.ie n \{\

6530

\h'-04'\(bu\h'+03'\c

6531

.\}

6532

.el \{\

6533

.sp -1

6534

.IP \(bu 2.3

6535

.\}

6536

\fI%t\fR

6537

= the destination that the message was sent to (probably the server name)\&.

6538

.RE

6539

.sp

6540

.RS 4

6541

.ie n \{\

6542

\h'-04'\(bu\h'+03'\c

6543

.\}

6544

.el \{\

6545

.sp -1

6546

.IP \(bu 2.3

6547

.\}

6548

\fI%f\fR

6549

= who the message is from\&.

6550

.RE

6551

.sp

6552

.RE

6553

You could make this command send mail, or whatever else takes your fancy\&. Please let us know of any really interesting ideas you have\&.

6554

.sp

6555

Here\'s a way of sending the messages as mail to root:

6556

.sp

6557

.if n \{\

6558

.RS 4

6559

.\}

6560

.nf

6561

message command = /bin/mail \-s \'message from %f on %m\' root < %s; rm %s

6562

.fi

6563

.if n \{\

6564

.RE

6565

.\}

6566

.sp

6567

If you don\'t have a message command then the message won\'t be delivered and Samba will tell the sender there was an error\&. Unfortunately WfWg totally ignores the error code and carries on regardless, saying that the message was delivered\&.

6568

.sp

6569

If you want to silently delete it then try:

6570

.sp

6571

.if n \{\

6572

.RS 4

6573

.\}

6574

.nf

6575

message command = rm %s

6576

.fi

6577

.if n \{\

6578

.RE

6579

.\}

6580

.sp

6581

Default:

6582

\fI\fImessage command\fR\fR\fI = \fR\fI\fR\fI \fR

6583

.sp

6584

Example:

6585

\fI\fImessage command\fR\fR\fI = \fR\fIcsh \-c \'xedit %s; rm %s\' &\fR\fI \fR

6586

.RE

6587

6588

min print space (S)

6589

.\" min print space

6590

.PP

6591

.RS 4

6592

This sets the minimum amount of free disk space that must be available before a user will be able to spool a print job\&. It is specified in kilobytes\&. The default is 0, which means a user can always spool a print job\&.

6593

.sp

6594

Default:

6595

\fI\fImin print space\fR\fR\fI = \fR\fI0\fR\fI \fR

6596

.sp

6597

Example:

6598

\fI\fImin print space\fR\fR\fI = \fR\fI2000\fR\fI \fR

6599

.RE

6600

6601

min protocol (G)

6602

.\" min protocol

6603

.PP

6604

.RS 4

6605

The value of the parameter (a string) is the lowest SMB protocol dialect than Samba will support\&. Please refer to the

6606

\m[blue]\fBmax protocol\fR\m[]

6607

parameter for a list of valid protocol names and a brief description of each\&. You may also wish to refer to the C source code in

6608

source/smbd/negprot\&.c

6609

for a listing of known protocol dialects supported by clients\&.

6610

.sp

6611

If you are viewing this parameter as a security measure, you should also refer to the

6612

\m[blue]\fBlanman auth\fR\m[]

6613

parameter\&. Otherwise, you should never need to change this parameter\&.

6614

.sp

6615

Default:

6616

\fI\fImin protocol\fR\fR\fI = \fR\fICORE\fR\fI \fR

6617

.sp

6618

Example:

6619

\fI\fImin protocol\fR\fR\fI = \fR\fINT1\fR\fI \fR

6620

.RE

6621

6622

min receivefile size (G)

6623

.\" min receivefile size

6624

.PP

6625

.RS 4

6626

This option changes the behavior of

6627

\fBsmbd\fR(8)

6628

when processing SMBwriteX calls\&. Any incoming SMBwriteX call on a non\-signed SMB/CIFS connection greater than this value will not be processed in the normal way but will be passed to any underlying kernel recvfile or splice system call (if there is no such call Samba will emulate in user space)\&. This allows zero\-copy writes directly from network socket buffers into the filesystem buffer cache, if available\&. It may improve performance but user testing is recommended\&. If set to zero Samba processes SMBwriteX calls in the normal way\&. To enable POSIX large write support (SMB/CIFS writes up to 16Mb) this option must be nonzero\&. The maximum value is 128k\&. Values greater than 128k will be silently set to 128k\&.

6629

.sp

6630

Note this option will have NO EFFECT if set on a SMB signed connection\&.

6631

.sp

6632

The default is zero, which diables this option\&.

6633

.sp

6634

Default:

6635

\fI\fImin receivefile size\fR\fR\fI = \fR\fI0\fR\fI \fR

6636

.RE

6637

6638

min wins ttl (G)

6639

.\" min wins ttl

6640

.PP

6641

.RS 4

6642

This option tells

6643

\fBnmbd\fR(8)

6644

when acting as a WINS server (\m[blue]\fBwins support = yes\fR\m[]) what the minimum \'time to live\' of NetBIOS names that

6645

nmbd

6646

will grant will be (in seconds)\&. You should never need to change this parameter\&. The default is 6 hours (21600 seconds)\&.

6647

.sp

6648

Default:

6649

\fI\fImin wins ttl\fR\fR\fI = \fR\fI21600\fR\fI \fR

6650

.RE

6651

6652

msdfs proxy (S)

6653

.\" msdfs proxy

6654

.PP

6655

.RS 4

6656

This parameter indicates that the share is a stand\-in for another CIFS share whose location is specified by the value of the parameter\&. When clients attempt to connect to this share, they are redirected to the proxied share using the SMB\-Dfs protocol\&.

6657

.sp

6658

Only Dfs roots can act as proxy shares\&. Take a look at the

6659

\m[blue]\fBmsdfs root\fR\m[]

6660

and

6661

\m[blue]\fBhost msdfs\fR\m[]

6662

options to find out how to set up a Dfs root share\&.

6663

.sp

6664

\fINo default\fR

6665

.sp

6666

Example:

6667

\fI\fImsdfs proxy\fR\fR\fI = \fR\fI\eotherserver\esomeshare\fR\fI \fR

6668

.RE

6669

6670

msdfs root (S)

6671

.\" msdfs root

6672

.PP

6673

.RS 4

6674

If set to

6675

\fByes\fR, Samba treats the share as a Dfs root and allows clients to browse the distributed file system tree rooted at the share directory\&. Dfs links are specified in the share directory by symbolic links of the form

6676

msdfs:serverA\e\eshareA,serverB\e\eshareB

6677

and so on\&. For more information on setting up a Dfs tree on Samba, refer to the MSDFS chapter in the Samba3\-HOWTO book\&.

6678

.sp

6679

Default:

6680

\fI\fImsdfs root\fR\fR\fI = \fR\fIno\fR\fI \fR

6681

.RE

6682

6683

multicast dns register (G)

6684

.\" multicast dns register

6685

.PP

6686

.RS 4

6687

If compiled with proper support for it, Samba will announce itself with multicast DNS services like for example provided by the Avahi daemon\&.

6688

.sp

6689

This parameter allows disabling Samba to register itself\&.

6690

.sp

6691

Default:

6692

\fI\fImulticast dns register\fR\fR\fI = \fR\fIyes\fR\fI \fR

6693

.RE

6694

6695

name cache timeout (G)

6696

.\" name cache timeout

6697

.PP

6698

.RS 4

6699

Specifies the number of seconds it takes before entries in samba\'s hostname resolve cache time out\&. If the timeout is set to 0\&. the caching is disabled\&.

6700

.sp

6701

Default:

6702

\fI\fIname cache timeout\fR\fR\fI = \fR\fI660\fR\fI \fR

6703

.sp

6704

Example:

6705

\fI\fIname cache timeout\fR\fR\fI = \fR\fI0\fR\fI \fR

6706

.RE

6707

6708

name resolve order (G)

6709

.\" name resolve order

6710

.PP

6711

.RS 4

6712

This option is used by the programs in the Samba suite to determine what naming services to use and in what order to resolve host names to IP addresses\&. Its main purpose to is to control how netbios name resolution is performed\&. The option takes a space separated string of name resolution options\&.

6713

.sp

6714

The options are: "lmhosts", "host", "wins" and "bcast"\&. They cause names to be resolved as follows:

6715

.sp

6716

.RS 4

6717

.ie n \{\

6718

\h'-04'\(bu\h'+03'\c

6719

.\}

6720

.el \{\

6721

.sp -1

6722

.IP \(bu 2.3

6723

.\}

6724

6725

\fBlmhosts\fR

6726

: Lookup an IP address in the Samba lmhosts file\&. If the line in lmhosts has no name type attached to the NetBIOS name (see the manpage for lmhosts for details) then any name type matches for lookup\&.

6727

.RE

6728

.sp

6729

.RS 4

6730

.ie n \{\

6731

\h'-04'\(bu\h'+03'\c

6732

.\}

6733

.el \{\

6734

.sp -1

6735

.IP \(bu 2.3

6736

.\}

6737

6738

\fBhost\fR

6739

: Do a standard host name to IP address resolution, using the system

6740

/etc/hosts, NIS, or DNS lookups\&. This method of name resolution is operating system depended for instance on IRIX or Solaris this may be controlled by the

6741

/etc/nsswitch\&.conf

6742

file\&. Note that this method is used only if the NetBIOS name type being queried is the 0x20 (server) name type or 0x1c (domain controllers)\&. The latter case is only useful for active directory domains and results in a DNS query for the SRV RR entry matching _ldap\&._tcp\&.domain\&.

6743

.RE

6744

.sp

6745

.RS 4

6746

.ie n \{\

6747

\h'-04'\(bu\h'+03'\c

6748

.\}

6749

.el \{\

6750

.sp -1

6751

.IP \(bu 2.3

6752

.\}

6753

\fBwins\fR

6754

: Query a name with the IP address listed in the

6755

\m[blue]\fBWINSSERVER\fR\m[]

6756

parameter\&. If no WINS server has been specified this method will be ignored\&.

6757

.RE

6758

.sp

6759

.RS 4

6760

.ie n \{\

6761

\h'-04'\(bu\h'+03'\c

6762

.\}

6763

.el \{\

6764

.sp -1

6765

.IP \(bu 2.3

6766

.\}

6767

\fBbcast\fR

6768

: Do a broadcast on each of the known local interfaces listed in the

6769

\m[blue]\fBinterfaces\fR\m[]

6770

parameter\&. This is the least reliable of the name resolution methods as it depends on the target host being on a locally connected subnet\&.

6771

.RE

6772

.sp

6773

.RE

6774

The example below will cause the local lmhosts file to be examined first, followed by a broadcast attempt, followed by a normal system hostname lookup\&.

6775

.sp

6776

When Samba is functioning in ADS security mode (security = ads) it is advised to use following settings for

6777

\fIname resolve order\fR:

6778

.sp

6779

name resolve order = wins bcast

6780

.sp

6781

DC lookups will still be done via DNS, but fallbacks to netbios names will not inundate your DNS servers with needless querys for DOMAIN<0x1c> lookups\&.

6782

.sp

6783

Default:

6784

\fI\fIname resolve order\fR\fR\fI = \fR\fIlmhosts host wins bcast\fR\fI \fR

6785

.sp

6786

Example:

6787

\fI\fIname resolve order\fR\fR\fI = \fR\fIlmhosts bcast host\fR\fI \fR

6788

.RE

6789

6790

ncalrpc dir (G)

6791

.\" ncalrpc dir

6792

.PP

6793

.RS 4

6794

This directory will hold a series of named pipes to allow RPC over inter\-process communication\&.

6795

.sp

6796

\&.

6797

This will allow Samba and other unix processes to interact over DCE/RPC without using TCP/IP\&. Additionally a sub\-directory \'np\' has restricted permissions, and allows a trusted communication channel between Samba processes

6798

.sp

6799

Default:

6800

\fI\fIncalrpc dir\fR\fR\fI = \fR\fI${prefix}/var/ncalrpc\fR\fI \fR

6801

.sp

6802

Example:

6803

\fI\fIncalrpc dir\fR\fR\fI = \fR\fI/var/run/samba/ncalrpc\fR\fI \fR

6804

.RE

6805

6806

netbios aliases (G)

6807

.\" netbios aliases

6808

.PP

6809

.RS 4

6810

This is a list of NetBIOS names that nmbd will advertise as additional names by which the Samba server is known\&. This allows one machine to appear in browse lists under multiple names\&. If a machine is acting as a browse server or logon server none of these names will be advertised as either browse server or logon servers, only the primary name of the machine will be advertised with these capabilities\&.

6811

.sp

6812

Default:

6813

\fI\fInetbios aliases\fR\fR\fI = \fR\fI # empty string (no additional names)\fR\fI \fR

6814

.sp

6815

Example:

6816

\fI\fInetbios aliases\fR\fR\fI = \fR\fITEST TEST1 TEST2\fR\fI \fR

6817

.RE

6818

6819

netbios name (G)

6820

.\" netbios name

6821

.PP

6822

.RS 4

6823

This sets the NetBIOS name by which a Samba server is known\&. By default it is the same as the first component of the host\'s DNS name\&. If a machine is a browse server or logon server this name (or the first component of the hosts DNS name) will be the name that these services are advertised under\&.

6824

.sp

6825

There is a bug in Samba\-3 that breaks operation of browsing and access to shares if the netbios name is set to the literal name

6826

PIPE\&. To avoid this problem, do not name your Samba\-3 server

6827

PIPE\&.

6828

.sp

6829

Default:

6830

\fI\fInetbios name\fR\fR\fI = \fR\fI # machine DNS name\fR\fI \fR

6831

.sp

6832

Example:

6833

\fI\fInetbios name\fR\fR\fI = \fR\fIMYNAME\fR\fI \fR

6834

.RE

6835

6836

netbios scope (G)

6837

.\" netbios scope

6838

.PP

6839

.RS 4

6840

This sets the NetBIOS scope that Samba will operate under\&. This should not be set unless every machine on your LAN also sets this value\&.

6841

.sp

6842

Default:

6843

\fI\fInetbios scope\fR\fR\fI = \fR\fI\fR\fI \fR

6844

.RE

6845

6846

nis homedir (G)

6847

.\" nis homedir

6848

.PP

6849

.RS 4

6850

Get the home share server from a NIS map\&. For UNIX systems that use an automounter, the user\'s home directory will often be mounted on a workstation on demand from a remote server\&.

6851

.sp

6852

When the Samba logon server is not the actual home directory server, but is mounting the home directories via NFS then two network hops would be required to access the users home directory if the logon server told the client to use itself as the SMB server for home directories (one over SMB and one over NFS)\&. This can be very slow\&.

6853

.sp

6854

This option allows Samba to return the home share as being on a different server to the logon server and as long as a Samba daemon is running on the home directory server, it will be mounted on the Samba client directly from the directory server\&. When Samba is returning the home share to the client, it will consult the NIS map specified in

6855

\m[blue]\fBhomedir map\fR\m[]

6856

and return the server listed there\&.

6857

.sp

6858

Note that for this option to work there must be a working NIS system and the Samba server with this option must also be a logon server\&.

6859

.sp

6860

Default:

6861

\fI\fInis homedir\fR\fR\fI = \fR\fIno\fR\fI \fR

6862

.RE

6863

6864

nmbd bind explicit broadcast (G)

6865

.\" nmbd bind explicit broadcast

6866

.PP

6867

.RS 4

6868

This option causes

6869

\fBnmbd\fR(8)

6870

to explicitly bind to the broadcast address of the local subnets\&. This is needed to make nmbd work correctly in combination with the

6871

\m[blue]\fBsocket address\fR\m[]

6872

option\&. You should not need to unset this option\&.

6873

.sp

6874

Default:

6875

\fI\fInmbd bind explicit broadcast\fR\fR\fI = \fR\fIyes\fR\fI \fR

6876

.RE

6877

6878

nt acl support (S)

6879

.\" nt acl support

6880

.PP

6881

.RS 4

6882

This boolean parameter controls whether

6883

\fBsmbd\fR(8)

6884

will attempt to map UNIX permissions into Windows NT access control lists\&. The UNIX permissions considered are the the traditional UNIX owner and group permissions, as well as POSIX ACLs set on any files or directories\&. This parameter was formally a global parameter in releases prior to 2\&.2\&.2\&.

6885

.sp

6886

Default:

6887

\fI\fInt acl support\fR\fR\fI = \fR\fIyes\fR\fI \fR

6888

.RE

6889

6890

ntlm auth (G)

6891

.\" ntlm auth

6892

.PP

6893

.RS 4

6894

This parameter determines whether or not

6895

\fBsmbd\fR(8)

6896

will attempt to authenticate users using the NTLM encrypted password response\&. If disabled, either the lanman password hash or an NTLMv2 response will need to be sent by the client\&.

6897

.sp

6898

If this option, and

6899

lanman auth

6900

are both disabled, then only NTLMv2 logins will be permited\&. Not all clients support NTLMv2, and most will require special configuration to use it\&.

6901

.sp

6902

Default:

6903

\fI\fIntlm auth\fR\fR\fI = \fR\fIyes\fR\fI \fR

6904

.RE

6905

6906

nt pipe support (G)

6907

.\" nt pipe support

6908

.PP

6909

.RS 4

6910

This boolean parameter controls whether

6911

\fBsmbd\fR(8)

6912

will allow Windows NT clients to connect to the NT SMB specific

6913

\fBIPC$\fR

6914

pipes\&. This is a developer debugging option and can be left alone\&.

6915

.sp

6916

Default:

6917

\fI\fInt pipe support\fR\fR\fI = \fR\fIyes\fR\fI \fR

6918

.RE

6919

6920

nt status support (G)

6921

.\" nt status support

6922

.PP

6923

.RS 4

6924

This boolean parameter controls whether

6925

\fBsmbd\fR(8)

6926

will negotiate NT specific status support with Windows NT/2k/XP clients\&. This is a developer debugging option and should be left alone\&. If this option is set to

6927

\fBno\fR

6928

then Samba offers exactly the same DOS error codes that versions prior to Samba 2\&.2\&.3 reported\&.

6929

.sp

6930

You should not need to ever disable this parameter\&.

6931

.sp

6932

Default:

6933

\fI\fInt status support\fR\fR\fI = \fR\fIyes\fR\fI \fR

6934

.RE

6935

6936

null passwords (G)

6937

.\" null passwords

6938

.PP

6939

.RS 4

6940

Allow or disallow client access to accounts that have null passwords\&.

6941

.sp

6942

See also

6943

\fBsmbpasswd\fR(5)\&.

6944

.sp

6945

Default:

6946

\fI\fInull passwords\fR\fR\fI = \fR\fIno\fR\fI \fR

6947

.RE

6948

6949

obey pam restrictions (G)

6950

.\" obey pam restrictions

6951

.PP

6952

.RS 4

6953

When Samba 3\&.0 is configured to enable PAM support (i\&.e\&. \-\-with\-pam), this parameter will control whether or not Samba should obey PAM\'s account and session management directives\&. The default behavior is to use PAM for clear text authentication only and to ignore any account or session management\&. Note that Samba always ignores PAM for authentication in the case of

6954

\m[blue]\fBencrypt passwords = yes\fR\m[]\&. The reason is that PAM modules cannot support the challenge/response authentication mechanism needed in the presence of SMB password encryption\&.

6955

.sp

6956

Default:

6957

\fI\fIobey pam restrictions\fR\fR\fI = \fR\fIno\fR\fI \fR

6958

.RE

6959

6960

only user (S)

6961

.\" only user

6962

.PP

6963

.RS 4

6964

This is a boolean option that controls whether connections with usernames not in the

6965

\fIuser\fR

6966

list will be allowed\&. By default this option is disabled so that a client can supply a username to be used by the server\&. Enabling this parameter will force the server to only use the login names from the

6967

\fIuser\fR

6968

list and is only really useful in

6969

\m[blue]\fBsecurity = share\fR\m[]

6970

level security\&.

6971

.sp

6972

Note that this also means Samba won\'t try to deduce usernames from the service name\&. This can be annoying for the [homes] section\&. To get around this you could use

6973

user = %S

6974

which means your

6975

\fIuser\fR

6976

list will be just the service name, which for home directories is the name of the user\&.

6977

.sp

6978

Default:

6979

\fI\fIonly user\fR\fR\fI = \fR\fIno\fR\fI \fR

6980

.RE

6981

6982

oplock break wait time (G)

6983

.\" oplock break wait time

6984

.PP

6985

.RS 4

6986

This is a tuning parameter added due to bugs in both Windows 9x and WinNT\&. If Samba responds to a client too quickly when that client issues an SMB that can cause an oplock break request, then the network client can fail and not respond to the break request\&. This tuning parameter (which is set in milliseconds) is the amount of time Samba will wait before sending an oplock break request to such (broken) clients\&.

6987

.if n \{\

6988

.sp

6989

.\}

6990

.RS 4

6991

.it 1 an-trap

6992

.nr an-no-space-flag 1

6993

.nr an-break-flag 1

6994

.br

6995

.ps +1

6996

\fBWarning\fR

6997

.ps -1

6998

.br

6999

DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ AND UNDERSTOOD THE SAMBA OPLOCK CODE\&.

7000

.sp .5v

7001

.RE

7002

Default:

7003

\fI\fIoplock break wait time\fR\fR\fI = \fR\fI0\fR\fI \fR

7004

.RE

7005

7006

oplock contention limit (S)

7007

.\" oplock contention limit

7008

.PP

7009

.RS 4

7010

This is a

7011

\fIvery\fR

7012

advanced

7013

\fBsmbd\fR(8)

7014

tuning option to improve the efficiency of the granting of oplocks under multiple client contention for the same file\&.

7015

.sp

7016

In brief it specifies a number, which causes

7017

\fBsmbd\fR(8)not to grant an oplock even when requested if the approximate number of clients contending for an oplock on the same file goes over this limit\&. This causes

7018

smbd

7019

to behave in a similar way to Windows NT\&.

7020

.if n \{\

7021

.sp

7022

.\}

7023

.RS 4

7024

.it 1 an-trap

7025

.nr an-no-space-flag 1

7026

.nr an-break-flag 1

7027

.br

7028

.ps +1

7029

\fBWarning\fR

7030

.ps -1

7031

.br

7032

DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ AND UNDERSTOOD THE SAMBA OPLOCK CODE\&.

7033

.sp .5v

7034

.RE

7035

Default:

7036

\fI\fIoplock contention limit\fR\fR\fI = \fR\fI2\fR\fI \fR

7037

.RE

7038

7039

oplocks (S)

7040

.\" oplocks

7041

.PP

7042

.RS 4

7043

This boolean option tells

7044

smbd

7045

whether to issue oplocks (opportunistic locks) to file open requests on this share\&. The oplock code can dramatically (approx\&. 30% or more) improve the speed of access to files on Samba servers\&. It allows the clients to aggressively cache files locally and you may want to disable this option for unreliable network environments (it is turned on by default in Windows NT Servers)\&.

7046

.sp

7047

Oplocks may be selectively turned off on certain files with a share\&. See the

7048

\m[blue]\fBveto oplock files\fR\m[]

7049

parameter\&. On some systems oplocks are recognized by the underlying operating system\&. This allows data synchronization between all access to oplocked files, whether it be via Samba or NFS or a local UNIX process\&. See the

7050

\m[blue]\fBkernel oplocks\fR\m[]

7051

parameter for details\&.

7052

.sp

7053

Default:

7054

\fI\fIoplocks\fR\fR\fI = \fR\fIyes\fR\fI \fR

7055

.RE

7056

7057

os2 driver map (G)

7058

.\" os2 driver map

7059

.PP

7060

.RS 4

7061

The parameter is used to define the absolute path to a file containing a mapping of Windows NT printer driver names to OS/2 printer driver names\&. The format is:

7062

.sp

7063

7064

.sp

7065

For example, a valid entry using the HP LaserJet 5 printer driver would appear as

7066

HP LaserJet 5L = LASERJET\&.HP LaserJet 5L\&.

7067

.sp

7068

The need for the file is due to the printer driver namespace problem described in the chapter on Classical Printing in the Samba3\-HOWTO book\&. For more details on OS/2 clients, please refer to chapter on other clients in the Samba3\-HOWTO book\&.

7069

.sp

7070

Default:

7071

\fI\fIos2 driver map\fR\fR\fI = \fR\fI\fR\fI \fR

7072

.RE

7073

7074

os level (G)

7075

.\" os level

7076

.PP

7077

.RS 4

7078

This integer value controls what level Samba advertises itself as for browse elections\&. The value of this parameter determines whether

7079

\fBnmbd\fR(8)

7080

has a chance of becoming a local master browser for the

7081

\m[blue]\fBworkgroup\fR\m[]

7082

in the local broadcast area\&.

7083

.sp

7084

\fI Note:\fR

7085

By default, Samba will win a local master browsing election over all Microsoft operating systems except a Windows NT 4\&.0/2000 Domain Controller\&. This means that a misconfigured Samba host can effectively isolate a subnet for browsing purposes\&. This parameter is largely auto\-configured in the Samba\-3 release series and it is seldom necessary to manually override the default setting\&. Please refer to the chapter on Network Browsing in the Samba\-3 HOWTO document for further information regarding the use of this parameter\&.

7086

\fINote:\fR

7087

The maximum value for this parameter is 255\&. If you use higher values, counting will start at 0!

7088

.sp

7089

Default:

7090

\fI\fIos level\fR\fR\fI = \fR\fI20\fR\fI \fR

7091

.sp

7092

Example:

7093

\fI\fIos level\fR\fR\fI = \fR\fI65\fR\fI \fR

7094

.RE

7095

7096

pam password change (G)

7097

.\" pam password change

7098

.PP

7099

.RS 4

7100

With the addition of better PAM support in Samba 2\&.2, this parameter, it is possible to use PAM\'s password change control flag for Samba\&. If enabled, then PAM will be used for password changes when requested by an SMB client instead of the program listed in

7101

\m[blue]\fBpasswd program\fR\m[]\&. It should be possible to enable this without changing your

7102

\m[blue]\fBpasswd chat\fR\m[]

7103

parameter for most setups\&.

7104

.sp

7105

Default:

7106

\fI\fIpam password change\fR\fR\fI = \fR\fIno\fR\fI \fR

7107

.RE

7108

7109

panic action (G)

7110

.\" panic action

7111

.PP

7112

.RS 4

7113

This is a Samba developer option that allows a system command to be called when either

7114

\fBsmbd\fR(8)

7115

7116

\fBnmbd\fR(8)

7117

crashes\&. This is usually used to draw attention to the fact that a problem occurred\&.

7118

.sp

7119

Default:

7120

\fI\fIpanic action\fR\fR\fI = \fR\fI\fR\fI \fR

7121

.sp

7122

Example:

7123

\fI\fIpanic action\fR\fR\fI = \fR\fI"/bin/sleep 90000"\fR\fI \fR

7124

.RE

7125

7126

paranoid server security (G)

7127

.\" paranoid server security

7128

.PP

7129

.RS 4

7130

Some version of NT 4\&.x allow non\-guest users with a bad passowrd\&. When this option is enabled, samba will not use a broken NT 4\&.x server as password server, but instead complain to the logs and exit\&.

7131

.sp

7132

Disabling this option prevents Samba from making this check, which involves deliberatly attempting a bad logon to the remote server\&.

7133

.sp

7134

Default:

7135

\fI\fIparanoid server security\fR\fR\fI = \fR\fIyes\fR\fI \fR

7136

.RE

7137

7138

passdb backend (G)

7139

.\" passdb backend

7140

.PP

7141

.RS 4

7142

This option allows the administrator to chose which backend will be used for storing user and possibly group information\&. This allows you to swap between different storage mechanisms without recompile\&.

7143

.sp

7144

The parameter value is divided into two parts, the backend\'s name, and a \'location\' string that has meaning only to that particular backed\&. These are separated by a : character\&.

7145

.sp

7146

Available backends can include:

7147

.sp

7148

.RS 4

7149

.ie n \{\

7150

\h'-04'\(bu\h'+03'\c

7151

.\}

7152

.el \{\

7153

.sp -1

7154

.IP \(bu 2.3

7155

.\}

7156

smbpasswd

7157

\- The old plaintext passdb backend\&. Some Samba features will not work if this passdb backend is used\&. Takes a path to the smbpasswd file as an optional argument\&.

7158

.RE

7159

.sp

7160

.RS 4

7161

.ie n \{\

7162

\h'-04'\(bu\h'+03'\c

7163

.\}

7164

.el \{\

7165

.sp -1

7166

.IP \(bu 2.3

7167

.\}

7168

tdbsam

7169

\- The TDB based password storage backend\&. Takes a path to the TDB as an optional argument (defaults to passdb\&.tdb in the

7170

\m[blue]\fBprivate dir\fR\m[]

7171

directory\&.

7172

.RE

7173

.sp

7174

.RS 4

7175

.ie n \{\

7176

\h'-04'\(bu\h'+03'\c

7177

.\}

7178

.el \{\

7179

.sp -1

7180

.IP \(bu 2.3

7181

.\}

7182

ldapsam

7183

\- The LDAP based passdb backend\&. Takes an LDAP URL as an optional argument (defaults to

7184

ldap://localhost)

7185

.sp

7186

LDAP connections should be secured where possible\&. This may be done using either Start\-TLS (see

7187

\m[blue]\fBldap ssl\fR\m[]) or by specifying

7188

\fIldaps://\fR

7189

in the URL argument\&.

7190

.sp

7191

Multiple servers may also be specified in double\-quotes\&. Whether multiple servers are supported or not and the exact syntax depends on the LDAP library you use\&.

7192

.RE

7193

.sp

7194

.RE

7195

7196

Examples of use are:

7197

.sp

7198

.if n \{\

7199

.RS 4

7200

.\}

7201

.nf

7202

passdb backend = tdbsam:/etc/samba/private/passdb\&.tdb

7203

7204

or multi server LDAP URL with OpenLDAP library:

7205

7206

passdb backend = ldapsam:"ldap://ldap\-1\&.example\&.com ldap://ldap\-2\&.example\&.com"

7207

7208

or multi server LDAP URL with Netscape based LDAP library:

7209

7210

passdb backend = ldapsam:"ldap://ldap\-1\&.example\&.com ldap\-2\&.example\&.com"

7211

.fi

7212

.if n \{\

7213

.RE

7214

.\}

7215

.sp

7216

Default:

7217

\fI\fIpassdb backend\fR\fR\fI = \fR\fItdbsam\fR\fI \fR

7218

.RE

7219

7220

passdb expand explicit (G)

7221

.\" passdb expand explicit

7222

.PP

7223

.RS 4

7224

This parameter controls whether Samba substitutes %\-macros in the passdb fields if they are explicitly set\&. We used to expand macros here, but this turned out to be a bug because the Windows client can expand a variable %G_osver% in which %G would have been substituted by the user\'s primary group\&.

7225

.sp

7226

Default:

7227

\fI\fIpassdb expand explicit\fR\fR\fI = \fR\fIno\fR\fI \fR

7228

.RE

7229

7230

passwd chat debug (G)

7231

.\" passwd chat debug

7232

.PP

7233

.RS 4

7234

This boolean specifies if the passwd chat script parameter is run in

7235

\fIdebug\fR

7236

mode\&. In this mode the strings passed to and received from the passwd chat are printed in the

7237

\fBsmbd\fR(8)

7238

log with a

7239

\m[blue]\fBdebug level\fR\m[]

7240

of 100\&. This is a dangerous option as it will allow plaintext passwords to be seen in the

7241

smbd

7242

log\&. It is available to help Samba admins debug their

7243

\fIpasswd chat\fR

7244

scripts when calling the

7245

\fIpasswd program\fR

7246

and should be turned off after this has been done\&. This option has no effect if the

7247

\m[blue]\fBpam password change\fR\m[]

7248

parameter is set\&. This parameter is off by default\&.

7249

.sp

7250

Default:

7251

\fI\fIpasswd chat debug\fR\fR\fI = \fR\fIno\fR\fI \fR

7252

.RE

7253

7254

passwd chat timeout (G)

7255

.\" passwd chat timeout

7256

.PP

7257

.RS 4

7258

This integer specifies the number of seconds smbd will wait for an initial answer from a passwd chat script being run\&. Once the initial answer is received the subsequent answers must be received in one tenth of this time\&. The default it two seconds\&.

7259

.sp

7260

Default:

7261

\fI\fIpasswd chat timeout\fR\fR\fI = \fR\fI2\fR\fI \fR

7262

.RE

7263

7264

passwd chat (G)

7265

.\" passwd chat

7266

.PP

7267

.RS 4

7268

This string controls the

7269

\fI"chat"\fR

7270

conversation that takes places between

7271

\fBsmbd\fR(8)

7272

and the local password changing program to change the user\'s password\&. The string describes a sequence of response\-receive pairs that

7273

\fBsmbd\fR(8)

7274

uses to determine what to send to the

7275

\m[blue]\fBpasswd program\fR\m[]

7276

and what to expect back\&. If the expected output is not received then the password is not changed\&.

7277

.sp

7278

This chat sequence is often quite site specific, depending on what local methods are used for password control (such as NIS etc)\&.

7279

.sp

7280

Note that this parameter only is used if the

7281

\m[blue]\fBunix password sync\fR\m[]

7282

parameter is set to

7283

\fByes\fR\&. This sequence is then called

7284

\fIAS ROOT\fR

7285

when the SMB password in the smbpasswd file is being changed, without access to the old password cleartext\&. This means that root must be able to reset the user\'s password without knowing the text of the previous password\&. In the presence of NIS/YP, this means that the

7286

\m[blue]\fBpasswd program\fR\m[]

7287

must be executed on the NIS master\&.

7288

.sp

7289

The string can contain the macro

7290

\fI%n\fR

7291

which is substituted for the new password\&. The old passsword (\fI%o\fR) is only available when

7292

\m[blue]\fBencrypt passwords\fR\m[]

7293

has been disabled\&. The chat sequence can also contain the standard macros \en, \er, \et and \es to give line\-feed, carriage\-return, tab and space\&. The chat sequence string can also contain a \'*\' which matches any sequence of characters\&. Double quotes can be used to collect strings with spaces in them into a single string\&.

7294

.sp

7295

If the send string in any part of the chat sequence is a full stop "\&.", then no string is sent\&. Similarly, if the expect string is a full stop then no string is expected\&.

7296

.sp

7297

If the

7298

\m[blue]\fBpam password change\fR\m[]

7299

parameter is set to

7300

\fByes\fR, the chat pairs may be matched in any order, and success is determined by the PAM result, not any particular output\&. The \en macro is ignored for PAM conversions\&.

7301

.sp

7302

Default:

7303

\fI\fIpasswd chat\fR\fR\fI = \fR\fI*new*password* %n\en*new*password* %n\en *changed*\fR\fI \fR

7304

.sp

7305

Example:

7306

\fI\fIpasswd chat\fR\fR\fI = \fR\fI"*Enter NEW password*" %n\en "*Reenter NEW password*" %n\en "*Password changed*"\fR\fI \fR

7307

.RE

7308

7309

passwd program (G)

7310

.\" passwd program

7311

.PP

7312

.RS 4

7313

The name of a program that can be used to set UNIX user passwords\&. Any occurrences of

7314

\fI%u\fR

7315

will be replaced with the user name\&. The user name is checked for existence before calling the password changing program\&.

7316

.sp

7317

Also note that many passwd programs insist in

7318

\fIreasonable \fR

7319

passwords, such as a minimum length, or the inclusion of mixed case chars and digits\&. This can pose a problem as some clients (such as Windows for Workgroups) uppercase the password before sending it\&.

7320

.sp

7321

\fINote\fR

7322

that if the

7323

\fIunix password sync\fR

7324

parameter is set to

7325

\fByes \fR

7326

then this program is called

7327

\fIAS ROOT\fR

7328

before the SMB password in the smbpasswd file is changed\&. If this UNIX password change fails, then

7329

smbd

7330

will fail to change the SMB password also (this is by design)\&.

7331

.sp

7332

If the

7333

\fIunix password sync\fR

7334

parameter is set this parameter

7335

\fIMUST USE ABSOLUTE PATHS\fR

7336

for

7337

\fIALL\fR

7338

programs called, and must be examined for security implications\&. Note that by default

7339

\fIunix password sync\fR

7340

is set to

7341

\fBno\fR\&.

7342

.sp

7343

Default:

7344

\fI\fIpasswd program\fR\fR\fI = \fR\fI\fR\fI \fR

7345

.sp

7346

Example:

7347

\fI\fIpasswd program\fR\fR\fI = \fR\fI/bin/passwd %u\fR\fI \fR

7348

.RE

7349

7350

password level (G)

7351

.\" password level

7352

.PP

7353

.RS 4

7354

Some client/server combinations have difficulty with mixed\-case passwords\&. One offending client is Windows for Workgroups, which for some reason forces passwords to upper case when using the LANMAN1 protocol, but leaves them alone when using COREPLUS! Another problem child is the Windows 95/98 family of operating systems\&. These clients upper case clear text passwords even when NT LM 0\&.12 selected by the protocol negotiation request/response\&.

7355

.sp

7356

This deprecated parameter defines the maximum number of characters that may be upper case in passwords\&.

7357

.sp

7358

For example, say the password given was "FRED"\&. If

7359

\fI password level\fR

7360

is set to 1, the following combinations would be tried if "FRED" failed:

7361

.sp

7362

"Fred", "fred", "fRed", "frEd","freD"

7363

.sp

7364

7365

\fIpassword level\fR

7366

was set to 2, the following combinations would also be tried:

7367

.sp

7368

"FRed", "FrEd", "FreD", "fREd", "fReD", "frED", \&.\&.

7369

.sp

7370

And so on\&.

7371

.sp

7372

The higher value this parameter is set to the more likely it is that a mixed case password will be matched against a single case password\&. However, you should be aware that use of this parameter reduces security and increases the time taken to process a new connection\&.

7373

.sp

7374

A value of zero will cause only two attempts to be made \- the password as is and the password in all\-lower case\&.

7375

.sp

7376

This parameter is used only when using plain\-text passwords\&. It is not at all used when encrypted passwords as in use (that is the default since samba\-3\&.0\&.0)\&. Use this only when

7377

\m[blue]\fBencrypt passwords = No\fR\m[]\&.

7378

.sp

7379

Default:

7380

\fI\fIpassword level\fR\fR\fI = \fR\fI0\fR\fI \fR

7381

.sp

7382

Example:

7383

\fI\fIpassword level\fR\fR\fI = \fR\fI4\fR\fI \fR

7384

.RE

7385

7386

password server (G)

7387

.\" password server

7388

.PP

7389

.RS 4

7390

By specifying the name of another SMB server or Active Directory domain controller with this option, and using

7391

security = [ads|domain|server]

7392

it is possible to get Samba to do all its username/password validation using a specific remote server\&.

7393

.sp

7394

If the

7395

\fIsecurity\fR

7396

parameter is set to

7397

\fBdomain\fR

7398

7399

\fBads\fR, then this option

7400

\fIshould not\fR

7401

be used, as the default \'*\' indicates to Samba to determine the best DC to contact dynamically, just as all other hosts in an AD domain do\&. This allows the domain to be maintained without modification to the smb\&.conf file\&. The cryptograpic protection on the authenticated RPC calls used to verify passwords ensures that this default is safe\&.

7402

.sp

7403

\fIIt is strongly recommended that you use the default of \'*\'\fR, however if in your particular environment you have reason to specify a particular DC list, then the list of machines in this option must be a list of names or IP addresses of Domain controllers for the Domain\&. If you use the default of \'*\', or list several hosts in the

7404

\fIpassword server\fR

7405

option then

7406

smbd

7407

will try each in turn till it finds one that responds\&. This is useful in case your primary server goes down\&.

7408

.sp

7409

If the list of servers contains both names/IP\'s and the \'*\' character, the list is treated as a list of preferred domain controllers, but an auto lookup of all remaining DC\'s will be added to the list as well\&. Samba will not attempt to optimize this list by locating the closest DC\&.

7410

.sp

7411

If parameter is a name, it is looked up using the parameter

7412

\m[blue]\fBname resolve order\fR\m[]

7413

and so may resolved by any method and order described in that parameter\&.

7414

.sp

7415

If the

7416

\fIsecurity\fR

7417

parameter is set to

7418

\fBserver\fR, these additional restrictions apply:

7419

.sp

7420

.RS 4

7421

.ie n \{\

7422

\h'-04'\(bu\h'+03'\c

7423

.\}

7424

.el \{\

7425

.sp -1

7426

.IP \(bu 2.3

7427

.\}

7428

You may list several password servers in the

7429

\fIpassword server\fR

7430

parameter, however if an

7431

smbd

7432

makes a connection to a password server, and then the password server fails, no more users will be able to be authenticated from this

7433

smbd\&. This is a restriction of the SMB/CIFS protocol when in

7434

security = server

7435

mode and cannot be fixed in Samba\&.

7436

.RE

7437

.sp

7438

.RS 4

7439

.ie n \{\

7440

\h'-04'\(bu\h'+03'\c

7441

.\}

7442

.el \{\

7443

.sp -1

7444

.IP \(bu 2.3

7445

.\}

7446

You will have to ensure that your users are able to login from the Samba server, as when in

7447

security = server

7448

mode the network logon will appear to come from the Samba server rather than from the users workstation\&.

7449

.RE

7450

.sp

7451

.RS 4

7452

.ie n \{\

7453

\h'-04'\(bu\h'+03'\c

7454

.\}

7455

.el \{\

7456

.sp -1

7457

.IP \(bu 2.3

7458

.\}

7459

The client must not select NTLMv2 authentication\&.

7460

.RE

7461

.sp

7462

.RS 4

7463

.ie n \{\

7464

\h'-04'\(bu\h'+03'\c

7465

.\}

7466

.el \{\

7467

.sp -1

7468

.IP \(bu 2.3

7469

.\}

7470

The password server must be a machine capable of using the "LM1\&.2X002" or the "NT LM 0\&.12" protocol, and it must be in user level security mode\&.

7471

.RE

7472

.sp

7473

.RS 4

7474

.ie n \{\

7475

\h'-04'\(bu\h'+03'\c

7476

.\}

7477

.el \{\

7478

.sp -1

7479

.IP \(bu 2.3

7480

.\}

7481

Using a password server means your UNIX box (running Samba) is only as secure as (a host masqurading as) your password server\&.

7482

\fIDO NOT CHOOSE A PASSWORD SERVER THAT YOU DON\'T COMPLETELY TRUST\fR\&.

7483

.RE

7484

.sp

7485

.RS 4

7486

.ie n \{\

7487

\h'-04'\(bu\h'+03'\c

7488

.\}

7489

.el \{\

7490

.sp -1

7491

.IP \(bu 2.3

7492

.\}

7493

Never point a Samba server at itself for password serving\&. This will cause a loop and could lock up your Samba server!

7494

.RE

7495

.sp

7496

.RS 4

7497

.ie n \{\

7498

\h'-04'\(bu\h'+03'\c

7499

.\}

7500

.el \{\

7501

.sp -1

7502

.IP \(bu 2.3

7503

.\}

7504

The name of the password server takes the standard substitutions, but probably the only useful one is

7505

\fI%m \fR, which means the Samba server will use the incoming client as the password server\&. If you use this then you better trust your clients, and you had better restrict them with hosts allow!

7506

.RE

7507

.sp

7508

.RE

7509

Default:

7510

\fI\fIpassword server\fR\fR\fI = \fR\fI*\fR\fI \fR

7511

.sp

7512

Example:

7513

\fI\fIpassword server\fR\fR\fI = \fR\fINT\-PDC, NT\-BDC1, NT\-BDC2, *\fR\fI \fR

7514

.sp

7515

Example:

7516

\fI\fIpassword server\fR\fR\fI = \fR\fIwindc\&.mydomain\&.com:389 192\&.168\&.1\&.101 *\fR\fI \fR

7517

.RE

7518

7519

See also

7637

\m[blue]\fBpreexec close\fR\m[]

7638

and

7639

\m[blue]\fBpostexec\fR\m[]\&.

7640

.sp

7641

Default:

7642

\fI\fIpreexec\fR\fR\fI = \fR\fI\fR\fI \fR

7643

.sp

7644

Example:

7645

\fI\fIpreexec\fR\fR\fI = \fR\fIecho \e"%u connected to %S from %m (%I)\e" >> /tmp/log\fR\fI \fR

7646

.RE

7647

7648

prefered master

7649

.\" prefered master

7650

.PP

7651

.RS 4

7652

This parameter is a synonym for

7653

preferred master\&.

7654

.RE

7655

7656

preferred master (G)

7657

.\" preferred master

7658

.PP

7659

.RS 4

7660

This boolean parameter controls if

7661

\fBnmbd\fR(8)

7662

is a preferred master browser for its workgroup\&.

7663

.sp

7664

If this is set to

7665

\fByes\fR, on startup,

7666

nmbd

7667

will force an election, and it will have a slight advantage in winning the election\&. It is recommended that this parameter is used in conjunction with

7668

\m[blue]\fBdomain master = yes\fR\m[], so that

7669

nmbd

7670

can guarantee becoming a domain master\&.

7671

.sp

7672

Use this option with caution, because if there are several hosts (whether Samba servers, Windows 95 or NT) that are preferred master browsers on the same subnet, they will each periodically and continuously attempt to become the local master browser\&. This will result in unnecessary broadcast traffic and reduced browsing capabilities\&.

7673

.sp

7674

Default:

7675

\fI\fIpreferred master\fR\fR\fI = \fR\fIauto\fR\fI \fR

7676

.RE

7677

7678

preload modules (G)

7679

.\" preload modules

7680

.PP

7681

.RS 4

7682

This is a list of paths to modules that should be loaded into smbd before a client connects\&. This improves the speed of smbd when reacting to new connections somewhat\&.

7683

.sp

7684

Default:

7685

\fI\fIpreload modules\fR\fR\fI = \fR\fI\fR\fI \fR

7686

.sp

7687

Example:

7688

\fI\fIpreload modules\fR\fR\fI = \fR\fI/usr/lib/samba/passdb/mysql\&.so\fR\fI \fR

7689

.RE

7690

7691

auto services

7692

.\" auto services

7693

.PP

7694

.RS 4

7695

This parameter is a synonym for

7696

preload\&.

7697

.RE

7698

7699

preload (G)

7700

.\" preload

7701

.PP

7702

.RS 4

7703

This is a list of services that you want to be automatically added to the browse lists\&. This is most useful for homes and printers services that would otherwise not be visible\&.

7704

.sp

7705

Note that if you just want all printers in your printcap file loaded then the

7706

\m[blue]\fBload printers\fR\m[]

7707

option is easier\&.

7708

.sp

7709

Default:

7710

\fI\fIpreload\fR\fR\fI = \fR\fI\fR\fI \fR

7711

.sp

7712

Example:

7713

\fI\fIpreload\fR\fR\fI = \fR\fIfred lp colorlp\fR\fI \fR

7714

.RE

7715

7716

preserve case (S)

7717

.\" preserve case

7718

.PP

7719

.RS 4

7720

This controls if new filenames are created with the case that the client passes, or if they are forced to be the

7721

\m[blue]\fBdefault case\fR\m[]\&.

7722

.sp

7723

See the section on

7724

NAME MANGLING

7725

for a fuller discussion\&.

7726

.sp

7727

Default:

7728

\fI\fIpreserve case\fR\fR\fI = \fR\fIyes\fR\fI \fR

7729

.RE

7730

7731

print ok

7732

.\" print ok

7733

.PP

7734

.RS 4

7735

This parameter is a synonym for

7736

printable\&.

7737

.RE

7738

7739

printable (S)

7740

.\" printable

7741

.PP

7742

.RS 4

7743

If this parameter is

7744

\fByes\fR, then clients may open, write to and submit spool files on the directory specified for the service\&.

7745

.sp

7746

Note that a printable service will ALWAYS allow writing to the service path (user privileges permitting) via the spooling of print data\&. The

7747

\m[blue]\fBread only\fR\m[]

7748

parameter controls only non\-printing access to the resource\&.

7749

.sp

7750

Default:

7751

\fI\fIprintable\fR\fR\fI = \fR\fIno\fR\fI \fR

7752

.RE

7753

7754

printcap cache time (G)

7755

.\" printcap cache time

7756

.PP

7757

.RS 4

7758

This option specifies the number of seconds before the printing subsystem is again asked for the known printers\&.

7759

.sp

7760

Setting this parameter to 0 disables any rescanning for new or removed printers after the initial startup\&.

7761

.sp

7762

Default:

7763

\fI\fIprintcap cache time\fR\fR\fI = \fR\fI750\fR\fI \fR

7764

.sp

7765

Example:

7766

\fI\fIprintcap cache time\fR\fR\fI = \fR\fI600\fR\fI \fR

7767

.RE

7768

7769

printcap

7770

.\" printcap

7771

.PP

7772

.RS 4

7773

This parameter is a synonym for

7774

printcap name\&.

7775

.RE

7776

7777

printcap name (G)

7778

.\" printcap name

7779

.PP

7780

.RS 4

7781

This parameter may be used to override the compiled\-in default printcap name used by the server (usually

7782

/etc/printcap)\&. See the discussion of the

7783

[printers]

7784

section above for reasons why you might want to do this\&.

7785

.sp

7786

To use the CUPS printing interface set

7787

printcap name = cups\&. This should be supplemented by an addtional setting

7788

\m[blue]\fBprinting = cups\fR\m[]

7789

in the [global] section\&.

7790

printcap name = cups

7791

will use the "dummy" printcap created by CUPS, as specified in your CUPS configuration file\&.

7792

.sp

7793

On System V systems that use

7794

lpstat

7795

to list available printers you can use

7796

printcap name = lpstat

7797

to automatically obtain lists of available printers\&. This is the default for systems that define SYSV at configure time in Samba (this includes most System V based systems)\&. If

7798

\fI printcap name\fR

7799

is set to

7800

lpstat

7801

on these systems then Samba will launch

7802

lpstat \-v

7803

and attempt to parse the output to obtain a printer list\&.

7804

.sp

7805

A minimal printcap file would look something like this:

7806

.sp

7807

.if n \{\

7808

.RS 4

7809

.\}

7810

.nf

7811

print1|My Printer 1

7812

print2|My Printer 2

7813

print3|My Printer 3

7814

print4|My Printer 4

7815

print5|My Printer 5

7816

.fi

7817

.if n \{\

7818

.RE

7819

.\}

7820

.sp

7821

where the \'|\' separates aliases of a printer\&. The fact that the second alias has a space in it gives a hint to Samba that it\'s a comment\&.

7822

.if n \{\

7823

.sp

7824

.\}

7825

.RS 4

7826

.it 1 an-trap

7827

.nr an-no-space-flag 1

7828

.nr an-break-flag 1

7829

.br

7830

.ps +1

7831

\fBNote\fR

7832

.ps -1

7833

.br

7834

Under AIX the default printcap name is

7835

/etc/qconfig\&. Samba will assume the file is in AIX

7836

qconfig

7837

format if the string

7838

qconfig

7839

appears in the printcap filename\&.

7840

.sp .5v

7841

.RE

7842

Default:

7843

\fI\fIprintcap name\fR\fR\fI = \fR\fI/etc/printcap\fR\fI \fR

7844

.sp

7845

Example:

7846

\fI\fIprintcap name\fR\fR\fI = \fR\fI/etc/myprintcap\fR\fI \fR

7847

.RE

7848

7849

print command (S)

7850

.\" print command

7851

.PP

7852

.RS 4

7853

After a print job has finished spooling to a service, this command will be used via a

7854

system()

7855

call to process the spool file\&. Typically the command specified will submit the spool file to the host\'s printing subsystem, but there is no requirement that this be the case\&. The server will not remove the spool file, so whatever command you specify should remove the spool file when it has been processed, otherwise you will need to manually remove old spool files\&.

7856

.sp

7857

The print command is simply a text string\&. It will be used verbatim after macro substitutions have been made:

7858

.sp

7859

%s, %f \- the path to the spool file name

7860

.sp

7861

%p \- the appropriate printer name

7862

.sp

7863

%J \- the job name as transmitted by the client\&.

7864

.sp

7865

%c \- The number of printed pages of the spooled job (if known)\&.

7866

.sp

7867

%z \- the size of the spooled print job (in bytes)

7868

.sp

7869

The print command

7870

\fIMUST\fR

7871

contain at least one occurrence of

7872

\fI%s\fR

7873

7874

\fI%f \fR

7875

\- the

7876

\fI%p\fR

7877

is optional\&. At the time a job is submitted, if no printer name is supplied the

7878

\fI%p \fR

7879

will be silently removed from the printer command\&.

7880

.sp

7881

If specified in the [global] section, the print command given will be used for any printable service that does not have its own print command specified\&.

7882

.sp

7883

If there is neither a specified print command for a printable service nor a global print command, spool files will be created but not processed and (most importantly) not removed\&.

7884

.sp

7885

Note that printing may fail on some UNIXes from the

7886

\fBnobody\fR

7887

account\&. If this happens then create an alternative guest account that can print and set the

7888

\m[blue]\fBguest account\fR\m[]

7889

in the [global] section\&.

7890

.sp

7891

You can form quite complex print commands by realizing that they are just passed to a shell\&. For example the following will log a print job, print the file, then remove it\&. Note that \';\' is the usual separator for command in shell scripts\&.

7892

.sp

7893

print command = echo Printing %s >> /tmp/print\&.log; lpr \-P %p %s; rm %s

7894

.sp

7895

You may have to vary this command considerably depending on how you normally print files on your system\&. The default for the parameter varies depending on the setting of the

7896

\m[blue]\fBprinting\fR\m[]

7897

parameter\&.

7898

.sp

7899

Default: For

7900

printing = BSD, AIX, QNX, LPRNG or PLP :

7901

.sp

7902

print command = lpr \-r \-P%p %s

7903

.sp

7904

For

7905

printing = SYSV or HPUX :

7906

.sp

7907

print command = lp \-c \-d%p %s; rm %s

7908

.sp

7909

For

7910

printing = SOFTQ :

7911

.sp

7912

print command = lp \-d%p \-s %s; rm %s

7913

.sp

7914

For printing = CUPS : If SAMBA is compiled against libcups, then

7915

\m[blue]\fBprintcap = cups\fR\m[]

7916

uses the CUPS API to submit jobs, etc\&. Otherwise it maps to the System V commands with the \-oraw option for printing, i\&.e\&. it uses

7917

lp \-c \-d%p \-oraw; rm %s\&. With

7918

printing = cups, and if SAMBA is compiled against libcups, any manually set print command will be ignored\&.

7919

.sp

7920

\fINo default\fR

7921

.sp

7922

Example:

7923

\fI\fIprint command\fR\fR\fI = \fR\fI/usr/local/samba/bin/myprintscript %p %s\fR\fI \fR

7924

.RE

7925

7926

printer admin (S)

7927

.\" printer admin

7928

.PP

7929

.RS 4

7930

This lists users who can do anything to printers via the remote administration interfaces offered by MS\-RPC (usually using a NT workstation)\&. This parameter can be set per\-share or globally\&. Note: The root user always has admin rights\&. Use caution with use in the global stanza as this can cause side effects\&.

7931

.sp

7932

This parameter has been marked deprecated in favor of using the SePrintOperatorPrivilege and individual print security descriptors\&. It will be removed in a future release\&.

7933

.sp

7934

Default:

7935

\fI\fIprinter admin\fR\fR\fI = \fR\fI\fR\fI \fR

7936

.sp

7937

Example:

7938

\fI\fIprinter admin\fR\fR\fI = \fR\fIadmin, @staff\fR\fI \fR

7939

.RE

7940

7941

printer

7942

.\" printer

7943

.PP

7944

.RS 4

7945

This parameter is a synonym for

7946

printer name\&.

7947

.RE

7948

7949

printer name (S)

7950

.\" printer name

7951

.PP

7952

.RS 4

7953

This parameter specifies the name of the printer to which print jobs spooled through a printable service will be sent\&.

7954

.sp

7955

If specified in the [global] section, the printer name given will be used for any printable service that does not have its own printer name specified\&.

7956

.sp

7957

The default value of the

7958

\m[blue]\fBprinter name\fR\m[]

7959

may be

7960

7961

on many systems\&.

7962

.sp

7963

Default:

7964

\fI\fIprinter name\fR\fR\fI = \fR\fInone\fR\fI \fR

7965

.sp

7966

Example:

7967

\fI\fIprinter name\fR\fR\fI = \fR\fIlaserwriter\fR\fI \fR

7968

.RE

7969

7970

printing (S)

7971

.\" printing

7972

.PP

7973

.RS 4

7974

This parameters controls how printer status information is interpreted on your system\&. It also affects the default values for the

7975

\fIprint command\fR,

7976

\fIlpq command\fR,

7977

\fIlppause command \fR,

7978

\fIlpresume command\fR, and

7979

\fIlprm command\fR

7980

if specified in the [global] section\&.

7981

.sp

7982

Currently nine printing styles are supported\&. They are

7983

\fBBSD\fR,

7984

\fBAIX\fR,

7985

\fBLPRNG\fR,

7986

\fBPLP\fR,

7987

\fBSYSV\fR,

7988

\fBHPUX\fR,

7989

\fBQNX\fR,

7990

\fBSOFTQ\fR, and

7991

\fBCUPS\fR\&.

7992

.sp

7993

To see what the defaults are for the other print commands when using the various options use the

7994

\fBtestparm\fR(1)

7995

program\&.

7996

.sp

7997

This option can be set on a per printer basis\&. Please be aware however, that you must place any of the various printing commands (e\&.g\&. print command, lpq command, etc\&.\&.\&.) after defining the value for the

7998

\fIprinting\fR

7999

option since it will reset the printing commands to default values\&.

8000

.sp

8001

See also the section

8564

NOTE ABOUT USERNAME/PASSWORD VALIDATION\&.

8565

.sp

8566

\fISECURITY = DOMAIN\fR

8567

.sp

8568

This mode will only work correctly if

8569

\fBnet\fR(8)

8570

has been used to add this machine into a Windows NT Domain\&. It expects the

8571

\m[blue]\fBencrypted passwords\fR\m[]

8572

parameter to be set to

8573

\fByes\fR\&. In this mode Samba will try to validate the username/password by passing it to a Windows NT Primary or Backup Domain Controller, in exactly the same way that a Windows NT Server would do\&.

8574

.sp

8575

\fINote\fR

8576

that a valid UNIX user must still exist as well as the account on the Domain Controller to allow Samba to have a valid UNIX account to map file access to\&.

8577

.sp

8578

\fINote\fR

8579

that from the client\'s point of view

8580

security = domain

8581

is the same as

8582

security = user\&. It only affects how the server deals with the authentication, it does not in any way affect what the client sees\&.

8583

.sp

8584

\fINote\fR

8585

that the name of the resource being requested is

8586

\fInot\fR

8587

8588

\m[blue]\fBguest account\fR\m[]\&. See the

8589

\m[blue]\fBmap to guest\fR\m[]

8590

parameter for details on doing this\&.

8591

.sp

8592

See also the section

8593

NOTE ABOUT USERNAME/PASSWORD VALIDATION\&.

8594

.sp

8595

See also the

8596

\m[blue]\fBpassword server\fR\m[]

8597

parameter and the

8598

\m[blue]\fBencrypted passwords\fR\m[]

8599

parameter\&.

8600

.sp

8601

\fISECURITY = SHARE\fR

8602

.if n \{\

8603

.sp

8604

.\}

8605

.RS 4

8606

.it 1 an-trap

8607

.nr an-no-space-flag 1

8608

.nr an-break-flag 1

8609

.br

8610

.ps +1

8611

\fBNote\fR

8612

.ps -1

8613

.br

8614

This option is deprecated as it is incompatible with SMB2

8615

.sp .5v

8616

.RE

8617

When clients connect to a share level security server, they need not log onto the server with a valid username and password before attempting to connect to a shared resource (although modern clients such as Windows 95/98 and Windows NT will send a logon request with a username but no password when talking to a

8618

security = share

8619

server)\&. Instead, the clients send authentication information (passwords) on a per\-share basis, at the time they attempt to connect to that share\&.

8620

.sp

8621

Note that

8622

smbd

8623

\fIALWAYS\fR

8624

uses a valid UNIX user to act on behalf of the client, even in

8625

security = share

8626

level security\&.

8627

.sp

8628

As clients are not required to send a username to the server in share level security,

8629

smbd

8630

uses several techniques to determine the correct UNIX user to use on behalf of the client\&.

8631

.sp

8632

A list of possible UNIX usernames to match with the given client password is constructed using the following methods :

8633

.sp

8634

.RS 4

8635

.ie n \{\

8636

\h'-04'\(bu\h'+03'\c

8637

.\}

8638

.el \{\

8639

.sp -1

8640

.IP \(bu 2.3

8641

.\}

8642

If the

8643

\m[blue]\fBguest only\fR\m[]

8644

parameter is set, then all the other stages are missed and only the

8645

\m[blue]\fBguest account\fR\m[]

8646

username is checked\&.

8647

.RE

8648

.sp

8649

.RS 4

8650

.ie n \{\

8651

\h'-04'\(bu\h'+03'\c

8652

.\}

8653

.el \{\

8654

.sp -1

8655

.IP \(bu 2.3

8656

.\}

8657

Is a username is sent with the share connection request, then this username (after mapping \- see

8658

\m[blue]\fBusername map\fR\m[]), is added as a potential username\&.

8659

.RE

8660

.sp

8661

.RS 4

8662

.ie n \{\

8663

\h'-04'\(bu\h'+03'\c

8664

.\}

8665

.el \{\

8666

.sp -1

8667

.IP \(bu 2.3

8668

.\}

8669

If the client did a previous

8670

\fIlogon \fR

8671

request (the SessionSetup SMB call) then the username sent in this SMB will be added as a potential username\&.

8672

.RE

8673

.sp

8674

.RS 4

8675

.ie n \{\

8676

\h'-04'\(bu\h'+03'\c

8677

.\}

8678

.el \{\

8679

.sp -1

8680

.IP \(bu 2.3

8681

.\}

8682

The name of the service the client requested is added as a potential username\&.

8683

.RE

8684

.sp

8685

.RS 4

8686

.ie n \{\

8687

\h'-04'\(bu\h'+03'\c

8688

.\}

8689

.el \{\

8690

.sp -1

8691

.IP \(bu 2.3

8692

.\}

8693

The NetBIOS name of the client is added to the list as a potential username\&.

8694

.RE

8695

.sp

8696

.RS 4

8697

.ie n \{\

8698

\h'-04'\(bu\h'+03'\c

8699

.\}

8700

.el \{\

8701

.sp -1

8702

.IP \(bu 2.3

8703

.\}

8704

Any users on the

8705

\m[blue]\fBuser\fR\m[]

8706

list are added as potential usernames\&.

8707

.RE

8708

.sp

8709

.RE

8710

If the

8711

\fIguest only\fR

8712

parameter is not set, then this list is then tried with the supplied password\&. The first user for whom the password matches will be used as the UNIX user\&.

8713

.sp

8714

If the

8715

\fIguest only\fR

8716

parameter is set, or no username can be determined then if the share is marked as available to the

8717

\fIguest account\fR, then this guest user will be used, otherwise access is denied\&.

8718

.sp

8719

Note that it can be

8720

\fIvery\fR

8721

confusing in share\-level security as to which UNIX username will eventually be used in granting access\&.

8722

.sp

8723

See also the section

8724

NOTE ABOUT USERNAME/PASSWORD VALIDATION\&.

8725

.sp

8726

\fISECURITY = SERVER\fR

8727

.sp

8728

In this depicted mode Samba will try to validate the username/password by passing it to another SMB server, such as an NT box\&. If this fails it will revert to

8729

security = user\&. It expects the

8730

\m[blue]\fBencrypted passwords\fR\m[]

8731

parameter to be set to

8732

\fByes\fR, unless the remote server does not support them\&. However note that if encrypted passwords have been negotiated then Samba cannot revert back to checking the UNIX password file, it must have a valid

8733

smbpasswd

8734

file to check users against\&. See the chapter about the User Database in the Samba HOWTO Collection for details on how to set this up\&.

8735

.if n \{\

8736

.sp

8737

.\}

8738

.RS 4

8739

.it 1 an-trap

8740

.nr an-no-space-flag 1

8741

.nr an-break-flag 1

8742

.br

8743

.ps +1

8744

\fBNote\fR

8745

.ps -1

8746

.br

8747

This mode of operation has significant pitfalls since it is more vulnerable to man\-in\-the\-middle attacks and server impersonation\&. In particular, this mode of operation can cause significant resource consumption on the PDC, as it must maintain an active connection for the duration of the user\'s session\&. Furthermore, if this connection is lost, there is no way to reestablish it, and further authentications to the Samba server may fail (from a single client, till it disconnects)\&.

8748

.sp .5v

8749

.RE

8750

.if n \{\

8751

.sp

8752

.\}

8753

.RS 4

8754

.it 1 an-trap

8755

.nr an-no-space-flag 1

8756

.nr an-break-flag 1

8757

.br

8758

.ps +1

8759

\fBNote\fR

8760

.ps -1

8761

.br

8762

If the client selects NTLMv2 authentication, then this mode of operation

8763

\fIwill fail\fR

8764

.sp .5v

8765

.RE

8766

.if n \{\

8767

.sp

8768

.\}

8769

.RS 4

8770

.it 1 an-trap

8771

.nr an-no-space-flag 1

8772

.nr an-break-flag 1

8773

.br

8774

.ps +1

8775

\fBNote\fR

8776

.ps -1

8777

.br

8778

From the client\'s point of view,

8779

security = server

8780

is the same as

8781

security = user\&. It only affects how the server deals with the authentication, it does not in any way affect what the client sees\&.

8782

.sp .5v

8783

.RE

8784

.if n \{\

8785

.sp

8786

.\}

8787

.RS 4

8788

.it 1 an-trap

8789

.nr an-no-space-flag 1

8790

.nr an-break-flag 1

8791

.br

8792

.ps +1

8793

\fBNote\fR

8794

.ps -1

8795

.br

8796

This option is deprecated, and may be removed in future

8797

.sp .5v

8798

.RE

8799

\fINote\fR

8800

that the name of the resource being requested is

8801

\fInot\fR

8802

8803

\m[blue]\fBguest account\fR\m[]\&. See the

8804

\m[blue]\fBmap to guest\fR\m[]

8805

parameter for details on doing this\&.

8806

.sp

8807

See also the section

8808

NOTE ABOUT USERNAME/PASSWORD VALIDATION\&.

8809

.sp

8810

See also the

8811

\m[blue]\fBpassword server\fR\m[]

8812

parameter and the

8813

\m[blue]\fBencrypted passwords\fR\m[]

8814

parameter\&.

8815

.sp

8816

\fISECURITY = ADS\fR

8817

.sp

8818

In this mode, Samba will act as a domain member in an ADS realm\&. To operate in this mode, the machine running Samba will need to have Kerberos installed and configured and Samba will need to be joined to the ADS realm using the net utility\&.

8819

.sp

8820

Note that this mode does NOT make Samba operate as a Active Directory Domain Controller\&.

8821

.sp

8822

Read the chapter about Domain Membership in the HOWTO for details\&.

8823

.sp

8824

Default:

8825

\fI\fIsecurity\fR\fR\fI = \fR\fIUSER\fR\fI \fR

8826

.sp

8827

Example:

8828

\fI\fIsecurity\fR\fR\fI = \fR\fIDOMAIN\fR\fI \fR

8829

.RE

8830

8831

send spnego principal (G)

8832

.\" send spnego principal

8833

.PP

8834

.RS 4

8835

This parameter determines whether or not

8836

\fBsmbd\fR(8)

8837

will send the server\-supplied principal sometimes given in the SPNEGO exchange\&.

8838

.sp

8839

If enabled, Samba can attempt to help clients to use Kerberos to contact it, even when known only by IP address or a name not registered with our KDC as a service principal name\&. Kerberos relies on names, so ordinarily cannot function in this situation\&.

8840

.sp

8841

If disabled, Samba will send the string not_defined_in_RFC4178@please_ignore as the \'rfc4178 hint\', following the updated RFC and Windows 2008 behaviour in this area\&.

8842

.sp

8843

Note that Windows XP SP2 and later versions already ignored this value in all circumstances\&.

8844

.sp

8845

Default:

8846

\fI\fIsend spnego principal\fR\fR\fI = \fR\fIno\fR\fI \fR

8847

.RE

8848

8849

server schannel (G)

8850

.\" server schannel

8851

.PP

8852

.RS 4

8853

This controls whether the server offers or even demands the use of the netlogon schannel\&.

8854

\m[blue]\fBserver schannel = no\fR\m[]

8855

does not offer the schannel,

8856

\m[blue]\fBserver schannel = auto\fR\m[]

8857

offers the schannel but does not enforce it, and

8858

\m[blue]\fBserver schannel = yes\fR\m[]

8859

denies access if the client is not able to speak netlogon schannel\&. This is only the case for Windows NT4 before SP4\&.

8860

.sp

8861

Please note that with this set to

8862

no, you will have to apply the WindowsXP

8863

WinXP_SignOrSeal\&.reg

8864

registry patch found in the docs/registry subdirectory of the Samba distribution tarball\&.

8865

.sp

8866

Default:

8867

\fI\fIserver schannel\fR\fR\fI = \fR\fIauto\fR\fI \fR

8868

.sp

8869

Example:

8870

\fI\fIserver schannel\fR\fR\fI = \fR\fIyes\fR\fI \fR

8871

.RE

8872

8873

server signing (G)

8874

.\" server signing

8875

.PP

8876

.RS 4

8877

This controls whether the client is allowed or required to use SMB signing\&. Possible values are

8878

\fIauto\fR,

8879

\fImandatory\fR

8880

and

8881

\fIdisabled\fR\&.

8882

.sp

8883

When set to auto, SMB signing is offered, but not enforced\&. When set to mandatory, SMB signing is required and if set to disabled, SMB signing is not offered either\&.

8884

.sp

8885

Default:

8886

\fI\fIserver signing\fR\fR\fI = \fR\fIDisabled\fR\fI \fR

8887

.RE

8888

8889

server string (G)

8890

.\" server string

8891

.PP

8892

.RS 4

8893

This controls what string will show up in the printer comment box in print manager and next to the IPC connection in

8894

net view\&. It can be any string that you wish to show to your users\&.

8895

.sp

8896

It also sets what will appear in browse lists next to the machine name\&.

8897

.sp

8898

8899

\fI%v\fR

8900

will be replaced with the Samba version number\&.

8901

.sp

8902

8903

\fI%h\fR

8904

will be replaced with the hostname\&.

8905

.sp

8906

Default:

8907

\fI\fIserver string\fR\fR\fI = \fR\fISamba %v\fR\fI \fR

8908

.sp

8909

Example:

8910

\fI\fIserver string\fR\fR\fI = \fR\fIUniversity of GNUs Samba Server\fR\fI \fR

8911

.RE

8912

8913

set directory (S)

8914

.\" set directory

8915

.PP

8916

.RS 4

8917

8918

set directory = no, then users of the service may not use the setdir command to change directory\&.

8919

.sp

8920

The

8921

setdir

8922

command is only implemented in the Digital Pathworks client\&. See the Pathworks documentation for details\&.

8923

.sp

8924

Default:

8925

\fI\fIset directory\fR\fR\fI = \fR\fIno\fR\fI \fR

8926

.RE

8927

8928

set primary group script (G)

8929

.\" set primary group script

8930

.PP

8931

.RS 4

8932

Thanks to the Posix subsystem in NT a Windows User has a primary group in addition to the auxiliary groups\&. This script sets the primary group in the unix userdatase when an administrator sets the primary group from the windows user manager or when fetching a SAM with

8933

net rpc vampire\&.

8934

\fI%u\fR

8935

will be replaced with the user whose primary group is to be set\&.

8936

\fI%g\fR

8937

will be replaced with the group to set\&.

8938

.sp

8939

Default:

8940

\fI\fIset primary group script\fR\fR\fI = \fR\fI\fR\fI \fR

8941

.sp

8942

Example:

8943

\fI\fIset primary group script\fR\fR\fI = \fR\fI/usr/sbin/usermod \-g \'%g\' \'%u\'\fR\fI \fR

8944

.RE

8945

8946

set quota command (G)

8947

.\" set quota command

8948

.PP

8949

.RS 4

8950

The

8951

set quota command

8952

should only be used whenever there is no operating system API available from the OS that samba can use\&.

8953

.sp

8954

This option is only available if Samba was configured with the argument

8955

\-\-with\-sys\-quotas

8956

or on linux when

8957

\&./configure \-\-with\-quotas

8958

was used and a working quota api was found in the system\&. Most packages are configured with these options already\&.

8959

.sp

8960

This parameter should specify the path to a script that can set quota for the specified arguments\&.

8961

.sp

8962

The specified script should take the following arguments:

8963

.sp

8964

.RS 4

8965

.ie n \{\

8966

\h'-04'\(bu\h'+03'\c

8967

.\}

8968

.el \{\

8969

.sp -1

8970

.IP \(bu 2.3

8971

.\}

8972

1 \- quota type

8973

.sp

8974

.RS 4

8975

.ie n \{\

8976

\h'-04'\(bu\h'+03'\c

8977

.\}

8978

.el \{\

8979

.sp -1

8980

.IP \(bu 2.3

8981

.\}

8982

1 \- user quotas

8983

.RE

8984

.sp

8985

.RS 4

8986

.ie n \{\

8987

\h'-04'\(bu\h'+03'\c

8988

.\}

8989

.el \{\

8990

.sp -1

8991

.IP \(bu 2.3

8992

.\}

8993

2 \- user default quotas (uid = \-1)

8994

.RE

8995

.sp

8996

.RS 4

8997

.ie n \{\

8998

\h'-04'\(bu\h'+03'\c

8999

.\}

9000

.el \{\

9001

.sp -1

9002

.IP \(bu 2.3

9003

.\}

9004

3 \- group quotas

9005

.RE

9006

.sp

9007

.RS 4

9008

.ie n \{\

9009

\h'-04'\(bu\h'+03'\c

9010

.\}

9011

.el \{\

9012

.sp -1

9013

.IP \(bu 2.3

9014

.\}

9015

4 \- group default quotas (gid = \-1)

9016

.RE

9017

.sp

9018

.RE

9019

.RE

9020

.sp

9021

.RS 4

9022

.ie n \{\

9023

\h'-04'\(bu\h'+03'\c

9024

.\}

9025

.el \{\

9026

.sp -1

9027

.IP \(bu 2.3

9028

.\}

9029

2 \- id (uid for user, gid for group, \-1 if N/A)

9030

.RE

9031

.sp

9032

.RS 4

9033

.ie n \{\

9034

\h'-04'\(bu\h'+03'\c

9035

.\}

9036

.el \{\

9037

.sp -1

9038

.IP \(bu 2.3

9039

.\}

9040

3 \- quota state (0 = disable, 1 = enable, 2 = enable and enforce)

9041

.RE

9042

.sp

9043

.RS 4

9044

.ie n \{\

9045

\h'-04'\(bu\h'+03'\c

9046

.\}

9047

.el \{\

9048

.sp -1

9049

.IP \(bu 2.3

9050

.\}

9051

4 \- block softlimit

9052

.RE

9053

.sp

9054

.RS 4

9055

.ie n \{\

9056

\h'-04'\(bu\h'+03'\c

9057

.\}

9058

.el \{\

9059

.sp -1

9060

.IP \(bu 2.3

9061

.\}

9062

5 \- block hardlimit

9063

.RE

9064

.sp

9065

.RS 4

9066

.ie n \{\

9067

\h'-04'\(bu\h'+03'\c

9068

.\}

9069

.el \{\

9070

.sp -1

9071

.IP \(bu 2.3

9072

.\}

9073

6 \- inode softlimit

9074

.RE

9075

.sp

9076

.RS 4

9077

.ie n \{\

9078

\h'-04'\(bu\h'+03'\c

9079

.\}

9080

.el \{\

9081

.sp -1

9082

.IP \(bu 2.3

9083

.\}

9084

7 \- inode hardlimit

9085

.RE

9086

.sp

9087

.RS 4

9088

.ie n \{\

9089

\h'-04'\(bu\h'+03'\c

9090

.\}

9091

.el \{\

9092

.sp -1

9093

.IP \(bu 2.3

9094

.\}

9095

8(optional) \- block size, defaults to 1024

9096

.RE

9097

.sp

9098

.RE

9099

The script should output at least one line of data on success\&. And nothing on failure\&.

9100

.sp

9101

Default:

9102

\fI\fIset quota command\fR\fR\fI = \fR\fI\fR\fI \fR

9103

.sp

9104

Example:

9105

\fI\fIset quota command\fR\fR\fI = \fR\fI/usr/local/sbin/set_quota\fR\fI \fR

9106

.RE

9107

9108

share:fake_fscaps (G)

9109

.\" share:fake_fscaps

9110

.PP

9111

.RS 4

9112

This is needed to support some special application that makes QFSINFO calls to check whether we set the SPARSE_FILES bit (0x40)\&. If this bit is not set that particular application refuses to work against Samba\&. With

9113

\m[blue]\fBshare:fake_fscaps = 64\fR\m[]

9114

the SPARSE_FILES file system capability flag is set\&. Use other decimal values to specify the bitmask you need to fake\&.

9115

.sp

9116

Default:

9117

\fI\fIshare:fake_fscaps\fR\fR\fI = \fR\fI0\fR\fI \fR

9118

.RE

9119

9120

share modes (S)

9121

.\" share modes

9122

.PP

9123

.RS 4

9124

This enables or disables the honoring of the

9125

\fIshare modes\fR

9126

during a file open\&. These modes are used by clients to gain exclusive read or write access to a file\&.

9127

.sp

9128

This is a deprecated option from old versions of Samba, and will be removed in the next major release\&.

9129

.sp

9130

These open modes are not directly supported by UNIX, so they are simulated using shared memory\&.

9131

.sp

9132

The share modes that are enabled by this option are the standard Windows share modes\&.

9133

.sp

9134

This option gives full share compatibility and is enabled by default\&.

9135

.sp

9136

You should

9137

\fINEVER\fR

9138

turn this parameter off as many Windows applications will break if you do so\&.

9139

.sp

9140

Default:

9141

\fI\fIshare modes\fR\fR\fI = \fR\fIyes\fR\fI \fR

9142

.RE

9143

9144

short preserve case (S)

9145

.\" short preserve case

9146

.PP

9147

.RS 4

9148

This boolean parameter controls if new files which conform to 8\&.3 syntax, that is all in upper case and of suitable length, are created upper case, or if they are forced to be the

9149

\m[blue]\fBdefault case\fR\m[]\&. This option can be use with

9150

\m[blue]\fBpreserve case = yes\fR\m[]

9151

to permit long filenames to retain their case, while short names are lowered\&.

9152

.sp

9153

See the section on

9154

NAME MANGLING\&.

9155

.sp

9156

Default:

9157

\fI\fIshort preserve case\fR\fR\fI = \fR\fIyes\fR\fI \fR

9158

.RE

9159

9160

show add printer wizard (G)

9161

.\" show add printer wizard

9162

.PP

9163

.RS 4

9164

With the introduction of MS\-RPC based printing support for Windows NT/2000 client in Samba 2\&.2, a "Printers\&.\&.\&." folder will appear on Samba hosts in the share listing\&. Normally this folder will contain an icon for the MS Add Printer Wizard (APW)\&. However, it is possible to disable this feature regardless of the level of privilege of the connected user\&.

9165

.sp

9166

Under normal circumstances, the Windows NT/2000 client will open a handle on the printer server with OpenPrinterEx() asking for Administrator privileges\&. If the user does not have administrative access on the print server (i\&.e is not root or a member of the

9167

\fIprinter admin\fR

9168

group), the OpenPrinterEx() call fails and the client makes another open call with a request for a lower privilege level\&. This should succeed, however the APW icon will not be displayed\&.

9169

.sp

9170

Disabling the

9171

\fIshow add printer wizard\fR

9172

parameter will always cause the OpenPrinterEx() on the server to fail\&. Thus the APW icon will never be displayed\&.

9173

.if n \{\

9174

.sp

9175

.\}

9176

.RS 4

9177

.it 1 an-trap

9178

.nr an-no-space-flag 1

9179

.nr an-break-flag 1

9180

.br

9181

.ps +1

9182

\fBNote\fR

9183

.ps -1

9184

.br

9185

This does not prevent the same user from having administrative privilege on an individual printer\&.

9186

.sp .5v

9187

.RE

9188

Default:

9189

\fI\fIshow add printer wizard\fR\fR\fI = \fR\fIyes\fR\fI \fR

9190

.RE

9191

9192

shutdown script (G)

9193

.\" shutdown script

9194

.PP

9195

.RS 4

9196

This a full path name to a script called by

9197

\fBsmbd\fR(8)

9198

that should start a shutdown procedure\&.

9199

.sp

9200

If the connected user posseses the

9201

\fBSeRemoteShutdownPrivilege\fR, right, this command will be run as root\&.

9202

.sp

9203

The %z %t %r %f variables are expanded as follows:

9204

.sp

9205

.RS 4

9206

.ie n \{\

9207

\h'-04'\(bu\h'+03'\c

9208

.\}

9209

.el \{\

9210

.sp -1

9211

.IP \(bu 2.3

9212

.\}

9213

\fI%z\fR

9214

will be substituted with the shutdown message sent to the server\&.

9215

.RE

9216

.sp

9217

.RS 4

9218

.ie n \{\

9219

\h'-04'\(bu\h'+03'\c

9220

.\}

9221

.el \{\

9222

.sp -1

9223

.IP \(bu 2.3

9224

.\}

9225

\fI%t\fR

9226

will be substituted with the number of seconds to wait before effectively starting the shutdown procedure\&.

9227

.RE

9228

.sp

9229

.RS 4

9230

.ie n \{\

9231

\h'-04'\(bu\h'+03'\c

9232

.\}

9233

.el \{\

9234

.sp -1

9235

.IP \(bu 2.3

9236

.\}

9237

\fI%r\fR

9238

will be substituted with the switch

9239

\fI\-r\fR\&. It means reboot after shutdown for NT\&.

9240

.RE

9241

.sp

9242

.RS 4

9243

.ie n \{\

9244

\h'-04'\(bu\h'+03'\c

9245

.\}

9246

.el \{\

9247

.sp -1

9248

.IP \(bu 2.3

9249

.\}

9250

\fI%f\fR

9251

will be substituted with the switch

9252

\fI\-f\fR\&. It means force the shutdown even if applications do not respond for NT\&.

9253

.RE

9254

.sp

9255

.RE

9256

Shutdown script example:

9257

.sp

9258

.if n \{\

9259

.RS 4

9260

.\}

9261

.nf

9262

#!/bin/bash

9263

9264

time=$2

9265

let time="${time} / 60"

9266

let time="${time} + 1"

9267

9268

/sbin/shutdown $3 $4 +$time $1 &

9269

9270

.fi

9271

.if n \{\

9272

.RE

9273

.\}

9274

.sp

9275

Shutdown does not return so we need to launch it in background\&.

9276

.sp

9277

Default:

9278

\fI\fIshutdown script\fR\fR\fI = \fR\fI\fR\fI \fR

9279

.sp

9280

Example:

9281

\fI\fIshutdown script\fR\fR\fI = \fR\fI/usr/local/samba/sbin/shutdown %m %t %r %f\fR\fI \fR

9282

.RE

9283

9284

smb2 max credits (G)

9285

.\" smb2 max credits

9286

.PP

9287

.RS 4

9288

This option controls the maximum number of outstanding simultaneous SMB2 operations that Samba tells the client it will allow\&. This is similar to the

9289

\m[blue]\fBmax mux\fR\m[]

9290

parameter for SMB1\&. You should never need to set this parameter\&.

9291

.sp

9292

The default is 8192 credits, which is the same as a Windows 2008R2 SMB2 server\&.

9293

.sp

9294

Default:

9295

\fI\fIsmb2 max credits\fR\fR\fI = \fR\fI8192\fR\fI \fR

9296

.RE

9297

9298

smb2 max read (G)

9299

.\" smb2 max read

9300

.PP

9301

.RS 4

9302

This option specifies the protocol value that

9303

\fBsmbd\fR(8)

9304

will return to a client, informing the client of the largest size that may be returned by a single SMB2 read call\&.

9305

.sp

9306

The maximum is 65536 bytes (64KB), which is the same as a Windows Vista SMB2 server\&.

9307

.sp

9308

Default:

9309

\fI\fIsmb2 max read\fR\fR\fI = \fR\fI65536\fR\fI \fR

9310

.RE

9311

9312

smb2 max trans (G)

9313

.\" smb2 max trans

9314

.PP

9315

.RS 4

9316

This option specifies the protocol value that

9317

\fBsmbd\fR(8)

9318

will return to a client, informing the client of the largest size of buffer that may be used in querying file meta\-data via QUERY_INFO and related SMB2 calls\&.

9319

.sp

9320

The maximum is 65536 bytes (64KB), which is the same as a Windows Vista SMB2 server\&.

9321

.sp

9322

Default:

9323

\fI\fIsmb2 max trans\fR\fR\fI = \fR\fI65536\fR\fI \fR

9324

.RE

9325

9326

smb2 max write (G)

9327

.\" smb2 max write

9328

.PP

9329

.RS 4

9330

This option specifies the protocol value that

9331

\fBsmbd\fR(8)

9332

will return to a client, informing the client of the largest size that may be sent to the server by a single SMB2 write call\&.

9333

.sp

9334

The maximum is 65536 bytes (64KB), which is the same as a Windows Vista SMB2 server\&.

9335

.sp

9336

Default:

9337

\fI\fIsmb2 max write\fR\fR\fI = \fR\fI65536\fR\fI \fR

9338

.RE

9339

9340

smb encrypt (S)

9341

.\" smb encrypt

9342

.PP

9343

.RS 4

9344

This is a new feature introduced with Samba 3\&.2 and above\&. It is an extension to the SMB/CIFS protocol negotiated as part of the UNIX extensions\&. SMB encryption uses the GSSAPI (SSPI on Windows) ability to encrypt and sign every request/response in a SMB protocol stream\&. When enabled it provides a secure method of SMB/CIFS communication, similar to an ssh protected session, but using SMB/CIFS authentication to negotiate encryption and signing keys\&. Currently this is only supported by Samba 3\&.2 smbclient, and hopefully soon Linux CIFSFS and MacOS/X clients\&. Windows clients do not support this feature\&.

9345

.sp

9346

This controls whether the remote client is allowed or required to use SMB encryption\&. Possible values are

9347

\fIauto\fR,

9348

\fImandatory\fR

9349

and

9350

\fIdisabled\fR\&. This may be set on a per\-share basis, but clients may chose to encrypt the entire session, not just traffic to a specific share\&. If this is set to mandatory then all traffic to a share

9351

\fImust\fR

9352

must be encrypted once the connection has been made to the share\&. The server would return "access denied" to all non\-encrypted requests on such a share\&. Selecting encrypted traffic reduces throughput as smaller packet sizes must be used (no huge UNIX style read/writes allowed) as well as the overhead of encrypting and signing all the data\&.

9353

.sp

9354

If SMB encryption is selected, Windows style SMB signing (see the

9355

\m[blue]\fBserver signing\fR\m[]

9356

option) is no longer necessary, as the GSSAPI flags use select both signing and sealing of the data\&.

9357

.sp

9358

When set to auto, SMB encryption is offered, but not enforced\&. When set to mandatory, SMB encryption is required and if set to disabled, SMB encryption can not be negotiated\&.

9359

.sp

9360

Default:

9361

\fI\fIsmb encrypt\fR\fR\fI = \fR\fIauto\fR\fI \fR

9362

.RE

9363

9364

smb passwd file (G)

9365

.\" smb passwd file

9366

.PP

9367

.RS 4

9368

This option sets the path to the encrypted smbpasswd file\&. By default the path to the smbpasswd file is compiled into Samba\&.

9369

.sp

9370

An example of use is:

9371

.sp

9372

.if n \{\

9373

.RS 4

9374

.\}

9375

.nf

9376

smb passwd file = /etc/samba/smbpasswd

9377

.fi

9378

.if n \{\

9379

.RE

9380

.\}

9381

.sp

9382

Default:

9383

\fI\fIsmb passwd file\fR\fR\fI = \fR\fI${prefix}/private/smbpasswd\fR\fI \fR

9384

.RE

9385

9386

smb ports (G)

9387

.\" smb ports

9388

.PP

9389

.RS 4

9390

Specifies which ports the server should listen on for SMB traffic\&.

9391

.sp

9392

Default:

9393

\fI\fIsmb ports\fR\fR\fI = \fR\fI445 139\fR\fI \fR

9394

.RE

9395

9396

socket address (G)

9397

.\" socket address

9398

.PP

9399

.RS 4

9400

This option allows you to control what address Samba will listen for connections on\&. This is used to support multiple virtual interfaces on the one server, each with a different configuration\&.

9401

.sp

9402

Setting this option should never be necessary on usual Samba servers running only one nmbd\&.

9403

.sp

9404

By default Samba will accept connections on any address\&.

9405

.sp

9406

Default:

9407

\fI\fIsocket address\fR\fR\fI = \fR\fI\fR\fI \fR

9408

.sp

9409

Example:

9410

\fI\fIsocket address\fR\fR\fI = \fR\fI192\&.168\&.2\&.20\fR\fI \fR

9411

.RE

9412

9413

socket options (G)

9414

.\" socket options

9415

.PP

9416

.RS 4

9417

This option allows you to set socket options to be used when talking with the client\&.

9418

.sp

9419

Socket options are controls on the networking layer of the operating systems which allow the connection to be tuned\&.

9420

.sp

9421

This option will typically be used to tune your Samba server for optimal performance for your local network\&. There is no way that Samba can know what the optimal parameters are for your net, so you must experiment and choose them yourself\&. We strongly suggest you read the appropriate documentation for your operating system first (perhaps

9422

man setsockopt

9423

will help)\&.

9424

.sp

9425

You may find that on some systems Samba will say "Unknown socket option" when you supply an option\&. This means you either incorrectly typed it or you need to add an include file to includes\&.h for your OS\&. If the latter is the case please send the patch to

9426

samba\-technical@samba\&.org\&.

9427

.sp

9428

Any of the supported socket options may be combined in any way you like, as long as your OS allows it\&.

9429

.sp

9430

This is the list of socket options currently settable using this option:

9431

.sp

9432

.RS 4

9433

.ie n \{\

9434

\h'-04'\(bu\h'+03'\c

9435

.\}

9436

.el \{\

9437

.sp -1

9438

.IP \(bu 2.3

9439

.\}

9440

SO_KEEPALIVE

9441

.RE

9442

.sp

9443

.RS 4

9444

.ie n \{\

9445

\h'-04'\(bu\h'+03'\c

9446

.\}

9447

.el \{\

9448

.sp -1

9449

.IP \(bu 2.3

9450

.\}

9451

SO_REUSEADDR

9452

.RE

9453

.sp

9454

.RS 4

9455

.ie n \{\

9456

\h'-04'\(bu\h'+03'\c

9457

.\}

9458

.el \{\

9459

.sp -1

9460

.IP \(bu 2.3

9461

.\}

9462

SO_BROADCAST

9463

.RE

9464

.sp

9465

.RS 4

9466

.ie n \{\

9467

\h'-04'\(bu\h'+03'\c

9468

.\}

9469

.el \{\

9470

.sp -1

9471

.IP \(bu 2.3

9472

.\}

9473

TCP_NODELAY

9474

.RE

9475

.sp

9476

.RS 4

9477

.ie n \{\

9478

\h'-04'\(bu\h'+03'\c

9479

.\}

9480

.el \{\

9481

.sp -1

9482

.IP \(bu 2.3

9483

.\}

9484

IPTOS_LOWDELAY

9485

.RE

9486

.sp

9487

.RS 4

9488

.ie n \{\

9489

\h'-04'\(bu\h'+03'\c

9490

.\}

9491

.el \{\

9492

.sp -1

9493

.IP \(bu 2.3

9494

.\}

9495

IPTOS_THROUGHPUT

9496

.RE

9497

.sp

9498

.RS 4

9499

.ie n \{\

9500

\h'-04'\(bu\h'+03'\c

9501

.\}

9502

.el \{\

9503

.sp -1

9504

.IP \(bu 2.3

9505

.\}

9506

SO_SNDBUF *

9507

.RE

9508

.sp

9509

.RS 4

9510

.ie n \{\

9511

\h'-04'\(bu\h'+03'\c

9512

.\}

9513

.el \{\

9514

.sp -1

9515

.IP \(bu 2.3

9516

.\}

9517

SO_RCVBUF *

9518

.RE

9519

.sp

9520

.RS 4

9521

.ie n \{\

9522

\h'-04'\(bu\h'+03'\c

9523

.\}

9524

.el \{\

9525

.sp -1

9526

.IP \(bu 2.3

9527

.\}

9528

SO_SNDLOWAT *

9529

.RE

9530

.sp

9531

.RS 4

9532

.ie n \{\

9533

\h'-04'\(bu\h'+03'\c

9534

.\}

9535

.el \{\

9536

.sp -1

9537

.IP \(bu 2.3

9538

.\}

9539

SO_RCVLOWAT *

9540

.RE

9541

.sp

9542

.RE

9543

Those marked with a

9544

\fI\'*\'\fR

9545

take an integer argument\&. The others can optionally take a 1 or 0 argument to enable or disable the option, by default they will be enabled if you don\'t specify 1 or 0\&.

9546

.sp

9547

To specify an argument use the syntax SOME_OPTION = VALUE for example

9548

SO_SNDBUF = 8192\&. Note that you must not have any spaces before or after the = sign\&.

9549

.sp

9550

If you are on a local network then a sensible option might be:

9551

.sp

9552

socket options = IPTOS_LOWDELAY

9553

.sp

9554

If you have a local network then you could try:

9555

.sp

9556

socket options = IPTOS_LOWDELAY TCP_NODELAY

9557

.sp

9558

If you are on a wide area network then perhaps try setting IPTOS_THROUGHPUT\&.

9559

.sp

9560

Note that several of the options may cause your Samba server to fail completely\&. Use these options with caution!

9561

.sp

9562

Default:

9563

\fI\fIsocket options\fR\fR\fI = \fR\fITCP_NODELAY\fR\fI \fR

9564

.sp

9565

Example:

9566

\fI\fIsocket options\fR\fR\fI = \fR\fIIPTOS_LOWDELAY\fR\fI \fR

9567

.RE

9568

9569

stat cache (G)

9570

.\" stat cache

9571

.PP

9572

.RS 4

9573

This parameter determines if

9574

\fBsmbd\fR(8)

9575

will use a cache in order to speed up case insensitive name mappings\&. You should never need to change this parameter\&.

9576

.sp

9577

Default:

9578

\fI\fIstat cache\fR\fR\fI = \fR\fIyes\fR\fI \fR

9579

.RE

9580

9581

state directory (G)

9582

.\" state directory

9583

.PP

9584

.RS 4

9585

Usually, most of the TDB files are stored in the

9586

\fIlock directory\fR\&. Since Samba 3\&.4\&.0, it is possible to differentiate between TDB files with persistent data and TDB files with non\-persistent data using the

9587

\fIstate directory\fR

9588

and the

9589

\fIcache directory\fR

9590

options\&.

9591

.sp

9592

This option specifies the directory where TDB files containing persistent data will be stored\&.

9593

.sp

9594

Default:

9595

\fI\fIstate directory\fR\fR\fI = \fR\fI${prefix}/var/locks\fR\fI \fR

9596

.sp

9597

Example:

9598

\fI\fIstate directory\fR\fR\fI = \fR\fI/var/run/samba/locks/state\fR\fI \fR

9599

.RE

9600

9601

store dos attributes (S)

9602

.\" store dos attributes

9603

.PP

9604

.RS 4

9605

If this parameter is set Samba attempts to first read DOS attributes (SYSTEM, HIDDEN, ARCHIVE or READ\-ONLY) from a filesystem extended attribute, before mapping DOS attributes to UNIX permission bits (such as occurs with

9606

\m[blue]\fBmap hidden\fR\m[]

9607

and

9608

\m[blue]\fBmap readonly\fR\m[])\&. When set, DOS attributes will be stored onto an extended attribute in the UNIX filesystem, associated with the file or directory\&. For no other mapping to occur as a fall\-back, the parameters

9609

\m[blue]\fBmap hidden\fR\m[],

9610

\m[blue]\fBmap system\fR\m[],

9611

\m[blue]\fBmap archive\fR\m[]

9612

and

9613

\m[blue]\fBmap readonly\fR\m[]

9614

must be set to off\&. This parameter writes the DOS attributes as a string into the extended attribute named "user\&.DOSATTRIB"\&. This extended attribute is explicitly hidden from smbd clients requesting an EA list\&. On Linux the filesystem must have been mounted with the mount option user_xattr in order for extended attributes to work, also extended attributes must be compiled into the Linux kernel\&. In Samba 3\&.5\&.0 and above the "user\&.DOSATTRIB" extended attribute has been extended to store the create time for a file as well as the DOS attributes\&. This is done in a backwards compatible way so files created by Samba 3\&.5\&.0 and above can still have the DOS attribute read from this extended attribute by earlier versions of Samba, but they will not be able to read the create time stored there\&. Storing the create time separately from the normal filesystem meta\-data allows Samba to faithfully reproduce NTFS semantics on top of a POSIX filesystem\&.

9615

.sp

9616

Default:

9617

\fI\fIstore dos attributes\fR\fR\fI = \fR\fIno\fR\fI \fR

9618

.RE

9619

9620

strict allocate (S)

9621

.\" strict allocate

9622

.PP

9623

.RS 4

9624

This is a boolean that controls the handling of disk space allocation in the server\&. When this is set to

9625

\fByes\fR

9626

the server will change from UNIX behaviour of not committing real disk storage blocks when a file is extended to the Windows behaviour of actually forcing the disk system to allocate real storage blocks when a file is created or extended to be a given size\&. In UNIX terminology this means that Samba will stop creating sparse files\&.

9627

.sp

9628

This option is really desgined for file systems that support fast allocation of large numbers of blocks such as extent\-based file systems\&. On file systems that don\'t support extents (most notably ext3) this can make Samba slower\&. When you work with large files over >100MB on file systems without extents you may even run into problems with clients running into timeouts\&.

9629

.sp

9630

When you have an extent based filesystem it\'s likely that we can make use of unwritten extents which allows Samba to allocate even large amounts of space very fast and you will not see any timeout problems caused by strict allocate\&. With strict allocate in use you will also get much better out of quota messages in case you use quotas\&. Another advantage of activating this setting is that it will help to reduce file fragmentation\&.

9631

.sp

9632

To give you an idea on which filesystems this setting might currently be a good option for you: XFS, ext4, btrfs, ocfs2 on Linux and JFS2 on AIX support unwritten extents\&. On Filesystems that do not support it, preallocation is probably an expensive operation where you will see reduced performance and risk to let clients run into timeouts when creating large files\&. Examples are ext3, ZFS, HFS+ and most others, so be aware if you activate this setting on those filesystems\&.

9633

.sp

9634

Default:

9635

\fI\fIstrict allocate\fR\fR\fI = \fR\fIno\fR\fI \fR

9636

.RE

9637

9638

strict locking (S)

9639

.\" strict locking

9640

.PP

9641

.RS 4

9642

This is an enumerated type that controls the handling of file locking in the server\&. When this is set to

9643

\fByes\fR, the server will check every read and write access for file locks, and deny access if locks exist\&. This can be slow on some systems\&.

9644

.sp

9645

When strict locking is set to Auto (the default), the server performs file lock checks only on non\-oplocked files\&. As most Windows redirectors perform file locking checks locally on oplocked files this is a good trade off for improved performance\&.

9646

.sp

9647

When strict locking is disabled, the server performs file lock checks only when the client explicitly asks for them\&.

9648

.sp

9649

Well\-behaved clients always ask for lock checks when it is important\&. So in the vast majority of cases,

9650

strict locking = Auto

9651

9652

strict locking = no

9653

is acceptable\&.

9654

.sp

9655

Default:

9656

\fI\fIstrict locking\fR\fR\fI = \fR\fIAuto\fR\fI \fR

9657

.RE

9658

9659

strict sync (S)

9660

.\" strict sync

9661

.PP

9662

.RS 4

9663

Many Windows applications (including the Windows 98 explorer shell) seem to confuse flushing buffer contents to disk with doing a sync to disk\&. Under UNIX, a sync call forces the process to be suspended until the kernel has ensured that all outstanding data in kernel disk buffers has been safely stored onto stable storage\&. This is very slow and should only be done rarely\&. Setting this parameter to

9664

\fBno\fR

9665

(the default) means that

9666

\fBsmbd\fR(8)

9667

ignores the Windows applications requests for a sync call\&. There is only a possibility of losing data if the operating system itself that Samba is running on crashes, so there is little danger in this default setting\&. In addition, this fixes many performance problems that people have reported with the new Windows98 explorer shell file copies\&.

9668

.sp

9669

Default:

9670

\fI\fIstrict sync\fR\fR\fI = \fR\fIno\fR\fI \fR

9671

.RE

9672

9673

svcctl list (G)

9674

.\" svcctl list

9675

.PP

9676

.RS 4

9677

This option defines a list of init scripts that smbd will use for starting and stopping Unix services via the Win32 ServiceControl API\&. This allows Windows administrators to utilize the MS Management Console plug\-ins to manage a Unix server running Samba\&.

9678

.sp

9679

The administrator must create a directory name

9680

svcctl

9681

in Samba\'s $(libdir) and create symbolic links to the init scripts in

9682

/etc/init\&.d/\&. The name of the links must match the names given as part of the

9683

\fIsvcctl list\fR\&.

9684

.sp

9685

Default:

9686

\fI\fIsvcctl list\fR\fR\fI = \fR\fI\fR\fI \fR

9687

.sp

9688

Example:

9689

\fI\fIsvcctl list\fR\fR\fI = \fR\fIcups postfix portmap httpd\fR\fI \fR

9690

.RE

9691

9692

sync always (S)

9693

.\" sync always

9694

.PP

9695

.RS 4

9696

This is a boolean parameter that controls whether writes will always be written to stable storage before the write call returns\&. If this is

9697

\fBno\fR

9698

then the server will be guided by the client\'s request in each write call (clients can set a bit indicating that a particular write should be synchronous)\&. If this is

9699

\fByes\fR

9700

then every write will be followed by a

9701

fsync()

9702

call to ensure the data is written to disk\&. Note that the

9703

\fIstrict sync\fR

9704

parameter must be set to

9705

\fByes\fR

9706

in order for this parameter to have any effect\&.

9707

.sp

9708

Default:

9709

\fI\fIsync always\fR\fR\fI = \fR\fIno\fR\fI \fR

9710

.RE

9711

9712

syslog only (G)

9713

.\" syslog only

9714

.PP

9715

.RS 4

9716

If this parameter is set then Samba debug messages are logged into the system syslog only, and not to the debug log files\&. There still will be some logging to log\&.[sn]mbd even if

9717

\fIsyslog only\fR

9718

is enabled\&.

9719

.sp

9720

Default:

9721

\fI\fIsyslog only\fR\fR\fI = \fR\fIno\fR\fI \fR

9722

.RE

9723

9724

syslog (G)

9725

.\" syslog

9726

.PP

9727

.RS 4

9728

This parameter maps how Samba debug messages are logged onto the system syslog logging levels\&. Samba debug level zero maps onto syslog

9729

\fBLOG_ERR\fR, debug level one maps onto

9730

\fBLOG_WARNING\fR, debug level two maps onto

9731

\fBLOG_NOTICE\fR, debug level three maps onto LOG_INFO\&. All higher levels are mapped to

9732

\fBLOG_DEBUG\fR\&.

9733

.sp

9734

This parameter sets the threshold for sending messages to syslog\&. Only messages with debug level less than this value will be sent to syslog\&. There still will be some logging to log\&.[sn]mbd even if

9735

\fIsyslog only\fR

9736

is enabled\&.

9737

.sp

9738

Default:

9739

\fI\fIsyslog\fR\fR\fI = \fR\fI1\fR\fI \fR

9740

.RE

9741

9742

template homedir (G)

9743

.\" template homedir

9744

.PP

9745

.RS 4

9746

When filling out the user information for a Windows NT user, the

9747

\fBwinbindd\fR(8)

9748

daemon uses this parameter to fill in the home directory for that user\&. If the string

9749

\fI%D\fR

9750

is present it is substituted with the user\'s Windows NT domain name\&. If the string

9751

\fI%U\fR

9752

is present it is substituted with the user\'s Windows NT user name\&.

9753

.sp

9754

Default:

9755

\fI\fItemplate homedir\fR\fR\fI = \fR\fI/home/%D/%U\fR\fI \fR

9756

.RE

9757

9758

template shell (G)

9759

.\" template shell

9760

.PP

9761

.RS 4

9762

When filling out the user information for a Windows NT user, the

9763

\fBwinbindd\fR(8)

9764

daemon uses this parameter to fill in the login shell for that user\&.

9765

.sp

9766

\fINo default\fR

9767

.RE

9768

9769

time offset (G)

9770

.\" time offset

9771

.PP

9772

.RS 4

9773

This deprecated parameter is a setting in minutes to add to the normal GMT to local time conversion\&. This is useful if you are serving a lot of PCs that have incorrect daylight saving time handling\&.

9774

.if n \{\

9775

.sp

9776

.\}

9777

.RS 4

9778

.it 1 an-trap

9779

.nr an-no-space-flag 1

9780

.nr an-break-flag 1

9781

.br

9782

.ps +1

9783

\fBNote\fR

9784

.ps -1

9785

.br

9786

This option is deprecated, and will be removed in the next major release

9787

.sp .5v

9788

.RE

9789

Default:

9790

\fI\fItime offset\fR\fR\fI = \fR\fI0\fR\fI \fR

9791

.sp

9792

Example:

9793

\fI\fItime offset\fR\fR\fI = \fR\fI60\fR\fI \fR

9794

.RE

9795

9796

time server (G)

9797

.\" time server

9798

.PP

9799

.RS 4

9800

This parameter determines if

9801

\fBnmbd\fR(8)

9802

advertises itself as a time server to Windows clients\&.

9803

.sp

9804

Default:

9805

\fI\fItime server\fR\fR\fI = \fR\fIno\fR\fI \fR

9806

.RE

9807

9808

unix charset (G)

9809

.\" unix charset

9810

.PP

9811

.RS 4

9812

Specifies the charset the unix machine Samba runs on uses\&. Samba needs to know this in order to be able to convert text to the charsets other SMB clients use\&.

9813

.sp

9814

This is also the charset Samba will use when specifying arguments to scripts that it invokes\&.

9815

.sp

9816

Default:

9817

\fI\fIunix charset\fR\fR\fI = \fR\fIUTF8\fR\fI \fR

9818

.sp

9819

Example:

9820

\fI\fIunix charset\fR\fR\fI = \fR\fIASCII\fR\fI \fR

9821

.RE

9822

9823

unix extensions (G)

9824

.\" unix extensions

9825

.PP

9826

.RS 4

9827

This boolean parameter controls whether Samba implements the CIFS UNIX extensions, as defined by HP\&. These extensions enable Samba to better serve UNIX CIFS clients by supporting features such as symbolic links, hard links, etc\&.\&.\&. These extensions require a similarly enabled client, and are of no current use to Windows clients\&.

9828

.sp

9829

Note if this parameter is turned on, the

9830

\m[blue]\fBwide links\fR\m[]

9831

parameter will automatically be disabled\&.

9832

.sp

9833

See the parameter

9834

\m[blue]\fBallow insecure wide links\fR\m[]

9835

if you wish to change this coupling between the two parameters\&.

9836

.sp

9837

Default:

9838

\fI\fIunix extensions\fR\fR\fI = \fR\fIyes\fR\fI \fR

9839

.RE

9840

9841

unix password sync (G)

9842

.\" unix password sync

9843

.PP

9844

.RS 4

9845

This boolean parameter controls whether Samba attempts to synchronize the UNIX password with the SMB password when the encrypted SMB password in the smbpasswd file is changed\&. If this is set to

9846

\fByes\fR

9847

the program specified in the

9848

\fIpasswd program\fR

9849

parameter is called

9850

\fIAS ROOT\fR

9851

\- to allow the new UNIX password to be set without access to the old UNIX password (as the SMB password change code has no access to the old password cleartext, only the new)\&.

9852

.sp

9853

Default:

9854

\fI\fIunix password sync\fR\fR\fI = \fR\fIno\fR\fI \fR

9855

.RE

9856

9857

use client driver (S)

9858

.\" use client driver

9859

.PP

9860

.RS 4

9861

This parameter applies only to Windows NT/2000 clients\&. It has no effect on Windows 95/98/ME clients\&. When serving a printer to Windows NT/2000 clients without first installing a valid printer driver on the Samba host, the client will be required to install a local printer driver\&. From this point on, the client will treat the print as a local printer and not a network printer connection\&. This is much the same behavior that will occur when

9862

disable spoolss = yes\&.

9863

.sp

9864

The differentiating factor is that under normal circumstances, the NT/2000 client will attempt to open the network printer using MS\-RPC\&. The problem is that because the client considers the printer to be local, it will attempt to issue the OpenPrinterEx() call requesting access rights associated with the logged on user\&. If the user possesses local administator rights but not root privilege on the Samba host (often the case), the OpenPrinterEx() call will fail\&. The result is that the client will now display an "Access Denied; Unable to connect" message in the printer queue window (even though jobs may successfully be printed)\&.

9865

.sp

9866

If this parameter is enabled for a printer, then any attempt to open the printer with the PRINTER_ACCESS_ADMINISTER right is mapped to PRINTER_ACCESS_USE instead\&. Thus allowing the OpenPrinterEx() call to succeed\&.

9867

\fIThis parameter MUST not be enabled on a print share which has valid print driver installed on the Samba server\&.\fR

9868

.sp

9869

Default:

9870

\fI\fIuse client driver\fR\fR\fI = \fR\fIno\fR\fI \fR

9871

.RE

9872

9873

use mmap (G)

9874

.\" use mmap

9875

.PP

9876

.RS 4

9877

This global parameter determines if the tdb internals of Samba can depend on mmap working correctly on the running system\&. Samba requires a coherent mmap/read\-write system memory cache\&. Currently only HPUX does not have such a coherent cache, and so this parameter is set to

9878

\fBno\fR

9879

by default on HPUX\&. On all other systems this parameter should be left alone\&. This parameter is provided to help the Samba developers track down problems with the tdb internal code\&.

9880

.sp

9881

Default:

9882

\fI\fIuse mmap\fR\fR\fI = \fR\fIyes\fR\fI \fR

9883

.RE

9884

9885

username level (G)

9886

.\" username level

9887

.PP

9888

.RS 4

9889

This option helps Samba to try and \'guess\' at the real UNIX username, as many DOS clients send an all\-uppercase username\&. By default Samba tries all lowercase, followed by the username with the first letter capitalized, and fails if the username is not found on the UNIX machine\&.

9890

.sp

9891

If this parameter is set to non\-zero the behavior changes\&. This parameter is a number that specifies the number of uppercase combinations to try while trying to determine the UNIX user name\&. The higher the number the more combinations will be tried, but the slower the discovery of usernames will be\&. Use this parameter when you have strange usernames on your UNIX machine, such as

9892

\fBAstrangeUser \fR\&.

9893

.sp

9894

This parameter is needed only on UNIX systems that have case sensitive usernames\&.

9895

.sp

9896

Default:

9897

\fI\fIusername level\fR\fR\fI = \fR\fI0\fR\fI \fR

9898

.sp

9899

Example:

9900

\fI\fIusername level\fR\fR\fI = \fR\fI5\fR\fI \fR

9901

.RE

9902

9903

username map cache time (G)

9904

.\" username map cache time

9905

.PP

9906

.RS 4

9907

Mapping usernames with the

9908

\m[blue]\fBusername map\fR\m[]

9909

9910

\m[blue]\fBusername map script\fR\m[]

9911

features of Samba can be relatively expensive\&. During login of a user, the mapping is done several times\&. In particular, calling the

9912

\m[blue]\fBusername map script\fR\m[]

9913

can slow down logins if external databases have to be queried from the script being called\&.

9914

.sp

9915

The parameter

9916

\m[blue]\fBusername map cache time\fR\m[]

9917

controls a mapping cache\&. It specifies the number of seconds a mapping from the username map file or script is to be efficiently cached\&. The default of 0 means no caching is done\&.

9918

.sp

9919

Default:

9920

\fI\fIusername map cache time\fR\fR\fI = \fR\fI0\fR\fI \fR

9921

.sp

9922

Example:

9923

\fI\fIusername map cache time\fR\fR\fI = \fR\fI60\fR\fI \fR

9924

.RE

9925

9926

username map script (G)

9927

.\" username map script

9928

.PP

9929

.RS 4

9930

This script is a mutually exclusive alternative to the

9931

\m[blue]\fBusername map\fR\m[]

9932

parameter\&. This parameter specifies and external program or script that must accept a single command line option (the username transmitted in the authentication request) and return a line line on standard output (the name to which the account should mapped)\&. In this way, it is possible to store username map tables in an LDAP or NIS directory services\&.

9933

.sp

9934

Default:

9935

\fI\fIusername map script\fR\fR\fI = \fR\fI\fR\fI \fR

9936

.sp

9937

Example:

9938

\fI\fIusername map script\fR\fR\fI = \fR\fI/etc/samba/scripts/mapusers\&.sh\fR\fI \fR

9939

.RE

9940

9941

username map (G)

9942

.\" username map

9943

.PP

9944

.RS 4

9945

This option allows you to specify a file containing a mapping of usernames from the clients to the server\&. This can be used for several purposes\&. The most common is to map usernames that users use on DOS or Windows machines to those that the UNIX box uses\&. The other is to map multiple users to a single username so that they can more easily share files\&.

9946

.sp

9947

Please note that for user or share mode security, the username map is applied prior to validating the user credentials\&. Domain member servers (domain or ads) apply the username map after the user has been successfully authenticated by the domain controller and require fully qualified enties in the map table (e\&.g\&. biddle =

9948

DOMAIN\efoo)\&.

9949

.sp

9950

The map file is parsed line by line\&. Each line should contain a single UNIX username on the left then a \'=\' followed by a list of usernames on the right\&. The list of usernames on the right may contain names of the form @group in which case they will match any UNIX username in that group\&. The special client name \'*\' is a wildcard and matches any name\&. Each line of the map file may be up to 1023 characters long\&.

9951

.sp

9952

The file is processed on each line by taking the supplied username and comparing it with each username on the right hand side of the \'=\' signs\&. If the supplied name matches any of the names on the right hand side then it is replaced with the name on the left\&. Processing then continues with the next line\&.

9953

.sp

9954

If any line begins with a \'#\' or a \';\' then it is ignored\&.

9955

.sp

9956

If any line begins with an \'!\' then the processing will stop after that line if a mapping was done by the line\&. Otherwise mapping continues with every line being processed\&. Using \'!\' is most useful when you have a wildcard mapping line later in the file\&.

9957

.sp

9958

For example to map from the name

9959

\fBadmin\fR

9960

9961

\fBadministrator\fR

9962

to the UNIX name

9963

\fB root\fR

9964

you would use:

9965

.sp

9966

.if n \{\

9967

.RS 4

9968

.\}

9969

.nf

9970

root = admin administrator

9971

.fi

9972

.if n \{\

9973

.RE

9974

.\}

9975

.sp

9976

Or to map anyone in the UNIX group

9977

\fBsystem\fR

9978

to the UNIX name

9979

\fBsys\fR

9980

you would use:

9981

.sp

9982

.if n \{\

9983

.RS 4

9984

.\}

9985

.nf

9986

sys = @system

9987

.fi

9988

.if n \{\

9989

.RE

9990

.\}

9991

.sp

9992

You can have as many mappings as you like in a username map file\&.

9993

.sp

9994

If your system supports the NIS NETGROUP option then the netgroup database is checked before the

9995

/etc/group

9996

database for matching groups\&.

9997

.sp

9998

You can map Windows usernames that have spaces in them by using double quotes around the name\&. For example:

9999

.sp

10000

.if n \{\

10001

.RS 4

10002

.\}

10003

.nf

10004

tridge = "Andrew Tridgell"

10005

.fi

10006

.if n \{\

10007

.RE

10008

.\}

10009

.sp

10010

would map the windows username "Andrew Tridgell" to the unix username "tridge"\&.

10011

.sp

10012

The following example would map mary and fred to the unix user sys, and map the rest to guest\&. Note the use of the \'!\' to tell Samba to stop processing if it gets a match on that line:

10013

.sp

10014

.if n \{\

10015

.RS 4

10016

.\}

10017

.nf

10018

!sys = mary fred

10019

guest = *

10020

.fi

10021

.if n \{\

10022

.RE

10023

.\}

10024

.sp

10025

Note that the remapping is applied to all occurrences of usernames\&. Thus if you connect to \e\eserver\efred and

10026

\fBfred\fR

10027

is remapped to

10028

\fBmary\fR

10029

then you will actually be connecting to \e\eserver\emary and will need to supply a password suitable for

10030

\fBmary\fR

10031

not

10032

\fBfred\fR\&. The only exception to this is the username passed to the

10033

\m[blue]\fBpassword server\fR\m[]

10034

(if you have one)\&. The password server will receive whatever username the client supplies without modification\&.

10035

.sp

10036

Also note that no reverse mapping is done\&. The main effect this has is with printing\&. Users who have been mapped may have trouble deleting print jobs as PrintManager under WfWg will think they don\'t own the print job\&.

10037

.sp

10038

Samba versions prior to 3\&.0\&.8 would only support reading the fully qualified username (e\&.g\&.:

10039

DOMAIN\euser) from the username map when performing a kerberos login from a client\&. However, when looking up a map entry for a user authenticated by NTLM[SSP], only the login name would be used for matches\&. This resulted in inconsistent behavior sometimes even on the same server\&.

10040

.sp

10041

The following functionality is obeyed in version 3\&.0\&.8 and later:

10042

.sp

10043

When performing local authentication, the username map is applied to the login name before attempting to authenticate the connection\&.

10044

.sp

10045

When relying upon a external domain controller for validating authentication requests, smbd will apply the username map to the fully qualified username (i\&.e\&.

10046

DOMAIN\euser) only after the user has been successfully authenticated\&.

10047

.sp

10048

An example of use is:

10049

.sp

10050

.if n \{\

10051

.RS 4

10052

.\}

10053

.nf

10054

username map = /usr/local/samba/lib/users\&.map

10055

.fi

10056

.if n \{\

10057

.RE

10058

.\}

10059

.sp

10060

Default:

10061

\fI\fIusername map\fR\fR\fI = \fR\fI # no username map\fR\fI \fR

10062

.RE

10063

10064

user

10065

.\" user

10066

.PP

10067

.RS 4

10068

This parameter is a synonym for

10069

username\&.

10070

.RE

10071

10072

users

10073

.\" users

10074

.PP

10075

.RS 4

10076

This parameter is a synonym for

10077

username\&.

10078

.RE

10079

10080

username (S)

10081

.\" username

10082

.PP

10083

.RS 4

10084

Multiple users may be specified in a comma\-delimited list, in which case the supplied password will be tested against each username in turn (left to right)\&.

10085

.sp

10086

The deprecated

10087

\fIusername\fR

10088

line is needed only when the PC is unable to supply its own username\&. This is the case for the COREPLUS protocol or where your users have different WfWg usernames to UNIX usernames\&. In both these cases you may also be better using the \e\eserver\eshare%user syntax instead\&.

10089

.sp

10090

The

10091

\fIusername\fR

10092

line is not a great solution in many cases as it means Samba will try to validate the supplied password against each of the usernames in the

10093

\fIusername\fR

10094

line in turn\&. This is slow and a bad idea for lots of users in case of duplicate passwords\&. You may get timeouts or security breaches using this parameter unwisely\&.

10095

.sp

10096

Samba relies on the underlying UNIX security\&. This parameter does not restrict who can login, it just offers hints to the Samba server as to what usernames might correspond to the supplied password\&. Users can login as whoever they please and they will be able to do no more damage than if they started a telnet session\&. The daemon runs as the user that they log in as, so they cannot do anything that user cannot do\&.

10097

.sp

10098

To restrict a service to a particular set of users you can use the

10099

\m[blue]\fBvalid users\fR\m[]

10100

parameter\&.

10101

.sp

10102

If any of the usernames begin with a \'@\' then the name will be looked up first in the NIS netgroups list (if Samba is compiled with netgroup support), followed by a lookup in the UNIX groups database and will expand to a list of all users in the group of that name\&.

10103

.sp

10104

If any of the usernames begin with a \'+\' then the name will be looked up only in the UNIX groups database and will expand to a list of all users in the group of that name\&.

10105

.sp

10106

If any of the usernames begin with a \'&\' then the name will be looked up only in the NIS netgroups database (if Samba is compiled with netgroup support) and will expand to a list of all users in the netgroup group of that name\&.

10107

.sp

10108

Note that searching though a groups database can take quite some time, and some clients may time out during the search\&.

10109

.sp

10110

See the section

10111

NOTE ABOUT USERNAME/PASSWORD VALIDATION

10112

for more information on how this parameter determines access to the services\&.

10113

.sp

10114

Default:

10115

\fI\fIusername\fR\fR\fI = \fR\fI # The guest account if a guest service, else <empty string>\&.\fR\fI \fR

10116

.sp

10117

Example:

10118

\fI\fIusername\fR\fR\fI = \fR\fIfred, mary, jack, jane, @users, @pcgroup\fR\fI \fR

10119

.RE

10120

10121

usershare allow guests (G)

10122

.\" usershare allow guests

10123

.PP

10124

.RS 4

10125

This parameter controls whether user defined shares are allowed to be accessed by non\-authenticated users or not\&. It is the equivalent of allowing people who can create a share the option of setting

10126

\fIguest ok = yes\fR

10127

in a share definition\&. Due to its security sensitive nature, the default is set to off\&.

10128

.sp

10129

Default:

10130

\fI\fIusershare allow guests\fR\fR\fI = \fR\fIno\fR\fI \fR

10131

.RE

10132

10133

usershare max shares (G)

10134

.\" usershare max shares

10135

.PP

10136

.RS 4

10137

This parameter specifies the number of user defined shares that are allowed to be created by users belonging to the group owning the usershare directory\&. If set to zero (the default) user defined shares are ignored\&.

10138

.sp

10139

Default:

10140

\fI\fIusershare max shares\fR\fR\fI = \fR\fI0\fR\fI \fR

10141

.RE

10142

10143

usershare owner only (G)

10144

.\" usershare owner only

10145

.PP

10146

.RS 4

10147

This parameter controls whether the pathname exported by a user defined shares must be owned by the user creating the user defined share or not\&. If set to True (the default) then smbd checks that the directory path being shared is owned by the user who owns the usershare file defining this share and refuses to create the share if not\&. If set to False then no such check is performed and any directory path may be exported regardless of who owns it\&.

10148

.sp

10149

Default:

10150

\fI\fIusershare owner only\fR\fR\fI = \fR\fITrue\fR\fI \fR

10151

.RE

10152

10153

usershare path (G)

10154

.\" usershare path

10155

.PP

10156

.RS 4

10157

This parameter specifies the absolute path of the directory on the filesystem used to store the user defined share definition files\&. This directory must be owned by root, and have no access for other, and be writable only by the group owner\&. In addition the "sticky" bit must also be set, restricting rename and delete to owners of a file (in the same way the /tmp directory is usually configured)\&. Members of the group owner of this directory are the users allowed to create usershares\&. If this parameter is undefined then no user defined shares are allowed\&.

10158

.sp

10159

For example, a valid usershare directory might be /usr/local/samba/lib/usershares, set up as follows\&.

10160

.sp

10161

10162

.sp

10163

.if n \{\

10164

.RS 4

10165

.\}

10166

.nf

10167

ls \-ld /usr/local/samba/lib/usershares/

10168

drwxrwx\-\-T 2 root power_users 4096 2006\-05\-05 12:27 /usr/local/samba/lib/usershares/

10169

10170

.fi

10171

.if n \{\

10172

.RE

10173

.\}

10174

.sp

10175

In this case, only members of the group "power_users" can create user defined shares\&.

10176

.sp

10177

Default:

10178

\fI\fIusershare path\fR\fR\fI = \fR\fINULL\fR\fI \fR

10179

.RE

10180

10181

usershare prefix allow list (G)

10182

.\" usershare prefix allow list

10183

.PP

10184

.RS 4

10185

This parameter specifies a list of absolute pathnames the root of which are allowed to be exported by user defined share definitions\&. If the pathname to be exported doesn\'t start with one of the strings in this list, the user defined share will not be allowed\&. This allows the Samba administrator to restrict the directories on the system that can be exported by user defined shares\&.

10186

.sp

10187

If there is a "usershare prefix deny list" and also a "usershare prefix allow list" the deny list is processed first, followed by the allow list, thus leading to the most restrictive interpretation\&.

10188

.sp

10189

Default:

10190

\fI\fIusershare prefix allow list\fR\fR\fI = \fR\fINULL\fR\fI \fR

10191

.sp

10192

Example:

10193

\fI\fIusershare prefix allow list\fR\fR\fI = \fR\fI/home /data /space\fR\fI \fR

10194

.RE

10195

10196

usershare prefix deny list (G)

10197

.\" usershare prefix deny list

10198

.PP

10199

.RS 4

10200

This parameter specifies a list of absolute pathnames the root of which are NOT allowed to be exported by user defined share definitions\&. If the pathname exported starts with one of the strings in this list the user defined share will not be allowed\&. Any pathname not starting with one of these strings will be allowed to be exported as a usershare\&. This allows the Samba administrator to restrict the directories on the system that can be exported by user defined shares\&.

10201

.sp

10202

10203

.sp

10204

Default:

10205

\fI\fIusershare prefix deny list\fR\fR\fI = \fR\fINULL\fR\fI \fR

10206

.sp

10207

Example:

10208

\fI\fIusershare prefix deny list\fR\fR\fI = \fR\fI/etc /dev /private\fR\fI \fR

10209

.RE

10210

10211

usershare template share (G)

10212

.\" usershare template share

10213

.PP

10214

.RS 4

10215

User defined shares only have limited possible parameters such as path, guest ok, etc\&. This parameter allows usershares to "cloned" from an existing share\&. If "usershare template share" is set to the name of an existing share, then all usershares created have their defaults set from the parameters set on this share\&.

10216

.sp

10217

The target share may be set to be invalid for real file sharing by setting the parameter "\-valid = False" on the template share definition\&. This causes it not to be seen as a real exported share but to be able to be used as a template for usershares\&.

10218

.sp

10219

Default:

10220

\fI\fIusershare template share\fR\fR\fI = \fR\fINULL\fR\fI \fR

10221

.sp

10222

Example:

10223

\fI\fIusershare template share\fR\fR\fI = \fR\fItemplate_share\fR\fI \fR

10224

.RE

10225

10226

use sendfile (S)

10227

.\" use sendfile

10228

.PP

10229

.RS 4

10230

If this parameter is

10231

\fByes\fR, and the

10232

\fBsendfile()\fR

10233

system call is supported by the underlying operating system, then some SMB read calls (mainly ReadAndX and ReadRaw) will use the more efficient sendfile system call for files that are exclusively oplocked\&. This may make more efficient use of the system CPU\'s and cause Samba to be faster\&. Samba automatically turns this off for clients that use protocol levels lower than NT LM 0\&.12 and when it detects a client is Windows 9x (using sendfile from Linux will cause these clients to fail)\&.

10234

.sp

10235

Default:

10236

\fI\fIuse sendfile\fR\fR\fI = \fR\fIfalse\fR\fI \fR

10237

.RE

10238

10239

use spnego (G)

10240

.\" use spnego

10241

.PP

10242

.RS 4

10243

This deprecated variable controls controls whether samba will try to use Simple and Protected NEGOciation (as specified by rfc2478) with WindowsXP and Windows2000 clients to agree upon an authentication mechanism\&.

10244

.sp

10245

Unless further issues are discovered with our SPNEGO implementation, there is no reason this should ever be disabled\&.

10246

.sp

10247

Default:

10248

\fI\fIuse spnego\fR\fR\fI = \fR\fIyes\fR\fI \fR

10249

.RE

10250

10251

utmp directory (G)

10252

.\" utmp directory

10253

.PP

10254

.RS 4

10255

This parameter is only available if Samba has been configured and compiled with the option

10256

\-\-with\-utmp\&. It specifies a directory pathname that is used to store the utmp or utmpx files (depending on the UNIX system) that record user connections to a Samba server\&. By default this is not set, meaning the system will use whatever utmp file the native system is set to use (usually

10257

/var/run/utmp

10258

on Linux)\&.

10259

.sp

10260

Default:

10261

\fI\fIutmp directory\fR\fR\fI = \fR\fI # Determined automatically\fR\fI \fR

10262

.sp

10263

Example:

10264

\fI\fIutmp directory\fR\fR\fI = \fR\fI/var/run/utmp\fR\fI \fR

10265

.RE

10266

10267

utmp (G)

10268

.\" utmp

10269

.PP

10270

.RS 4

10271

This boolean parameter is only available if Samba has been configured and compiled with the option

10272

\-\-with\-utmp\&. If set to

10273

\fByes\fR

10274

then Samba will attempt to add utmp or utmpx records (depending on the UNIX system) whenever a connection is made to a Samba server\&. Sites may use this to record the user connecting to a Samba share\&.

10275

.sp

10276

Due to the requirements of the utmp record, we are required to create a unique identifier for the incoming user\&. Enabling this option creates an n^2 algorithm to find this number\&. This may impede performance on large installations\&.

10277

.sp

10278

Default:

10279

\fI\fIutmp\fR\fR\fI = \fR\fIno\fR\fI \fR

10280

.RE

10281

10282

valid users (S)

10283

.\" valid users

10284

.PP

10285

.RS 4

10286

This is a list of users that should be allowed to login to this service\&. Names starting with \'@\', \'+\' and \'&\' are interpreted using the same rules as described in the

10287

\fIinvalid users\fR

10288

parameter\&.

10289

.sp

10290

If this is empty (the default) then any user can login\&. If a username is in both this list and the

10291

\fIinvalid users\fR

10292

list then access is denied for that user\&.

10293

.sp

10294

The current servicename is substituted for

10295

\fI%S\fR\&. This is useful in the [homes] section\&.

10296

.sp

10297

Default:

10298

\fI\fIvalid users\fR\fR\fI = \fR\fI # No valid users list (anyone can login) \fR\fI \fR

10299

.sp

10300

Example:

10301

\fI\fIvalid users\fR\fR\fI = \fR\fIgreg, @pcusers\fR\fI \fR

10302

.RE

10303

10304

\-valid (S)

10305

.\" -valid

10306

.PP

10307

.RS 4

10308

This parameter indicates whether a share is valid and thus can be used\&. When this parameter is set to false, the share will be in no way visible nor accessible\&.

10309

.sp

10310

This option should not be used by regular users but might be of help to developers\&. Samba uses this option internally to mark shares as deleted\&.

10311

.sp

10312

Default:

10313

\fI\fI\-valid\fR\fR\fI = \fR\fIyes\fR\fI \fR

10314

.RE

10315

10316

veto files (S)

10317

.\" veto files

10318

.PP

10319

.RS 4

10320

This is a list of files and directories that are neither visible nor accessible\&. Each entry in the list must be separated by a \'/\', which allows spaces to be included in the entry\&. \'*\' and \'?\' can be used to specify multiple files or directories as in DOS wildcards\&.

10321

.sp

10322

Each entry must be a unix path, not a DOS path and must

10323

\fInot\fR

10324

include the unix directory separator \'/\'\&.

10325

.sp

10326

Note that the

10327

\m[blue]\fBcase sensitive\fR\m[]

10328

option is applicable in vetoing files\&.

10329

.sp

10330

One feature of the veto files parameter that it is important to be aware of is Samba\'s behaviour when trying to delete a directory\&. If a directory that is to be deleted contains nothing but veto files this deletion will

10331

\fIfail\fR

10332

unless you also set the

10333

\m[blue]\fBdelete veto files\fR\m[]

10334

parameter to

10335

\fIyes\fR\&.

10336

.sp

10337

Setting this parameter will affect the performance of Samba, as it will be forced to check all files and directories for a match as they are scanned\&.

10338

.sp

10339

Examples of use include:

10340

.sp

10341

.if n \{\

10342

.RS 4

10343

.\}

10344

.nf

10345

; Veto any files containing the word Security,

10346

; any ending in \&.tmp, and any directory containing the

10347

; word root\&.

10348

veto files = /*Security*/*\&.tmp/*root*/

10349

10350

; Veto the Apple specific files that a NetAtalk server

10351

; creates\&.

10352

veto files = /\&.AppleDouble/\&.bin/\&.AppleDesktop/Network Trash Folder/

10353

.fi

10354

.if n \{\

10355

.RE

10356

.\}

10357

.sp

10358

Default:

10359

\fI\fIveto files\fR\fR\fI = \fR\fINo files or directories are vetoed\&.\fR\fI \fR

10360

.RE

10361

10362

veto oplock files (S)

10363

.\" veto oplock files

10364

.PP

10365

.RS 4

10366

This parameter is only valid when the

10367

\m[blue]\fBoplocks\fR\m[]

10368

parameter is turned on for a share\&. It allows the Samba administrator to selectively turn off the granting of oplocks on selected files that match a wildcarded list, similar to the wildcarded list used in the

10369

\m[blue]\fBveto files\fR\m[]

10370

parameter\&.

10371

.sp

10372

You might want to do this on files that you know will be heavily contended for by clients\&. A good example of this is in the NetBench SMB benchmark program, which causes heavy client contention for files ending in

10373

\&.SEM\&. To cause Samba not to grant oplocks on these files you would use the line (either in the [global] section or in the section for the particular NetBench share\&.

10374

.sp

10375

An example of use is:

10376

.sp

10377

.if n \{\

10378

.RS 4

10379

.\}

10380

.nf

10381

veto oplock files = /\&.*SEM/

10382

.fi

10383

.if n \{\

10384

.RE

10385

.\}

10386

.sp

10387

Default:

10388

\fI\fIveto oplock files\fR\fR\fI = \fR\fI # No files are vetoed for oplock grants\fR\fI \fR

10389

.RE

10390

10391

vfs object

10392

.\" vfs object

10393

.PP

10394

.RS 4

10395

This parameter is a synonym for

10396

vfs objects\&.

10397

.RE

10398

10399

vfs objects (S)

10400

.\" vfs objects

10401

.PP

10402

.RS 4

10403

This parameter specifies the backend names which are used for Samba VFS I/O operations\&. By default, normal disk I/O operations are used but these can be overloaded with one or more VFS objects\&.

10404

.sp

10405

Default:

10406

\fI\fIvfs objects\fR\fR\fI = \fR\fI\fR\fI \fR

10407

.sp

10408

Example:

10409

\fI\fIvfs objects\fR\fR\fI = \fR\fIextd_audit recycle\fR\fI \fR

10410

.RE

10411

10412

volume (S)

10413

.\" volume

10414

.PP

10415

.RS 4

10416

This allows you to override the volume label returned for a share\&. Useful for CDROMs with installation programs that insist on a particular volume label\&.

10417

.sp

10418

Default:

10419

\fI\fIvolume\fR\fR\fI = \fR\fI # the name of the share\fR\fI \fR

10420

.RE

10421

10422

wide links (S)

10423

.\" wide links

10424

.PP

10425

.RS 4

10426

This parameter controls whether or not links in the UNIX file system may be followed by the server\&. Links that point to areas within the directory tree exported by the server are always allowed; this parameter controls access only to areas that are outside the directory tree being exported\&.

10427

.sp

10428

Note: Turning this parameter on when UNIX extensions are enabled will allow UNIX clients to create symbolic links on the share that can point to files or directories outside restricted path exported by the share definition\&. This can cause access to areas outside of the share\&. Due to this problem, this parameter will be automatically disabled (with a message in the log file) if the

10429

\m[blue]\fBunix extensions\fR\m[]

10430

option is on\&.

10431

.sp

10432

See the parameter

10433

\m[blue]\fBallow insecure wide links\fR\m[]

10434

if you wish to change this coupling between the two parameters\&.

10435

.sp

10436

Default:

10437

\fI\fIwide links\fR\fR\fI = \fR\fIno\fR\fI \fR

10438

.RE

10439

10440

winbind cache time (G)

10441

.\" winbind cache time

10442

.PP

10443

.RS 4

10444

This parameter specifies the number of seconds the

10445

\fBwinbindd\fR(8)

10446

daemon will cache user and group information before querying a Windows NT server again\&.

10447

.sp

10448

This does not apply to authentication requests, these are always evaluated in real time unless the

10449

\m[blue]\fBwinbind offline logon\fR\m[]

10450

option has been enabled\&.

10451

.sp

10452

Default:

10453

\fI\fIwinbind cache time\fR\fR\fI = \fR\fI300\fR\fI \fR

10454

.RE

10455

10456

winbind enum groups (G)

10457

.\" winbind enum groups

10458

.PP

10459

.RS 4

10460

On large installations using

10461

\fBwinbindd\fR(8)

10462

it may be necessary to suppress the enumeration of groups through the

10463

setgrent(),

10464

getgrent()

10465

and

10466

endgrent()

10467

group of system calls\&. If the

10468

\fIwinbind enum groups\fR

10469

parameter is

10470

\fBno\fR, calls to the

10471

getgrent()

10472

system call will not return any data\&.

10473

.if n \{\

10474

.sp

10475

.\}

10476

.RS 4

10477

.it 1 an-trap

10478

.nr an-no-space-flag 1

10479

.nr an-break-flag 1

10480

.br

10481

.ps +1

10482

\fBWarning\fR

10483

.ps -1

10484

.br

10485

Turning off group enumeration may cause some programs to behave oddly\&.

10486

.sp .5v

10487

.RE

10488

Default:

10489

\fI\fIwinbind enum groups\fR\fR\fI = \fR\fIno\fR\fI \fR

10490

.RE

10491

10492

winbind enum users (G)

10493

.\" winbind enum users

10494

.PP

10495

.RS 4

10496

On large installations using

10497

\fBwinbindd\fR(8)

10498

it may be necessary to suppress the enumeration of users through the

10499

setpwent(),

10500

getpwent()

10501

and

10502

endpwent()

10503

group of system calls\&. If the

10504

\fIwinbind enum users\fR

10505

parameter is

10506

\fBno\fR, calls to the

10507

getpwent

10508

system call will not return any data\&.

10509

.if n \{\

10510

.sp

10511

.\}

10512

.RS 4

10513

.it 1 an-trap

10514

.nr an-no-space-flag 1

10515

.nr an-break-flag 1

10516

.br

10517

.ps +1

10518

\fBWarning\fR

10519

.ps -1

10520

.br

10521

Turning off user enumeration may cause some programs to behave oddly\&. For example, the finger program relies on having access to the full user list when searching for matching usernames\&.

10522

.sp .5v

10523

.RE

10524

Default:

10525

\fI\fIwinbind enum users\fR\fR\fI = \fR\fIno\fR\fI \fR

10526

.RE

10527

10528

winbind expand groups (G)

10529

.\" winbind expand groups

10530

.PP

10531

.RS 4

10532

This option controls the maximum depth that winbindd will traverse when flattening nested group memberships of Windows domain groups\&. This is different from the

10533

\m[blue]\fBwinbind nested groups\fR\m[]

10534

option which implements the Windows NT4 model of local group nesting\&. The "winbind expand groups" parameter specifically applies to the membership of domain groups\&.

10535

.sp

10536

Be aware that a high value for this parameter can result in system slowdown as the main parent winbindd daemon must perform the group unrolling and will be unable to answer incoming NSS or authentication requests during this time\&.

10537

.sp

10538

Default:

10539

\fI\fIwinbind expand groups\fR\fR\fI = \fR\fI1\fR\fI \fR

10540

.RE

10541

10542

winbind max clients (G)

10543

.\" winbind max clients

10544

.PP

10545

.RS 4

10546

This parameter specifies the maximum number of clients the

10547

\fBwinbindd\fR(8)

10548

daemon can connect with\&.

10549

.sp

10550

Default:

10551

\fI\fIwinbind max clients\fR\fR\fI = \fR\fI200\fR\fI \fR

10552

.RE

10553

10554

winbind max domain connections (G)

10555

.\" winbind max domain connections

10556

.PP

10557

.RS 4

10558

This parameter specifies the maximum number of simultaneous connections that the

10559

\fBwinbindd\fR(8)

10560

daemon should open to the domain controller of one domain\&. Setting this parameter to a value greater than 1 can improve scalability with many simultaneous winbind requests, some of which might be slow\&.

10561

.sp

10562

Note that if

10563

\m[blue]\fBwinbind offline logon\fR\m[]

10564

is set to

10565

\fBYes\fR, then only one DC connection is allowed per domain, regardless of this setting\&.

10566

.sp

10567

Default:

10568

\fI\fIwinbind max domain connections\fR\fR\fI = \fR\fI1\fR\fI \fR

10569

.sp

10570

Example:

10571

\fI\fIwinbind max domain connections\fR\fR\fI = \fR\fI10\fR\fI \fR

10572

.RE

10573

10574

winbind nested groups (G)

10575

.\" winbind nested groups

10576

.PP

10577

.RS 4

10578

If set to yes, this parameter activates the support for nested groups\&. Nested groups are also called local groups or aliases\&. They work like their counterparts in Windows: Nested groups are defined locally on any machine (they are shared between DC\'s through their SAM) and can contain users and global groups from any trusted SAM\&. To be able to use nested groups, you need to run nss_winbind\&.

10579

.sp

10580

Default:

10581

\fI\fIwinbind nested groups\fR\fR\fI = \fR\fIyes\fR\fI \fR

10582

.RE

10583

10584

winbind normalize names (G)

10585

.\" winbind normalize names

10586

.PP

10587

.RS 4

10588

This parameter controls whether winbindd will replace whitespace in user and group names with an underscore (_) character\&. For example, whether the name "Space Kadet" should be replaced with the string "space_kadet"\&. Frequently Unix shell scripts will have difficulty with usernames contains whitespace due to the default field separator in the shell\&. If your domain possesses names containing the underscore character, this option may cause problems unless the name aliasing feature is supported by your nss_info plugin\&.

10589

.sp

10590

This feature also enables the name aliasing API which can be used to make domain user and group names to a non\-qualified version\&. Please refer to the manpage for the configured idmap and nss_info plugin for the specifics on how to configure name aliasing for a specific configuration\&. Name aliasing takes precedence (and is mutually exclusive) over the whitespace replacement mechanism discussed previsouly\&.

10591

.sp

10592

Default:

10593

\fI\fIwinbind normalize names\fR\fR\fI = \fR\fIno\fR\fI \fR

10594

.sp

10595

Example:

10596

\fI\fIwinbind normalize names\fR\fR\fI = \fR\fIyes\fR\fI \fR

10597

.RE

10598

10599

winbind nss info (G)

10600

.\" winbind nss info

10601

.PP

10602

.RS 4

10603

This parameter is designed to control how Winbind retrieves Name Service Information to construct a user\'s home directory and login shell\&. Currently the following settings are available:

10604

.sp

10605

.RS 4

10606

.ie n \{\

10607

\h'-04'\(bu\h'+03'\c

10608

.\}

10609

.el \{\

10610

.sp -1

10611

.IP \(bu 2.3

10612

.\}

10613

\fItemplate\fR

10614

\- The default, using the parameters of

10615

\fItemplate shell\fR

10616

and

10617

\fItemplate homedir\fR)

10618

.RE

10619

.sp

10620

.RS 4

10621

.ie n \{\

10622

\h'-04'\(bu\h'+03'\c

10623

.\}

10624

.el \{\

10625

.sp -1

10626

.IP \(bu 2.3

10627

.\}

10628

\fI<sfu | rfc2307 >\fR

10629

\- When Samba is running in security = ads and your Active Directory Domain Controller does support the Microsoft "Services for Unix" (SFU) LDAP schema, winbind can retrieve the login shell and the home directory attributes directly from your Directory Server\&. Note that retrieving UID and GID from your ADS\-Server requires to use

10630

\fIidmap config DOMAIN:backend\fR

10631

= ad as well\&.

10632

.RE

10633

.sp

10634

.RE

10635

.sp

10636

Default:

10637

\fI\fIwinbind nss info\fR\fR\fI = \fR\fItemplate\fR\fI \fR

10638

.sp

10639

Example:

10640

\fI\fIwinbind nss info\fR\fR\fI = \fR\fIsfu\fR\fI \fR

10641

.RE

10642

10643

winbind offline logon (G)

10644

.\" winbind offline logon

10645

.PP

10646

.RS 4

10647

This parameter is designed to control whether Winbind should allow to login with the

10648

\fIpam_winbind\fR

10649

module using Cached Credentials\&. If enabled, winbindd will store user credentials from successful logins encrypted in a local cache\&.

10650

.sp

10651

Default:

10652

\fI\fIwinbind offline logon\fR\fR\fI = \fR\fIfalse\fR\fI \fR

10653

.sp

10654

Example:

10655

\fI\fIwinbind offline logon\fR\fR\fI = \fR\fItrue\fR\fI \fR

10656

.RE

10657

10658

winbind reconnect delay (G)

10659

.\" winbind reconnect delay

10660

.PP

10661

.RS 4

10662

This parameter specifies the number of seconds the

10663

\fBwinbindd\fR(8)

10664

daemon will wait between attempts to contact a Domain controller for a domain that is determined to be down or not contactable\&.

10665

.sp

10666

Default:

10667

\fI\fIwinbind reconnect delay\fR\fR\fI = \fR\fI30\fR\fI \fR

10668

.RE

10669

10670

winbind refresh tickets (G)

10671

.\" winbind refresh tickets

10672

.PP

10673

.RS 4

10674

This parameter is designed to control whether Winbind should refresh Kerberos Tickets retrieved using the

10675

\fIpam_winbind\fR

10676

module\&.

10677

.sp

10678

Default:

10679

\fI\fIwinbind refresh tickets\fR\fR\fI = \fR\fIfalse\fR\fI \fR

10680

.sp

10681

Example:

10682

\fI\fIwinbind refresh tickets\fR\fR\fI = \fR\fItrue\fR\fI \fR

10683

.RE

10684

10685

winbind rpc only (G)

10686

.\" winbind rpc only

10687

.PP

10688

.RS 4

10689

Setting this parameter to

10690

yes

10691

forces winbindd to use RPC instead of LDAP to retrieve information from Domain Controllers\&.

10692

.sp

10693

Default:

10694

\fI\fIwinbind rpc only\fR\fR\fI = \fR\fIno\fR\fI \fR

10695

.RE

10696

10697

winbind separator (G)

10698

.\" winbind separator

10699

.PP

10700

.RS 4

10701

This parameter allows an admin to define the character used when listing a username of the form of

10702

\fIDOMAIN \fR\e\fIuser\fR\&. This parameter is only applicable when using the

10703

pam_winbind\&.so

10704

and

10705

nss_winbind\&.so

10706

modules for UNIX services\&.

10707

.sp

10708

Please note that setting this parameter to + causes problems with group membership at least on glibc systems, as the character + is used as a special character for NIS in /etc/group\&.

10709

.sp

10710

Default:

10711

\fI\fIwinbind separator\fR\fR\fI = \fR\fI\'\e\'\fR\fI \fR

10712

.sp

10713

Example:

10714

\fI\fIwinbind separator\fR\fR\fI = \fR\fI+\fR\fI \fR

10715

.RE

10716

10717

winbind trusted domains only (G)

10718

.\" winbind trusted domains only

10719

.PP

10720

.RS 4

10721

This parameter is designed to allow Samba servers that are members of a Samba controlled domain to use UNIX accounts distributed via NIS, rsync, or LDAP as the uid\'s for winbindd users in the hosts primary domain\&. Therefore, the user

10722

DOMAIN\euser1

10723

would be mapped to the account user1 in /etc/passwd instead of allocating a new uid for him or her\&.

10724

.sp

10725

This parameter is now deprecated in favor of the newer idmap_nss backend\&. Refer to the

10726

\fBidmap_nss\fR(8)

10727

man page for more information\&.

10728

.sp

10729

Default:

10730

\fI\fIwinbind trusted domains only\fR\fR\fI = \fR\fIno\fR\fI \fR

10731

.RE

10732

10733

winbind use default domain (G)

10734

.\" winbind use default domain

10735

.PP

10736

.RS 4

10737

This parameter specifies whether the

10738

\fBwinbindd\fR(8)

10739

daemon should operate on users without domain component in their username\&. Users without a domain component are treated as is part of the winbindd server\'s own domain\&. While this does not benefit Windows users, it makes SSH, FTP and e\-mail function in a way much closer to the way they would in a native unix system\&.

10740

.sp

10741

This option should be avoided if possible\&. It can cause confusion about responsibilities for a user or group\&. In many situations it is not clear whether winbind or /etc/passwd should be seen as authoritative for a user, likewise for groups\&.

10742

.sp

10743

Default:

10744

\fI\fIwinbind use default domain\fR\fR\fI = \fR\fIno\fR\fI \fR

10745

.sp

10746

Example:

10747

\fI\fIwinbind use default domain\fR\fR\fI = \fR\fIyes\fR\fI \fR

10748

.RE

10749

10750

wins hook (G)

10751

.\" wins hook

10752

.PP

10753

.RS 4

10754

When Samba is running as a WINS server this allows you to call an external program for all changes to the WINS database\&. The primary use for this option is to allow the dynamic update of external name resolution databases such as dynamic DNS\&.

10755

.sp

10756

The wins hook parameter specifies the name of a script or executable that will be called as follows:

10757

.sp

10758

wins_hook operation name nametype ttl IP_list

10759

.sp

10760

.RS 4

10761

.ie n \{\

10762

\h'-04'\(bu\h'+03'\c

10763

.\}

10764

.el \{\

10765

.sp -1

10766

.IP \(bu 2.3

10767

.\}

10768

The first argument is the operation and is one of "add", "delete", or "refresh"\&. In most cases the operation can be ignored as the rest of the parameters provide sufficient information\&. Note that "refresh" may sometimes be called when the name has not previously been added, in that case it should be treated as an add\&.

10769

.RE

10770

.sp

10771

.RS 4

10772

.ie n \{\

10773

\h'-04'\(bu\h'+03'\c

10774

.\}

10775

.el \{\

10776

.sp -1

10777

.IP \(bu 2.3

10778

.\}

10779

The second argument is the NetBIOS name\&. If the name is not a legal name then the wins hook is not called\&. Legal names contain only letters, digits, hyphens, underscores and periods\&.

10780

.RE

10781

.sp

10782

.RS 4

10783

.ie n \{\

10784

\h'-04'\(bu\h'+03'\c

10785

.\}

10786

.el \{\

10787

.sp -1

10788

.IP \(bu 2.3

10789

.\}

10790

The third argument is the NetBIOS name type as a 2 digit hexadecimal number\&.

10791

.RE

10792

.sp

10793

.RS 4

10794

.ie n \{\

10795

\h'-04'\(bu\h'+03'\c

10796

.\}

10797

.el \{\

10798

.sp -1

10799

.IP \(bu 2.3

10800

.\}

10801

The fourth argument is the TTL (time to live) for the name in seconds\&.

10802

.RE

10803

.sp

10804

.RS 4

10805

.ie n \{\

10806

\h'-04'\(bu\h'+03'\c

10807

.\}

10808

.el \{\

10809

.sp -1

10810

.IP \(bu 2.3

10811

.\}

10812

The fifth and subsequent arguments are the IP addresses currently registered for that name\&. If this list is empty then the name should be deleted\&.

10813

.RE

10814

.sp

10815

.RE

10816

An example script that calls the BIND dynamic DNS update program

10817

nsupdate

10818

is provided in the examples directory of the Samba source code\&.

10819

.sp

10820

\fINo default\fR

10821

.RE

10822

10823

wins proxy (G)

10824

.\" wins proxy

10825

.PP

10826

.RS 4

10827

This is a boolean that controls if

10828

\fBnmbd\fR(8)

10829

will respond to broadcast name queries on behalf of other hosts\&. You may need to set this to

10830

\fByes\fR

10831

for some older clients\&.

10832

.sp

10833

Default:

10834

\fI\fIwins proxy\fR\fR\fI = \fR\fIno\fR\fI \fR

10835

.RE

10836

10837

wins server (G)

10838

.\" wins server

10839

.PP

10840

.RS 4

10841

This specifies the IP address (or DNS name: IP address for preference) of the WINS server that

10842

\fBnmbd\fR(8)

10843

should register with\&. If you have a WINS server on your network then you should set this to the WINS server\'s IP\&.

10844

.sp

10845

You should point this at your WINS server if you have a multi\-subnetted network\&.

10846

.sp

10847

If you want to work in multiple namespaces, you can give every wins server a \'tag\'\&. For each tag, only one (working) server will be queried for a name\&. The tag should be separated from the ip address by a colon\&.

10848

.if n \{\

10849

.sp

10850

.\}

10851

.RS 4

10852

.it 1 an-trap

10853

.nr an-no-space-flag 1

10854

.nr an-break-flag 1

10855

.br

10856

.ps +1

10857

\fBNote\fR

10858

.ps -1

10859

.br

10860

You need to set up Samba to point to a WINS server if you have multiple subnets and wish cross\-subnet browsing to work correctly\&.

10861

.sp .5v

10862

.RE

10863

See the chapter in the Samba3\-HOWTO on Network Browsing\&.

10864

.sp

10865

Default:

10866

\fI\fIwins server\fR\fR\fI = \fR\fI\fR\fI \fR

10867

.sp

10868

Example:

10869

\fI\fIwins server\fR\fR\fI = \fR\fImary:192\&.9\&.200\&.1 fred:192\&.168\&.3\&.199 mary:192\&.168\&.2\&.61 # For this example when querying a certain name, 192\&.19\&.200\&.1 will be asked first and if that doesn\'t respond 192\&.168\&.2\&.61\&. If either of those doesn\'t know the name 192\&.168\&.3\&.199 will be queried\&.\fR\fI \fR

10870

.sp

10871

Example:

10872

\fI\fIwins server\fR\fR\fI = \fR\fI192\&.9\&.200\&.1 192\&.168\&.2\&.61\fR\fI \fR

10873

.RE

10874

10875

wins support (G)

10876

.\" wins support

10877

.PP

10878

.RS 4

10879

This boolean controls if the

10880

\fBnmbd\fR(8)

10881

process in Samba will act as a WINS server\&. You should not set this to

10882

\fByes\fR

10883

unless you have a multi\-subnetted network and you wish a particular

10884

nmbd

10885

to be your WINS server\&. Note that you should

10886

\fINEVER\fR

10887

set this to

10888

\fByes\fR

10889

on more than one machine in your network\&.

10890

.sp

10891

Default:

10892

\fI\fIwins support\fR\fR\fI = \fR\fIno\fR\fI \fR

10893

.RE

10894

10895

workgroup (G)

10896

.\" workgroup

10897

.PP

10898

.RS 4

10899

This controls what workgroup your server will appear to be in when queried by clients\&. Note that this parameter also controls the Domain name used with the

10900

\m[blue]\fBsecurity = domain\fR\m[]

10901

setting\&.

10902

.sp

10903

Default:

10904

\fI\fIworkgroup\fR\fR\fI = \fR\fIWORKGROUP\fR\fI \fR

10905

.sp

10906

Example:

10907

\fI\fIworkgroup\fR\fR\fI = \fR\fIMYGROUP\fR\fI \fR

10908

.RE

10909

10910

writable

10911

.\" writable

10912

.PP

10913

.RS 4

10914

This parameter is a synonym for

10915

writeable\&.

10916

.RE

10917

10918

writeable (S)

10919

.\" writeable

10920

.PP

10921

.RS 4

10922

Inverted synonym for

10923

\m[blue]\fBread only\fR\m[]\&.

10924

.sp

10925

Default:

10926

\fI\fIwriteable\fR\fR\fI = \fR\fIno\fR\fI \fR

10927

.RE

10928

10929

write cache size (S)

10930

.\" write cache size

10931

.PP

10932

.RS 4

10933

If this integer parameter is set to non\-zero value, Samba will create an in\-memory cache for each oplocked file (it does

10934

\fInot\fR

10935

do this for non\-oplocked files)\&. All writes that the client does not request to be flushed directly to disk will be stored in this cache if possible\&. The cache is flushed onto disk when a write comes in whose offset would not fit into the cache or when the file is closed by the client\&. Reads for the file are also served from this cache if the data is stored within it\&.

10936

.sp

10937

This cache allows Samba to batch client writes into a more efficient write size for RAID disks (i\&.e\&. writes may be tuned to be the RAID stripe size) and can improve performance on systems where the disk subsystem is a bottleneck but there is free memory for userspace programs\&.

10938

.sp

10939

The integer parameter specifies the size of this cache (per oplocked file) in bytes\&.

10940

.sp

10941

Default:

10942

\fI\fIwrite cache size\fR\fR\fI = \fR\fI0\fR\fI \fR

10943

.sp

10944

Example:

10945

\fI\fIwrite cache size\fR\fR\fI = \fR\fI262144 # for a 256k cache size per file\fR\fI \fR

10946

.RE

10947

10948

write list (S)

10949

.\" write list

10950

.PP

10951

.RS 4

10952

This is a list of users that are given read\-write access to a service\&. If the connecting user is in this list then they will be given write access, no matter what the

10953

\m[blue]\fBread only\fR\m[]

10954

option is set to\&. The list can include group names using the @group syntax\&.

10955

.sp

10956

Note that if a user is in both the read list and the write list then they will be given write access\&.

10957

.sp

10958

By design, this parameter will not work with the

10959

\m[blue]\fBsecurity = share\fR\m[]

10960

in Samba 3\&.0\&.

10961

.sp

10962

Default:

10963

\fI\fIwrite list\fR\fR\fI = \fR\fI\fR\fI \fR

10964

.sp

10965

Example:

10966

\fI\fIwrite list\fR\fR\fI = \fR\fIadmin, root, @staff\fR\fI \fR

10967

.RE

10968

10969

write raw (G)

10970

.\" write raw

10971

.PP

10972

.RS 4

10973

This parameter controls whether or not the server will support raw write SMB\'s when transferring data from clients\&. You should never need to change this parameter\&.

10974

.sp

10975

Default:

10976

\fI\fIwrite raw\fR\fR\fI = \fR\fIyes\fR\fI \fR

10977

.RE

10978

10979

wtmp directory (G)

10980

.\" wtmp directory

10981

.PP

10982

.RS 4

10983

This parameter is only available if Samba has been configured and compiled with the option

10984

\-\-with\-utmp\&. It specifies a directory pathname that is used to store the wtmp or wtmpx files (depending on the UNIX system) that record user connections to a Samba server\&. The difference with the utmp directory is the fact that user info is kept after a user has logged out\&.

10985

.sp

10986

By default this is not set, meaning the system will use whatever utmp file the native system is set to use (usually

10987

/var/run/wtmp

10988

on Linux)\&.

10989

.sp

10990

Default:

10991

\fI\fIwtmp directory\fR\fR\fI = \fR\fI\fR\fI \fR

10992

.sp

10993

Example:

10994

\fI\fIwtmp directory\fR\fR\fI = \fR\fI/var/log/wtmp\fR\fI \fR

10995

.RE

10996

.SH "WARNINGS"

10997

.PP

10998

Although the configuration file permits service names to contain spaces, your client software may not\&. Spaces will be ignored in comparisons anyway, so it shouldn\'t be a problem \- but be aware of the possibility\&.

10999

.PP

11000

On a similar note, many clients \- especially DOS clients \- limit service names to eight characters\&.

11001

\fBsmbd\fR(8)

11002

has no such limitation, but attempts to connect from such clients will fail if they truncate the service names\&. For this reason you should probably keep your service names down to eight characters in length\&.

11003

.PP

11004

Use of the

11005

[homes]

11006

and

11007

[printers]

11008

special sections make life for an administrator easy, but the various combinations of default attributes can be tricky\&. Take extreme care when designing these sections\&. In particular, ensure that the permissions on spool directories are correct\&.

11009

.SH "VERSION"

11010

.PP

11011

This man page is correct for version 3 of the Samba suite\&.

11012

.SH "SEE ALSO"

11013

.PP

11014

11015

\fBsamba\fR(7),

11016

\fBsmbpasswd\fR(8),

11017

\fBswat\fR(8),

11018

\fBsmbd\fR(8),

11019

\fBnmbd\fR(8),

11020

\fBsmbclient\fR(1),

11021

\fBnmblookup\fR(1),

11022

\fBtestparm\fR(1),

11023

\fBtestprns\fR(1)\&.

11024

.SH "AUTHOR"

11025

.PP

11026

The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&.

11027

.PP

11028

The original Samba man pages were written by Karl Auer\&. The man page sources were converted to YODL format (another excellent piece of Open Source software, available at

11029

ftp://ftp\&.icce\&.rug\&.nl/pub/unix/) and updated for the Samba 2\&.0 release by Jeremy Allison\&. The conversion to DocBook for Samba 2\&.2 was done by Gerald Carter\&. The conversion to DocBook XML 4\&.2 for Samba 3\&.0 was done by Alexander Bokovoy\&.

Older »