Samba-tool-external: Difference between revisions

From SambaWiki
mNo edit summary
mNo edit summary
Line 176: Line 176:
<h4>samba-tool proposal for command syntax changes</h4>
<h4>samba-tool proposal for command syntax changes</h4>


Command syntax will follow the format samba-tool <object> <action> <object/action specific options> <global options> unless otherwise indicated.
Command syntax will follow the format samba-tool <object> <action> parameter(s) <command specific options> <global options> unless otherwise indicated.
<table border="1">
<table border="1">
<tr>
<tr>
<td>'''Object'''</td>
<td>'''Object'''</td>
<td>'''Description'''</td>
<td>'''Action'''</td>
<td>'''Action'''</td>
<td>'''Parameter(s)</td>
<td>'''Parameter(s)</td>
<td>'''Specific Options'''</td>
<td>'''Specific Options'''</td>
<td>'''General Options'''</td>
<td>'''Global Options'''</td>
</tr>
</tr>
<tr>
<tr>
<td>acl</td>
<td>acl</td>
<td>get or set acls on a file or directory</td>
<td>getnt</td>
<td>getnt</td>
<td><file></td>
<td><file></td>
Line 195: Line 193:
</tr>
</tr>
<tr>
<tr>
<td></td>
<td></td>
<td></td>
<td>setnt</td>
<td>setnt</td>
Line 203: Line 200:
</tr>
</tr>
<tr>
<tr>
<td></td>
<td></td>
<td></td>
<td>setds</td>
<td>setds</td>
Line 209: Line 205:
<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>
</tr>
</tr>
</tr>
<tr>
<tr>
<td>domainlevel</td>
<td>domainlevel</td>
<td>Raises domain and forest function level</td>
<td>show</td>
<td>show or raise</td>
<td></td>
<td></td>
<td>add options</td>
<td></td>
<td></td>
<td>global options</td>
</tr>
<tr>
<td></td>
<td>raise</td>
<td></td>
<td>-H<br>--quiet<br>--forest<br>--domain</td>
<td>global options</td>
</tr>
</tr>
<tr>
<tr>

Revision as of 16:41, 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.

Object Action Parameter(s) Specific Options Global Options
acl getnt <file> --as-sddl
--xattr-backend=native|tdb
--eadb-file=file
global options
setnt <file> --xattr-backend=native|tdb
--eadb-file=file
global options
setds <file> --objectdn=objectdn
--car=control right
--action=deny|allow
--trusteedn=trustee-dn
global options
domainlevel show global options
raise -H
--quiet
--forest
--domain
global 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...