Bug 2062117

Summary: Write a RN about the changes in command-line utilities in Samba 4.15
Product: Red Hat Enterprise Linux 8 Reporter: Marc Muehlfeld <mmuehlfe>
Component: doc-Release_Notes-8-en-USAssignee: Lucie Vařáková <lmanasko>
Status: CLOSED CURRENTRELEASE QA Contact: RHEL DPM <rhel-docs>
Severity: unspecified Docs Contact: Marc Muehlfeld <mmuehlfe>
Priority: medium    
Version: 8.6CC: asn, gfialova, rhel-docs
Target Milestone: rcKeywords: Documentation
Target Release: 8.6Flags: pm-rhel: mirror+
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Enhancement
Doc Text:
.Options in Samba utilities have been renamed and removed for a consistent user experience The Samba utilities have been improved to provide a consistent command-line interface. These improvements include renamed and removed options. Therefore, to avoid problems after the update, review your scripts that use Samba utilities, and update them, if necessary. Samba 4.15 introduces the following changes to the Samba utilities: * Previously, Samba command-line utilities silently ignored unknown options. To prevent unexpected behavior, the utilities now consistently reject unknown options. * Several command-line options now have a corresponding `smb.conf` variable to control their default value. See the man pages of the utilities to identify if a command-line option has an `smb.conf` variable name. * By default, Samba utilities now log to standard error (`stderr`). Use the `--debug-stdout` option to change this behavior. * The `--client-protection=off|sign|encrypt` option has been added to the common parser. * The following options have been renamed in all utilities: ** `--kerberos` to `--use-kerberos=required|desired|off` ** `--krb5-ccache` to `--use-krb5-ccache=__CCACHE__` ** `--scope` to `--netbios-scope=__SCOPE__` ** `--use-ccache` to `--use-winbind-ccache` * The following options have been removed from all utilities: ** `-e` and `--encrypt` ** `-C` removed from `--use-winbind-ccache` ** `-i` removed from `--netbios-scope` ** `-S` and `--signing` * To avoid duplicate options, certain options have been removed or renamed from the following utilities: ** `ndrdump`: `-l` is no longer available for `--load-dso` ** `net`: `-l` is no longer available for `--long` ** `sharesec`: `-V` is no longer available for `--viewsddl` ** `smbcquotas`: `--user` has been renamed to `--quota-user` ** `nmbd`: `--log-stdout` has been renamed to `--debug-stdout` ** `smbd`: `--log-stdout` has been renamed to `--debug-stdout` ** `winbindd`: `--log-stdout` has been renamed to `--debug-stdout`
Story Points: ---
Clone Of:
: 2065646 (view as bug list) Environment:
Last Closed: 2022-04-07 05:28:38 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:
Bug Depends On:    
Bug Blocks: 2065646    

Description Marc Muehlfeld 2022-03-09 08:33:17 UTC
Samba 4.15 introduces several changes to command-line utilities, which can break existing scripts, Cron jobs, etc. This deserves a separate release note and should not be hidden in the Samba rebase release note.


From https://www.samba.org/samba/history/samba-4.15.0.html:


Improved command line user experience
-------------------------------------

Samba utilities did not consistently implement their command line interface. A
number of options were requiring to specify values in one tool and not in the
other, some options meant different in different tools.

These should be stories of the past now. A new command line parser has been
implemented with sanity checking. Also the command line interface has been
simplified and provides better control for encryption, signing and kerberos.

Previously many tools silently ignored unknown options. To prevent unexpected
behaviour all tools will now consistently reject unknown options.

Also several command line options have a smb.conf variable to control the
default now.

All tools are now logging to stderr by default. You can use "--debug-stdout" to
change the behavior. All servers will log to stderr at early startup until logging
is setup to go to a file by default.

### Common parser:

Options added:
--client-protection=off|sign|encrypt

Options renamed:
--kerberos       ->    --use-kerberos=required|desired|off
--krb5-ccache    ->    --use-krb5-ccache=CCACHE
--scope          ->    --netbios-scope=SCOPE
--use-ccache     ->    --use-winbind-ccache

Options removed:
-e|--encrypt
-C removed from --use-winbind-ccache
-i removed from --netbios-scope
-S|--signing


### Duplicates in command line utils

ldbadd/ldbdel/ldbedit/ldbmodify/ldbrename/ldbsearch:
-e is still available as an alias for --editor,
   as it used to be.
-s is no longer reported as an alias for --configfile,
   it never worked that way as it was shadowed by '-s' for '--scope'.

ndrdump:
-l is not available for --load-dso anymore

net:
-l is not available for --long anymore

sharesec:
-V is not available for --viewsddl anymore

smbcquotas:
--user        ->    --quota-user

nmbd:
--log-stdout  ->    --debug-stdout

smbd:
--log-stdout  ->    --debug-stdout

winbindd:
--log-stdout  ->    --debug-stdout

Comment 2 Andreas Schneider 2022-03-22 09:54:19 UTC
Look fine. Please add to RHEL 9.0 too. Thanks!