ACC SHELL

Path : /usr/share/doc/packages/yast2-firewall/autodocs/
File Upload :
Current File : //usr/share/doc/packages/yast2-firewall/autodocs/SuSEFirewallCMDLine.html

<?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>
Firewall configuration</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>
Firewall configuration</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>
Firewall configuration</h1>
      </td>
      <td class="filecell">modules/SuSEFirewallCMDLine.ycp</td>
     </tr>
     <tr>
      <td>Command Line for YaST2 Firewall (Only for Firewall)</td>
     </tr>
     <tr>
      <td>
       <ul>
        <li>Lukas Ocilka <locilka@suse.cz></li>
       </ul>
      </td>
     </tr>
     <tr>
      <td>
       <p>This module has an unstable interface.</p>
       <p>This module is for internal use only.</p>
      </td>
     </tr>
    </table>
    <table class="padtbl">
     <tr>
      <td> Copyright 2004, Novell, Inc.  All rights reserved.



       <h1>Imports</h1>
       <ul>
        <li>CommandLine</li>
        <li>Mode</li>
        <li>Report</li>
        <li>String</li>
        <li>SuSEFirewall</li>
        <li>SuSEFirewallServices</li>
        <li>SuSEFirewallUI</li>
       </ul>
       <h1>Includes</h1>
       <ul>
        <li>firewall/generalfunctions.ycp</li>
        <li>firewall/summary.ycp</li>
       </ul>
       <h1>Global Functions</h1>
       <ul>
        <li>
         <a href="#Run">Run ()</a>
        </li>
       </ul>
       <h1>Local Functions</h1>
       <ul>
        <li>
         <a href="#CheckZone">CheckZone (string zone, boolean optional)</a>
        </li>
        <li>
         <a href="#CommaSeparatedList">CommaSeparatedList (any comma_separated_string)</a>
        </li>
        <li>
         <a href="#FWCMDBroadcast">FWCMDBroadcast (map options)</a>
        </li>
        <li>
         <a href="#FWCMDInterfaces">FWCMDInterfaces (map options)</a>
        </li>
        <li>
         <a href="#FWCMDLogging">FWCMDLogging (map options)</a>
        </li>
        <li>
         <a href="#FWCMDMasqRedirect">FWCMDMasqRedirect (map options)</a>
        </li>
        <li>
         <a href="#FWCMDMasqRedirectShow">FWCMDMasqRedirectShow (map options)</a>
        </li>
        <li>
         <a href="#FWCMDMasquerade">FWCMDMasquerade (map options)</a>
        </li>
        <li>
         <a href="#FWCMDServices">FWCMDServices (map options)</a>
        </li>
        <li>
         <a href="#FWCMDServicesAdditionalPortsManagement">FWCMDServicesAdditionalPortsManagement (string action, string zone, list &lt;string&gt; ports_or_protocols, string type)</a>
        </li>
        <li>
         <a href="#FWCMDServicesDefinedServicesManagement">FWCMDServicesDefinedServicesManagement (string action, string zone, list &lt;string&gt; services)</a>
        </li>
        <li>
         <a href="#FWCMDServicesList">FWCMDServicesList ()</a>
        </li>
        <li>
         <a href="#FWCMDServicesProtect">FWCMDServicesProtect (string zone, string protect)</a>
        </li>
        <li>
         <a href="#FWCMDServicesShow">FWCMDServicesShow (list &lt;string&gt; for_zones, boolean detailed)</a>
        </li>
        <li>
         <a href="#FWCMDStartup">FWCMDStartup (map options)</a>
        </li>
        <li>
         <a href="#FWCMDSummary">FWCMDSummary (map options)</a>
        </li>
        <li>
         <a href="#FWCMDZones">FWCMDZones (map options)</a>
        </li>
        <li>
         <a href="#ListFirewallZones">ListFirewallZones ()</a>
        </li>
       </ul>
      </td>
     </tr>
    </table>
   </div>
   <p />
   <div class="sigbox">
    <span class="sig" id="CommaSeparatedList">local
     <b>CommaSeparatedList (any comma_separated_string)
      <span class="a"> -&gt; </span>
      <span class="t">list &lt;string&gt;</span>
     </b>
    </span>
   </div>
   <p>
 Returns list of strings made from the comma-separated string got as param.</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">comma_separated_string</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">items</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="CheckZone">local
     <b>CheckZone (string zone, boolean optional)
      <span class="a"> -&gt; </span>
      <span class="t">boolean</span>
     </b>
    </span>
   </div>
   <p>
 Function checks zone string for existency</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">zone</span>
       </td>
       <td class="descbox"></td>
      </tr>
      <tr>
       <td class="pbox">
        <span class="p">optional</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">if zone exists or not set if optional</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="ListFirewallZones">local
     <b>ListFirewallZones ()
      <span class="a"> -&gt; </span>
      <span class="t">void</span>
     </b>
    </span>
   </div>
   <p>
 Function prints table of known firewall zones</p>
   <div class="sigbox">
    <span class="sig" id="FWCMDZones">local
     <b>FWCMDZones (map options)
      <span class="a"> -&gt; </span>
      <span class="t">boolean</span>
     </b>
    </span>
   </div>
   <p>
 Calls ListFirewallZones</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">options</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">always false</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="FWCMDSummary">local
     <b>FWCMDSummary (map options)
      <span class="a"> -&gt; </span>
      <span class="t">boolean</span>
     </b>
    </span>
   </div>
   <p>
 Prints firewall summary for zones</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">options</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">always false</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="FWCMDStartup">local
     <b>FWCMDStartup (map options)
      <span class="a"> -&gt; </span>
      <span class="t">boolean</span>
     </b>
    </span>
   </div>
   <p>
 Sets startup details</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">options</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">always true</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="FWCMDInterfaces">local
     <b>FWCMDInterfaces (map options)
      <span class="a"> -&gt; </span>
      <span class="t">boolean</span>
     </b>
    </span>
   </div>
   <p>
 Sets network interface assignment</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">options</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">whether write call is needed</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="FWCMDLogging">local
     <b>FWCMDLogging (map options)
      <span class="a"> -&gt; </span>
      <span class="t">boolean</span>
     </b>
    </span>
   </div>
   <p>
 Sets logging details</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">options</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">whether write is needed</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="FWCMDBroadcast">local
     <b>FWCMDBroadcast (map options)
      <span class="a"> -&gt; </span>
      <span class="t">boolean</span>
     </b>
    </span>
   </div>
   <p>
 Sets broadcast</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">options</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">if write is needed</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="FWCMDServicesList">local
     <b>FWCMDServicesList ()
      <span class="a"> -&gt; </span>
      <span class="t">void</span>
     </b>
    </span>
   </div>
   <p>
 Prints all known firewall services</p>
   <div class="sigbox">
    <span class="sig" id="FWCMDServicesShow">local
     <b>FWCMDServicesShow (list &lt;string&gt; for_zones, boolean detailed)
      <span class="a"> -&gt; </span>
      <span class="t">void</span>
     </b>
    </span>
   </div>
   <p>
 Prints currently allowed services</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">for_zones</span>
       </td>
       <td class="descbox"></td>
      </tr>
      <tr>
       <td class="pbox">
        <span class="p">detailed</span>
       </td>
       <td class="descbox"></td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="FWCMDServicesDefinedServicesManagement">local
     <b>FWCMDServicesDefinedServicesManagement (string action, string zone, list &lt;string&gt; services)
      <span class="a"> -&gt; </span>
      <span class="t">void</span>
     </b>
    </span>
   </div>
   <p>
 Adds/removes services to/from zone.</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">action</span>
       </td>
       <td class="descbox"></td>
      </tr>
      <tr>
       <td class="pbox">
        <span class="p">zone</span>
       </td>
       <td class="descbox"></td>
      </tr>
      <tr>
       <td class="pbox">
        <span class="p">services</span>
       </td>
       <td class="descbox"></td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="FWCMDServicesAdditionalPortsManagement">local
     <b>FWCMDServicesAdditionalPortsManagement (string action, string zone, list &lt;string&gt; ports_or_protocols, string type)
      <span class="a"> -&gt; </span>
      <span class="t">void</span>
     </b>
    </span>
   </div>
   <p>
 Adds/removes ports to/from zone.</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">action</span>
       </td>
       <td class="descbox"></td>
      </tr>
      <tr>
       <td class="pbox">
        <span class="p">zone</span>
       </td>
       <td class="descbox"></td>
      </tr>
      <tr>
       <td class="pbox">
        <span class="p">ports_or_protocols</span>
       </td>
       <td class="descbox"></td>
      </tr>
      <tr>
       <td class="pbox">
        <span class="p">type</span>
       </td>
       <td class="descbox"></td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="FWCMDServicesProtect">local
     <b>FWCMDServicesProtect (string zone, string protect)
      <span class="a"> -&gt; </span>
      <span class="t">void</span>
     </b>
    </span>
   </div>
   <p>
 Sets protect-from value</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">zone</span>
       </td>
       <td class="descbox"></td>
      </tr>
      <tr>
       <td class="pbox">
        <span class="p">protect</span>
       </td>
       <td class="descbox"></td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="FWCMDServices">local
     <b>FWCMDServices (map options)
      <span class="a"> -&gt; </span>
      <span class="t">boolean</span>
     </b>
    </span>
   </div>
   <p>
 Overall handler function for services</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">options</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">whether write call is needed</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="FWCMDMasqRedirectShow">local
     <b>FWCMDMasqRedirectShow (map options)
      <span class="a"> -&gt; </span>
      <span class="t">void</span>
     </b>
    </span>
   </div>
   <p>
 Prints the table of the current redirect-to-masquerade rules</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">options</span>
       </td>
       <td class="descbox"></td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="FWCMDMasqRedirect">local
     <b>FWCMDMasqRedirect (map options)
      <span class="a"> -&gt; </span>
      <span class="t">boolean</span>
     </b>
    </span>
   </div>
   <p>
 Overall handler for redirect to masqueraded network</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">options</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">whether write call is needed</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="FWCMDMasquerade">local
     <b>FWCMDMasquerade (map options)
      <span class="a"> -&gt; </span>
      <span class="t">boolean</span>
     </b>
    </span>
   </div>
   <p>
 Overall masquerade-related handler</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">options</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">whether write call is needed</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="Run">global
     <b>Run ()
      <span class="a"> -&gt; </span>
      <span class="t">void</span>
     </b>
    </span>
   </div>
   <p>
 Runs the commandline interface for firewall</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