207. Samba

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

207.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.)

  • 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?

  • 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)

  • ReadSharesSetting - Read user shares settings

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

  • SetMkHomeDir - Set the new value of mkhomedir

  • 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

  • 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.

207.2. Global Functions

207.2.1. AdjustSharesServices

adjust the services for sharing

Function parameters

  • boolean write_only

Return value

  • boolean

207.2.2. AutoPackages

Return required packages for auto-installation

Return value

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

207.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 ())

207.2.4. GetGuessAccess

check if shares guest access is allowed

Return value

  • boolean

207.2.5. GetMaxShares

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

Return value

  • integer

207.2.6. GetModified

Data was modified?

Return value

  • boolean - true if modified

207.2.7. GetWinbind

Get a winbind status

Return value

  • boolean - booleand a winbind status

207.2.8. GetWinbindCaching

Get the current status of winbind caching

Return value

  • boolean

207.2.9. GetWorkgroup

Get a host workgroup

Return value

  • string - a new workgroup

207.2.10. Import

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

Function parameters

  • map settings

Return value

  • boolean - True on success

207.2.11. Read

Read all samba-client settings

Return value

  • boolean - true on success

207.2.12. ReadMkHomeDir

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

Return value

  • boolean

207.2.13. ReadSharesSetting

Read user shares settings

Return value

  • boolean

207.2.14. SetGuessAccess

Set the new value for guest access (#144787)

Function parameters

  • boolean guest

Return value

  • boolean

207.2.15. SetMkHomeDir

Set the new value of mkhomedir

Function parameters

  • boolean new_value

Return value

  • boolean

207.2.16. SetShares

set the new values for user shares

Function parameters

  • integer max

  • string group

Return value

  • boolean

207.2.17. SetStartFAM

update the information if FAM should be started

Function parameters

  • boolean fam

Return value

  • boolean - current fam status

207.2.18. SetWinbind

Set a windind status

Function parameters

  • boolean status

Return value

  • void

207.2.19. SetWinbindCaching

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

Function parameters

  • boolean enable

Return value

  • boolean

207.2.20. SetWorkgroup

Set a host workgroup

Function parameters

  • string group

Return value

  • void

207.2.21. ShortSummary

Create shorter textual summary and a list of unconfigured options

Return value

  • string - summary of the current configuration

207.2.22. Summary

Create a textual summary and a list of unconfigured options

Return value

  • string - summary of the current configuration

207.2.23. 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>

207.2.24. Write

Write all samba-client settings

Function parameters

  • boolean write_only

Return value

  • boolean - true on success

207.2.25. WriteMkHomeDir

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

Function parameters

  • boolean enabled

Return value

  • boolean

207.2.26. WriteShares

create the shares directory with correct rights

Return value

  • boolean

207.3. Global Variables

207.3.1. globals_configured

Are globals already configured (for AutoYaST)

207.3.2. mkhomedir

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

207.3.3. modified

Data was modified?

207.3.4. password_data

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

207.3.5. start_fam

If FAM should be started

207.3.6. winbind_enabled

Should be winbind enabled?

207.3.7. write_only

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

207.4. Module Requirements

207.4.1. Module Imports

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

207.4.2. Module Includes