<p>Daniel Willmann has uploaded this change for <strong>review</strong>.</p><p><a href="https://gerrit.osmocom.org/13642">View Change</a></p><pre style="font-family: monospace,monospace; white-space: pre-wrap;">Change VTY samples from OsmoNITB to OsmoMSC<br><br>Change-Id: I9fb3c43ea56087900eee4427f1ae50a7c9e84698<br>Related: OS#2299<br>---<br>M common/chapters/vty.adoc<br>1 file changed, 92 insertions(+), 67 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/42/13642/1</pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/common/chapters/vty.adoc b/common/chapters/vty.adoc</span><br><span>index c9e3d59..3aed41a 100644</span><br><span>--- a/common/chapters/vty.adoc</span><br><span>+++ b/common/chapters/vty.adoc</span><br><span>@@ -133,7 +133,7 @@</span><br><span> </span><br><span> NOTE: The VTY is present on most Osmocom GSM/UMTS/GPRS software, thus this</span><br><span> chapter is present in all the relevant manuals. The detailed examples</span><br><span style="color: hsl(0, 100%, 40%);">-below assume you are executing them on the OsmoNITB VTY. They will work</span><br><span style="color: hsl(120, 100%, 40%);">+below assume you are executing them on the OsmoMSC VTY. They will work</span><br><span> in similar fashion on the other VTY interfaces, while the node structure will</span><br><span> differ in each program.</span><br><span> </span><br><span>@@ -147,9 +147,9 @@</span><br><span> even only a partial command), you will get a list of the first word of</span><br><span> all possible commands available at this node:</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-.Example: Typing `?` at start of OsmoNITB prompt</span><br><span style="color: hsl(120, 100%, 40%);">+.Example: Typing `?` at start of OsmoMSC prompt</span><br><span> ----</span><br><span style="color: hsl(0, 100%, 40%);">-OpenBSC> <1></span><br><span style="color: hsl(120, 100%, 40%);">+OsmoMSC> <1></span><br><span>   show        Show running system information</span><br><span>   list        Print command list</span><br><span>   exit        Exit current mode and down to previous mode</span><br><span>@@ -157,7 +157,8 @@</span><br><span>   enable      Turn on privileged mode command</span><br><span>   terminal    Set terminal line parameters</span><br><span>   who         Display who is on vty</span><br><span style="color: hsl(0, 100%, 40%);">-  logging     Configure log message to this terminal</span><br><span style="color: hsl(120, 100%, 40%);">+  logging     Configure logging</span><br><span style="color: hsl(120, 100%, 40%);">+  no          Negate a command or set its defaults</span><br><span>   sms         SMS related commands</span><br><span>   subscriber  Operations on a Subscriber</span><br><span> ----</span><br><span>@@ -171,35 +172,35 @@</span><br><span> </span><br><span> .Example: Typing `?` after a partial command</span><br><span> ----</span><br><span style="color: hsl(0, 100%, 40%);">-OpenBSC> show <1></span><br><span style="color: hsl(0, 100%, 40%);">-  version       Displays program version</span><br><span style="color: hsl(0, 100%, 40%);">-  online-help   Online help</span><br><span style="color: hsl(0, 100%, 40%);">-  history       Display the session command history</span><br><span style="color: hsl(0, 100%, 40%);">-  network       Display information about a GSM NETWORK</span><br><span style="color: hsl(0, 100%, 40%);">-  bts           Display information about a BTS</span><br><span style="color: hsl(0, 100%, 40%);">-  trx           Display information about a TRX</span><br><span style="color: hsl(0, 100%, 40%);">-  timeslot      Display information about a TS</span><br><span style="color: hsl(0, 100%, 40%);">-  lchan         Display information about a logical channel</span><br><span style="color: hsl(0, 100%, 40%);">-  paging        Display information about paging requests of a BTS</span><br><span style="color: hsl(0, 100%, 40%);">-  paging-group  Display the paging group</span><br><span style="color: hsl(0, 100%, 40%);">-  logging       Show current logging configuration</span><br><span style="color: hsl(0, 100%, 40%);">-  alarms        Show current logging configuration</span><br><span style="color: hsl(0, 100%, 40%);">-  stats         Show statistical values</span><br><span style="color: hsl(0, 100%, 40%);">-  e1_driver     Display information about available E1 drivers</span><br><span style="color: hsl(0, 100%, 40%);">-  e1_line       Display information about a E1 line</span><br><span style="color: hsl(0, 100%, 40%);">-  e1_timeslot   Display information about a E1 timeslot</span><br><span style="color: hsl(0, 100%, 40%);">-  subscriber    Operations on a Subscriber</span><br><span style="color: hsl(0, 100%, 40%);">-  statistics    Display network statistics</span><br><span style="color: hsl(0, 100%, 40%);">-  sms-queue     Display SMSqueue statistics</span><br><span style="color: hsl(120, 100%, 40%);">+OsmoMSC> show <1></span><br><span style="color: hsl(120, 100%, 40%);">+  version          Displays program version</span><br><span style="color: hsl(120, 100%, 40%);">+  online-help      Online help</span><br><span style="color: hsl(120, 100%, 40%);">+  history          Display the session command history</span><br><span style="color: hsl(120, 100%, 40%);">+  cs7              ITU-T Signaling System 7</span><br><span style="color: hsl(120, 100%, 40%);">+  logging          Show current logging configuration</span><br><span style="color: hsl(120, 100%, 40%);">+  alarms           Show current logging configuration</span><br><span style="color: hsl(120, 100%, 40%);">+  talloc-context   Show talloc memory hierarchy</span><br><span style="color: hsl(120, 100%, 40%);">+  stats            Show statistical values</span><br><span style="color: hsl(120, 100%, 40%);">+  asciidoc         Asciidoc generation</span><br><span style="color: hsl(120, 100%, 40%);">+  rate-counters    Show all rate counters</span><br><span style="color: hsl(120, 100%, 40%);">+  fsm              Show information about finite state machines</span><br><span style="color: hsl(120, 100%, 40%);">+  fsm-instances    Show information about finite state machine instances</span><br><span style="color: hsl(120, 100%, 40%);">+  sgs-connections  Show SGs interface connections / MMEs</span><br><span style="color: hsl(120, 100%, 40%);">+  subscriber       Operations on a Subscriber</span><br><span style="color: hsl(120, 100%, 40%);">+  bsc              BSC</span><br><span style="color: hsl(120, 100%, 40%);">+  connection       Subscriber Connections</span><br><span style="color: hsl(120, 100%, 40%);">+  transaction      Transactions</span><br><span style="color: hsl(120, 100%, 40%);">+  statistics       Display network statistics</span><br><span style="color: hsl(120, 100%, 40%);">+  sms-queue        Display SMSqueue statistics</span><br><span>   smpp          SMPP Interface</span><br><span> ----</span><br><span> <1> Type `?` after the `show` command, the `?` itself will not be printed.</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-You may pick the `network` object and type `?` again:</span><br><span style="color: hsl(120, 100%, 40%);">+You may pick the `bsc` object and type `?` again:</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-.Example: Typing `?` after `show network`</span><br><span style="color: hsl(120, 100%, 40%);">+.Example: Typing `?` after `show bsc`</span><br><span> ----</span><br><span style="color: hsl(0, 100%, 40%);">-OpenBSC> show network</span><br><span style="color: hsl(120, 100%, 40%);">+OsmoMSC> show bsc</span><br><span>   <cr></span><br><span> ----</span><br><span> </span><br><span>@@ -216,7 +217,7 @@</span><br><span> </span><br><span> .Example: Use of `<tab>` pressed after typing only `s` as command</span><br><span> ----</span><br><span style="color: hsl(0, 100%, 40%);">-OpenBSC> s<1></span><br><span style="color: hsl(120, 100%, 40%);">+OsmoMSC> s<1></span><br><span> show       sms        subscriber</span><br><span> ----</span><br><span> <1> Type `<tab>` here.</span><br><span>@@ -225,11 +226,11 @@</span><br><span> </span><br><span> .Example: Use of `<tab>` pressed after typing `show` command</span><br><span> ----</span><br><span style="color: hsl(0, 100%, 40%);">-OpenBSC> show <1></span><br><span style="color: hsl(0, 100%, 40%);">-version    online-help history    network    bts        trx</span><br><span style="color: hsl(0, 100%, 40%);">-timeslot   lchan      paging     paging-group logging    alarms</span><br><span style="color: hsl(0, 100%, 40%);">-stats      e1_driver  e1_line    e1_timeslot subscriber statistics</span><br><span style="color: hsl(0, 100%, 40%);">-sms-queue  smpp</span><br><span style="color: hsl(120, 100%, 40%);">+OsmoMSC> show <1></span><br><span style="color: hsl(120, 100%, 40%);">+version    online-help history    cs7        logging    alarms</span><br><span style="color: hsl(120, 100%, 40%);">+talloc-context stats      asciidoc   rate-counters fsm        fsm-instances</span><br><span style="color: hsl(120, 100%, 40%);">+sgs-connections subscriber bsc        connection transaction statistics</span><br><span style="color: hsl(120, 100%, 40%);">+sms-queue smpp</span><br><span> ----</span><br><span> <1> Type `<tab>` here.</span><br><span> </span><br><span>@@ -239,9 +240,9 @@</span><br><span> The `list` command will give you a full list of all commands and their</span><br><span> arguments available at the current node:</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-.Example: Typing `list` at start of OsmoNITB 'VIEW' node prompt</span><br><span style="color: hsl(120, 100%, 40%);">+.Example: Typing `list` at start of OsmoMSC 'VIEW' node prompt</span><br><span> ----</span><br><span style="color: hsl(0, 100%, 40%);">-OpenBSC> list</span><br><span style="color: hsl(120, 100%, 40%);">+OsmoMSC> list</span><br><span>   show version</span><br><span>   show online-help</span><br><span>   list</span><br><span>@@ -252,14 +253,15 @@</span><br><span>   terminal no length</span><br><span>   who</span><br><span>   show history</span><br><span style="color: hsl(0, 100%, 40%);">-  show network</span><br><span style="color: hsl(0, 100%, 40%);">-  show bts [<0-255>]</span><br><span style="color: hsl(0, 100%, 40%);">-  show trx [<0-255>] [<0-255>]</span><br><span style="color: hsl(0, 100%, 40%);">-  show timeslot [<0-255>] [<0-255>] [<0-7>]</span><br><span style="color: hsl(0, 100%, 40%);">-  show lchan [<0-255>] [<0-255>] [<0-7>] [lchan_nr]</span><br><span style="color: hsl(0, 100%, 40%);">-  show lchan summary [<0-255>] [<0-255>] [<0-7>] [lchan_nr]</span><br><span style="color: hsl(0, 100%, 40%);">-  show paging [<0-255>]</span><br><span style="color: hsl(0, 100%, 40%);">-  show paging-group <0-255> IMSI</span><br><span style="color: hsl(120, 100%, 40%);">+  show cs7 instance <0-15> users</span><br><span style="color: hsl(120, 100%, 40%);">+  show cs7 (sua|m3ua|ipa) [<0-65534>]</span><br><span style="color: hsl(120, 100%, 40%);">+  show cs7 instance <0-15> asp</span><br><span style="color: hsl(120, 100%, 40%);">+  show cs7 instance <0-15> as (active|all|m3ua|sua)</span><br><span style="color: hsl(120, 100%, 40%);">+  show cs7 instance <0-15> sccp addressbook</span><br><span style="color: hsl(120, 100%, 40%);">+  show cs7 instance <0-15> sccp users</span><br><span style="color: hsl(120, 100%, 40%);">+  show cs7 instance <0-15> sccp ssn <0-65535></span><br><span style="color: hsl(120, 100%, 40%);">+  show cs7 instance <0-15> sccp connections</span><br><span style="color: hsl(120, 100%, 40%);">+  show cs7 instance <0-15> sccp timers</span><br><span>   logging enable</span><br><span>   logging disable</span><br><span>   logging filter all (0|1)</span><br><span>@@ -267,25 +269,44 @@</span><br><span>   logging timestamp (0|1)</span><br><span>   logging print extended-timestamp (0|1)</span><br><span>   logging print category (0|1)</span><br><span style="color: hsl(120, 100%, 40%);">+  logging print category-hex (0|1)</span><br><span style="color: hsl(120, 100%, 40%);">+  logging print level (0|1)</span><br><span style="color: hsl(120, 100%, 40%);">+  logging print file (0|1|basename) [last]</span><br><span>   logging set-log-mask MASK</span><br><span style="color: hsl(0, 100%, 40%);">-  logging level (all|rll|cc|mm|rr|rsl|nm|mncc|pag|meas|sccp|msc|mgcp|ho|db|ref|gprs|ns|bssgp|llc|sndcp|nat|ctrl|smpp|filter|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats) (debug|info|notice|error|fatal)</span><br><span style="color: hsl(120, 100%, 40%);">+  logging level (rll|cc|mm|rr|mncc|pag|msc|mgcp|ho|db|ref|ctrl|smpp|ranap|vlr|iucs|bssap|sgs|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro) (debug|info|notice|error|fatal)</span><br><span style="color: hsl(120, 100%, 40%);">+  logging level set-all (debug|info|notice|error|fatal)</span><br><span style="color: hsl(120, 100%, 40%);">+  logging level force-all (debug|info|notice|error|fatal)</span><br><span style="color: hsl(120, 100%, 40%);">+  no logging level force-all</span><br><span>   show logging vty</span><br><span>   show alarms</span><br><span style="color: hsl(120, 100%, 40%);">+  show talloc-context (application|all) (full|brief|DEPTH)</span><br><span style="color: hsl(120, 100%, 40%);">+  show talloc-context (application|all) (full|brief|DEPTH) tree ADDRESS</span><br><span style="color: hsl(120, 100%, 40%);">+  show talloc-context (application|all) (full|brief|DEPTH) filter REGEXP</span><br><span>   show stats</span><br><span>   show stats level (global|peer|subscriber)</span><br><span style="color: hsl(0, 100%, 40%);">-  show e1_driver</span><br><span style="color: hsl(0, 100%, 40%);">-  show e1_line [line_nr] [stats]</span><br><span style="color: hsl(0, 100%, 40%);">-  show e1_timeslot [line_nr] [ts_nr]</span><br><span style="color: hsl(0, 100%, 40%);">-  show subscriber (extension|imsi|tmsi|id) ID</span><br><span style="color: hsl(120, 100%, 40%);">+  show asciidoc counters</span><br><span style="color: hsl(120, 100%, 40%);">+  show rate-counters</span><br><span style="color: hsl(120, 100%, 40%);">+  show fsm NAME</span><br><span style="color: hsl(120, 100%, 40%);">+  show fsm all</span><br><span style="color: hsl(120, 100%, 40%);">+  show fsm-instances NAME</span><br><span style="color: hsl(120, 100%, 40%);">+  show fsm-instances all</span><br><span style="color: hsl(120, 100%, 40%);">+  show sgs-connections</span><br><span style="color: hsl(120, 100%, 40%);">+  show subscriber (msisdn|extension|imsi|tmsi|id) ID</span><br><span>   show subscriber cache</span><br><span style="color: hsl(120, 100%, 40%);">+  show bsc</span><br><span style="color: hsl(120, 100%, 40%);">+  show connection</span><br><span style="color: hsl(120, 100%, 40%);">+  show transaction</span><br><span>   sms send pending</span><br><span style="color: hsl(120, 100%, 40%);">+  sms delete expired</span><br><span>   subscriber create imsi ID</span><br><span style="color: hsl(0, 100%, 40%);">-  subscriber (extension|imsi|tmsi|id) ID sms sender (extension|imsi|tmsi|id) SENDER_ID send .LINE</span><br><span style="color: hsl(0, 100%, 40%);">-  subscriber (extension|imsi|tmsi|id) ID silent-sms sender (extension|imsi|tmsi|id) SENDER_ID send .LINE</span><br><span style="color: hsl(0, 100%, 40%);">-  subscriber (extension|imsi|tmsi|id) ID silent-call start (any|tch/f|tch/any|sdcch)</span><br><span style="color: hsl(0, 100%, 40%);">-  subscriber (extension|imsi|tmsi|id) ID silent-call stop</span><br><span style="color: hsl(0, 100%, 40%);">-  subscriber (extension|imsi|tmsi|id) ID ussd-notify (0|1|2) .TEXT</span><br><span style="color: hsl(0, 100%, 40%);">-  subscriber (extension|imsi|tmsi|id) ID update</span><br><span style="color: hsl(120, 100%, 40%);">+  subscriber (msisdn|extension|imsi|tmsi|id) ID sms sender (msisdn|extension|imsi|tmsi|id) SENDER_ID send .LINE</span><br><span style="color: hsl(120, 100%, 40%);">+  subscriber (msisdn|extension|imsi|tmsi|id) ID silent-sms sender (msisdn|extension|imsi|tmsi|id) SENDER_ID send .LINE</span><br><span style="color: hsl(120, 100%, 40%);">+  subscriber (msisdn|extension|imsi|tmsi|id) ID silent-call start (any|tch/f|tch/any|sdcch)</span><br><span style="color: hsl(120, 100%, 40%);">+  subscriber (msisdn|extension|imsi|tmsi|id) ID silent-call stop</span><br><span style="color: hsl(120, 100%, 40%);">+  subscriber (msisdn|extension|imsi|tmsi|id) ID ussd-notify (0|1|2) .TEXT</span><br><span style="color: hsl(120, 100%, 40%);">+  subscriber (msisdn|extension|imsi|tmsi|id) ID ms-test close-loop (a|b|c|d|e|f|i)</span><br><span style="color: hsl(120, 100%, 40%);">+  subscriber (msisdn|extension|imsi|tmsi|id) ID ms-test open-loop</span><br><span style="color: hsl(120, 100%, 40%);">+  subscriber (msisdn|extension|imsi|tmsi|id) ID paging</span><br><span>   show statistics</span><br><span>   show sms-queue</span><br><span>   logging filter imsi IMSI</span><br><span>@@ -294,12 +315,12 @@</span><br><span> </span><br><span> TIP: Remember, the list of available commands will change significantly</span><br><span> depending on the Osmocom program you are accessing, its software version and</span><br><span style="color: hsl(0, 100%, 40%);">-the current node you're at. Compare the above example of the OsmoNITB 'VIEW'</span><br><span style="color: hsl(0, 100%, 40%);">-node with the list of the OsmoNITB 'TRX' config node:</span><br><span style="color: hsl(120, 100%, 40%);">+the current node you're at. Compare the above example of the OsmoMSC 'VIEW'</span><br><span style="color: hsl(120, 100%, 40%);">+node with the list of the OsmoMSC 'NETWORK' config node:</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-.Example: Typing `list` at start of OsmoNITB 'TRX' config node prompt</span><br><span style="color: hsl(120, 100%, 40%);">+.Example: Typing `list` at start of OsmoMSC 'NETWORK' config node prompt</span><br><span> ----</span><br><span style="color: hsl(0, 100%, 40%);">-OpenBSC(config-net-bts-trx)# list</span><br><span style="color: hsl(120, 100%, 40%);">+OsmoMSC(config-net)# list</span><br><span>   help</span><br><span>   list</span><br><span>   write terminal</span><br><span>@@ -309,13 +330,17 @@</span><br><span>   show running-config</span><br><span>   exit</span><br><span>   end</span><br><span style="color: hsl(0, 100%, 40%);">-  arfcn <0-1023></span><br><span style="color: hsl(0, 100%, 40%);">-  description .TEXT</span><br><span style="color: hsl(0, 100%, 40%);">-  no description</span><br><span style="color: hsl(0, 100%, 40%);">-  nominal power <0-100></span><br><span style="color: hsl(0, 100%, 40%);">-  max_power_red <0-100></span><br><span style="color: hsl(0, 100%, 40%);">-  rsl e1 line E1_LINE timeslot <1-31> sub-slot (0|1|2|3|full)</span><br><span style="color: hsl(0, 100%, 40%);">-  rsl e1 tei <0-63></span><br><span style="color: hsl(0, 100%, 40%);">-  rf_locked (0|1)</span><br><span style="color: hsl(0, 100%, 40%);">-  timeslot <0-7></span><br><span style="color: hsl(120, 100%, 40%);">+  network country code <1-999></span><br><span style="color: hsl(120, 100%, 40%);">+  mobile network code <0-999></span><br><span style="color: hsl(120, 100%, 40%);">+  short name NAME</span><br><span style="color: hsl(120, 100%, 40%);">+  long name NAME</span><br><span style="color: hsl(120, 100%, 40%);">+  encryption a5 <0-3> [<0-3>] [<0-3>] [<0-3>]</span><br><span style="color: hsl(120, 100%, 40%);">+  authentication (optional|required)</span><br><span style="color: hsl(120, 100%, 40%);">+  rrlp mode (none|ms-based|ms-preferred|ass-preferred)</span><br><span style="color: hsl(120, 100%, 40%);">+  mm info (0|1)</span><br><span style="color: hsl(120, 100%, 40%);">+  timezone <-19-19> (0|15|30|45)</span><br><span style="color: hsl(120, 100%, 40%);">+  timezone <-19-19> (0|15|30|45) <0-2></span><br><span style="color: hsl(120, 100%, 40%);">+  no timezone</span><br><span style="color: hsl(120, 100%, 40%);">+  periodic location update <6-1530></span><br><span style="color: hsl(120, 100%, 40%);">+  no periodic location update</span><br><span> ----</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.osmocom.org/13642">change 13642</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/13642"/><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-MessageType: newchange </div>
<div style="display:none"> Gerrit-Change-Id: I9fb3c43ea56087900eee4427f1ae50a7c9e84698 </div>
<div style="display:none"> Gerrit-Change-Number: 13642 </div>
<div style="display:none"> Gerrit-PatchSet: 1 </div>
<div style="display:none"> Gerrit-Owner: Daniel Willmann <dwillmann@sysmocom.de> </div>