You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

714 lines
35 KiB
HTML

<!DOCTYPE html>
<html >
<head>
<meta charset="utf-8" />
<title>scimport &#8212; SeisComP Release documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/seiscomp.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css" />
<script type="text/javascript" src="../_static/seiscomp.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="scm" href="scm.html" />
<link rel="prev" title="scimex" href="scimex.html" />
</head>
<body>
<div class="header">
<div class="container">
<div class="brand">
<img class="logo" src="../_static/brands/seiscomp/text/white.svg"/>
<!-- span class="title">SeisComP Release</span -->
<span class="version">5.3.0</span>
</div>
</div>
</div>
<div class="nav">
<div class="container">
<div class="content"><a class="pull-right" id="sidebar-toggle">TOC</a>
<div class="related" role="navigation" aria-label="related navigation">
<ul>
<li class="right">
<a href="../genindex.html" title="General Index"
accesskey="I">
index
</a>
</li>
<li class="right">
<a href="scm.html" title="scm"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="scimex.html" title="scimex"
accesskey="P">
previous
</a>
</li>
<li class="nav-item nav-item-0">
<a href="../index.html">Home</a>
</li>
<li class="nav-item nav-item-1">
<a href="../modules.html" >Modules</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/utilities.html" accesskey="U">Utilities</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<div class="section" id="scimport">
<span id="id1"></span><h1>scimport<a class="headerlink" href="#scimport" title="Permalink to this headline"></a></h1>
<p><strong>Forward messages across two SeisComP systems.</strong></p>
<div class="section" id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>scimport is responsible to forward messages from one system to another. The
difference to <a class="reference internal" href="scimex.html#scimex"><span class="std std-ref">scimex</span></a> is that scimport does not handle the messages
event based. scimport supports two different modes. The relay mode does a
simple mapping from GROUP:SYSTEM_A to GROUP:SYSTEM_B. This mode is default.</p>
<p>In case GROUP is not defined in the second system the message is forwarded to
IMPORT_GROUP. The import mode supports custom mapping and filter functionality.
It is possible to forward GROUP1:SYSTEM_A to GROUP2:SYSTEM_B. In addition the
forwarded objects can be filtered by:</p>
<dl class="simple">
<dt>Pick</dt><dd><ul class="simple">
<li><p>Status</p></li>
<li><p>Mode</p></li>
<li><p>Phase</p></li>
<li><p>AgencyID</p></li>
</ul>
</dd>
<dt>Amplitude</dt><dd><ul class="simple">
<li><p>Amplitude</p></li>
</ul>
</dd>
<dt>Origin</dt><dd><ul class="simple">
<li><p>Location</p></li>
<li><p>Depth</p></li>
<li><p>AgencyID</p></li>
<li><p>Status</p></li>
<li><p>Mode</p></li>
</ul>
</dd>
<dt>Event</dt><dd><ul class="simple">
<li><p>Type</p></li>
</ul>
</dd>
<dt>StationMagnitude</dt><dd><ul class="simple">
<li><p>Type</p></li>
</ul>
</dd>
<dt>Magnitude</dt><dd><ul class="simple">
<li><p>Type</p></li>
</ul>
</dd>
</dl>
</div>
<div class="section" id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<p>Example scimport.cfg</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># The address of the importing system</span>
<span class="nv">sink</span> <span class="o">=</span> sinkAddress
<span class="c1"># This option has to be set if the application runs in import mode.</span>
<span class="c1"># The routing table has to be defined in the form of source_group:sink_group</span>
<span class="nv">routingtable</span> <span class="o">=</span> PICK:PICK
<span class="c1"># List of sink groups to subscribe to. If this option is not set the message</span>
<span class="c1"># groups will be determined automatically. If this option is set but not</span>
<span class="c1"># needed for a setup it can be ignored with the option --ignore-groups</span>
<span class="nv">msggroups</span> <span class="o">=</span> GROUP_ONE, GROUP_TWO
<span class="c1"># Available filter options</span>
filter.pick.mode <span class="o">=</span> manual
filter.pick.status <span class="o">=</span> confirmed
filter.pick.phase <span class="o">=</span> P
filter.pick.agencyID <span class="o">=</span> GFZ
<span class="c1"># Values: eq (==), lt (&lt;=) ,gt (&gt;=), *</span>
filter.amplitude.operator <span class="o">=</span> gt
filter.amplitude.amplitude <span class="o">=</span> <span class="m">100</span>
<span class="c1"># Values: lat0:lat1 (range)</span>
filter.origin.latitude <span class="o">=</span> -90:90
<span class="c1"># Values: lon0:lon1 (range)</span>
filter.origin.longitude <span class="o">=</span> -180:180
filter.origin.depth <span class="o">=</span> <span class="m">0</span>:100
filter.origin.agencyID <span class="o">=</span> GFZ
<span class="c1"># Values: automatic, manual</span>
filter.origin.mode <span class="o">=</span> manual
filter.origin.status <span class="o">=</span> confirmed
<span class="c1"># Values: earthquake, explosion, quarry blast, chemical explosion,</span>
<span class="c1"># nuclear explosion, landslide, debris avalanche, rockslide,</span>
<span class="c1"># mine collapse, volcanic eruption, meteor impact, plane crash,</span>
<span class="c1"># building collapse, sonic boom, other</span>
filter.event.type <span class="o">=</span> earthquake
<span class="c1"># Values: Whatever your magnitudes are named</span>
filter.stationMagnitude.type <span class="o">=</span> MLv
<span class="c1"># Values: Whatever your magnitudes are named</span>
filter.magnitude.type <span class="o">=</span> MLv
<span class="c1"># Values: latency, delay, timing quality, gaps interval, gaps length,</span>
<span class="c1"># spikes interval, spikes amplitude, offset, rms</span>
filter.qc.type <span class="o">=</span> latency
</pre></div>
</div>
</div>
<div class="section" id="module-configuration">
<span id="scimport-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/scimport.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/scimport.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/scimport.cfg</span></code></div>
</div>
<p>scimport inherits <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
<dl class="confval">
<dt id="confval-sink">
<code class="sig-name descname">sink</code><a class="headerlink" href="#confval-sink" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>URI of receiving host which runs scmaster. The URI contains
the host name with an optional protocol and port.</p>
<p>Format: protocol://host:port</p>
<p>Examples:</p>
<p>- proc</p>
<p>- scmp://proc:18180</p>
</dd></dl>
<dl class="confval">
<dt id="confval-routingtable">
<code class="sig-name descname">routingtable</code><a class="headerlink" href="#confval-routingtable" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>list:string</em></p>
<p>This option has to be set if the application runs in import mode.
The routing table has to be defined in the form of
source_group:sink_group</p>
</dd></dl>
<dl class="confval">
<dt id="confval-msggroups">
<code class="sig-name descname">msggroups</code><a class="headerlink" href="#confval-msggroups" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>list:string</em></p>
<p>Define a list of message groups of the source system
(connection.server). If not specified, the source system is
queried for a list of message groups which are then used to check
each subscription extracted from the routing table.
This parameter allows to override to source query result.</p>
</dd></dl>
<dl class="confval">
<dt id="confval-useFilter">
<code class="sig-name descname">useFilter</code><a class="headerlink" href="#confval-useFilter" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
<p>Type: <em>boolean</em></p>
<p><em>No description available</em></p>
</dd></dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>filter.*</strong>
<em>Define filter criteria before sending.</em></p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>filter.pick.*</strong>
<em>Criteria for filtering picks.</em></p>
</div>
<dl class="confval">
<dt id="confval-filter.pick.mode">
<code class="sig-name descname">filter.pick.mode</code><a class="headerlink" href="#confval-filter.pick.mode" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>The mode of picks to filter for. Allowed values:
“automatic” and “manual”.</p>
</dd></dl>
<dl class="confval">
<dt id="confval-filter.pick.status">
<code class="sig-name descname">filter.pick.status</code><a class="headerlink" href="#confval-filter.pick.status" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>The status of picks to filter for. Allowed values:
“preliminary”, “confirmed”,
“reviewed”, “final”,
“rejected” and “reported”.</p>
</dd></dl>
<dl class="confval">
<dt id="confval-filter.pick.phase">
<code class="sig-name descname">filter.pick.phase</code><a class="headerlink" href="#confval-filter.pick.phase" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>The pick phase hint to filter for. Allowed values:
all possible phase codes.</p>
</dd></dl>
<dl class="confval">
<dt id="confval-filter.pick.agencyIDs">
<code class="sig-name descname">filter.pick.agencyIDs</code><a class="headerlink" href="#confval-filter.pick.agencyIDs" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>list:string</em></p>
<p>The pick agencyIDs to filter for. Allowed values:
all possible agency ids;</p>
</dd></dl>
<dl class="confval">
<dt id="confval-filter.pick.networkCode">
<code class="sig-name descname">filter.pick.networkCode</code><a class="headerlink" href="#confval-filter.pick.networkCode" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>The pick network code of the processed waveforms.
Allowed values: all possible network codes.</p>
</dd></dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>filter.amplitude.*</strong>
<em>Criteria for filtering amplitudes</em></p>
</div>
<dl class="confval">
<dt id="confval-filter.amplitude.operator">
<code class="sig-name descname">filter.amplitude.operator</code><a class="headerlink" href="#confval-filter.amplitude.operator" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>The amplitude comparison operator. Allowed values:
“eq”, “lt”, “gt” and “*”.</p>
</dd></dl>
<dl class="confval">
<dt id="confval-filter.amplitude.amplitude">
<code class="sig-name descname">filter.amplitude.amplitude</code><a class="headerlink" href="#confval-filter.amplitude.amplitude" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>double</em></p>
<p>The amplitude threshold to filter for. The operator
configured with “operator” is used to compare this threshold with
the incoming value. If “operator” is “*” then
values will pass.</p>
</dd></dl>
<dl class="confval">
<dt id="confval-filter.amplitude.agencyIDs">
<code class="sig-name descname">filter.amplitude.agencyIDs</code><a class="headerlink" href="#confval-filter.amplitude.agencyIDs" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>list:string</em></p>
<p>The amplitude agencyIDs to filter for. Allowed values:
all possible agency ids.</p>
</dd></dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>filter.origin.*</strong>
<em>Criteria for filtering origins</em></p>
</div>
<dl class="confval">
<dt id="confval-filter.origin.latitude">
<code class="sig-name descname">filter.origin.latitude</code><a class="headerlink" href="#confval-filter.origin.latitude" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>The latitude range in format [min]:[max].</p>
</dd></dl>
<dl class="confval">
<dt id="confval-filter.origin.longitude">
<code class="sig-name descname">filter.origin.longitude</code><a class="headerlink" href="#confval-filter.origin.longitude" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>The longitude range in format [min]:[max].</p>
</dd></dl>
<dl class="confval">
<dt id="confval-filter.origin.depth">
<code class="sig-name descname">filter.origin.depth</code><a class="headerlink" href="#confval-filter.origin.depth" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>The depth range in format [min]:[max].</p>
</dd></dl>
<dl class="confval">
<dt id="confval-filter.origin.agencyIDs">
<code class="sig-name descname">filter.origin.agencyIDs</code><a class="headerlink" href="#confval-filter.origin.agencyIDs" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>list:string</em></p>
<p>The origin agencyIDs to filter for. Allowed values:
all possible agency ids;</p>
</dd></dl>
<dl class="confval">
<dt id="confval-filter.origin.mode">
<code class="sig-name descname">filter.origin.mode</code><a class="headerlink" href="#confval-filter.origin.mode" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>The origin evaluation mode to filter for. Allowed values:
“automatic” and “manual”.</p>
</dd></dl>
<dl class="confval">
<dt id="confval-filter.origin.status">
<code class="sig-name descname">filter.origin.status</code><a class="headerlink" href="#confval-filter.origin.status" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>The origin status to filter for. Allowed values:
“preliminary”, “confirmed”,
“reviewed”, “final”,
“rejected” and “reported”.</p>
</dd></dl>
<dl class="confval">
<dt id="confval-filter.origin.arrivalcount">
<code class="sig-name descname">filter.origin.arrivalcount</code><a class="headerlink" href="#confval-filter.origin.arrivalcount" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>The minimum number of arrivals of an origin to pass
the filter.</p>
</dd></dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>filter.event.*</strong>
<em>Criteria for filtering events</em></p>
</div>
<dl class="confval">
<dt id="confval-filter.event.type">
<code class="sig-name descname">filter.event.type</code><a class="headerlink" href="#confval-filter.event.type" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>The event type to filter for, e.g. “earthquake”,
“explosion” …</p>
</dd></dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>filter.stationMagnitude.*</strong>
<em>Criteria for filtering station magnitudes</em></p>
</div>
<dl class="confval">
<dt id="confval-filter.stationMagnitude.type">
<code class="sig-name descname">filter.stationMagnitude.type</code><a class="headerlink" href="#confval-filter.stationMagnitude.type" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>The station magnitude type. Allowed values: all possible
magnitude types such as “MLv”.</p>
</dd></dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>filter.magnitude.*</strong>
<em>Criteria for filtering network magnitudes</em></p>
</div>
<dl class="confval">
<dt id="confval-filter.magnitude.type">
<code class="sig-name descname">filter.magnitude.type</code><a class="headerlink" href="#confval-filter.magnitude.type" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>The magnitude type. Allowed values: all possible
magnitude types such as “MLv”.</p>
</dd></dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>filter.qc.*</strong>
<em>Criteria for filtering QC parameters</em></p>
</div>
<dl class="confval">
<dt id="confval-filter.qc.type">
<code class="sig-name descname">filter.qc.type</code><a class="headerlink" href="#confval-filter.qc.type" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>The QC parameter type. Allowed values: all possible
types such as “latency”, “delay” …</p>
</dd></dl>
</div>
<div class="section" id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this headline"></a></h2>
<p><strong class="program">scimport [options]</strong></p>
<div class="section" id="generic">
<h3>Generic<a class="headerlink" href="#generic" title="Permalink to this headline"></a></h3>
<dl class="option">
<dt id="cmdoption-scimport-h">
<code class="sig-name descname">-h</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--help</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-scimport-h" title="Permalink to this definition"></a></dt>
<dd><p>Show help message.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scimport-v">
<code class="sig-name descname">-V</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--version</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-scimport-v" title="Permalink to this definition"></a></dt>
<dd><p>Show version information.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scimport-config-file">
<code class="sig-name descname">--config-file</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scimport-config-file" title="Permalink to this definition"></a></dt>
<dd><p>Use alternative configuration file. When this option is
used the loading of all stages is disabled. Only the
given configuration file is parsed and used. To use
another name for the configuration create a symbolic
link of the application or copy it. Example:
scautopick -&gt; scautopick2.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scimport-plugins">
<code class="sig-name descname">--plugins</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scimport-plugins" title="Permalink to this definition"></a></dt>
<dd><p>Load given plugins.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scimport-d">
<code class="sig-name descname">-D</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--daemon</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-scimport-d" title="Permalink to this definition"></a></dt>
<dd><p>Run as daemon. This means the application will fork itself
and doesnt need to be started with &amp;.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scimport-auto-shutdown">
<code class="sig-name descname">--auto-shutdown</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scimport-auto-shutdown" title="Permalink to this definition"></a></dt>
<dd><p>Enable/disable self-shutdown because a master module shutdown.
This only works when messaging is enabled and the master
module sends a shutdown message (enabled with start-stop-msg
for the master module).</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scimport-shutdown-master-module">
<code class="sig-name descname">--shutdown-master-module</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scimport-shutdown-master-module" title="Permalink to this definition"></a></dt>
<dd><p>Set the name of the master-module used for auto-shutdown.
This is the application name of the module actually
started. If symlinks are used, then it is the name of
the symlinked application.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scimport-shutdown-master-username">
<code class="sig-name descname">--shutdown-master-username</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scimport-shutdown-master-username" title="Permalink to this definition"></a></dt>
<dd><p>Set the name of the master-username of the messaging
used for auto-shutdown. If “shutdown-master-module” is
given as well, this parameter is ignored.</p>
</dd></dl>
</div>
<div class="section" id="verbosity">
<h3>Verbosity<a class="headerlink" href="#verbosity" title="Permalink to this headline"></a></h3>
<dl class="option">
<dt id="cmdoption-scimport-verbosity">
<code class="sig-name descname">--verbosity</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scimport-verbosity" title="Permalink to this definition"></a></dt>
<dd><p>Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info,
4:debug.</p>
</dd></dl>
<dl class="option">
<dt id="id2">
<code class="sig-name descname">-v</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--v</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#id2" title="Permalink to this definition"></a></dt>
<dd><p>Increase verbosity level (may be repeated, eg. -vv).</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scimport-q">
<code class="sig-name descname">-q</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--quiet</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-scimport-q" title="Permalink to this definition"></a></dt>
<dd><p>Quiet mode: no logging output.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scimport-component">
<code class="sig-name descname">--component</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scimport-component" title="Permalink to this definition"></a></dt>
<dd><p>Limit the logging to a certain component. This option can
be given more than once.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scimport-s">
<code class="sig-name descname">-s</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--syslog</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-scimport-s" title="Permalink to this definition"></a></dt>
<dd><p>Use syslog logging backend. The output usually goes to
/var/lib/messages.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scimport-l">
<code class="sig-name descname">-l</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--lockfile</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scimport-l" title="Permalink to this definition"></a></dt>
<dd><p>Path to lock file.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scimport-console">
<code class="sig-name descname">--console</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scimport-console" title="Permalink to this definition"></a></dt>
<dd><p>Send log output to stdout.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scimport-debug">
<code class="sig-name descname">--debug</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-scimport-debug" title="Permalink to this definition"></a></dt>
<dd><p>Execute in debug mode.
Equivalent to verbosity=4 console=1 .</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scimport-log-file">
<code class="sig-name descname">--log-file</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scimport-log-file" title="Permalink to this definition"></a></dt>
<dd><p>Use alternative log file.</p>
</dd></dl>
</div>
<div class="section" id="messaging">
<h3>Messaging<a class="headerlink" href="#messaging" title="Permalink to this headline"></a></h3>
<dl class="option">
<dt id="cmdoption-scimport-u">
<code class="sig-name descname">-u</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--user</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scimport-u" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.username"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.username</span></code></a>.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scimport-host">
<code class="sig-name descname">-H</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--host</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scimport-host" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.server"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.server</span></code></a>.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scimport-t">
<code class="sig-name descname">-t</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--timeout</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scimport-t" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.timeout"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.timeout</span></code></a>.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scimport-g">
<code class="sig-name descname">-g</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--primary-group</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scimport-g" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.primaryGroup"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.primaryGroup</span></code></a>.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scimport-subscribe-group">
<code class="sig-name descname">-S</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--subscribe-group</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scimport-subscribe-group" title="Permalink to this definition"></a></dt>
<dd><p>A group to subscribe to.
This option can be given more than once.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scimport-content-type">
<code class="sig-name descname">--content-type</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scimport-content-type" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.contentType"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.contentType</span></code></a>.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scimport-start-stop-msg">
<code class="sig-name descname">--start-stop-msg</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scimport-start-stop-msg" title="Permalink to this definition"></a></dt>
<dd><p>Set sending of a start and a stop message.</p>
</dd></dl>
</div>
<div class="section" id="import">
<h3>Import<a class="headerlink" href="#import" title="Permalink to this headline"></a></h3>
<dl class="option">
<dt id="cmdoption-scimport-o">
<code class="sig-name descname">-o</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--sink</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-scimport-o" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="#confval-sink"><code class="xref std std-confval docutils literal notranslate"><span class="pre">sink</span></code></a>.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scimport-i">
<code class="sig-name descname">-i</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--import</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-scimport-i" title="Permalink to this definition"></a></dt>
<dd><p>Switch to import mode (default is relay). Im import mode the
routing table has to be specified whereas in relay the
routing table will be calculated automatically.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scimport-no-filter">
<code class="sig-name descname">--no-filter</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-scimport-no-filter" title="Permalink to this definition"></a></dt>
<dd><p>Disable message filtering and ignore all configured filters.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scimport-routeunknowngroup">
<code class="sig-name descname">--routeunknowngroup</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-scimport-routeunknowngroup" title="Permalink to this definition"></a></dt>
<dd><p>Route unknown groups to the default group IMPORT_GROUP.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scimport-ignore-groups">
<code class="sig-name descname">--ignore-groups</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-scimport-ignore-groups" title="Permalink to this definition"></a></dt>
<dd><p>Ignore user specified groups.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scimport-test">
<code class="sig-name descname">--test</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-scimport-test" title="Permalink to this definition"></a></dt>
<dd><p>Do not send any messages.</p>
</dd></dl>
</div>
</div>
</div>
<div id="anchors-bottom"></div>
</div>
<div class="sidebar" role="navigation" aria-label="main navigation">
<div id="anchors-top"></div>
<div id="anchors" class="content">
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">scimport</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#examples">Examples</a></li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
<li><a class="reference internal" href="#generic">Generic</a></li>
<li><a class="reference internal" href="#verbosity">Verbosity</a></li>
<li><a class="reference internal" href="#messaging">Messaging</a></li>
<li><a class="reference internal" href="#import">Import</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="scimex.html"
title="previous chapter">scimex</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="scm.html"
title="next chapter">scm</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/scimport.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<div class="container">
<div class="horizontal layout content">
<a class="fade-in" href="https://www.gempa.de" target="_blank">
<img class="brand" src="../_static/brands/gempa.svg"/>
</a>
<div class="stretched align-center fitted content">
<div>
Version <b>5.3.0</b> Release
</div>
<div class="copyright">
Copyright &copy; gempa GmbH, GFZ Potsdam.
</div>
</div>
<a class="fade-in" href="https://www.gfz-potsdam.de" target="_blank">
<img class="brand" src="../_static/brands/gfz.svg"/>
</a>
</div>
</div>
</div>
</body>
</html>