YaST2 Developers Documentation: Configuration of samba-client

Configuration of samba-client

include/samba-client/routines.ycp
Miscelanous functions for configuration of samba-client.

This module has an unstable interface.

Imports

  • FileUtils
  • Label
  • Mode
  • Popup
  • Samba
  • SambaAD
  • SambaConfig
  • SambaNetJoin
  • SambaNmbLookup
  • Service
  • Stage
  • String

Local Functions

local passwordUserPopup (string message, string defaultuser) -> map<string, string>

Allow user to type in a user/password pair in a popup.

Parameters:
message a text to be displayed above the password text entry
defaultuser a pre-filled user name
Return value:
$["user": string, "password": string] with information provided by the user or nil on cancel
local ReallyAbort () -> boolean

If modified, ask for confirmation

Return value:
true if abort is confirmed
local CheckWorkgroup (string workgroup) -> symbol

Check, if the workgroup is a domain or a workgroup. Uses caching to avoid long checks of a workgroup members.

Parameters:
workgroup the workgroup to be checked
Return value:
type of the workgroup: `joined_domain, `not_joined_domain, `workgroup or `domain if it is a domain, but the status is not known
local AskJoinDomain (string workgroup, symbol status) -> symbol

Allow to join a domain. Uses result of CheckWorkgroup to inform the user about the status.

Parameters:
workgroup the workgroup to be joined
status domain status returned by CheckWorkgroup
Return value:
`ok on successful join (workgroup is always successful), `fail on error or user cancel `nojoin if user don't want to join
local SharesExist (string share_dir) -> boolean

Check if user shares already exist

Parameters:
share_dir
local AskForSharesRemoval () -> boolean

ask user if existing shares should be removed

Return value:
true for removing
local AskToStopServices () -> boolean

check if services should be stopped: only if there are more sections in smb.conf and if user confirms (bug #143908)

Return value:
true if smb+nmb should be stopped
local SharesTerm (map settings) -> term

return the term with shares settings

Parameters:
settings map with parameters to show in term
local GetSharesTerm (boolean allow, string group, integer max) -> term

return the term with shares settings

Parameters:
allow if shares are allowed
group name of group owning the shares dir
max maximum number of allowed shares
local SharesHelp () -> string

return the help text for shares