ACC SHELL
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html>
<head>
<title>
Configuration of samba-client</title>
<style type="text/css">body { background-color: #c8c8c8 }
h1 { color: #e00000 }
table { width: 100%/ border: none }
img { border: 0px }
.sigbox { background-color: #ffc080; border: solid thin #f96500 }
.sig { font: larger monospace }
.padtbl { background-color: #ffc080; padding: 10px; margin: 10px }
/* arrow */
.a { color: #606060 }
/* type, parameter */
.t, .p { color: #c05000 }
.pbox { width: 20% }
.descbox { }
.right { align: right }
.header {}
.footer { clear: both}
.menu { width: 10%; float: left }
.main { width: 90%; float: left }
</style>
</head>
<body>
<div class="header">
<i>YaST2 Developers Documentation:</i>
<a href="index.html">
<b>
Configuration of samba-client</b>
</a>
<img class="right" alt="" src="/usr/share/doc/packages/yast2-devtools/images/yast2-mini.png" />
<hr />
</div>
<div class="menu">
<img alt="YaST" src="/usr/share/doc/packages/yast2-devtools/images/yast2-half.png" />
<br />
<br />
<a href="index.html">functions</a>
<br />
<a href="files.html">files</a>
<br />
<a href="intro.html">intro</a>
</div>
<div class="main">
<div class="sigbox">
<table class="padtbl">
<tr>
<td>
<h1>
Configuration of samba-client</h1>
</td>
<td class="filecell">include/samba-client/routines.ycp</td>
</tr>
<tr>
<td>Miscelanous functions for configuration of samba-client.</td>
</tr>
<tr>
<td>
<ul>
<li>Stanislav Visnovsky <visnov@suse.cz></li>
</ul>
</td>
</tr>
<tr>
<td>
<p>This module has an unstable interface.</p>
</td>
</tr>
</table>
<table class="padtbl">
<tr>
<td>
<h1>Imports</h1>
<ul>
<li>FileUtils</li>
<li>Label</li>
<li>Mode</li>
<li>Popup</li>
<li>Samba</li>
<li>SambaAD</li>
<li>SambaConfig</li>
<li>SambaNetJoin</li>
<li>SambaNmbLookup</li>
<li>Service</li>
<li>Stage</li>
<li>String</li>
</ul>
<h1>Local Functions</h1>
<ul>
<li>
<a href="#AskForSharesRemoval">AskForSharesRemoval ()</a>
</li>
<li>
<a href="#AskJoinDomain">AskJoinDomain (string workgroup, symbol status)</a>
</li>
<li>
<a href="#AskToStopServices">AskToStopServices ()</a>
</li>
<li>
<a href="#CheckWorkgroup">CheckWorkgroup (string workgroup)</a>
</li>
<li>
<a href="#DHCPSupportHelp">DHCPSupportHelp ()</a>
</li>
<li>
<a href="#DHCPSupportTerm">DHCPSupportTerm (boolean dhcp_support)</a>
</li>
<li>
<a href="#GetSharesTerm">GetSharesTerm (boolean allow, string group, integer max)</a>
</li>
<li>
<a href="#HostsResolutionHelp">HostsResolutionHelp ()</a>
</li>
<li>
<a href="#HostsResolutionTerm">HostsResolutionTerm (boolean hosts_resolution)</a>
</li>
<li>
<a href="#LeaveDomain">LeaveDomain (string workgroup)</a>
</li>
<li>
<a href="#PAMMountHelp">PAMMountHelp ()</a>
</li>
<li>
<a href="#ReallyAbort">ReallyAbort ()</a>
</li>
<li>
<a href="#SharesExist">SharesExist (string share_dir)</a>
</li>
<li>
<a href="#SharesHelp">SharesHelp ()</a>
</li>
<li>
<a href="#SharesTerm">SharesTerm (map settings)</a>
</li>
<li>
<a href="#passwordUserPopup">passwordUserPopup (string message, string defaultuser, string domain, symbol what)</a>
</li>
</ul>
</td>
</tr>
</table>
</div>
<p />
<div class="sigbox">
<span class="sig" id="passwordUserPopup">local
<b>passwordUserPopup (string message, string defaultuser, string domain, symbol what)
<span class="a"> -> </span>
<span class="t">map<string, string></span>
</b>
</span>
</div>
<p>
Allow user to type in a user/password pair in a popup.</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">message</span>
</td>
<td class="descbox">a text to be displayed above the password text entry</td>
</tr>
<tr>
<td class="pbox">
<span class="p">defaultuser</span>
</td>
<td class="descbox">a pre-filled user name</td>
</tr>
<tr>
<td class="pbox">
<span class="p">domain</span>
</td>
<td class="descbox"></td>
</tr>
<tr>
<td class="pbox">
<span class="p">what</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">$["user": string, "password": string] with information
provided by the user or nil on cancel</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="ReallyAbort">local
<b>ReallyAbort ()
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
If modified, ask for confirmation</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">true if abort is confirmed</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="CheckWorkgroup">local
<b>CheckWorkgroup (string workgroup)
<span class="a"> -> </span>
<span class="t">symbol</span>
</b>
</span>
</div>
<p>
Check, if the workgroup is a domain or a workgroup. Uses caching to avoid long checks of a workgroup members.</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">workgroup</span>
</td>
<td class="descbox">the workgroup to be checked</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">type of the workgroup: `joined_domain, `not_joined_domain, `workgroup or `domain if
it is a domain, but the status is not known</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="LeaveDomain">local
<b>LeaveDomain (string workgroup)
<span class="a"> -> </span>
<span class="t">symbol</span>
</b>
</span>
</div>
<p>
Leave an AD domain</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">workgroup</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="AskJoinDomain">local
<b>AskJoinDomain (string workgroup, symbol status)
<span class="a"> -> </span>
<span class="t">symbol</span>
</b>
</span>
</div>
<p>
Allow to join a domain. Uses result of <a href="#CheckWorkgroup">CheckWorkgroup</a> to inform the user about the status.</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">workgroup</span>
</td>
<td class="descbox">the workgroup to be joined</td>
</tr>
<tr>
<td class="pbox">
<span class="p">status</span>
</td>
<td class="descbox">domain status returned by CheckWorkgroup</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">`ok on successful join (workgroup is always successful),
`fail on error or user cancel
`nojoin if user don't want to join</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="SharesExist">local
<b>SharesExist (string share_dir)
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Check if user shares already exist</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">share_dir</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="AskForSharesRemoval">local
<b>AskForSharesRemoval ()
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
ask user if existing shares should be removed</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">true for removing</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="AskToStopServices">local
<b>AskToStopServices ()
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
check if services should be stopped: only if there are more sections in
smb.conf and if user confirms (bug #143908)</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">true if smb+nmb should be stopped</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="HostsResolutionTerm">local
<b>HostsResolutionTerm (boolean hosts_resolution)
<span class="a"> -> </span>
<span class="t">term</span>
</b>
</span>
</div>
<p>
return the term with hosts resolution support check box (fate#300971)</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">hosts_resolution</span>
</td>
<td class="descbox">current value of hosts resolution in nsswitch.conf</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="HostsResolutionHelp">local
<b>HostsResolutionHelp ()
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Return help text for hosts resolution term</p>
<div class="sigbox">
<span class="sig" id="DHCPSupportTerm">local
<b>DHCPSupportTerm (boolean dhcp_support)
<span class="a"> -> </span>
<span class="t">term</span>
</b>
</span>
</div>
<p>
return the term with DHCP support check box</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">dhcp_support</span>
</td>
<td class="descbox">current value of DHCP support in smb.conf</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="DHCPSupportHelp">local
<b>DHCPSupportHelp ()
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
return the help text for DHCP support</p>
<div class="sigbox">
<span class="sig" id="SharesTerm">local
<b>SharesTerm (map settings)
<span class="a"> -> </span>
<span class="t">term</span>
</b>
</span>
</div>
<p>
return the term with shares settings</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">settings</span>
</td>
<td class="descbox">map with parameters to show in term</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="GetSharesTerm">local
<b>GetSharesTerm (boolean allow, string group, integer max)
<span class="a"> -> </span>
<span class="t">term</span>
</b>
</span>
</div>
<p>
return the term with shares settings</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">allow</span>
</td>
<td class="descbox">if shares are allowed</td>
</tr>
<tr>
<td class="pbox">
<span class="p">group</span>
</td>
<td class="descbox">name of group owning the shares dir</td>
</tr>
<tr>
<td class="pbox">
<span class="p">max</span>
</td>
<td class="descbox">maximum number of allowed shares</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="SharesHelp">local
<b>SharesHelp ()
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
return the help text for shares</p>
<div class="sigbox">
<span class="sig" id="PAMMountHelp">local
<b>PAMMountHelp ()
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
return the help text for PAM Mount table</p>
</div>
<div class="footer">
<hr />
<i>YaST2 Developers Documentation</i>
<img class="right" alt="" src="/usr/share/doc/packages/yast2-devtools/images/yast2-mini.png" />
</div>
</body>
</html>
ACC SHELL 2018