View on
MetaCPAN is shutting down
For details read Perl NOC. After June 25th this page will redirect to
Gavin Henry > Samba-LDAP > smbldap-usermod


Annotate this POD


Open  1
View/Report Bugs


smbldap-usermod - Modify a user account


smbldap-usermod [-a] [-c comment] [-d home_dir] [-e expiration_date] [-g initial_group] [-l login_name] [-p passwd] [-s shell] [-u uid [ -o]] [-x] [-A canchange] [-B mustchange] [-C smbhome] [-D homedrive] [-E scriptpath] [-F profilepath] [-G group[,...]] [-H acctflags] [-N canonical_name] [-S surname] [-P] login


The smbldap-usermod command modifies the system account files to reflect the changes that are specified on the command line. The options which apply to the usermod command are

-a Add the sambaSAMAccount objectclass to the specified user account. This allow the user to become a samba user.

-c comment The new value of the user's comment field (gecos).

-d home_dir The user's new login directory.

-e expiration_date Set the expiration date for the user account. This only affect samba account. The date must be in the following format : YYYY-MM-DD HH:MM:SS. This option call the external 'date' command to set calculate the number of seconds from Junary 1 1970 to the specified date.

-g initial_group The group name or number of the user's new initial login group. The group name must exist. A group number must refer to an already existing group. The default group number is 1.

-G group,[...] A list of supplementary groups which the user is also a member of. Each group is separated from the next by a comma, with no intervening whitespace. The groups are subject to the same restrictions as the group given with the -g option. If the user is currently a member of a group which is not listed, the user will be removed from the group

-l login_name The name of the user will be changed from login to login_name. Nothing else is changed. In particular, the user's home directory name should probably be changed to reflect the new login name.

-s shell The name of the user's new login shell. Setting this field to blank causes the system to select the default login shell.

-u uid The numerical value of the user's ID. This value must be unique, unless the -o option is used. The value must be non negative. Any files which the user owns and which are located in the directory tree rooted at the user's home directory will have the file user ID changed automatically. Files outside of the user's home directory must be altered manually.

-r new_user Allow to rename a user. This option will update the cn, sn and dn attribute for the user. You can also update others attributes using the corresponding script options.

-x Creates rid and primaryGroupID in hex instead of decimal (for Samba 2.2.2 unpatched only - higher versions always use decimal)

-A can change password ? 0 if no, 1 if yes

-B must change password ? 0 if no, 1 if yes

-C sambaHomePath (SMB home share, like '\\\\PDC-SRV\\homes')

-D sambaHomeDrive (letter associated with home share, like 'H:')

-E sambaLogonScript, relative to the [netlogon] share (DOS script to execute on login, like 'foo.bat')

-F sambaProfilePath (profile directory, like '\\\\PDC-SRV\\profiles\\foo')

-H sambaAcctFlags, spaces and trailing bracket are ignored (samba account control bits like '[NDHTUMWSLKI]')

-I disable user. Can't be used with -H or -J

-J enable user. Can't be used with -H or -I

-N set the canonical name (attribut cn)

-S Set the surname

-P End by invoking smbldap-passwd to change the user password (both unix and samba passwords)


syntax highlighting: