Samba-tool-external: Difference between revisions

From SambaWiki
mNo edit summary
mNo edit summary
Line 121: Line 121:
<td>addmembers <groupname> <listofmembers></td>
<td>addmembers <groupname> <listofmembers></td>
<td>removemembers <groupname> <listofmembers></td>
<td>removemembers <groupname> <listofmembers></td>
Line 136: Line 136:

Revision as of 17:01, 2 May 2011

This wiki page will document the current externals of the samba-tool command with proposed changes to be made for consistency and usability.

General options are options that can be used on all commands and are as follows:

  • Samba Options
    • list samba options here
  • Version Options
    • -V
    • --version
  • Credential Options
    • list cred options

Open for discussion is the formats of some of the global options. Improvements to usability will be considered and implemented on option by option basis as community approves.

Current commands listed in in samba 4 Version 4.0.0alpha15-GIT-b12fbc2

samba-tool current commands:

Subcommand Description Parameters Command specific options Net command
acl get or set acls on a file nt get <file> --as-sddl
nt set <file> --quiet=
ds set <file> --host=
domainlevel Raises domain and forest function level show -H
drs various directory replication services bind <dc>
kcc <dc>
replicate <dest_dc> <source_dc> <nc> --add-ref
showrepl <dc>
enableaccount enable a user <username> --filter=
export Dumps kerberos keys of the domain into a keytab keytab <keytab> net export keytab <keytab>
fsmo Makes the target DC transfer or seize fsmo role (server connection needed) show --url
transfer --url
seize --url
group Add or delete groups or add members to or remove members from a group add <groupname> -H
delete <groupname> -H
addmembers <groupname> <listofmembers> -H
removemembers <groupname> <listofmembers> -H
gpo2 List group policies list <username> -H
join Join a domain as either a member or a backup domain controller
(server connection required)
dns domain add options
ldapcmp compare two ldap databases UR1L, URL2 add options
machinepw get machine PW out of SAM
pwsettings Sets password settings set, show
password set or change password, set, change user
setexpiry Sets the expiration of a user account [username] add options
setpassword set user password locally, need write access to ldb files
time Retrieve the time on a remote server (server connection needed) [server-name]
user create or delete a user create, delete options
vampire Join and synchronise a remote AD domain to the local server
(server connection needed)

samba-tool proposal for command syntax changes

The proposed format for all new / existing functions on the samba-tool command are as follows:

Command syntax will follow the format samba-tool <object> <action> parameter(s) <command specific options> <global options> unless otherwise indicated.

samba-tool <object> <action> <command specific options> <general options>

  • When the samba-tool command is issued without a subcommand, it will return a list of valid subcommands (it does this today)
  • After each subcommand is entered, if more parameters are required a list of what comes next will be shown (sometimes does this today)
  • If the command syntax is completely incorrect, will give the format of the subcommand (sometimes does this today)
  • For each subcommand, help will be provided
  • Error handling will be improved, more errors will be caught with useable messages being issued where applicable
Object Action Parameters Specific Options Global Options Comments and Equivalent net command (samba 3)
acl get nt <file> --as-sddl
global options Could combine get and nt into one action getnt
Of leave as get <space> nt for historical purposes
set nt <file> --xattr-backend=native|tdb
global options Could combine set and nt into one action setnt
set ds <file> --objectdn=objectdn
--car=control right
global options Could combine set and ds into one action setds
domainlevel show global options
raise -H
global options
drs bind
group add
gpo2 list
join dns domain add options global options What is the object being joined? server? machine?
fsmo show add options global options What is the object being shown?
domain controller? server? machine?
fsmo transfer add options global options What is the object?
fsmo seize add options global options What is the object?
export keytab add options global options What is the object?
ldap compare URL1, URL2 add options Change to split into ldap compare.
pwsettings show
set add parameters that can be set
password set user
change user
time server-name Change format? add an optional action: show ?
user create username global options Changing add to create, can / should make an alias?
The help on this command already says add - create a new user
create makes more sense, add sounds like it already exists and adding it to a group, for instance
opposite of removemembers is addmembers
delete username global options
setexpiry username -H help global options this used to be setexpiry username command
enableaccount username -H help global options this used to be enableaccount username command
vampire domain global options Keep as vampire command for usability / historical purposes
Do not change to object action format