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 kerberos-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 kerberos-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 kerberos-client</h1>
</td>
<td class="filecell">modules/Kerberos.ycp</td>
</tr>
<tr>
<td>Data for configuration of kerberos-client, i/o functions.</td>
</tr>
<tr>
<td>
<ul>
<li>Jiri Suchomel <jsuchome@suse.cz></li>
</ul>
</td>
</tr>
<tr>
<td>
<p>This module has an unstable interface.</p>
</td>
</tr>
</table>
<table class="padtbl">
<tr>
<td>
Representation of the configuration of kerberos-client.
Input and output routines.
<h1>Imports</h1>
<ul>
<li>FileUtils</li>
<li>Hostname</li>
<li>Label</li>
<li>Mode</li>
<li>Package</li>
<li>Pam</li>
<li>Progress</li>
<li>Report</li>
<li>Service</li>
<li>Stage</li>
<li>Summary</li>
</ul>
<h1>Global Variables</h1>
<ul>
<li>
<a href="#ExpertSettings">ExpertSettings</a>
</li>
<li>
<a href="#required_packages">required_packages</a>
</li>
</ul>
<h1>Global Functions</h1>
<ul>
<li>
<a href="#AutoPackages">AutoPackages ()</a>
</li>
<li>
<a href="#Export">Export ()</a>
</li>
<li>
<a href="#Import">Import (map settings)</a>
</li>
<li>
<a href="#Modified">Modified ()</a>
</li>
<li>
<a href="#Read">Read ()</a>
</li>
<li>
<a href="#ReadFile">ReadFile (path path_to_value, string def_value)</a>
</li>
<li>
<a href="#ReadKrb5ConfValue">ReadKrb5ConfValue (path path_to_value, string def_value)</a>
</li>
<li>
<a href="#ReadKrb5ConfValues">ReadKrb5ConfValues (path path_to_value, string def_value)</a>
</li>
<li>
<a href="#ShortSummary">ShortSummary ()</a>
</li>
<li>
<a href="#Summary">Summary ()</a>
</li>
<li>
<a href="#ValidateTimeEntries">ValidateTimeEntries (string key, string val)</a>
</li>
<li>
<a href="#Write">Write ()</a>
</li>
<li>
<a href="#WriteFile">WriteFile (path path_to_value, string value)</a>
</li>
<li>
<a href="#WriteKrb5ConfValue">WriteKrb5ConfValue (path path_to_value, string value)</a>
</li>
<li>
<a href="#WriteKrb5ConfValues">WriteKrb5ConfValues (path path_to_value, list<string> values)</a>
</li>
<li>
<a href="#WriteKrb5ConfValuesAsString">WriteKrb5ConfValuesAsString (path path_to_value, string values)</a>
</li>
</ul>
</td>
</tr>
</table>
</div>
<p />
<div class="sigbox">
<span class="sig" id="required_packages">global
<b>required_packages
<span class="a"> -> </span>
<span class="t">list<string></span>
</b>
</span>
</div>
<p>
Required packages for this module to operate</p>
<div class="sigbox">
<span class="sig" id="ExpertSettings">global
<b>ExpertSettings
<span class="a"> -> </span>
<span class="t">map<string,any></span>
</b>
</span>
</div>
<p>
map with the settings configurable in the expert tabs</p>
<div class="sigbox">
<span class="sig" id="Modified">global
<b>Modified ()
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Data was modified?</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">true if modified</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="Import">global
<b>Import (map settings)
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Get all the Kerberos configuration from a map.</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">settings</span>
</td>
<td class="descbox">imported map</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">success</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="Export">global
<b>Export ()
<span class="a"> -> </span>
<span class="t">map</span>
</b>
</span>
</div>
<p>
Dump the Kerberos settings to a map, for autoinstallation use.</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">with settings</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="ReadKrb5ConfValues">global
<b>ReadKrb5ConfValues (path path_to_value, string def_value)
<span class="a"> -> </span>
<span class="t">list<string></span>
</b>
</span>
</div>
<p>
Reads the item values from the /etc/krb5.conf via ini agent
If the item doesn't exist, returns the default value</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">path_to_value</span>
</td>
<td class="descbox">path for agent (.etc.krb5_conf)</td>
</tr>
<tr>
<td class="pbox">
<span class="p">def_value</span>
</td>
<td class="descbox">default value for the key (path)</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">string the values for given key</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="ReadKrb5ConfValue">global
<b>ReadKrb5ConfValue (path path_to_value, string def_value)
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Reads the item value from the /etc/krb5.conf via ini agent
If the item doesn't exist, returns the default value</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">path_to_value</span>
</td>
<td class="descbox">path for agent (.etc.krb5_conf)</td>
</tr>
<tr>
<td class="pbox">
<span class="p">def_value</span>
</td>
<td class="descbox">default value for the key (path)</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">the value</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="ReadFile">global
<b>ReadFile (path path_to_value, string def_value)
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
<em>This function is deprecated.</em>
</p>
<p>
Deprecated variant to ReadKrb5ConfValue</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">path_to_value</span>
</td>
<td class="descbox"></td>
</tr>
<tr>
<td class="pbox">
<span class="p">def_value</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="WriteKrb5ConfValues">global
<b>WriteKrb5ConfValues (path path_to_value, list<string> values)
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Write list of values for given key to /etc/krb5.conf
Do not write anything for empty and nil values</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">path_to_value</span>
</td>
<td class="descbox">path for agent (.etc.krb5_conf)</td>
</tr>
<tr>
<td class="pbox">
<span class="p">values</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">false when nothing was written, success of write otherwise</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="WriteKrb5ConfValuesAsString">global
<b>WriteKrb5ConfValuesAsString (path path_to_value, string values)
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Write (possible) multiple values of given key to /etc/krb5.conf</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">path_to_value</span>
</td>
<td class="descbox"></td>
</tr>
<tr>
<td class="pbox">
<span class="p">values</span>
</td>
<td class="descbox">values separated by spaces</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="WriteKrb5ConfValue">global
<b>WriteKrb5ConfValue (path path_to_value, string value)
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Write the item value to /etc/krb5.conf
Do not write anything for empty and nil values</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">path_to_value</span>
</td>
<td class="descbox">path for agent (.etc.krb5_conf)</td>
</tr>
<tr>
<td class="pbox">
<span class="p">value</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">false when nothing was written, success of write otherwise</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="WriteFile">global
<b>WriteFile (path path_to_value, string value)
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
<em>This function is deprecated.</em>
</p>
<p>
Deprecated variant to WriteKrb5ConfValue</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">path_to_value</span>
</td>
<td class="descbox"></td>
</tr>
<tr>
<td class="pbox">
<span class="p">value</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="Read">global
<b>Read ()
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Reads Kerberos settings from the SCR</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">success</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="Write">global
<b>Write ()
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Saves Kerberos configuration.
(No parameters because it is too short to abort)</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">true on success</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="Summary">global
<b>Summary ()
<span class="a"> -> </span>
<span class="t">list</span>
</b>
</span>
</div>
<p>
Create a textual summary</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">summary of the current configuration</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="ShortSummary">global
<b>ShortSummary ()
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Create a short textual summary</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">summary of the current configuration</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="AutoPackages">global
<b>AutoPackages ()
<span class="a"> -> </span>
<span class="t">map</span>
</b>
</span>
</div>
<p>
Return required packages for auto-installation</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">of packages to be installed and to be removed</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="ValidateTimeEntries">global
<b>ValidateTimeEntries (string key, string val)
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Validation function for time-related values</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">key</span>
</td>
<td class="descbox"></td>
</tr>
<tr>
<td class="pbox">
<span class="p">val</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
</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