<p>laforge has uploaded this change for <strong>review</strong>.</p><p><a href="https://gerrit.osmocom.org/c/osmo-remsim/+/17347">View Change</a></p><pre style="font-family: monospace,monospace; white-space: pre-wrap;">doc: Add documentation for remsim-apitool.py<br><br>Change-Id: I0e280cd4276e1aff7d6f694ac4affbca0336eba5<br>---<br>M doc/manuals/chapters/overview.adoc<br>A doc/manuals/chapters/remsim-apitool.adoc<br>M doc/manuals/osmo-remsim-usermanual.adoc<br>3 files changed, 95 insertions(+), 0 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;">git pull ssh://gerrit.osmocom.org:29418/osmo-remsim refs/changes/47/17347/1</pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/doc/manuals/chapters/overview.adoc b/doc/manuals/chapters/overview.adoc</span><br><span>index d39a4f6..1e19d05 100644</span><br><span>--- a/doc/manuals/chapters/overview.adoc</span><br><span>+++ b/doc/manuals/chapters/overview.adoc</span><br><span>@@ -96,6 +96,14 @@</span><br><span> </span><br><span> For more information, please see <<remsim-bankd>>.</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+=== remsim-apitool.py</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+The `remsim-apitool.py` utility is an optional tool that can be used to</span><br><span style="color: hsl(120, 100%, 40%);">+manually interface with the RSRES interface of `osmo-remsim-server` in</span><br><span style="color: hsl(120, 100%, 40%);">+absence of a back-end system managing this.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+For more information, please see <<remsim-apitool>>.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> === RSPRO</span><br><span> </span><br><span> RSPRO is the *R*emote *S*IM *PRO*tocol.  It is a binary protocol</span><br><span>diff --git a/doc/manuals/chapters/remsim-apitool.adoc b/doc/manuals/chapters/remsim-apitool.adoc</span><br><span>new file mode 100644</span><br><span>index 0000000..3c4d858</span><br><span>--- /dev/null</span><br><span>+++ b/doc/manuals/chapters/remsim-apitool.adoc</span><br><span>@@ -0,0 +1,85 @@</span><br><span style="color: hsl(120, 100%, 40%);">+[[remsim-apitool]]</span><br><span style="color: hsl(120, 100%, 40%);">+== remsim-apitool.py</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+`remsim-apitool.py` is a small python script whic can be used to manually</span><br><span style="color: hsl(120, 100%, 40%);">+control `osmo-remsim-server` via its RESTful interface in setups where</span><br><span style="color: hsl(120, 100%, 40%);">+no external back-end application is controlling this interface.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+For more information about The RESTful inteface, see <<RSRES>>.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+=== Usage</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+Common command line arguments that can be used with any of the commands below:</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+*-H, --host HOST*::</span><br><span style="color: hsl(120, 100%, 40%);">+  Specify the hostname / IP of the `osmo-remsim-server` to connect to. Default: localhost</span><br><span style="color: hsl(120, 100%, 40%);">+*-P, --port PORT*::</span><br><span style="color: hsl(120, 100%, 40%);">+  Specify the remote TCP port of the RSRES interface of `osmo-remsim-server`. Default: 9997</span><br><span style="color: hsl(120, 100%, 40%);">+*-v, --verbose*</span><br><span style="color: hsl(120, 100%, 40%);">+  Increase verbosity of output: Show the GET request generated, not just the response.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+==== Listing connected clients</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+The command `remsim-apitool.py -c` can be used to list all currently connected clients.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+$ remsim-apitool.py -c</span><br><span style="color: hsl(120, 100%, 40%);">+/clients: {'clients': [{'peer': 'C23:0', 'state': 'CONNECTED_CLIENT', 'component_id': {'type_': 'remsimClient', 'name': 'nataraja', 'software': 'remsim-client', 'swVersion': '0.2.2.63-844b'}}]}</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+==== Listing connected bankds</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+The command `remsim-apitool.py -b` can be used to list all currently connected bankds.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+$ remsim-apitool.py -b</span><br><span style="color: hsl(120, 100%, 40%);">+/banks: {'banks': [{'peer': 'B1', 'state': 'CONNECTED_BANKD', 'component_id': {'type_': 'remsimBankd', 'name': 'fixme-name', 'software': 'remsim-bankd', 'swVersion': '0.2.2.46-3598'}, 'bankId': 1, 'numberOfSlots': 5}]}</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+==== Listing installed slotmaps</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+The command `remsim-apitool.py -s` can be used to list all currently installed slotmaps.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+$ remsim-apitool.py -s</span><br><span style="color: hsl(120, 100%, 40%);">+/slotmaps: {'slotmaps': [{'bank': {'bankId': 1, 'slotNr': 1}, 'client': {'clientId': 23, 'slotNr': 0}, 'state': 'ACTIVE'}]}</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+==== Listing all information</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+The command `remsim-apitool.py -a` can be used to list all information (clients, bankds, slotmaps).</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+$ remsim-apitool.py -a</span><br><span style="color: hsl(120, 100%, 40%);">+/clients: {'clients': [{'peer': 'C23:0', 'state': 'CONNECTED_CLIENT', 'component_id': {'type_': 'remsimClient', 'name': 'nataraja', 'software': 'remsim-client', 'swVersion': '0.2.2.63-844b'}}]}</span><br><span style="color: hsl(120, 100%, 40%);">+/banks: {'banks': [{'peer': 'B1', 'state': 'CONNECTED_BANKD', 'component_id': {'type_': 'remsimBankd', 'name': 'fixme-name', 'software': 'remsim-bankd', 'swVersion': '0.2.2.46-3598'}, 'bankId': 1, 'numberOfSlots': 5}]}</span><br><span style="color: hsl(120, 100%, 40%);">+/slotmaps: {'slotmaps': [{'bank': {'bankId': 1, 'slotNr': 1}, 'client': {'clientId': 23, 'slotNr': 0}, 'state': 'ACTIVE'}]}</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+==== Creating a slotmap</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+The command `remsim-apitool.py -m bank_id bankd_slot client_id client_slot` can be used to create a new slotmap.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+.Create a slotmap between Bankd 1 Slot a (B1:1) and Client 23 Slot 0 (C23:0)</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+$ remsim-apitool.py -m 1 1 23 0</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+==== Deleting a slotmap</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+The command `remsim-apitool.py -d bank_id bank_slot` can be used to create a new slotmap.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+.Remove a slotmap for Bankd 1 Slot a (B1:1)</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+$ remsim-apitool.py -m 1 1</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+==== Reset all state</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+The command `remsim-apitool.py -r` can be used to reset all state in bankd, including all slotmaps.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+$ remsim-apitool.py -r</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+WARNING: Use with extreme caution, particularly in production environments.</span><br><span>diff --git a/doc/manuals/osmo-remsim-usermanual.adoc b/doc/manuals/osmo-remsim-usermanual.adoc</span><br><span>index 854271a..1679db2 100644</span><br><span>--- a/doc/manuals/osmo-remsim-usermanual.adoc</span><br><span>+++ b/doc/manuals/osmo-remsim-usermanual.adoc</span><br><span>@@ -10,6 +10,8 @@</span><br><span> </span><br><span> include::{srcdir}/chapters/remsim-server.adoc[]</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+include::{srcdir}/chapters/remsim-apitool.adoc[]</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> include::{srcdir}/chapters/remsim-client.adoc[]</span><br><span> </span><br><span> include::{srcdir}/chapters/remsim-bankd.adoc[]</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.osmocom.org/c/osmo-remsim/+/17347">change 17347</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://gerrit.osmocom.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://gerrit.osmocom.org/c/osmo-remsim/+/17347"/><meta itemprop="name" content="View Change"/></div></div>

<div style="display:none"> Gerrit-Project: osmo-remsim </div>
<div style="display:none"> Gerrit-Branch: master </div>
<div style="display:none"> Gerrit-Change-Id: I0e280cd4276e1aff7d6f694ac4affbca0336eba5 </div>
<div style="display:none"> Gerrit-Change-Number: 17347 </div>
<div style="display:none"> Gerrit-PatchSet: 1 </div>
<div style="display:none"> Gerrit-Owner: laforge <laforge@osmocom.org> </div>
<div style="display:none"> Gerrit-MessageType: newchange </div>