diff options
author | Amitay Isaacs <amitay@gmail.com> | 2011-08-22 09:42:13 +1000 |
---|---|---|
committer | Andrew Bartlett <abartlet@samba.org> | 2011-08-26 10:06:32 +1000 |
commit | 886203f3bc2ed445c6b3a03dbe145ecaa1b44050 (patch) | |
tree | 6abd7f4ca72a3cf8f1ea6d3440649bdc23cd0a34 /source4/scripting/python | |
parent | a3538b92d3ecc9d819d170d2e64cdbb0f4fff941 (diff) | |
download | samba-886203f3bc2ed445c6b3a03dbe145ecaa1b44050.tar.gz samba-886203f3bc2ed445c6b3a03dbe145ecaa1b44050.tar.bz2 samba-886203f3bc2ed445c6b3a03dbe145ecaa1b44050.zip |
s3_upgrade: Add document strings for python methods
Signed-off-by: Andrew Bartlett <abartlet@samba.org>
Diffstat (limited to 'source4/scripting/python')
-rw-r--r-- | source4/scripting/python/samba/upgrade.py | 32 |
1 files changed, 23 insertions, 9 deletions
diff --git a/source4/scripting/python/samba/upgrade.py b/source4/scripting/python/samba/upgrade.py index 579c9e6f11..b71b1d7d7c 100644 --- a/source4/scripting/python/samba/upgrade.py +++ b/source4/scripting/python/samba/upgrade.py @@ -151,7 +151,14 @@ def import_sam_group(samldb, sid, gid, sid_name_use, nt_name, comment, domaindn) def add_idmap_entry(idmapdb, sid, xid, xid_type, logger): - """Create idmap entry""" + """Create idmap entry + + :param idmapdb: Samba4 IDMAP database + :param sid: user/group sid + :param xid: user/group id + :param xid_type: type of id (UID/GID) + :param logger: Logger object + """ # First try to see if we already have this entry found = False @@ -187,16 +194,15 @@ def add_idmap_entry(idmapdb, sid, xid, xid_type, logger): except ldb.LdbError, e: logger.warn('Could not add idmap entry for sid=%s, id=%s, type=%s (%s)', str(sid), str(xid), xid_type, str(e)) - except Exception, e: - raise e def import_idmap(idmapdb, samba3_idmap, logger): """Import idmap data. - :param samba3_idmap: Samba 3 IDMAP database to import from + :param idmapdb: Samba4 IDMAP database + :param samba3_idmap: Samba3 IDMAP database to import from + :param logger: Logger object """ - currentxid = max(samba3_idmap.get_user_hwm(), samba3_idmap.get_group_hwm()) lowerbound = currentxid # FIXME: upperbound @@ -221,7 +227,12 @@ def import_idmap(idmapdb, samba3_idmap, logger): def add_group_from_mapping_entry(samdb, groupmap, logger): - """Add or modify group from group mapping entry""" + """Add or modify group from group mapping entry + + param samdb: Samba4 SAM database + param groupmap: Groupmap entry + param logger: Logger object + """ # First try to see if we already have this entry try: @@ -257,13 +268,16 @@ def add_group_from_mapping_entry(samdb, groupmap, logger): samdb.add(m, controls=["relax:0"]) except ldb.LdbError, e: logger.warn('Could not add group name=%s (%s)', groupmap.nt_name, str(e)) - except Exception, e: - raise(e) def add_users_to_group(samdb, group, members, logger): - """Add user/member to group/alias""" + """Add user/member to group/alias + param samdb: Samba4 SAM database + param group: Groupmap object + param members: List of member SIDs + param logger: Logger object + """ for member_sid in members: m = ldb.Message() m.dn = ldb.Dn(samdb, "<SID=%s" % str(group.sid)) |