Difference between revisions of "Samba-tool-external"

From SambaWiki
m
m
Line 184: Line 184:
 
<td>'''Specific Options'''</td>
 
<td>'''Specific Options'''</td>
 
<td>'''Global Options'''</td>
 
<td>'''Global Options'''</td>
 
<td>'''Comments'''</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Line 191: Line 192:
 
<td>--as-sddl<br>--xattr-backend=native|tdb<br>--eadb-file=file</td>
 
<td>--as-sddl<br>--xattr-backend=native|tdb<br>--eadb-file=file</td>
 
<td>global options</td>
 
<td>global options</td>
  +
<td>Combined get and nt into one action getnt</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Line 197: Line 199:
 
<td>--xattr-backend=native|tdb<br>--eadb-file=file</td>
 
<td>--xattr-backend=native|tdb<br>--eadb-file=file</td>
 
<td>global options</td>
 
<td>global options</td>
  +
<td>Combined set and nt into one action setnt</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Line 203: Line 206:
 
<td>--objectdn=objectdn<br>--car=control right<br>--action=deny|allow<br>--trusteedn=trustee-dn</td>
 
<td>--objectdn=objectdn<br>--car=control right<br>--action=deny|allow<br>--trusteedn=trustee-dn</td>
 
<td>global options</td>
 
<td>global options</td>
  +
<td>Combined set and ds into one action setds</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Line 210: Line 214:
 
<td></td>
 
<td></td>
 
<td>global options</td>
 
<td>global options</td>
 
<td></td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Line 216: Line 221:
 
<td>-H<br>--quiet<br>--forest<br>--domain</td>
 
<td>-H<br>--quiet<br>--forest<br>--domain</td>
 
<td>global options</td>
 
<td>global options</td>
 
<td></td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
 
<td rowspan="5">drs</td>
 
<td rowspan="5">drs</td>
 
<td>bind</td>
 
<td>bind</td>
 
<td></td>
 
<td></td>
 
<td></td>
 
<td></td>
 
<td></td>
Line 226: Line 233:
 
<tr>
 
<tr>
 
<td>kcc</td>
 
<td>kcc</td>
 
<td></td>
 
<td></td>
 
<td></td>
 
<td></td>
 
<td></td>
Line 232: Line 240:
 
<tr>
 
<tr>
 
<td>replicate</td>
 
<td>replicate</td>
 
<td></td>
 
<td></td>
 
<td></td>
 
<td></td>
 
<td></td>
Line 238: Line 247:
 
<tr>
 
<tr>
 
<td>showrepl</td>
 
<td>showrepl</td>
 
<td></td>
 
<td></td>
 
<td></td>
 
<td></td>
 
<td></td>
Line 247: Line 257:
 
<td></td>
 
<td></td>
 
<td></td>
 
<td></td>
</tr>
 
<tr>
 
<td>export</td>
 
<td>keytab</td>
 
 
<td></td>
 
<td></td>
<td></td>
 
<td>Change to '''keytab export''' to be consistent with object action</td>
 
 
</tr>
 
</tr>
<tr>
 
<td>fsmo</td>
 
<td>show, transfer, seize</td>
 
<td></td>
 
<td>Add options</td>
 
<td></td>
 
</tr>
 
<tr>
 
 
<td rowspan="4">group</td>
 
<td rowspan="4">group</td>
 
<td>add</td>
 
<td>add</td>
 
<td></td>
 
<td></td>
 
<td></td>
 
<td></td>
 
<td></td>
Line 271: Line 268:
 
<tr>
 
<tr>
 
<td>delete</td>
 
<td>delete</td>
 
<td></td>
 
<td></td>
 
<td></td>
 
<td></td>
 
<td></td>
Line 277: Line 275:
 
<tr>
 
<tr>
 
<td>addmembers</td>
 
<td>addmembers</td>
 
<td></td>
 
<td></td>
 
<td></td>
 
<td></td>
 
<td></td>
Line 283: Line 282:
 
<tr>
 
<tr>
 
<td>removemembers</td>
 
<td>removemembers</td>
 
<td></td>
 
<td></td>
 
<td></td>
 
<td></td>
 
<td></td>
Line 290: Line 290:
 
<td>gpo2</td>
 
<td>gpo2</td>
 
<td>list, listall</td>
 
<td>list, listall</td>
  +
<td></td>
 
<td></td>
 
<td></td>
 
<td></td>
 
<td></td>
Line 300: Line 301:
 
<td>add options</td>
 
<td>add options</td>
 
<td>global options</td>
 
<td>global options</td>
  +
<td></td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Line 307: Line 309:
 
<td>add options</td>
 
<td>add options</td>
 
<td>Change to split into ldap compare.</td>
 
<td>Change to split into ldap compare.</td>
</tr>
 
