234. Samba

Data for configuration of samba-client, input and output functions.

234.1. Summary of Module Globals

List of Global Functions

  • AdjustSharesServices - adjust the services for sharing

  • AutoPackages - Return required packages for auto-installation

  • Export - Dump the samba-client settings to a single map (For use by autoinstallation.)

  • GetDHCP - Check if dhcp.conf is included in smb.conf

  • GetGuessAccess - check if shares guest access is allowed

  • GetMaxShares - get number of max shares from smb.conf; 0 mean shares are not enabled

  • GetModified - Data was modified?

  • GetSSHSupport - Get the current status of ssh single-sign-on support

  • GetWinbind - Get a winbind status

  • GetWinbindCaching - Get the current status of winbind caching

  • GetWorkgroup - Get a host workgroup

  • Import - Get all samba-client settings from the first parameter (For use by autoinstallation.)

  • Read - Read all samba-client settings

  • ReadMkHomeDir - Read the state of mkhomedir in /etc/pam.d/common-session (bug #143519)

  • ReadSSHSupport - Read the current status of ssh single-sign-on support (fate #303415)

  • ReadSharesSetting - Read user shares settings

  • SetDHCP - Set the support of DHCP (include dhcp.conf in smb.conf)

  • SetGuessAccess - Set the new value for guest access (#144787)

  • SetMkHomeDir - Set the new value of mkhomedir

  • SetSSHSupport - Set the new value for sh single-sign-on support

  • SetShares - set the new values for user shares

  • SetStartFAM - update the information if FAM should be started

  • SetWinbind - Set a windind status

  • SetWinbindCaching - Set the new value for winbind caching (see bug #143927)

  • SetWorkgroup - Set a host workgroup

  • ShortSummary - Create shorter textual summary and a list of unconfigured options

  • Summary - Create a textual summary and a list of unconfigured options

  • UpdatedArchPackages - Return list of architecture specific packages (derived from package list given as parameter) merged with the packages in parameter

  • Write - Write all samba-client settings

  • WriteMkHomeDir - Write the new value of pam_mkhomedir to /etc/pam.d/common-session

  • WriteSSHSupport - Write the new value for sh single-sign-on support (fate #303415)

  • WriteShares - create the shares directory with correct rights

List of Global Variables

  • globals_configured - Are globals already configured (for AutoYaST)

  • mkhomedir - if pam_mkhomedir is set in /etc/pam.d/commond-session

  • modified - Data was modified?

  • password_data - map with user name and password (used for autoinstallation only)

  • start_fam - If FAM should be started

  • winbind_enabled - Should be winbind enabled?

  • write_only - Write only, used during autoinstallation. Don't run services and SuSEconfig, it's all done at one place.

234.2. Global Functions

234.2.1. AdjustSharesServices

adjust the services for sharing

Function parameters

  • boolean write_only

Return value

  • boolean

234.2.2. AutoPackages

Return required packages for auto-installation

Return value

  • map - of packages to be installed and to be removed

234.2.3. Export

Dump the samba-client settings to a single map (For use by autoinstallation.)

Return value

  • map - Dumped settings (later acceptable by Import ())

234.2.4. GetDHCP

Check if dhcp.conf is included in smb.conf

Return value

  • boolean

234.2.5. GetGuessAccess

check if shares guest access is allowed

Return value

  • boolean

234.2.6. GetMaxShares

get number of max shares from smb.conf; 0 mean shares are not enabled

Return value

  • integer

234.2.7. GetModified

Data was modified?

Return value

  • boolean - true if modified

234.2.8. GetSSHSupport

Get the current status of ssh single-sign-on support

Return value

  • boolean

234.2.9. GetWinbind

Get a winbind status

Return value

  • boolean - booleand a winbind status

234.2.10. GetWinbindCaching

Get the current status of winbind caching

Return value

  • boolean

234.2.11. GetWorkgroup

Get a host workgroup

Return value

  • string - a new workgroup

234.2.12. Import

Get all samba-client settings from the first parameter (For use by autoinstallation.)

Function parameters

  • map settings

Return value

  • boolean - True on success

234.2.13. Read

Read all samba-client settings

Return value

  • boolean - true on success

234.2.14. ReadMkHomeDir

Read the state of mkhomedir in /etc/pam.d/common-session (bug #143519)

Return value

  • boolean

234.2.15. ReadSSHSupport

Read the current status of ssh single-sign-on support (fate #303415)

Return value

  • boolean

234.2.16. ReadSharesSetting

Read user shares settings

Return value

  • boolean

234.2.17. SetDHCP

Set the support of DHCP (include dhcp.conf in smb.conf)

Function parameters

  • boolean new

Return value

  • boolean - if status was changed

234.2.18. SetGuessAccess

Set the new value for guest access (#144787)

Function parameters

  • boolean guest

Return value

  • boolean

234.2.19. SetMkHomeDir

Set the new value of mkhomedir

Function parameters

  • boolean new_value

Return value

  • boolean

234.2.20. SetSSHSupport

Set the new value for sh single-sign-on support

Function parameters

  • boolean enable

Return value

  • boolean

234.2.21. SetShares

set the new values for user shares

Function parameters

  • integer max

  • string group

Return value

  • boolean

234.2.22. SetStartFAM

update the information if FAM should be started

Function parameters

  • boolean fam

Return value

  • boolean - current fam status

234.2.23. SetWinbind

Set a windind status

Function parameters

  • boolean status

Return value

  • void

234.2.24. SetWinbindCaching

Set the new value for winbind caching (see bug #143927)

Function parameters

  • boolean enable

Return value

  • boolean

234.2.25. SetWorkgroup

Set a host workgroup

Function parameters

  • string group

Return value

  • void

234.2.26. ShortSummary

Create shorter textual summary and a list of unconfigured options

Return value

  • string - summary of the current configuration

234.2.27. Summary

Create a textual summary and a list of unconfigured options

Return value

  • string - summary of the current configuration

234.2.28. UpdatedArchPackages

Return list of architecture specific packages (derived from package list given as parameter) merged with the packages in parameter

Function parameters

  • list<string> packages

Return value

  • list<string>

234.2.29. Write

Write all samba-client settings

Function parameters

  • boolean write_only

Return value

  • boolean - true on success

234.2.30. WriteMkHomeDir

Write the new value of pam_mkhomedir to /etc/pam.d/common-session

Function parameters

  • boolean enabled

Return value

  • boolean

234.2.31. WriteSSHSupport

Write the new value for sh single-sign-on support (fate #303415)

Function parameters

  • boolean enable

Return value

  • boolean

234.2.32. WriteShares

create the shares directory with correct rights

Return value

  • boolean

234.3. Global Variables

234.3.1. globals_configured

Are globals already configured (for AutoYaST)

234.3.2. mkhomedir

if pam_mkhomedir is set in /etc/pam.d/commond-session

234.3.3. modified

Data was modified?

234.3.4. password_data

map with user name and password (used for autoinstallation only)

234.3.5. start_fam

If FAM should be started

234.3.6. winbind_enabled

Should be winbind enabled?

234.3.7. write_only

Write only, used during autoinstallation. Don't run services and SuSEconfig, it's all done at one place.

234.4. Module Requirements

234.4.1. Module Imports

  • Arch
  • Autologin
  • FileUtils
  • Mode
  • NetworkConfig
  • Package
  • Pam
  • Progress
  • Report
  • SambaAD
  • SambaConfig
  • SambaNetJoin
  • SambaNmbLookup
  • SambaWinbind
  • Service
  • String
  • Summary

234.4.2. Module Includes