From dc468e644294b10126530cf401d1860d4b21fcd7 Mon Sep 17 00:00:00 2001 From: Daniel Willmann Date: Mon, 29 Jul 2019 12:10:21 +0200 Subject: Add VTY reference manual Fixes: OS#2589 Change-Id: I042734fa9979b598d5471839e408cbf39bba57b5 --- doc/Makefile.am | 5 +- doc/manuals/Makefile.am | 12 + doc/manuals/osmohnbgw-vty-reference.xml | 38 + doc/manuals/regen_doc.sh | 17 + doc/manuals/vty/hnbgw_vty_additions.xml | 2 + doc/manuals/vty/hnbgw_vty_reference.xml | 1535 +++++++++++++++++++++++++++++++ 6 files changed, 1608 insertions(+), 1 deletion(-) create mode 100644 doc/manuals/Makefile.am create mode 100644 doc/manuals/osmohnbgw-vty-reference.xml create mode 100755 doc/manuals/regen_doc.sh create mode 100644 doc/manuals/vty/hnbgw_vty_additions.xml create mode 100644 doc/manuals/vty/hnbgw_vty_reference.xml (limited to 'doc') diff --git a/doc/Makefile.am b/doc/Makefile.am index 81a25e2..eeed875 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,4 +1,7 @@ -SUBDIRS = examples +SUBDIRS = \ + examples \ + manuals \ + $(NULL) EXTRA_DIST = \ hnb_cs_lu.msc \ diff --git a/doc/manuals/Makefile.am b/doc/manuals/Makefile.am new file mode 100644 index 0000000..91aa8f8 --- /dev/null +++ b/doc/manuals/Makefile.am @@ -0,0 +1,12 @@ +EXTRA_DIST = \ + osmohnbgw-vty-reference.xml \ + regen_doc.sh \ + vty + +if BUILD_MANUALS + VTY_REFERENCE = osmohnbgw-vty-reference.xml + include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.vty-reference.inc + + OSMO_REPOSITORY = osmo-hnbgw + include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.common.inc +endif diff --git a/doc/manuals/osmohnbgw-vty-reference.xml b/doc/manuals/osmohnbgw-vty-reference.xml new file mode 100644 index 0000000..cd69333 --- /dev/null +++ b/doc/manuals/osmohnbgw-vty-reference.xml @@ -0,0 +1,38 @@ + + + + +]> + + + + + + v1 + 29th July 2019 + dw + Initial + + + + OsmoHNBGW VTY Reference + + + 2019 + + + + This work is copyright by sysmocom - s.f.m.c. GmbH. All rights reserved. + + + + + + &chapter-vty; + + diff --git a/doc/manuals/regen_doc.sh b/doc/manuals/regen_doc.sh new file mode 100755 index 0000000..39dd9ee --- /dev/null +++ b/doc/manuals/regen_doc.sh @@ -0,0 +1,17 @@ +#!/bin/sh -x + +if [ -z "$DOCKER_PLAYGROUND" ]; then + echo "You need to set DOCKER_PLAYGROUND" + exit 1 +fi + +SCRIPT=$(realpath "$0") +MANUAL_DIR=$(dirname "$SCRIPT") + +COMMIT=${COMMIT:-$(git log -1 --format=format:%H)} + +cd "$DOCKER_PLAYGROUND/scripts" || exit 1 + +OSMO_SGSN_BRANCH=$COMMIT ./regen_doc.sh osmo-hnbgw 4261 \ + "$MANUAL_DIR/chapters/counters_generated.adoc" \ + "$MANUAL_DIR/vty/hnbgw_vty_reference.xml" diff --git a/doc/manuals/vty/hnbgw_vty_additions.xml b/doc/manuals/vty/hnbgw_vty_additions.xml new file mode 100644 index 0000000..a4c675e --- /dev/null +++ b/doc/manuals/vty/hnbgw_vty_additions.xml @@ -0,0 +1,2 @@ + + diff --git a/doc/manuals/vty/hnbgw_vty_reference.xml b/doc/manuals/vty/hnbgw_vty_reference.xml new file mode 100644 index 0000000..4046636 --- /dev/null +++ b/doc/manuals/vty/hnbgw_vty_reference.xml @@ -0,0 +1,1535 @@ + + + Common Commands + These commands are available on all VTY nodes. They are listed here only once, to unclutter the VTY reference. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + view + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + enable + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + config + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + config-log + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + config-line + + + + + + + + + + + + + + + + + + + + + config-cs7 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + config-cs7-as + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + config-cs7-asp + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + config-cs7-sccpaddr + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + config-cs7-sccpaddr-gt + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + config-hnbgw + + + + + + + + + + + + + + + + + + + + + + + + config-hnbgw-iuh + + + + + + + + + + + + + + + + + + + + + + config-hnbgw-iucs + + + + + + + + + config-hnbgw-iups + + + + + + + + -- cgit v1.2.3