<tr>
 
<td>machinepw</td>
 
<td></td>
 
<td></td>
 
<td></td>
 
 
<td></td>
 
<td></td>
 
</tr>
 
</tr>
Line 318: Line 314:
 
<td>pwsettings</td>
 
<td>pwsettings</td>
 
<td>set, show</td>
 
<td>set, show</td>
  +
<td></td>
 
<td></td>
 
<td></td>
 
<td></td>
 
<td></td>
Line 328: Line 325:
 
<td></td>
 
<td></td>
 
<td</tr>
 
<td</tr>
  +
<td></td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Line 335: Line 333:
 
<td></td>
 
<td></td>
 
<td></tr>
 
<td></tr>
  +
<td></td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Line 342: Line 341:
 
<td></td>
 
<td></td>
 
<td>Change format</td>
 
<td>Change format</td>
  +
<td></td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
<td>user</td>
+
<td rowspan="4">user</td>
  +
<td>add</td>
  +
<td>username</td>
 
<td></td>
 
<td></td>
<td>create, delete, setexpiry, enableaccount</td>
 
<td>options</td>
 
 
<td>global options</td>
 
<td>global options</td>
  +
<td></td>
 
</tr>
 
<tr>
  +
<td>delete</td>
  +
<td>username</td>
  +
<td></td>
 
<td>global options</td>
  +
<td></td>
 
</tr>
 
<tr>
  +
<td>setexpiry</td>
  +
<td>username</td>
  +
<td></td>
  +
<td>global options</td>
  +
<td></td>
 
</tr>
 
<tr>
 
<td>enableaccount</td>
  +
<td>username</td>
  +
<td></td>
  +
<td>global options</td>
  +
<td></td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Line 356: Line 378:
 
<td></td>
 
<td></td>
 
<td>global options</td>
 
<td>global options</td>
  +
<td>Keep as vampire command for usability / historical purposes<br>Do not change to object action format</td>
 
</tr>
 
</tr>
 
</table>
 
</table>

Revision as of 18:25, 22 April 2011

samba-tool

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

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

samba-tool <object> <action> <options>

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

samba-tool current commands:

Object Description Action Parameters - specific Options - general Proposed Changes
acl get or set acls on a file get set nt(file), ds(directory object) general options
domainlevel Raises domain and forest function level show or raise add options
drs various directory replication services bind, kcc, replicate, showrepl, options add options
enableaccount enable a user username Change to user enableaccount to be consistent with object action
export Dumps kerberos keys of the domain into a keytab keytab Change to keytab export to be consistent with object action
fsmo Makes the target DC transfer or seize fsmo role (server connection needed) show, transfer, seize Add options
group Add or delete groups or add members to or remove members from a group add,delete,addmembers,removemembers
gpo2 List group policies list, listall
join Join a domain as either a member or a backup domain controller (server connection required) dns domain add options Change command to DOMAIN [JOINDC JOINRODC, JOINMEMBER, options] so consistent with object action format.
not sure is the object of the join a domain?
ldapcmp compare two ldap databases UR1L, URL2 add options Change to split into ldap compare.
machinepw get machine PW out of SAM Change to password machine show
newuser combine function with user create
pwsettings Sets password settings set, show
password set or change password, set, change user re-write into python
code similar to gpo to tell me local or not
add machinepw to this command: password machine show
setexpiry Sets the expiration of a user account [username] add options Change to user setexpiry [username]?
setpassword set user password locally, need write access to ldb files Use password command
combine both commands local and remote into one external
time Retrieve the time on a remote server (server connection needed) [server-name] Change format
user create or delete a user create, delete options Add enable, add setexpiry?
vampire Join and synchronise a remote AD domain to the local server (server connection needed) domain hmmm...

samba-tool proposal for command syntax changes

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

<td
Object Action Parameter(s) Specific Options Global Options Comments
acl getnt <file> --as-sddl
--xattr-backend=native|tdb
--eadb-file=file
global options Combined get and nt into one action getnt
setnt <file> --xattr-backend=native|tdb
--eadb-file=file
global options Combined set and nt into one action setnt
setds <file> --objectdn=objectdn
--car=control right
--action=deny|allow
--trusteedn=trustee-dn
global options Combined set and ds into one action setds
domainlevel show global options
raise -H
--quiet
--forest
--domain
global options
drs bind
kcc
replicate
showrepl
options
group add
delete
addmembers
removemembers
gpo2 list, listall
DC join dsn domain add options global options
ldap compare URL1, URL2 add options Change to split into ldap compare.
pwsettings set, show
password set, change user
setpassword
time> [server-name] Change format
user add username global options
delete username global options
setexpiry username global options
enableaccount username global options
vampire domain global options Keep as vampire command for usability / historical purposes
Do not change to object action format