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 nfs
</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 nfs
</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 nfs
</h1>
</td>
<td class="filecell">
Nfs.ycp
</td>
</tr>
<tr>
<td>
NFS client configuration data, I/O functions.
</td>
</tr>
<tr>
<td>
<ul>
<li> Jan Holesovsky <kendy@suse.cz></li>
<li> Dan Vesely <dan@suse.cz></li>
<li> Martin Vidner <mvidner@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>Mode</li>
<li>PackageSystem</li>
<li>Progress</li>
<li>Report</li>
<li>Service</li>
<li>SuSEFirewall</li>
<li>Summary</li>
<li>Wizard</li>
</ul>
<h1>Includes</h1>
<ul>
<li>nfs/routines.ycp</li>
</ul>
<h1>Global Variables</h1>
<ul>
<li>
<a href="#nfs_entries">nfs_entries</a>
</li>
<li>
<a href="#non_nfs_entries">non_nfs_entries</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="#GetModified">GetModified ()</a>
</li>
<li>
<a href="#Import">Import (map <string, any> settings)</a>
</li>
<li>
<a href="#Mount">Mount (string server, string share, string mpoint, string options, string type)</a>
</li>
<li>
<a href="#Read">Read ()</a>
</li>
<li>
<a href="#Set">Set (map <string, any> settings)</a>
</li>
<li>
<a href="#SetModified">SetModified ()</a>
</li>
<li>
<a href="#Summary">Summary ()</a>
</li>
<li>
<a href="#Unmount">Unmount (string mpoint)</a>
</li>
<li>
<a href="#Write">Write ()</a>
</li>
<li>
<a href="#WriteOnly">WriteOnly ()</a>
</li>
</ul>
<h1>Local Functions</h1>
<ul>
<li>
<a href="#EscapeSpaces">EscapeSpaces (list<map<string,any> > entries)</a>
</li>
<li>
<a href="#EscapeSpaces1">EscapeSpaces1 (string s)</a>
</li>
<li>
<a href="#UnescapeSpaces">UnescapeSpaces (list<map<string,any> > entries)</a>
</li>
<li>
<a href="#UnescapeSpaces1">UnescapeSpaces1 (string s)</a>
</li>
<li>
<a href="#gsub">gsub (string regex, string replacement, string s)</a>
</li>
</ul>
</td>
</tr>
</table>
</div>
<p />
<div class="sigbox">
<span class="sig" id="SetModified">global
<b>SetModified ()
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Function sets internal variable, which indicates, that any
settings were modified, to "true"</p>
<div class="sigbox">
<span class="sig" id="GetModified">global
<b>GetModified ()
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Functions which returns if the settings were modified</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">settings were modified</td>
</tr>
</table>
</dd>
</dl>
<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</p>
<div class="sigbox">
<span class="sig" id="nfs_entries">global
<b>nfs_entries
<span class="a"> -> </span>
<span class="t">list<map<string,any> ></span>
</b>
</span>
</div>
<p>
eg.: [ $["spec": "moon:/cheese", file: "/mooncheese", "mntopts": "defaults"], ...]</p>
<div class="sigbox">
<span class="sig" id="non_nfs_entries">global
<b>non_nfs_entries
<span class="a"> -> </span>
<span class="t">list<map></span>
</b>
</span>
</div>
<p>
Read only, intended for checking mount-point uniqueness.</p>
<div class="sigbox">
<span class="sig" id="Set">global
<b>Set (map <string, any> settings)
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Set module data</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">settings</span>
</td>
<td class="descbox">module settings</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="Import">global
<b>Import (map <string, any> settings)
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Get all NFS configuration from a map.
When called by nfs_auto (preparing autoinstallation data)
the map may be empty.</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">settings</span>
</td>
<td class="descbox">a map with a single key: nfs_entries</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 NFS 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">a list of nfs entries.</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="EscapeSpaces1">local
<b>EscapeSpaces1 (string s)
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Escape spaces " " -> "\\040".</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">s</span>
</td>
<td class="descbox">a string or nil</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">escaped string or nil</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="EscapeSpaces">local
<b>EscapeSpaces (list<map<string,any> > entries)
<span class="a"> -> </span>
<span class="t">list<map<string,any> ></span>
</b>
</span>
</div>
<p>
Escape spaces " " -> "\\040" in all values of all entries</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">entries</span>
</td>
<td class="descbox">a list of maps, such as nfs_entries</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">escaped entries</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="gsub">local
<b>gsub (string regex, string replacement, string s)
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
(like awk gsub, but return the result, not number of replacements)
replaces from back!</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">regex</span>
</td>
<td class="descbox">regular expression to replace</td>
</tr>
<tr>
<td class="pbox">
<span class="p">replacement</span>
</td>
<td class="descbox">the replacement string</td>
</tr>
<tr>
<td class="pbox">
<span class="p">s</span>
</td>
<td class="descbox">where to replace</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 changed string</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="UnescapeSpaces1">local
<b>UnescapeSpaces1 (string s)
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Un-escape spaces "\\040" -> " "</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">s</span>
</td>
<td class="descbox">string or nil</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">escaped string or nil</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="UnescapeSpaces">local
<b>UnescapeSpaces (list<map<string,any> > entries)
<span class="a"> -> </span>
<span class="t">list<map<string,any> ></span>
</b>
</span>
</div>
<p>
Un-escape spaces "\\040" -> " " in all values of all entries</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">entries</span>
</td>
<td class="descbox">a list of maps, such as nfs_entries</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">escaped entries</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 NFS settings from the SCR (.etc.fstab)</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="WriteOnly">global
<b>WriteOnly ()
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Writes the NFS client configuration without
starting/stopping the service.
Autoinstallation uses this and then calls SuSEconfig only once
and starts the services together.
(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="Write">global
<b>Write ()
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Writes the NFS client configuration and starts/stops the service.
(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">string</span>
</b>
</span>
</div>
<p>
Summary()</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">Html formatted configuration summary</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="Mount">global
<b>Mount (string server, string share, string mpoint, string options, string type)
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Mount NFS directory</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">server</span>
</td>
<td class="descbox">remote server name</td>
</tr>
<tr>
<td class="pbox">
<span class="p">share</span>
</td>
<td class="descbox">name of the exported directory</td>
</tr>
<tr>
<td class="pbox">
<span class="p">mpoint</span>
</td>
<td class="descbox">mount point (can be empty or nil, in this case it will be mounted in temporary directory)</td>
</tr>
<tr>
<td class="pbox">
<span class="p">options</span>
</td>
<td class="descbox">mount options - e.g. "ro,hard,intr", see man nfs</td>
</tr>
<tr>
<td class="pbox">
<span class="p">type</span>
</td>
<td class="descbox">nfs type (nfs vs. nfsv4) - if empty, 'nfs' is used</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">directory where volume was mounted or nil if mount failed</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="Unmount">global
<b>Unmount (string mpoint)
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Unmount NFS directory from the system</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">mpoint</span>
</td>
<td class="descbox">NFS mount point to unmount</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">true on success</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>
<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