<p>lynxis lazus has uploaded this change for <strong>review</strong>.</p><p><a href="https://gerrit.osmocom.org/c/osmo-gsm-manuals/+/24687">View Change</a></p><pre style="font-family: monospace,monospace; white-space: pre-wrap;">WIP: add ns2 docs<br><br>Change-Id: I5571001a127c933397a4bc26e85410288d50fc2f<br>---<br>A common/chapters/gb-ns2-maintainance.adoc<br>A common/chapters/gb-ns2-nsvc-states-alive.dot<br>A common/chapters/gb-ns2-nsvc-states-reset-block.dot<br>3 files changed, 123 insertions(+), 0 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;">git pull ssh://gerrit.osmocom.org:29418/osmo-gsm-manuals refs/changes/87/24687/1</pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/common/chapters/gb-ns2-maintainance.adoc b/common/chapters/gb-ns2-maintainance.adoc</span><br><span>new file mode 100644</span><br><span>index 0000000..e16fa63</span><br><span>--- /dev/null</span><br><span>+++ b/common/chapters/gb-ns2-maintainance.adoc</span><br><span>@@ -0,0 +1,108 @@</span><br><span style="color: hsl(120, 100%, 40%);">+=== Gb/NS maintaince</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+This section describes common maintance procedures.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+==== NSE states</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+A NSE can have the following states:</span><br><span style="color: hsl(120, 100%, 40%);">+- ALIVE</span><br><span style="color: hsl(120, 100%, 40%);">+- DEAD</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+For FR, IPA: The NSE is ALIVE if there is at least one NSVC in state UNBLOCKED.</span><br><span style="color: hsl(120, 100%, 40%);">+For IP-SNS/UDP: The NSE is ALIVE if there is at least one NSVC ALIVE and the sum of all ALIVE NSVCs signalling weights > 0 and data weights > 0.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+The state of the NSE is shown by vty.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+.show ns</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+GbProxy# show ns nsei 1234</span><br><span style="color: hsl(120, 100%, 40%);">+NSEI 01234: UDP, DEAD <1></span><br><span style="color: hsl(120, 100%, 40%);">+ FSM Instance Name: 'GPRS-NS2-SNS-BSS(NSE01234-SNS)[0x6120000012a0]', ID: 'NSE01234-SNS'</span><br><span style="color: hsl(120, 100%, 40%);">+ Log-Level: 'DEBUG', State: 'BSS_SIZE'</span><br><span style="color: hsl(120, 100%, 40%);">+ Timer: 1</span><br><span style="color: hsl(120, 100%, 40%);">+ Maximum number of remote NS-VCs: 8192, IPv4 Endpoints: 8192, IPv6 Endpoints: 8192</span><br><span style="color: hsl(120, 100%, 40%);">+ 1 NS-VC:</span><br><span style="color: hsl(120, 100%, 40%);">+ NSVCI none: DISABLED DYNAMIC data_weight=1 sig_weight=1 udp)[127.0.0.1]:23000<>[127.0.0.1]:22000</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+<1> NSE state</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+==== NSVC states</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+A NSVC can have the following states:</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+- DISABLED</span><br><span style="color: hsl(120, 100%, 40%);">+- RESET</span><br><span style="color: hsl(120, 100%, 40%);">+- BLOCKED</span><br><span style="color: hsl(120, 100%, 40%);">+- UNBLOCKED</span><br><span style="color: hsl(120, 100%, 40%);">+- RECOVERING</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+.nsvc states</span><br><span style="color: hsl(120, 100%, 40%);">+[options="header"]</span><br><span style="color: hsl(120, 100%, 40%);">+|=========================================================</span><br><span style="color: hsl(120, 100%, 40%);">+| State | transport UNITDATA | Description</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+| DISABLED | No | Either the transport layer is unavailable (FR) or this NSVC is currently used by IP-SNS dynamic configuration.</span><br><span style="color: hsl(120, 100%, 40%);">+| RESET | No | Sending out RESET PDU and awaiting data.</span><br><span style="color: hsl(120, 100%, 40%);">+| BLOCKED | No* | The NSVC has been BLOCKED. * see 3GPP TS 48.016 ยง 7.2 exception</span><br><span style="color: hsl(120, 100%, 40%);">+| UNBLOCKED/ALIVE | Yes | The NSVC transport UNITDATA.</span><br><span style="color: hsl(120, 100%, 40%);">+| RECOVERING | No | The NSVC test procedure timed out. NSVC type is a IP-SNS which don't use RESET/BLOCK/UNBLOCK.</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%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+[[fig-nsvc-states-reset-block]]</span><br><span style="color: hsl(120, 100%, 40%);">+.Simplified state diagram for RESET BLOCK UNBLOCK NSVCs</span><br><span style="color: hsl(120, 100%, 40%);">+[graphviz]</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+include::gb-ns2-nsvc-states-reset-block.dot[]</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%);">+[[fig-nsvc-states-reset-block]]</span><br><span style="color: hsl(120, 100%, 40%);">+.Simplified state diagram for IP-SNS/UDP</span><br><span style="color: hsl(120, 100%, 40%);">+[graphviz]</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+include::gb-ns2-nsvc-states-alive.dot[]</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%);">+==== Show information of a specific NSE</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+The NSE 1234 has been configured for as BSS with IP-SNS configuration.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+.show ns on a dynamic configured IP-SNS NSE</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+GbProxy# show ns nsei 1234</span><br><span style="color: hsl(120, 100%, 40%);">+NSEI 01234: UDP, DEAD <1></span><br><span style="color: hsl(120, 100%, 40%);">+ FSM Instance Name: 'GPRS-NS2-SNS-BSS(NSE01234-SNS)[0x6120000012a0]', ID: 'NSE01234-SNS'</span><br><span style="color: hsl(120, 100%, 40%);">+ Log-Level: 'DEBUG', State: 'BSS_SIZE' <2></span><br><span style="color: hsl(120, 100%, 40%);">+ Timer: 1</span><br><span style="color: hsl(120, 100%, 40%);">+ Maximum number of remote NS-VCs: 8192, IPv4 Endpoints: 8192, IPv6 Endpoints: 8192</span><br><span style="color: hsl(120, 100%, 40%);">+ 1 NS-VC:</span><br><span style="color: hsl(120, 100%, 40%);">+ NSVCI none: DISABLED DYNAMIC data_weight=1 sig_weight=1 udp)[127.0.0.1]:23000<>[127.0.0.1]:22000</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+<1> A UDP NSE. A NSE can be ALIVE or DEAD</span><br><span style="color: hsl(120, 100%, 40%);">+<2> The SNS state. CONFIGURED and LOCAL_PROCEDURE are ALIVE states</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+For FR, IPA: The NSE is ALIVE if there is at least one NSVC in state UNBLOCKED.</span><br><span style="color: hsl(120, 100%, 40%);">+For IP-SNS/UDP: The NSE is alive if there is at least one NSVC ALIVE and the summary of all NSVC signalling weights > 1 and data weights > 1.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+.show ns on a frame relay NSE</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+OsmoNSdummy# show ns nsei 02001</span><br><span style="color: hsl(120, 100%, 40%);">+NSEI 02001: FR, ALIVE <1></span><br><span style="color: hsl(120, 100%, 40%);">+ 4 NS-VC:</span><br><span style="color: hsl(120, 100%, 40%);">+ NSVCI 00001: DISABLED PERSIST data_weight=1 sig_weight=1 fr)netif: hdlcnet1 dlci: 16 <2></span><br><span style="color: hsl(120, 100%, 40%);">+ NSVCI 00002: DISABLED PERSIST data_weight=1 sig_weight=1 fr)netif: hdlcnet2 dlci: 17 <3></span><br><span style="color: hsl(120, 100%, 40%);">+ NSVCI 00003: DISABLED PERSIST <4> data_weight=1 sig_weight=1 fr)netif: hdlcnet3 dlci: 18</span><br><span style="color: hsl(120, 100%, 40%);">+ NSVCI 00004: DISABLED PERSIST data_weight=1 sig_weight=1 fr)netif: hdlcnet4 dlci: 19</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+<1> A FR NSE. A NSE can be ALIVE or DEAD</span><br><span style="color: hsl(120, 100%, 40%);">+<2> An unblocked NS-VC will be used for data and signalling. data and signalling weight are only relevant for UDP NSVC.</span><br><span style="color: hsl(120, 100%, 40%);">+<3> NSVC is still blocked.</span><br><span style="color: hsl(120, 100%, 40%);">+<4> A PERSIST NSVC is a configured via VTY.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+==== Blocking a NSVC</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+To block a single NSVC </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%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span>diff --git a/common/chapters/gb-ns2-nsvc-states-alive.dot b/common/chapters/gb-ns2-nsvc-states-alive.dot</span><br><span>new file mode 100644</span><br><span>index 0000000..7e919c1</span><br><span>--- /dev/null</span><br><span>+++ b/common/chapters/gb-ns2-nsvc-states-alive.dot</span><br><span>@@ -0,0 +1,6 @@</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+digraph G {</span><br><span style="color: hsl(120, 100%, 40%);">+ DISABLED -> ALIVE;</span><br><span style="color: hsl(120, 100%, 40%);">+ ALIVE -> RECOVERING [label="test procedure timeout"];</span><br><span style="color: hsl(120, 100%, 40%);">+ RECOVERING -> ALIVE [label="test procedure success"];</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span>diff --git a/common/chapters/gb-ns2-nsvc-states-reset-block.dot b/common/chapters/gb-ns2-nsvc-states-reset-block.dot</span><br><span>new file mode 100644</span><br><span>index 0000000..b1825d5</span><br><span>--- /dev/null</span><br><span>+++ b/common/chapters/gb-ns2-nsvc-states-reset-block.dot</span><br><span>@@ -0,0 +1,9 @@</span><br><span style="color: hsl(120, 100%, 40%);">+digraph G {</span><br><span style="color: hsl(120, 100%, 40%);">+ DISABLED -> RESET [label="transport layer available"];</span><br><span style="color: hsl(120, 100%, 40%);">+ RESET -> BLOCKED [label="reset ack"];</span><br><span style="color: hsl(120, 100%, 40%);">+ BLOCKED -> UNBLOCKED [label="unblock"];</span><br><span style="color: hsl(120, 100%, 40%);">+ UNBLOCKED -> BLOCKED [label="block"];</span><br><span style="color: hsl(120, 100%, 40%);">+ BLOCKED -> RESET [label="test procedure timeout"];</span><br><span style="color: hsl(120, 100%, 40%);">+ UNBLOCKED -> RESET [label="test procedure timeout"];</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.osmocom.org/c/osmo-gsm-manuals/+/24687">change 24687</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-gsm-manuals/+/24687"/><meta itemprop="name" content="View Change"/></div></div>
<div style="display:none"> Gerrit-Project: osmo-gsm-manuals </div>
<div style="display:none"> Gerrit-Branch: master </div>
<div style="display:none"> Gerrit-Change-Id: I5571001a127c933397a4bc26e85410288d50fc2f </div>
<div style="display:none"> Gerrit-Change-Number: 24687 </div>
<div style="display:none"> Gerrit-PatchSet: 1 </div>
<div style="display:none"> Gerrit-Owner: lynxis lazus <lynxis@fe80.eu> </div>
<div style="display:none"> Gerrit-MessageType: newchange </div>