fixeria has uploaded this change for review. ( https://gerrit.osmocom.org/c/erlang/osmo-s1gw/+/42369?usp=email )
Change subject: doc/manuals: update MmeItem related info ......................................................................
doc/manuals: update MmeItem related info
The osmo-s1gw-cli documentation was not properly updated in 63ce2c9:
* default local/bind address for an MME is "any", not "::" * allowed TACs (--tac) was missing in help and examples
Change-Id: I0b8115fe6342a80bf1eb99bd6ad210492a013947 Fixes: 63ce2c9 ("[REST] Add MmeList, MmeAdd, MmeInfo, MmeDelete") Related: OS#6671 --- M doc/manuals/chapters/cli.adoc M doc/manuals/chapters/rest.adoc 2 files changed, 15 insertions(+), 11 deletions(-)
git pull ssh://gerrit.osmocom.org:29418/erlang/osmo-s1gw refs/changes/69/42369/1
diff --git a/doc/manuals/chapters/cli.adoc b/doc/manuals/chapters/cli.adoc index b1562c0..984ad14 100644 --- a/doc/manuals/chapters/cli.adoc +++ b/doc/manuals/chapters/cli.adoc @@ -135,11 +135,11 @@
---- OsmoS1GW# mme_list -| Name | Local address | Remote address/port | -|--------|-----------------|-----------------------| -| mme0 | :: | 127.0.2.10:36412 | -| mme1 | :: | 127.0.2.20:36412 | -| mme2 | :: | 127.0.2.30:36412 | +| Name | Local address | Remote address/port | Allowed TACs | +|--------|-----------------|-----------------------|----------------| +| mme0 | 127.0.2.1 | 127.0.2.10:36412 | all | +| mme1 | 127.0.2.1 | 127.0.2.11:36412 | all | +| mme2 | 127.0.2.1 | 127.0.2.12:36412 | all | ----
==== `mme_add` @@ -147,15 +147,18 @@ Add an MME to the pool.
---- -Usage: mme_add -N NAME -ra RADDR [-la LADDR] [-rp RPORT] +Usage: mme_add -N NAME -ra RADDR [-h] [-la LADDR] [-rp RPORT] [--tac TAC_LIST] + +Add an MME to the pool
required arguments: -N, --name NAME MME name (example: mme0) -ra, --raddr RADDR Remote address (example: 192.168.1.101)
optional arguments: - -la, --laddr LADDR Local address (default: ::) + -la, --laddr LADDR Local address (default: any) -rp, --rport RPORT Remote port (default: 36412) + --tac TAC_LIST Allowed TAC (Tracking Area Code) ----
Example: @@ -182,8 +185,9 @@ | Parameter | Value | |---------------------|------------------| | Name | mme0 | -| Local address | :: | +| Local address | any | | Remote address/port | 127.0.2.10:36412 | +| Allowed TACs | all | ----
==== `mme_delete` diff --git a/doc/manuals/chapters/rest.adoc b/doc/manuals/chapters/rest.adoc index 938421d..57342ef 100644 --- a/doc/manuals/chapters/rest.adoc +++ b/doc/manuals/chapters/rest.adoc @@ -135,8 +135,8 @@
---- [ - {"name": "mme0", "laddr": "::", "raddr": "192.168.2.10", "rport": 36412, "tac_list": []}, - {"name": "mme1", "laddr": "::", "raddr": "192.168.2.20", "rport": 36412, "tac_list": [100, 101]} + {"name": "mme0", "laddr": "any", "raddr": "192.168.2.10", "rport": 36412, "tac_list": []}, + {"name": "mme1", "laddr": "any", "raddr": "192.168.2.20", "rport": 36412, "tac_list": [100, 101]} ] ----
@@ -148,7 +148,7 @@
`name` (required):: Unique human-readable name. `raddr` (required):: Remote IP address of the MME. -`laddr` (optional):: Local bind address. Default: `"::"` (any). +`laddr` (optional):: Local bind address. Default: `"any"`. `rport` (optional):: Remote SCTP port. Default: `36412`. `tac_list` (optional):: List of TACs this MME serves. Default: `[]` (all).