From f450f442f3554bc963eb3ebc30853af2ef79f24d Mon Sep 17 00:00:00 2001 From: Daniel Willmann Date: Thu, 6 Jun 2019 17:52:25 +0200 Subject: manuals: Update generated VTY reference and counters Change-Id: I9f75edf2e5b88ef8f4592fa89548f32e0a7df8d8 Related: OS#1700 --- doc/manuals/chapters/counters_generated.adoc | 196 ++++++++++++++++++++------- doc/manuals/osmobsc-vty-reference.xml | 8 +- doc/manuals/vty/bsc_vty_reference.xml | 169 +++++++++++++++++------ 3 files changed, 281 insertions(+), 92 deletions(-) diff --git a/doc/manuals/chapters/counters_generated.adoc b/doc/manuals/chapters/counters_generated.adoc index d55df072f..65f4ca40b 100644 --- a/doc/manuals/chapters/counters_generated.adoc +++ b/doc/manuals/chapters/counters_generated.adoc @@ -1,7 +1,88 @@ + // autogenerated by show asciidoc counters -These counters and their description based on OsmoBSC (OsmoBSC). +These counters and their description based on OsmoBSC 1.4.0.84-3f1f8 (OsmoBSC). + +=== Rate Counters // generating tables for rate_ctr_group +// rate_ctr_group table base transceiver station +.bts - base transceiver station +[options="header"] +|=== +| Name | Reference | Description +| chreq:total | <> | Received channel requests. +| chreq:no_channel | <> | Sent to MS no channel available. +| chan:rf_fail | <> | Received a RF failure indication from BTS. +| chan:rll_err | <> | Received a RLL failure with T200 cause from BTS. +| oml_fail | <> | Received a TEI down on a OML link. +| rsl_fail | <> | Received a TEI down on a OML link. +| codec:amr_f | <> | Count the usage of AMR/F codec by channel mode requested. +| codec:amr_h | <> | Count the usage of AMR/H codec by channel mode requested. +| codec:efr | <> | Count the usage of EFR codec by channel mode requested. +| codec:fr | <> | Count the usage of FR codec by channel mode requested. +| codec:hr | <> | Count the usage of HR codec by channel mode requested. +| paging:attempted | <> | Paging attempts for a subscriber. +| paging:already | <> | Paging attempts ignored as subsciber was already being paged. +| paging:responded | <> | Paging attempts with successful paging response. +| paging:expired | <> | Paging Request expired because of timeout T3113. +| chan_act:total | <> | Total number of Channel Activations. +| chan_act:nack | <> | Number of Channel Activations that the BTS NACKed +| rsl:unknown | <> | Number of unknown/unsupported RSL messages received from BTS +| rsl:ipa_nack | <> | Number of IPA (RTP/dyn-PDCH) related NACKs received from BTS +| chan:mode_modify_nack | <> | Number of Channel Mode Modify NACKs received from BTS +|=== +// rate_ctr_group table base transceiver station +.bts - base transceiver station +[options="header"] +|=== +| Name | Reference | Description +| chreq:total | <> | Received channel requests. +| chreq:no_channel | <> | Sent to MS no channel available. +| chan:rf_fail | <> | Received a RF failure indication from BTS. +| chan:rll_err | <> | Received a RLL failure with T200 cause from BTS. +| oml_fail | <> | Received a TEI down on a OML link. +| rsl_fail | <> | Received a TEI down on a OML link. +| codec:amr_f | <> | Count the usage of AMR/F codec by channel mode requested. +| codec:amr_h | <> | Count the usage of AMR/H codec by channel mode requested. +| codec:efr | <> | Count the usage of EFR codec by channel mode requested. +| codec:fr | <> | Count the usage of FR codec by channel mode requested. +| codec:hr | <> | Count the usage of HR codec by channel mode requested. +| paging:attempted | <> | Paging attempts for a subscriber. +| paging:already | <> | Paging attempts ignored as subsciber was already being paged. +| paging:responded | <> | Paging attempts with successful paging response. +| paging:expired | <> | Paging Request expired because of timeout T3113. +| chan_act:total | <> | Total number of Channel Activations. +| chan_act:nack | <> | Number of Channel Activations that the BTS NACKed +| rsl:unknown | <> | Number of unknown/unsupported RSL messages received from BTS +| rsl:ipa_nack | <> | Number of IPA (RTP/dyn-PDCH) related NACKs received from BTS +| chan:mode_modify_nack | <> | Number of Channel Mode Modify NACKs received from BTS +|=== +// rate_ctr_group table base transceiver station +.bts - base transceiver station +[options="header"] +|=== +| Name | Reference | Description +| chreq:total | <> | Received channel requests. +| chreq:no_channel | <> | Sent to MS no channel available. +| chan:rf_fail | <> | Received a RF failure indication from BTS. +| chan:rll_err | <> | Received a RLL failure with T200 cause from BTS. +| oml_fail | <> | Received a TEI down on a OML link. +| rsl_fail | <> | Received a TEI down on a OML link. +| codec:amr_f | <> | Count the usage of AMR/F codec by channel mode requested. +| codec:amr_h | <> | Count the usage of AMR/H codec by channel mode requested. +| codec:efr | <> | Count the usage of EFR codec by channel mode requested. +| codec:fr | <> | Count the usage of FR codec by channel mode requested. +| codec:hr | <> | Count the usage of HR codec by channel mode requested. +| paging:attempted | <> | Paging attempts for a subscriber. +| paging:already | <> | Paging attempts ignored as subsciber was already being paged. +| paging:responded | <> | Paging attempts with successful paging response. +| paging:expired | <> | Paging Request expired because of timeout T3113. +| chan_act:total | <> | Total number of Channel Activations. +| chan_act:nack | <> | Number of Channel Activations that the BTS NACKed +| rsl:unknown | <> | Number of unknown/unsupported RSL messages received from BTS +| rsl:ipa_nack | <> | Number of IPA (RTP/dyn-PDCH) related NACKs received from BTS +| chan:mode_modify_nack | <> | Number of Channel Mode Modify NACKs received from BTS +|=== // rate_ctr_group table E1 Input subsystem .e1inp - E1 Input subsystem [options="header"] @@ -18,59 +99,74 @@ These counters and their description based on OsmoBSC (OsmoBSC). [options="header"] |=== | Name | Reference | Description -| chreq:total | <> | Received channel requests. -| chreq:no_channel | <> | Sent to MS no channel available. -| handover:attempted | <> | Received handover attempts. -| handover:no_channel | <> | Sent no channel available responses. -| handover:timeout | <> | Count the amount of timeouts of timer T3103. -| handover:completed | <> | Received handover completed. -| handover:failed | <> | Receive HO FAIL messages. -| paging:attempted | <> | Paging attempts for a MS. -| paging:detached | <> | Counts the amount of paging attempts which couldn't sent out any paging request because no responsible bts found. -| paging:completed | <> | Paging successful completed. -| paging:expired | <> | Paging Request expired because of timeout T3113. -| chan:rf_fail | <> | Received a RF failure indication from BTS. -| chan:rll_err | <> | Received a RLL failure with T200 cause from BTS. -| bts:oml_fail | <> | Received a TEI down on a OML link. -| bts:rsl_fail | <> | Received a TEI down on a OML link. -| bts:codec_amr_f | <> | Count the usage of AMR/F codec by channel mode requested. -| bts:codec_amr_h | <> | Count the usage of AMR/H codec by channel mode requested. -| bts:codec_efr | <> | Count the usage of EFR codec by channel mode requested. -| bts:codec_fr | <> | Count the usage of FR codec by channel mode requested. -| bts:codec_hr | <> | Count the usage of HR codec by channel mode requested. -|=== -// rate_ctr_group table mobile switching center -.msc - mobile switching center +| assignment:attempted | <> | Assignment attempts. +| assignment:completed | <> | Assignment completed. +| assignment:stopped | <> | Connection ended during Assignment. +| assignment:no_channel | <> | Failure to allocate lchan for Assignment. +| assignment:timeout | <> | Assignment timed out. +| assignment:failed | <> | Received Assignment Failure message. +| assignment:error | <> | Assigment failed for other reason. +| handover:attempted | <> | Intra-BSC handover attempts. +| handover:completed | <> | Intra-BSC handover completed. +| handover:stopped | <> | Connection ended during HO. +| handover:no_channel | <> | Failure to allocate lchan for HO. +| handover:timeout | <> | Handover timed out. +| handover:failed | <> | Received Handover Fail messages. +| handover:error | <> | Re-assigment failed for other reason. +| interbsc_ho_out:attempted | <> | Attempts to handover to remote BSS. +| interbsc_ho_out:completed | <> | Handover to remote BSS completed. +| interbsc_ho_out:stopped | <> | Connection ended during HO. +| interbsc_ho_out:timeout | <> | Handover timed out. +| interbsc_ho_out:error | <> | Handover to remote BSS failed for other reason. +| interbsc_ho_in:attempted | <> | Attempts to handover from remote BSS. +| interbsc_ho_in:completed | <> | Handover from remote BSS completed. +| interbsc_ho_in:stopped | <> | Connection ended during HO. +| interbsc_ho_in:no_channel | <> | Failure to allocate lchan for HO. +| interbsc_ho_in:failed | <> | Received Handover Fail message. +| interbsc_ho_in:timeout | <> | Handover from remote BSS timed out. +| interbsc_ho_in:error | <> | Handover from remote BSS failed for other reason. +| paging:attempted | <> | Paging attempts for a subscriber. +| paging:detached | <> | Paging request send failures because no responsible BTS was found. +| paging:responded | <> | Paging attempts with successful response. +| abis:unknown_unit_id | <> | Connection attempts from unknown IPA CCM Unit ID. +|=== +== Osmo Stat Items + +// generating tables for osmo_stat_items +base transceiver station +// osmo_stat_item_group table base transceiver station +.bts - base transceiver station [options="header"] |=== -| Name | Reference | Description -| loc_update_type:attach | <> | Received location update imsi attach requests. -| loc_update_type:normal | <> | Received location update normal requests. -| loc_update_type:periodic | <> | Received location update periodic requests. -| loc_update_type:detach | <> | Received location update detach indication. -| loc_update_resp:failed | <> | Rejected location updates. -| loc_update_resp:completed | <> | Successful location updates. -| sms:submitted | <> | Received a RPDU from a MS (MO). -| sms:no_receiver | <> | Counts SMS which couldn't routed because no receiver found. -| sms:delivered | <> | Global SMS Deliver attempts. -| sms:rp_err_mem | <> | CAUSE_MT_MEM_EXCEEDED errors of MS responses on a sms deliver attempt. -| sms:rp_err_other | <> | Other error of MS responses on a sms delive attempt. -| sms:deliver_unknown_error | <> | Unknown error occured during sms delivery. -| call:mo_setup | <> | Received setup requests from a MS to init a MO call. -| call:mo_connect_ack | <> | Received a connect ack from MS of a MO call. Call is now succesful connected up. -| call:mt_setup | <> | Sent setup requests to the MS (MT). -| call:mt_connect | <> | Sent a connect to the MS (MT). -| call:active | <> | Count total amount of calls that ever reached active state. -| call:complete | <> | Count total amount of calls which got terminated by disconnect req or ind after reaching active state. -| call:incomplete | <> | Count total amount of call which got terminated by any other reason after reaching active state. +| Name | Reference | Description | Unit +| chanloadavg | <> | Channel load average. | % +| T3122 | <> | T3122 IMMEDIATE ASSIGNMENT REJECT wait indicator. | s +| rach_busy | <> | RACH slots with signal above threshold | % +| rach_access | <> | RACH slots with access bursts in them | % |=== -// generating tables for osmo_stat_items -// generating tables for osmo_counters -// ungrouped osmo_counters -.ungrouped osmo counters +base transceiver station +// osmo_stat_item_group table base transceiver station +.bts - base transceiver station [options="header"] |=== -| Name | Reference | Description -| msc.active_calls | <> | +| Name | Reference | Description | Unit +| chanloadavg | <> | Channel load average. | % +| T3122 | <> | T3122 IMMEDIATE ASSIGNMENT REJECT wait indicator. | s +| rach_busy | <> | RACH slots with signal above threshold | % +| rach_access | <> | RACH slots with access bursts in them | % +|=== +base transceiver station +// osmo_stat_item_group table base transceiver station +.bts - base transceiver station +[options="header"] +|=== +| Name | Reference | Description | Unit +| chanloadavg | <> | Channel load average. | % +| T3122 | <> | T3122 IMMEDIATE ASSIGNMENT REJECT wait indicator. | s +| rach_busy | <> | RACH slots with signal above threshold | % +| rach_access | <> | RACH slots with access bursts in them | % |=== +== Osmo Counters +// generating tables for osmo_counters +// there are no ungrouped osmo_counters diff --git a/doc/manuals/osmobsc-vty-reference.xml b/doc/manuals/osmobsc-vty-reference.xml index f51e56eff..ec3022c3a 100644 --- a/doc/manuals/osmobsc-vty-reference.xml +++ b/doc/manuals/osmobsc-vty-reference.xml @@ -24,12 +24,18 @@ hf Update to match osmo-bsc version 0.13.0-305 + + v3 + 6th June 2019 + dw + Update to match osmo-bsc version 1.4.0.84-3f1f + OsmoBSC VTY Reference - 2012-2014 + 2012-2019 diff --git a/doc/manuals/vty/bsc_vty_reference.xml b/doc/manuals/vty/bsc_vty_reference.xml index f56b951ec..9992267fb 100644 --- a/doc/manuals/vty/bsc_vty_reference.xml +++ b/doc/manuals/vty/bsc_vty_reference.xml @@ -152,6 +152,14 @@ + + + + + + + + @@ -175,13 +183,31 @@ - + + + + + + + + + + + + + + + + + + + @@ -294,7 +320,7 @@ - + @@ -335,6 +361,7 @@ + @@ -424,13 +451,6 @@ - - - - - - - @@ -759,6 +779,14 @@ + + + + + + + + @@ -782,13 +810,31 @@ - + + + + + + + + + + + + + + + + + + + @@ -925,7 +971,7 @@ - + @@ -966,6 +1012,7 @@ + @@ -1055,13 +1102,6 @@ - - - - - - - @@ -1172,11 +1212,14 @@ - + + + + @@ -1790,7 +1833,7 @@ - + @@ -1831,6 +1874,7 @@ + @@ -1961,10 +2005,11 @@ - + + @@ -2470,12 +2515,12 @@ - + - - - - + + + + @@ -2960,6 +3005,13 @@ + + + + + + + @@ -3117,7 +3169,7 @@ - + @@ -3129,6 +3181,7 @@ + @@ -3301,6 +3354,19 @@ + + + + + + + + + + + + + @@ -3319,7 +3385,7 @@ - + @@ -3868,6 +3934,19 @@ + + + + + + + + + + + + + @@ -4573,11 +4652,19 @@ - + + + + + + + + - + + @@ -4647,19 +4734,11 @@ - + - - - - - - - - - - + + @@ -4676,6 +4755,14 @@ + + + + + + + + om2k -- cgit v1.2.3