This is merely a historical archive of years 2008-2021, before the migration to mailman3.
A maintained and still updated list archive can be found at https://lists.osmocom.org/hyperkitty/list/gerrit-log@lists.osmocom.org/.
laforge gerrit-no-reply at lists.osmocom.orglaforge has submitted this change. ( https://gerrit.osmocom.org/c/osmo-gsm-manuals/+/20890 )
Change subject: chapters/vty: add documentation for the expert mode
......................................................................
chapters/vty: add documentation for the expert mode
Change-Id: Ic43fbef8df77ad5561ca4521a29bc9f60bd3d7ac
Related: SYS#4910
---
M common/chapters/vty.adoc
1 file changed, 37 insertions(+), 0 deletions(-)
Approvals:
Jenkins Builder: Verified
laforge: Looks good to me, approved
diff --git a/common/chapters/vty.adoc b/common/chapters/vty.adoc
index 6fe31a8..972e71f 100644
--- a/common/chapters/vty.adoc
+++ b/common/chapters/vty.adoc
@@ -363,6 +363,7 @@
----
OsmoBSC> show vty-attributes
Global attributes:
+ ^ This command is hidden (check expert mode)
! This command applies immediately
@ This command applies on VTY node exit
Library specific attributes:
@@ -435,3 +436,39 @@
commands outside "configure terminal", vty node navigation commands, commands
to show / write the config file) or will require a full restart of the overall
process to take effect.
+
+==== The expert mode
+
+Some VTY commands are considered relatively dangerous if used in production operation,
+so the general approach is to hide them. This means that they don't show up anywhere
+but the source code, but can still be executed. On the one hand, this approach reduces
+the risk of an accidental invocation and potential service degradation; on the other,
+it complicates intentional use of the hidden commands.
+
+The VTY features so-called __expert__ mode, that makes the hidden commands appear in
+the interactive help, as well as in the XML VTY reference, just like normal ones. This
+mode can be activated from the 'VIEW' node by invoking the `enable` command with the
+parameter `expert-mode`. It remains active for the individual VTY session, and gets
+disabled automatically when the user switches back to the 'VIEW' node or terminates
+the session.
+
+A special attribute in the output of the `list with-flags` command indicates whether
+a given command is hidden in normal mode, or is a regular command:
+
+.Example: Hidden commands in the output of the `list with-flags` command
+----
+OsmoBSC> enable expert-mode <1>
+OsmoBSC# list with-flags
+ ...
+ ^ bts <0-255> (activate-all-lchan|deactivate-all-lchan) <2>
+ ^ bts <0-255> trx <0-255> (activate-all-lchan|deactivate-all-lchan) <2>
+ . bts <0-255> trx <0-255> timeslot <0-7> sub-slot <0-7> mdcx A.B.C.D <0-65535> <3>
+ ^ bts <0-255> trx <0-255> timeslot <0-7> sub-slot <0-7> (borken|unused) <2>
+ . bts <0-255> trx <0-255> timeslot <0-7> sub-slot <0-7> handover <0-255> <3>
+ . bts <0-255> trx <0-255> timeslot <0-7> sub-slot <0-7> assignment <3>
+ . bts <0-255> smscb-command (normal|schedule|default) <1-4> HEXSTRING <3>
+ ...
+----
+<1> This command enables the __expert__ mode.
+<2> This is a hidden command (only shown in the __expert__ mode).
+<3> This is a regular command that is always shown regardless of the mode.
--
To view, visit https://gerrit.osmocom.org/c/osmo-gsm-manuals/+/20890
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings
Gerrit-Project: osmo-gsm-manuals
Gerrit-Branch: master
Gerrit-Change-Id: Ic43fbef8df77ad5561ca4521a29bc9f60bd3d7ac
Gerrit-Change-Number: 20890
Gerrit-PatchSet: 2
Gerrit-Owner: fixeria <vyanitskiy at sysmocom.de>
Gerrit-Reviewer: Jenkins Builder
Gerrit-Reviewer: laforge <laforge at osmocom.org>
Gerrit-Reviewer: neels <nhofmeyr at sysmocom.de>
Gerrit-Reviewer: pespin <pespin at sysmocom.de>
Gerrit-MessageType: merged
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osmocom.org/pipermail/gerrit-log/attachments/20201102/3603ed77/attachment.htm>