From 7898364664a4423b0e40fe556caddeb70708eec8 Mon Sep 17 00:00:00 2001 From: Oliver Smith Date: Wed, 28 Nov 2018 10:45:40 +0100 Subject: remove OsmoHLR files (now avail in osmo-hlr.git) Files were added in osmo-hlr.git Change-Id I52b7b06fddd77c6dc272004f434e9e7651f6b349 Depends: osmo-hlr.git Change-Id I52b7b06fddd77c6dc272004f434e9e7651f6b349 Related: OS#3385 Change-Id: Ice3f24888deed8affec40d5d91d71d5e1f3827c8 --- OsmoHLR/chapters/control.adoc | 106 ------------------------------------------ 1 file changed, 106 deletions(-) delete mode 100644 OsmoHLR/chapters/control.adoc (limited to 'OsmoHLR/chapters/control.adoc') diff --git a/OsmoHLR/chapters/control.adoc b/OsmoHLR/chapters/control.adoc deleted file mode 100644 index 50fd314..0000000 --- a/OsmoHLR/chapters/control.adoc +++ /dev/null @@ -1,106 +0,0 @@ -[[hlr-ctrl]] -== Control interface - -The actual protocol is described in <>, the variables common -to all programs using it are described in <>. This section -describes the CTRL interface variables specific to OsmoHLR. - -All subscriber variables are available by different selectors, which are freely -interchangeable: - -.Subscriber selectors available on OsmoHLR's Control interface -[options="header",width="100%",cols="35%,65%"] -|=== -|Selector|Comment -|subscriber.*by-imsi-*'123456'.*|Subscriber selector by IMSI, replace "123456" with the actual IMSI -|subscriber.*by-msisdn-*'123456'.*|Subscriber selector by MSISDN -|subscriber.*by-id-*'123456'.*|Subscriber selector by database ID -|=== - -Each of the above selectors feature all of these control variables: - -.Subscriber variables available on OsmoHLR's Control interface -[options="header",width="100%",cols="35%,8%,8%,8%,41%"] -|=== -|Name|Access|Trap|Value|Comment -|subscriber.by-\*.*info*|R|No||List (short) subscriber information -|subscriber.by-\*.*info-aud*|R|No||List subscriber authentication tokens -|subscriber.by-\*.*info-all*|R|No||List both 'info' and 'info-aud' in one -|subscriber.by-\*.*cs-enabled*|RW|No|'1' or '0'|Enable/disable circuit-switched access -|subscriber.by-\*.*ps-enabled*|RW|No|'1' or '0'|Enable/disable packet-switched access -|=== - -=== subscriber.by-*.info, info-aud, info-all - -Query the HLR database and return current subscriber record, in multiple lines -of the format - ----- -namevalue ----- - -To keep the reply as short as possible, some values are omitted if they are -empty. These are the returned values and their presence -modalities; for their meaning, see <>: - -.Returned values by OsmoHLR's 'info', 'info-all' and 'info-aud' commands -[options="header",width="100%",cols="15%,15%,30%,40%"] -|=== -|Returned by 'info-all' and|Name|Format|Presence -|'info'|id|-9223372036854775808 .. 9223372036854775807 (usually not negative)|always -|'info'|imsi|6 to 15 decimal digits|always -|'info'|msisdn|1 to 15 decimal digits|when non-empty -|'info'|nam_cs|'1' if CS is enabled, or '0'|always -|'info'|nam_ps|'1' if PS is enabled, or '0'|always -|'info'|vlr_number|up to 15 decimal digits|when non-empty -|'info'|sgsn_number|up to 15 decimal digits|when non-empty -|'info'|sgsn_address||when non-empty -|'info'|ms_purged_cs|'1' if CS is purged, or '0'|always -|'info'|ms_purged_ps|'1' if PS is purged, or '0'|always -|'info'|periodic_lu_timer|0..4294967295|always -|'info'|periodic_rau_tau_timer|0..4294967295|always -|'info'|lmsi|8 hex digits|always -|'info-aud'|aud2g.algo|one of 'comp128v1', 'comp128v2', 'comp128v3' or 'xor'|when valid 2G auth data is set -|'info-aud'|aud2g.ki|32 hexadecimal digits|when valid 2G auth data is set -|'info-aud'|aud3g.algo|so far always 'milenage'|when valid 3G auth data is set -|'info-aud'|aud3g.k|32 hexadecimal digits|when valid 3G auth data is set -|'info-aud'|aud3g.op|32 hexadecimal digits|when valid 3G auth data is set, *not* when OPC is set -|'info-aud'|aud3g.opc|32 hexadecimal digits|when valid 3G auth data is set, *not* when OP is set -|'info-aud'|aud3g.ind_bitlen|0..28|when valid 3G auth data is set -|'info-aud'|aud3g.sqn|0 .. 18446744073709551615|when valid 3G auth data is set -|=== - -This is an example Control Interface transcript that illustrates the various -'info' commands: - ----- -include::../example_subscriber_info.ctrl[] ----- - -=== subscriber.by-*.ps-enabled, cs-enabled - -Disable or enable packet-/circuit-switched access for the given IMSI; - -* 'ps-enabled' switches access to GPRS or UMTS data services, -* 'cs-enabled' switches access to voice services. - -When disabled, the next time this subscriber attempts to do a Location Updating -GSUP operation for the given domain (i.e. from the SGSN for 'ps-enabled', from -the MSC/VLR for 'cs-enabled'), it will be rejected by OsmoHLR. Currently -connected GSUP clients will be notified via GSUP when a subscriber is being -disabled, so that the subscriber can be dropped in case it is currently -attached. - -The current 'ps-enabled'/'cs-enabled' status can be queried by 'GET' commands, -and also by looking at 'nam_ps' and 'nam_cs' in a 'subscriber.by-*.info' -response. - -A value of "1" indicates that the given domain is enabled, which is the -default; a value of "0" disables access. - -This is an example transcript that illustrates 'ps-enabled' and 'cs-enabled' -commands: - ----- -include::../example_subscriber_cs_ps_enabled.ctrl[] ----- -- cgit v1.2.3