Layered HLR AUC Massive Operations over CLI
Ericsson Dynamic Activation 1

Contents

1Introduction
1.1Purpose and Scope
1.2Target Group
1.3Typographic Conventions

2
AUC Conditional Search Commands
2.1Print Authentication and Key Agreement Algorithm (AEMSAAP)
2.1.1AEMSAAP Request
2.1.2AEMSAAP Result File Schema
2.2Print Subscription State (AEMSSSP)
2.2.1AEMSSSP Request
2.2.2AEMSSSP Result File Schema
2.3Print Subscription (AEMSSUP)
2.3.1AEMSSUP Request
2.3.2AEMSSUP Result File Schema

3
HLR Conditional Search Commands
3.1Print Access Point Name (HEMSAPP)
3.1.1HEMSAPP Request
3.1.2HEMSAPP Result File Schema
3.2Print CAMEL Subscription List (HEMSCMP)
3.2.1HEMSCMP Request
3.2.2HEMSCMP Result File Schema
3.3Print Extended Quality of Service (HEMSEQP)
3.3.1HEMSEQP Request
3.3.2HEMSEQP Result File Schema
3.4Print Location Services Address (HEMSGLP)
3.4.1HEMSGLP Request
3.4.2HEMSGLP Result File Schema
3.5Print GSM Service Control Function Address (HEMSGSP)
3.5.1HEMSGSP Request
3.5.2HEMSGSP Result File Schema
3.6Print IMSI Changeover (HEMSICP)
3.6.1HEMSICP Request
3.6.2HEMSICP Result File Schema
3.7Print Subscriber Location Services Data (HEMSLDP)
3.7.1HEMSLDP Request
3.7.2HEMSLDP Result File Schema
3.8Print Conditional Subscriber List (HEMSLIP)
3.8.1HEMSLIP Request
3.8.2HEMSLIP Result File Schema
3.9Print Monitoring Call Forwarding Registration Data (HEMSMRP)
3.9.1HEMSMRP Request
3.9.2HEMSMRP Result File Schema
3.10Print Multiple Subscription Data (HEMSMSP)
3.10.1HEMSMSP Request
3.10.2HEMSMSP Result File Schema
3.11Print Subscriber PDP Context (HEMSPDP)
3.11.1HEMSPDP Request
3.11.2HEMSPDP Result File Schema
3.12Print PDP Context Profile (HEMSPPP)
3.12.1HEMSPPP Request
3.12.2HEMSPPP Result File Schema
3.13Print Service Center Survey (HEMSSCP)
3.13.1HEMSSCP Request
3.13.2HEMSSCP Result File Schema
3.14Print Subscriber Data (HEMSSDP)
3.14.1HEMSSDP Request
3.14.2HEMSSDP Result File Schema
3.15Print Subscriber Location Services Address (HEMSSGP)
3.15.1HEMSSGP Request
3.15.2HEMSSGP Result File Schema
3.16Print Subscriber Tracing (HEMSSTP)
3.16.1HEMSSTP Request
3.16.2HEMSSTP Result File Schema
3.17Print PRP Data (HESDCDP)
3.17.1HESDCDP Request
3.17.2HESDCDP Result File Schema
3.18Print Subscriber Roaming Data (HEMSRLP)
3.18.1HEMSRLP Request
3.18.2HEMSRLP Result File Schema
3.19Print Subscribers Location Based on Geographic Area (HEMSSLP)
3.19.1HEMSSLP Request
3.19.2HEMSSLP Result File Schema

4
MNP Conditional Search Commands
4.1Print MNP Subscriber Data (HEMSNTP)
4.1.1HEMSNTP Request
4.1.2HEMSNTP Result File Schema

5
AUC Massive Update Commands
5.1Change Authentication and Key Agreement Algorithm (AEMSAAC)
5.1.1AEMSAAC Request
5.1.2AEMSAAC Result File Schema
5.2Change Subscription (AEMSSUC)
5.2.1AEMSSUC Request
5.2.2AEMSSUC Result File Schema

6
HLR Massive Update Commands
6.1Initiate Massive Change of Subscriber Data (HEMSMCI)
6.1.1HEMSMCI Request
6.1.2HEMSMCI Result File Schema
6.1.3SUD and NEWSUD Rules for HEMSMCI
6.2End Monitoring Call Forwarding Registration (HEMSMRE)
6.2.1HEMSMRE Request
6.2.2HEMSMRE Result File Schema
6.3Initiate Monitoring Call Forwarding Registration (HEMSMRI)
6.3.1HEMSMRI Request
6.3.2HEMSMRI Result File Schema
6.4Massive Change of Primary HLR Identity (HEMSPIC)
6.4.1HEMSPIC Request
6.4.2HEMSPIC Result File Schema

7
Faults or Errors
7.1General CLI Errors
7.2Command Mapped Errors
7.3HLR Errors
7.4AUC Errors

8
Appendix - HLR Classic and HLR-FE Layered Incompatibilities

Reference List

1   Introduction

This document covers the massive operations available through the Ericsson™ Dynamic Activation (EDA) Command Line Interface (CLI).

1.1   Purpose and Scope

This document describes the layered Home Location Register (HLR-FE), layered Authentication Center (AUC-FE), Mobile Number Portability (MNP), feature in the HLR-FE product, conditional search commands, and massive update commands.

How to use these commands is covered in the document Generic CLI Interface Specification, Reference [1].

1.2   Target Group

The target group for this document is as follows:

1.3   Typographic Conventions

Typographic conventions are described in the document Library Overview, Reference [3].

In addition to the writing conventions mentioned above, the following applies:

For information about glossary and terms throughout this document, see Glossary of Terms and Acronyms, Reference [2].

2   AUC Conditional Search Commands

This section covers all AUC conditional search commands available through the Dynamic Activation CLI. All Conditional Search commands generate response files, rather than printing the answer directly to the client.

The following AUC search commands are available:

2.1   Print Authentication and Key Agreement Algorithm (AEMSAAP)

The Authentication and Key Agreement Algorithm Data CLI allows requesting of the following information:

2.1.1   AEMSAAP Request

Command Description:

AEMSAAP:IMSIS=imsis[,RID=rid...]

Example of an AEMSAAP command

AEMSAAP:IMSIS=349133921;

This CLI command obtains the Authentication and Key Agreement Algorithm Data for subscribed IMSI numbers of the IMSI series 349133921.

The following table explains the attributes that can be used in a AEMSAAP request.

Table 1    Command Attributes

Attribute

Type

Description

IMSIS

Digit String, 1-15 digits


Each digit is 0-9.

IMSI number series

The beginning of an IMSI number. The search will match all IMSI numbers beginning with the specified digits.

RID

Numeral 0-31, see HLR Subscriber Data Type Definitions, Reference [6].

Region Identifier

2.1.2   AEMSAAP Result File Schema

The following is a result file schema for AEMSAAP:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
 targetNamespace="http://schemas.ericsson.com/pg/auc/13.5/" elementFormDefault="qualified"
 attributeFormDefault="qualified">
 <xs:element name="AKAAlgorithmSubscriptionData">
  <xs:complexType>
   <xs:sequence>
    <xs:element name="AKAAlgorithmSubscription"
     minOccurs="0" maxOccurs="unbounded">
     <xs:complexType>
      <xs:sequence>
       <xs:element name="imsi" type="xs:string" />
       <xs:element name="eki" type="xs:string" />
       <xs:element name="amf" type="xs:integer" />
       <xs:element name="kind" type="xs:integer" />
       <xs:element name="fsetind" type="xs:integer" />
       <xs:element name="a4ind" type="xs:integer" />
       <xs:element name="akaalgind" type="xs:string" />
      </xs:sequence>
     </xs:complexType>
    </xs:element>
   </xs:sequence>
  </xs:complexType>
 </xs:element>
</xs:schema>

The following table covers the attributes that can be received in a AEMSAAP response.

Table 2    Result Attributes

Attribute

Type

Description

a4ind

Integer 0-7

A4 algorithm indicator

akaalgind

One of the following text strings:


  • "1"

  • "2"

  • "N/A"

Authentication and Key Agreement (AKA) algorithm indicator

amf

Integer 0-65535

Authentication Management Field (AMF)

eki

Text string of 32 characters


Each character is digit 0-9 or letter A to F.

Encrypted Subscriber Authentication Key

fsetind

Integer 0-31

Function set indicator

imsi

Text string, 6-15 digits


Each digit is 0-9.

International Mobile Subscriber Identity

kind

Integer 0-511

A4 key indicator

2.2   Print Subscription State (AEMSSSP)

The Authentication Center Subscription State CLI allows requesting of the following information:

2.2.1   AEMSSSP Request

Command Description:

                   
        IMSIS=imsis
AEMSSSP:           ,AKATYPE=akatype[,RID=rid...];
        IMSIALL

 

Example of an AEMSSSP command

AEMSSSP:IMSIALL,AKATYPE=0;

This CLI command obtains all subscribed IMSI numbers with GSM AKA type.

The following table explains the attributes that can be used in a AEMSSSP request.

Table 3    Command Attributes

Attribute

Type

Description

AKATYPE

Integer 0-1


0 = GSM


1 = UMTS

Authentication and Key Agreement (AKA) type

IMSIALL

This parameter has no value.

If IMSIALL is used, all IMSI with initiated trace data is printed.

IMSIS

Digit string, 1-15 digits


Each digit is 0-9.

IMSI number series

The beginning of an IMSI number. The search will match all IMSI numbers beginning with the specified digits.

RID

Numeral 0-31, see HLR Subscriber Data Type Definitions, Reference [6].

Region Identifier

2.2.2   AEMSSSP Result File Schema

The following is a result file schema for AEMSSSP:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
 targetNamespace="http://schemas.ericsson.com/pg/auc/13.5/" elementFormDefault="qualified"
 attributeFormDefault="qualified">
 <xs:element name="SubscriptionStatusData">
  <xs:complexType>
   <xs:sequence>
    <xs:element name="akatype" type="xs:integer" />
    <xs:element name="imsi" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
   </xs:sequence>
  </xs:complexType>
 </xs:element>
</xs:schema>

The following table covers the attributes that can be received in a AEMSSSP response.

Table 4    Result Attributes

Attribute

Type

Description

akatype

Integer 0-1


0 = GSM


1 = UMTS

Authentication and Key Agreement (AKA) type

imsi

Text string, 6-15 digits


Each digit is 0-9.

International Mobile Subscriber Identity

2.3   Print Subscription (AEMSSUP)

The Authentication Center Subscription CLI allows requesting of the following information:

2.3.1   AEMSSUP Request

Command Description:

                   
        IMSIS=imsis
AEMSSUP:           ,AKATYPE=akatype[,RID=rid...];
        IMSIALL

 

Example of an AEMSSUP command

AEMSSUP:IMSIS=349133921,AKATYPE=0;

This CLI command obtains the subscription data for subscribers belonging to the IMSI series 349133921 with GSM AKA type

The following table explains the attributes that can be used in a AEMSSUP request.

Table 5    Command Attributes

Attribute

Type

Description

AKATYPE

Integer 0-1


0 = GSM


1 = UMTS

Authentication and Key Agreement (AKA) type

IMSIALL

This parameter has no value.

If IMSIALL is used, all IMSI with authentication subscription data is printed.

IMSIS

Digit string, 1-15 digits


Each digit is 0-9.

IMSI number series

The beginning of an IMSI number. The search will match all IMSI numbers beginning with the specified digits.

RID

Numeral 0-31, see HLR Subscriber Data Type Definitions, Reference [6].

Region Identifier

2.3.2   AEMSSUP Result File Schema

The following is a result file schema for AEMSSUP:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
 targetNamespace="http://schemas.ericsson.com/pg/auc/13.5/" elementFormDefault="qualified"
 attributeFormDefault="qualified">
 <xs:element name="SubscriptionData">
  <xs:complexType>
   <xs:sequence>
    <xs:element name="akatype" type="xs:integer" />
    <xs:element name="Subscription" minOccurs="0" maxOccurs="unbounded">
     <xs:complexType>
      <xs:sequence>
       <xs:element name="imsi" type="xs:string" />
       <xs:element name="eki" type="xs:string" />
       <xs:element name="kind" type="xs:integer" />
       <xs:choice>
        <xs:element name="a3a8ind" type="xs:integer" />
        <xs:element name="fsetind" type="xs:integer" />
       </xs:choice>
       <xs:element name="a4ind" type="xs:integer" />
       <xs:element name="amf" type="xs:integer" minOccurs="0" />
       <xs:element name="rid" type="xs:integer" minOccurs="0" />
      </xs:sequence>
     </xs:complexType>
    </xs:element>
   </xs:sequence>
  </xs:complexType>
 </xs:element>
</xs:schema>

The following table covers the attributes that can be received in a AEMSSUP response.

Table 6    Result Attributes

Attribute

Type

Description

a3a8ind

Integer 0-15

A3 and A8 algorithm indicator

a4ind

Integer 0-7

A4 algorithm indicator

akatype

Integer 0-1


0 = GSM


1 = UMTS

Authentication and Key Agreement type

amf

Integer 0-65535

Authentication Management Field (AMF)

eki

Text string of 32 characters


Each character is digit 0-9 or letter A to F.

Encrypted Subscriber Authentication Key

fsetind

Integer 0-31

Function set indicator

imsi

Text string, 6-15 digits


Each digit is 0-9.

International Mobile Subscriber Identity

kind

Integer 0-511

A4 key indicator

rid

Integer 0-31

Region Identifier

3   HLR Conditional Search Commands

The following HLR search commands are available in Dynamic Activation. For standard subscribers, all subscriber-related commands are supported.

3.1   Print Access Point Name (HEMSAPP)

The Access Point Name CLI allows requesting the information as follows for standard subscribers and M2M subscribers.

When neither APN or APNID is included in the request:

When APNID is included in the request:

When APN is included in the request:

The Access Point Name CLI allows requesting the information as follows for M2M Service Profile subscribers.

When neither APN or APNID is included in the request:

When APNID is included in the request:

When APN is included in the request:

The Access Point Name CLI allows requesting the information as follows for PDP context profiles.

When neither APN or APNID is included in the request:

When APNID is included in the request:

When APN is included in the request:

3.1.1   HEMSAPP Request

Command Description:

                      
                                                
        APN=apn,    MSISDNALL[,RID=rid...]      
HEMSAPP:            MSISDNS=msisdns[,RID=rid...];
        APNID=apnid,PDPCPS

 

Example of a HEMSAPP command

HEMSAPP:APN="ERICSSON.COM",MSISDNS=349133921;

This CLI command obtains the MSISDN and the IMSI of mobile subscribers belonging to MSISDN number series 349133921using the APN 'ERICSSON.COM' in any of their PDP contexts (directly assigned to the subscriber or by a profile).

The following table explains the attributes that can be used in a HEMSAPP request:

Table 7    Command Attributes

Attribute

Type

Description

APN

Text string, 1-62 characters


The entered APN must be compliant with the following syntax:


  • The APN consists of one or more labels separated with dots. Each label must start with a letter or a digit, end with a letter or a digit, and have as criteria characters only letters, digits, and hyphens.

  • APN must not start with the text RAC, LAC, SGSN, or RNC

  • APN must not end in .GPRS.

Access Point Name (APN)

APNID

Integer 0-16383

APN Identifier

MSISDNALL

This parameter has no value.

If given, all subscribers using the entered APN data are fetched

MSISDNS

Digit string, 1-15 digits


Each digit is 0-9.

MSISDN number series

The beginning of an MSISDN number. The search will match all MSISDNnumbers beginning with the specified digits.

PDPCPS

This parameter has no value.

PDP context profiles using the requested APN

RID

Numeral 0-31, see HLR Subscriber Data Type Definitions, Reference [6].

Region Identifier

3.1.2   HEMSAPP Result File Schema

The following is a result file schema for HEMSAPP:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
 targetNamespace="http://schemas.ericsson.com/pg/hlr/13.5/" elementFormDefault="qualified"
 attributeFormDefault="qualified">
 <xs:element name="AccessPointNameData">
  <xs:complexType>
   <xs:sequence>
    <xs:element name="AccessPointName" />
    <xs:complexType>
     <xs:sequence>
      <xs:element name="apn" type="xs:string" minOccurs="0" />
      <xs:element name="apnid" type="xs:integer" minOccurs="0" />
      <xs:choice>
       <xs:element name="MobileSubscriber" minOccurs="0" maxOccurs="unbounded">
        <xs:complexType>
         <xs:sequence>
          <xs:element name="msisdn" type="xs:string" />
          <xs:element name="imsi" type="xs:string" />
          <xs:element name="pdpcp" type="xs:integer" minOccurs="0" />
          <xs:element name="pdpid" type="xs:integer" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
        </xs:element>
        <xs:element name="PDPContextProfile" minOccurs="0" maxOccurs="unbounded">
         <xs:complexType>
          <xs:sequence>
           <xs:element name="pdpcp" type="xs:integer" />
           <xs:element name="pdpid" type="xs:integer" maxOccurs="unbounded"/>
          </xs:sequence>
         </xs:complexType>
        </xs:element>
       </xs:choice>
      </xs:sequence>
     </xs:complexType>
    </xs:element>
   </xs:sequence>
  </xs:complexType>
 </xs:element>
</xs:schema>

The following table covers the attributes that can be received in a HEMSAPP response.

Table 8    Result Attributes

Attribute

Type

Description

apn

Text string of up to 62 characters

Access Point Name

apnid

Integer 0-16383

APN identifier

imsi

Text string, 6-15 digits


Each digit is 0-9.

International Mobile Subscriber Identity

msisdn

Text string, 5-15 digits


Each digit is 0-9.

Mobile Station International PSTN/ISDN Number

pdpcp

Integer 0-8160

PDP context profile

pdpid

Integer 1-50

PDP context identifier

3.2   Print CAMEL Subscription List (HEMSCMP)

The CAMEL Subscription List CLI allows requesting of the following information:

3.2.1   HEMSCMP Request

Command Description:

                                                
        MSISDNALL[,RID][,OPT][,EXT][,CRIT]      
                                                
        MSISDNS=msisdns[,RID][,OPT][,EXT][,CRIT]
HEMSCMP:+                                        +;
        CSPALL[,OPT][,EXT][,CRIT]               
                                                
        CPD=cpd...

 
Note:  
Up to eight CPDs can be included in this command.

Example of a HEMSCMP command

HEMSCMP:CSPALL,OPT,EXT;

This CLI command obtains CAMEL subscription data, extended CAMEL data, and CAMEL subscription options of all CAMEL subscription profiles containing any CAMEL subscription data.

The following table explains the attributes that can be used in a HEMSCMP request:

Table 9    Command Attributes

Attribute

Type

Description

CPD

String, see HLR Subscriber Data Type Definitions, Reference [6]

CAMEL profile data

CRIT

This parameter has no value.

CAMEL triggering criteria

CSPALL

This parameter has no value.

All CAMEL subscription profiles with CAMEL subscription data

EXT

This parameter has no value.

Extended CAMEL data

MSISDNALL

This parameter has no value.

When this attribute is present, all subscribers and subscriber-based CAMEL subscription data are fetched

MSISDNS

Digit string, 1–15 digits


Each digit is 0–9.

MSISDN number series


The beginning of an MSISDN number. The search returns all the subscribers and subscriber-based CAMEL subscription data whose MSISDN number begins with the specified digits.

OPT

This parameter has no value.

CAMEL subscription options

RID

Numeral 0–31, see HLR Subscriber Data Type Definitions, Reference [6].

Region identifier

3.2.2   HEMSCMP Result File Schema

The result file schema of HEMSCMP varies depending on what parameters are used in the request.

The result file schema for CSPALL[,OPT][,EXT][,CRIT] is declared in Section 3.2.2.1.

The result file schema for MSISDNALL and MSISDNS is declared in Section 3.2.2.2.

The result file schema for CPD=cpd... is declared in Section 3.2.2.3.

3.2.2.1   CAMEL Subscription Profile Data

A file based on the following schema is returned if CSPALL[,OPT][,EXT][,CRIT] was included in the request.

The following is a result file schema for HEMSCMP:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
 targetNamespace="http://schemas.ericsson.com/pg/hlr/13.5/" elementFormDefault="qualified"
 attributeFormDefault="qualified">
 <xs:element name="CAMELSubscriptionProfileData">
  <xs:complexType>
   <xs:sequence>
    <xs:element name="CAMELSubscriptionProfile" minOccurs="0" maxOccurs="unbounded">
     <xs:complexType>
      <xs:sequence>
       <xs:element name="csp" type="xs:integer" />
       <xs:element name="CamelTriggeringDetectionPointData" maxOccurs="unbounded">
        <xs:complexType>
         <xs:sequence>
          <xs:element name="tdptype" type="xs:string" />
          <xs:element name="tdp" type="xs:integer"/>
          <xs:element name="sk" type="xs:integer" />
          <xs:element name="gsa" type="xs:string" />
          <xs:element name="deh" type="xs:integer" minOccurs="0" />
          <xs:element name="cch" type="xs:integer"/>
          <xs:element name="i" type="xs:boolean" minOccurs="0" />
          <xs:element name="dialnum" type="xs:string" minOccurs="0" />
         </xs:sequence>
        </xs:complexType>
       </xs:element>
       <xs:element name="CAMELSubscriptionOptions" minOccurs="0">
        <xs:complexType>
         <xs:sequence>
          <xs:sequence minOccurs="0">
           <xs:element name="gcso" type="xs:integer" />
           <xs:element name="mcso" type="xs:integer" />
           <xs:element name="sslo" type="xs:integer" />
           <xs:element name="gc2so" type="xs:integer" />
           <xs:element name="mc2so" type="xs:integer" />
           <xs:element name="tif" type="xs:integer" minOccurs="0" />
          </xs:sequence>
          <xs:sequence minOccurs="0">
           <xs:element name="gprsso" type="xs:integer"/>
          </xs:sequence>
          <xs:sequence minOccurs="0">
           <xs:element name="osmsso" type="xs:integer"/>
          </xs:sequence>
          <xs:sequence minOccurs="0">
           <xs:element name="gc3so" type="xs:integer" />
           <xs:element name="mc3so" type="xs:integer" />
          </xs:sequence>
          <xs:sequence minOccurs="0">
           <xs:element name="gc4so" type="xs:integer" />
           <xs:element name="mc4so" type="xs:integer" />
          </xs:sequence>
          <xs:sequence minOccurs="0">
           <xs:element name="mmso" type="xs:integer" />
          </xs:sequence>
          <xs:sequence minOccurs="0">
           <xs:element name="tsmsso" type="xs:integer"/>
          </xs:sequence>
         </xs:sequence>
        </xs:complexType>
       </xs:element>
       <xs:element name="ExtendedCAMELData" minOccurs="0">
        <xs:complexType>
         <xs:sequence>
          <xs:element name="eoinci" type="xs:integer" />
          <xs:element name="eoick" type="xs:integer" />
          <xs:element name="etinci" type="xs:integer" />
          <xs:element name="etick" type="xs:integer" />
         </xs:sequence>
        </xs:complexType>
       </xs:element>
       <xs:element name="CAMELTriggeringCriteriaData" minOccurs="0">
        <xs:complexType>
         <xs:sequence>
          <xs:element name="OCTDP2TriggeringCriteriaData" minOccurs="0" maxOccurs="unbounded">
           <xs:complexType>
            <xs:sequence>


             <xs:element name="cch" type="xs:integer" />
             <xs:element name="mty" type="xs:string" minOccurs="0" />
             <xs:element name="dnum" type="xs:string" minOccurs="0" maxOccurs="unbounded" />
             <xs:element name="dlgh" type="xs:integer" minOccurs="0" maxOccurs="unbounded" />
             <xs:element name="ftc" type="xs:string" minOccurs="0" />
             <xs:element name="bs" type="xs:string" minOccurs="0" maxOccurs="unbounded" />
             <xs:element name="bsg" type="xs:string" minOccurs="0" maxOccurs="unbounded" />
            </xs:sequence>
           </xs:complexType>
          </xs:element>
          <xs:element name="TCTDP12TriggeringCriteriaData" minOccurs="0" maxOccurs="unbounded">
           <xs:complexType>
            <xs:sequence>
             <xs:element name="cch" type="xs:integer" />
             <xs:element name="bs" type="xs:string" minOccurs="0" maxOccurs="unbounded" />
             <xs:element name="bsg" type="xs:string" minOccurs="0" maxOccurs="unbounded" />
            </xs:sequence>
           </xs:complexType>
          </xs:element>
         </xs:sequence>
        </xs:complexType>
       </xs:element>
      </xs:sequence>
     </xs:complexType>
    </xs:element>
   </xs:sequence>
  </xs:complexType>
 </xs:element>
</xs:schema>

 

3.2.2.2   CAMEL Subscription Data

A file based on the following schema is returned if MSISDNALL or MSISDNS was included in the request.

The following is a result file schema for CAMEL Subscription Data:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
 targetNamespace="http://schemas.ericsson.com/pg/hlr/13.5/" elementFormDefault="qualified"
 attributeFormDefault="qualified">
 <xs:element name="CAMELSubscriptionData">
  <xs:complexType>
   <xs:sequence>
    <xs:element name="CAMELSubscription" minOccurs="0" maxOccurs="unbounded">
     <xs:complexType>
      <xs:sequence>
       <xs:element name="msisdn" type="xs:string" />
       <xs:element name="csp" type="xs:integer" minOccurs="0" />
       <xs:element name="CamelTriggeringDetectionPointData" minOccurs="0" maxOccurs="unbounded">
        <xs:complexType>
         <xs:sequence>
          <xs:element name="tdptype" type="xs:string" />
          <xs:element name="tdp" type="xs:integer"/>
          <xs:element name="sk" type="xs:integer" />
          <xs:element name="gsa" type="xs:string" />
          <xs:element name="deh" type="xs:integer" minOccurs="0" />
          <xs:element name="cch" type="xs:integer"/>
          <xs:element name="i" type="xs:boolean" minOccurs="0" />
          <xs:element name="dialnum" type="xs:string" minOccurs="0" />
         </xs:sequence>
        </xs:complexType>
       </xs:element>
       <xs:element name="CAMELSubscriptionOptions" minOccurs="0">
        <xs:complexType>
         <xs:sequence>
          <xs:sequence minOccurs="0">
           <xs:element name="gcso" type="xs:integer" />
           <xs:element name="mcso" type="xs:integer" />
           <xs:element name="sslo" type="xs:integer" />
           <xs:element name="gc2so" type="xs:integer" />
           <xs:element name="mc2so" type="xs:integer" />
           <xs:element name="tif" type="xs:integer" minOccurs="0" />
          </xs:sequence>
          <xs:sequence minOccurs="0">
           <xs:element name="gprsso" type="xs:integer"/>
          </xs:sequence>
          <xs:sequence minOccurs="0">
           <xs:element name="osmsso" type="xs:integer"/>
          </xs:sequence>
          <xs:sequence minOccurs="0">
           <xs:element name="gc3so" type="xs:integer" />
           <xs:element name="mc3so" type="xs:integer" />
          </xs:sequence>
          <xs:sequence minOccurs="0">
           <xs:element name="gc4so" type="xs:integer" />
           <xs:element name="mc4so" type="xs:integer" />
          </xs:sequence>
          <xs:sequence minOccurs="0">
           <xs:element name="mmso" type="xs:integer" />
          </xs:sequence>
          <xs:sequence minOccurs="0">
           <xs:element name="tsmsso" type="xs:integer"/>
          </xs:sequence>
         </xs:sequence>
        </xs:complexType>
       </xs:element>
       <xs:element name="ExtendedCAMELData" minOccurs="0">
        <xs:complexType>
         <xs:sequence>
          <xs:element name="eoinci" type="xs:integer" />
          <xs:element name="eoick" type="xs:integer" />
          <xs:element name="etinci" type="xs:integer" />
          <xs:element name="etick" type="xs:integer" />
         </xs:sequence>
        </xs:complexType>
       </xs:element>
       <xs:element name="CAMELTriggeringCriteriaData" minOccurs="0">
        <xs:complexType>
         <xs:sequence>
          <xs:element name="OCTDP2TriggeringCriteriaData" minOccurs="0" maxOccurs="unbounded">
           <xs:complexType>
            <xs:sequence>



             <xs:element name="cch" type="xs:integer" />
             <xs:element name="mty" type="xs:string" minOccurs="0" />
             <xs:element name="dnum" type="xs:string" minOccurs="0" maxOccurs="unbounded" />
             <xs:element name="dlgh" type="xs:integer" minOccurs="0" maxOccurs="unbounded" />
             <xs:element name="ftc" type="xs:string" minOccurs="0" />
             <xs:element name="bs" type="xs:string" minOccurs="0" maxOccurs="unbounded" />
             <xs:element name="bsg" type="xs:string" minOccurs="0" maxOccurs="unbounded" />
            </xs:sequence>
           </xs:complexType>
          </xs:element>
          <xs:element name="TCTDP12TriggeringCriteriaData" minOccurs="0" maxOccurs="unbounded">
           <xs:complexType>
            <xs:sequence>
             <xs:element name="cch" type="xs:integer" />
             <xs:element name="bs" type="xs:string" minOccurs="0" maxOccurs="unbounded" />
             <xs:element name="bsg" type="xs:string" minOccurs="0" maxOccurs="unbounded" />
            </xs:sequence>
           </xs:complexType>
          </xs:element>
         </xs:sequence>
        </xs:complexType>
       </xs:element>
      </xs:sequence>
     </xs:complexType>
    </xs:element>
   </xs:sequence>
  </xs:complexType>
 </xs:element>
</xs:schema>

 

3.2.2.3   Conditional CAMEL Subscription Profile List

A file based on the following schema is returned if CPD=cpd... was included in the request.

The following is a result file schema for Conditional CAMEL Subscription Profile List:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
 targetNamespace="http://schemas.ericsson.com/pg/hlr/13.5/" elementFormDefault="qualified"
 attributeFormDefault="qualified">
 <xs:element name="ConditionalCAMELSubscriptionProfileList">
  <xs:complexType>
   <xs:sequence>
    <xs:element name="CAMELProfileDataConditions">
     <xs:complexType>
      <xs:sequence>
       <xs:element name="cpd" type="xs:string" maxOccurs="unbounded" />
      </xs:sequence>
     </xs:complexType>
    </xs:element>
    <xs:element name="CAMELProfileList">
     <xs:annotation>
      <xs:documentation>
       If no CAMEL subscription profiles where found in the
       search, nothing will be printed under CAMELProfileList.
      </xs:documentation>
     </xs:annotation>
     <xs:complexType>
      <xs:sequence>
       <xs:element name="csp" type="xs:integer" minOccurs="0" maxOccurs="unbounded" />
      </xs:sequence>
     </xs:complexType>
    </xs:element>
   </xs:sequence>
  </xs:complexType>
 </xs:element>
</xs:schema>

3.2.2.4   Result Parameters

The following table covers the attributes that can be received in a HEMSCMP response.

Table 10    Result Attributes

Attribute

Type

Description

bs

String


See HLR Subscriber Data Type Definitions, Reference [6], for values and value descriptions.

Basic Service (BS).

bsg

String


See HLR Subscriber Data Type Definitions, Reference [6], for values and value descriptions.

Basic Service Group (BSG).

cch

Integer 1–4


CAMEL Phase

CAMEL capability handling.

csp

Integer 1-8160

CAMEL Subscription Profile (CSP)

deh

Integer 0-1

0 = Transaction released in case of error in the GlobalSystem for Mobile Communication (GSM) service control function to GSM or GeneralPacket Radio Service (GPRS) service switching function dialogue.

1= Transaction continued in case of error in the GSM service control functionto GSM or GPRS service switching function dialogue.

Default error handling

dialnum

String starting with a digit 0-4(1), followed by -, followed by a text string 1-15 characters. Acceptable characters are 0-9, *, #, a, b, and c.


Example:


0-baccab#22

Dialed number.

dlgh

Integer 1-15

Destination number length.

dnum

String starting with a digit 0-4(1), followed by -, followed by a text string 1-15 characters. Acceptable characters are 0-9, *, #, a, b, and c.


Example:


3-4000#

Destination number.

eoick

Integer 0-999


Value 0 means not assigned.

Extended originating intelligent network category key.

eoinci

Integer 0-255


Value 0 means not assigned.

Extended originating intelligent network capability indicator.

etick

Integer 0-999


Value 0 means not assigned.

Extended terminating intelligent network category key.

etinci

Integer 0-255


Value 0 means not assigned.

Extended terminating intelligent network capability indicator.

ftc

String F (Forwarding) or N (Not forwarding)

Forwarding triggering criteria.

gcso

Integer 0-1


0 = Allow call terminating handling without CAMEL invocation when CAMEL phase 1 is not supported in the interrogating GMSC/gsmSCF


1 = Apply ODB of all incoming calls when CAMEL phase 1 is not supported in the interrogating GMSC/gsmSCF

GMSC gsmSCF CAMEL phase 1 support subscription option.

gc2so

Integer 0-1


0 = Allow call terminating handling with CAMEL phase 1 invocation when CAMEL phase 2 is not supported in the interrogating GMSC/gsmSCF


1 = Apply Operator Determined Barring (ODB) of all incoming calls when CAMEL phase 2 is not supported in the interrogating GMSC/gsmSCF

Gateway Mobile Switching Centre (GMSC) / Global System for Mobile Communication Service Control Function (gsmSCF) CAMEL phase 2 support subscription option.

gc3so

Integer 0-1


0 = Allow call terminating handling with lower CAMEL phase invocation when CAMEL phase 3 is not supported in the interrogating GMSC/gsmSCF


1 = Apply ODB of all incoming calls when CAMEL phase 3 is not supported in the interrogating GMSC/gsmSCF

GMSC gsmSCF CAMEL phase 3 support subscription option.

gc4so

Integer 0-1


0 = Allow call terminating handling with lower CAMEL phase invocation when CAMEL phase 4 is not supported in the interrogating GMSC/gsmSCF


1 = Apply ODB of all incoming calls when CAMEL phase 4 is not supported in the interrogating GMSC/gsmSCF

GMSC gsmSCF CAMEL phase 4 support subscription option.

gprsso

Integer 0-1


0 = Allow mobile subscribers registration in the Serving GPRS Support Node (SGSN) without sending GPRS CAMEL phase 3 data when CAMEL phase 3 data is not allowed to be sent to the SGSN


1 = Deny mobile subscribers registration in the SGSN when CAMEL phase 3 data is not allowed to be sent to the SGSN

GPRS CAMEL phase 3 denied subscription option.

gsa

Digit string, 3-15 digits


Each digit is 0-9.

GSM service control function address

i

Boolean


true = Terminating CAMEL subscription data for the given Trigger Detection Point (TDP) is not sent towards the GMSC when the subscriber is roaming inside the Home Public Land Mobile Network (HPLMN)


false = Terminating CAMEL subscription data for the given TDP is always sent towards the GMSC

Inhibition indicator

mcso

Integer 0–2


0 = Allow mobile subscribers registration in the serving MSC/VLR without sending CAMEL data when CAMEL phase 1 data is not allowed to be sent to the MSC/VLR.


1 = Network induced activation of supplementary service BAOC performed when CAMEL phase 1 data is not allowed to be sent to the serving MSC/VLR.


2 = Deny mobile subscribers registration in the serving MSC/VLR when CAMEL phase 1 data is not allowed to be sent to the MSC/VLR.

Mobile Switching Center (MSC) / Visitor Location Register (VLR) CAMEL phase 1 denied subscription option.

mc2so

Integer 0–2


0 = Check if mobile subscribers registration in the serving MSC/VLR with CAMEL phase 1 data can be performed or register without CAMEL data when CAMEL phase 2 data is not allowed to be sent to the MSC/VLR.


1 = Network induced activation of supplementary service Barring of All Outgoing Calls (BAOC) performed when CAMEL phase 2 data is not allowed to be sent to the serving MSC/VLR.


2 = Deny mobile subscribers registration in the serving MSC/VLR when CAMEL phase 2 data is not allowed to be sent to the MSC/VLR.

MSC/VLR CAMEL phase 2 denied subscription option

mc3so

Integer 0-2


0 = Check if mobile subscribers registration in the serving MSC/VLR with lower CAMEL phase data can be performed or register without CAMEL data when CAMEL phase 3 data is not allowed to be sent to the MSC/VLR


1 = Network induced activation of supplementary service BAOC performed when CAMEL phase 3 data is not allowed to be sent to the serving MSC/VLR. For Visited MSC (VMSC) terminating CAMEL TDPs value 1 has the same meaning as value 0


2 = Deny mobile subscribers registration in the serving MSC/VLR when CAMEL phase 3 data is not allowed to be sent to the MSC/VLR

MSC VLR CAMEL phase 3 denied subscription option.

mc4so

Integer 0-2


0 = Check if mobile subscribers registration in the serving MSC/VLR with lower CAMEL phase data can be performed or register without CAMEL data when CAMEL phase 4 data is not allowed to be sent to the MSC/VLR


1 = Network induced activation of supplementary service BAOC performed when CAMEL phase 4 data is not allowed to be sent to the serving MSC/VLR. For VMSC terminating CAMEL TDPs value 1 has the same meaning as value 0.


2 = Deny mobile subscribers registration in the serving MSC/VLR when CAMEL phase 4 data is not allowed to be sent to the MSC/VLR

MSC VLR CAMEL phase 4 denied subscription option.

mmso

Integer 0-1


0 = Allow mobile subscribers registration in the serving MSC/VLR without sending mobility management CAMEL phase 3 data when CAMEL phase 3 data is not allowed to be sent to the MSC/VLR


1 = Deny mobile subscribers registration in the serving MSC/VLR when CAMEL phase 3 data is not allowed to be sent to the MSC/VLR

Mobility management CAMEL phase 3 denied subscription option

msisdn

Text string, 5-15 digits


Each digit is 0-9.

Mobile Subscriber ISDN Number (MSISDN)

mty

String I (Inhibiting) or E (Enabling)

Match type.

osmsso

Integer 0-2


0 = Allow mobile subscribers registration in the serving node (MSC/VLR or SGSN or both) without sending originating SMS CAMEL phase 3 data when CAMEL phase 3 data is not allowed to be sent to the MSC/VLR or SGSN


1 = Network induced service withdrawal of Teleservice Short Message MO/PP performed when CAMEL phase 3 data is not allowed to be sent to the MSC/VLR or SGSN


2 = Deny mobile subscribers registration in the serving node (MSC/VLR or SGSN or both) when CAMEL phase 3 data is not allowed to be sent to the MSC/VLR or SGSN

Originating Short Message Service (SMS) CAMEL phase 3 denied subscription option.

sk

Integer 0-2147483647

Service key

sslo

Integer 0-1


0 = Subscriber state and location information are not sent at Send Routing Information Mobile Application Part (MAP) version 3 message response


1 = Subscriber state and location information are sent at Send Routing Information MAP version 3 message response

Subscriber state and location information sending CAMEL subscription option.

tdp

Integer 0-255


The value range depends on tdptype. See HLR Subscriber Data Type Definitions, Reference [6].

Trigger detection point

tdptype

String


  • Enumeration value = "DSTDP"

  • Enumeration value = "GPRSTDP"

  • Enumeration value = "MMTDP"

  • Enumeration value = "OCTDP"

  • Enumeration value = "OSMSTDP"

  • Enumeration value = "TCTDP"

  • Enumeration value = "TSMSTDP"

  • Enumeration value = "VTTDP"

Type of TDP

tif

Integer 0-1


0 = Number length, format, and conditional barrings checks are performed, when the mobile subscriber or the service provider registers a forwarded-to number


1 = Number length, format, and conditional barrings checks are not performed, when the mobile subscriber or the service provider registers a forwarded-to number

Translation information flag.

tsmsso

Integer 0-2


0 = Allow mobile subscribers registration in the serving node (MSC/VLR or SGSN or both) without sending terminating SMS CAMEL phase 4 data, when terminating SMS CAMEL phase 4 data is not allowed to be sent to the MSC/VLR or SGSN or both


1 = Allow mobile subscribers registration in the serving node (MSC/VLR or SGSN or both) without sending terminating SMS CAMEL phase 4 data, when terminating SMS CAMEL phase 4 data is not allowed to be sent to the MSC/VLR or SGSN or both. Network induced service invocation of an incoming call barring service is applied to mobile terminating short message delivery by MSC or SGSN or both.


2 = Deny mobile subscribers registration in the serving node (MSC/VLR or SGSN or both) when terminating SMS CAMEL phase 4 data is not allowed to be sent to the MSC/VLR or SGSN or both

Terminating SMS CAMEL phase 4 denied subscription option.

(1)  0 means Unknown, 1 or 2 means Not used, 3 means National number, and 4 means International number.


3.3   Print Extended Quality of Service (HEMSEQP)

The Extended Quality of Service CLI allows requesting of the following information for standard subscribers:

The Extended Quality of Service CLI allows requesting of the following information for PDP context profiles.

3.3.1   HEMSEQP Request

Note:  
  • The element HSDPASubscriber is returned if SUBSNUM is given in the request.
  • The element ExtendedQualityOfService is returned if EQOSID is given in the request.
  • The element MobileSubscriber is returned if MSISDNALL or MSISDNS is given in the request.
  • The element PDPContextProfile is returned if PDPCPS is given in the request.

Command Description:

                                                    
                                                  
                      MSISDNALL[,RID=rid...]      
                                                  
        EQOSID=eqosid,MSISDNS=msisdns[,RID=rid...]
HEMSEQP:                                          ;
                      PDPCPS                      
                                                  
                                                    
        SUBSNUM[,VALUE=value][,RID=rid...]

 

Example of a HEMSEQP command

HEMSEQP:EQOSID=234,MSISDNALL;

This CLI command obtains the MSISDN and the IMSI of the mobile subscribers that use the extended QoS corresponding to the extended QoS identifier 234 in any of their PDP contexts, either directly assigned to the subscriber or through a PDP context profile.

Example of a HEMSEQP command

HEMSEQP:SUBSNUM,VALUE=500;

This CLI command counts all subscribers having the Maximum Bit Rate for Downlink (MBRD) value set to at least 500 Kbps. The result is sorted on EQOSID with belonging MBRD value and for each EQOSID the number of subscribers connected to it is shown.

Note:  
If the parameter VALUE is omitted, the default value 384 Kbps is used.

The following table explains the attributes that can be used in a HEMSEQP request:

Table 11    Command Attributes

Attribute

Type

Description

EQOSID

Integer 0-4095

Extended QOS ID

MSISDNALL

This parameter has no value.

If given, all subscribers using the entered extended Quality of Service (QOS) are fetched

MSISDNS

Digit string, 1-15 digits


Each digit is 0-9.

MSISDN number series

The beginning of an MSISDN number. The search will match all MSISDNnumbers beginning with the specified digits.

PDPCPS

This parameter has no value.

If PDPCPS is used, PDP context profiles using the requested extended QoS identifier are returned.

RID

Numeral 0-31, see HLR Subscriber Data Type Definitions, Reference [6].

Region Identifier

SUBSNUM

This parameter has no value.

If SUBSNUM is used, it activates a procedure for counting all subscribers having a minimum MBRD value as specified in the parameter VALUE. The result is stored in a file.

VALUE

Integer 0-256000

Optional parameter that allows the operator to select a minimum MBRD value. If omitted, the default value is 384 Kbps.


Values from 1 Kbps to 63 Kbps are possible in 1 Kbps increments.


Values from 64 Kbps to 568 Kbps are possible in 8 Kbps increments.


Values from 576 Kbps to 8640 Kbps are possible in 64 Kbps increments.


Values from 8700 Kbps to 16000 Kbps are possible in 100 Kbps increments.


Values from 17000 Kbps to 128000 Kbps are possible in 1000 Kbps increments.


Values from 130000 Kbps to 256000 Kbps are possible in 2000 Kbps increments.


Values higher than 2048 Kbps are application system-dependent parameter values.

3.3.2   HEMSEQP Result File Schema

The following is a result file schema for HEMSEQP:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
 targetNamespace="http://schemas.ericsson.com/pg/hlr/13.5/" elementFormDefault="qualified"
 attributeFormDefault="qualified">
 <xs:element name="ExtendedQualityOfServiceData">
  <xs:complexType>
   <xs:sequence>
    <xs:choice>
     <xs:element name="ExtendedQualityOfService">
      <xs:complexType>
       <xs:sequence>
        <xs:element name="eqosid" type="xs:integer" />
        <xs:element name="tc" type="xs:string" />
        <xs:element name="arp" type="xs:integer" />
        <xs:element name="do" type="xs:boolean" />
        <xs:element name="sdu" type="xs:string" />
        <xs:element name="mbru" type="xs:integer" />
        <xs:element name="mbrd" type="xs:integer" />
        <xs:element name="thp" type="xs:integer" minOccurs="0" />
        <xs:element name="td" type="xs:integer" minOccurs="0" />
        <xs:element name="gbru" type="xs:integer" minOccurs="0" />
        <xs:element name="gbrd" type="xs:integer" minOccurs="0" />
        <xs:choice>
         <xs:element name="MobileSubscriber" minOccurs="0" maxOccurs="unbounded" >
          <xs:complexType>
           <xs:sequence>
            <xs:element name="msisdn" type="xs:string" />
            <xs:element name="imsi" type="xs:string" />
            <xs:element name="pdpcp" type="xs:integer" minOccurs="0" />
            <xs:element name="pdpid" type="xs:integer" minOccurs="0"
           </xs:sequence>
          </xs:complexType>
         </xs:element>
         <xs:element name="PDPContextProfile" minOccurs="0" maxOccurs="unbounded" >
          <xs:complexType>
           <xs:sequence>
            <xs:element name="pdpcp" type="xs:integer" />
            <xs:element name="pdpid" type="xs:integer" maxOccurs="unbounded" />
           </xs:sequence>
          </xs:complexType>
         </xs:element>
        </xs:choice>
       </xs:sequence>
      </xs:complexType>
     </xs:element>
     <xs:element name="HSDPASubscriber">
     <xs:complexType>
      <xs:sequence>
       <xs:element name="eqosid" type="xs:integer" />
       <xs:element name="mbrd" type="xs:integer" />
       <xs:element name="subsnum" type="xs:integer" />
      </xs:sequence>
     </xs:complexType>
     </xs:element>
    </xs:choice>
   </xs:sequence>
  </xs:complexType>
 </xs:element>
</xs:schema>

Note:  
The element ExtendedQualityOfService is returned if EQOSID is given in the request. The element MobileSubscriber is returned if MSISDNALL or MSISDNS is given in the request. The element PDPContextProfile is returned if PDPCPS is given in the request. The element HSDPASubscriber is returned if SUBSNUM is given in the request

The following table covers the attributes that can be received in a HEMSEQP response.

Table 12    Result Attributes

Attribute

Type

Description

arp

Integer 1-3


1 = High priority


2 = Normal priority


3 = Low priority

Allocation and retention priority

do

Boolean


true means with delivery order.


false means without delivery order.

Delivery order

eqosid

Integer 0-4095

Extended QOS ID

gbrd

Integer 0-256000

Guaranteed bit rate for downlink in Kbps

gbru

Integer 0-256000

Guaranteed bit rate for uplink in Kbps

imsi

Text string, 6-15 digits


Each digit is 0-9.

International Mobile Subscriber Identity

mbrd

Integer 0-256000

Maximum bit rate for downlink in Kbps

mbru

Integer 0-256000

Maximum bit rate for uplink in Kbps

msisdn

Text string, 5-15 digits


Each digit is 0-9.

Mobile Station International PSTN/ISDN Number

pdpcp

Integer 0-8160

PDP context profile

pdpid

Integer 1-50

PDP context ID

sdu

Text string in the format of <desdu>-<maxsu>-<rber>-<sduer>


<desdu> is delivery of erronous SDUs


NDU = No detect erroneous SDUs


NO = Erronous SDUs are not delivered


YES = Erronous SDUs are delivered


<maxsu> is the maximal SDU size. The unit is tens of octets. For example, the value 151 means 1502 octets.


<rber> is residential bit error


1 = 5e-2


2 = 1e-2


3 = 5e-3


4 = 4e-3


5 = 1e-3


6 = 1e-4


7 = 1e-5


8 = 1e-6


9 = 6e-8


<sduer> is SDU error ratio


1 0 1e-2


2 = 7e-3


3 = 1e-3


4 = 1e-4


5 = 1e-5


6 = 1e-6


7 = 1e-1

Service Data Unit (SDU)

subsnum

Integer

The number of calculated subscribers using the specific eqosid.

tc

One of the following text strings:


  • BACK for background

  • CON for conversational

  • INT for interactive

  • STR for streaming

Traffic class

td

Integer 100-4000

Transfer delay in milliseconds

thp

Integer 1-4

Traffic handling priority

3.4   Print Location Services Address (HEMSGLP)

The Location Services Address CLI allows requesting of the following data:

3.4.1   HEMSGLP Request

Command Description:

                                   
        GMLCA=gmlca[,USRF=usrf]    
                                   
        GMLCID=gmlcid[,USRF=usrf]  
                                                      
        HGMLCA=hgmlca               ,MSISDNALL        
HEMSGLP:                                              [,RID=rid...];
        HGMLCID=hgmlcid             ,MSISDNS=msisdns  
                                                      
        PPRA=ppra                  
                                   
        PPRID=pprid

 

Example of a HEMSGLP command

HEMSGLP:GMLCID=123,USRF=LCS,MSISDNALL;

This CLI command obtains the GMLC address identifier 123, its corresponding GMLC address, and the MSISDN of the subscribers having the entered GMLC address in the location services user function.

The following table explains the attributes that can be used in a HEMSGLP request:

Table 13    Command Attributes

Attribute

Type

Description

GMLCA

Text string, 3-15 digits


Each digit is 0-9.

Gateway Mobile Location Center (GMLC) address

GMLCID

Integer 0-255

GMLC address identifier

HGMLCA

Text String


This parameter allows either an Internet Protocol (IP) version 4 or an IP version 6 address.


IP version 4 (IPv4) address:


Text string 7-15 characters


Expressed as oc1, oc2, oc3, oc4 where:


oc1 - oc4
Octet 1 - 4
Integer 0-255


IP version 6 (IPv6) address:


Text string 2-39 characters


Expressed as hex1:hex2:hex3:hex4:hex5:hex6:hex7:hex8 where:


hex1 - hex 8


Hexadecimal word 1 - 8


Hexadecimal numeral 0-FFFF

Home GMLC (HGMLC) address

HGMLCID

Integer 0-255

Home GMLC address identifier

MSISDNALL

This parameter has no value.

If given, all subscribers using the entered LCS address is fetched.

MSISDNS

Digit string, 1-15 digits


Each digit is 0-9.

MSISDN number series

The beginning of an MSISDN number. The search will match all MSISDNnumbers beginning with the specified digits.

PPRA

Text string


This parameter allows either an Internet Protocol (IP) version 4 or an IP version 6 address.


IP version 4 (IPv4) address:


Text string 7-15 characters


Expressed as oc1, oc2, oc3, oc4 where:


oc1 - oc4


Octet 1 - 4


Integer 0-255


IP version 6 (IPv6) address:


Text string 2-39 characters


Expressed as hex1:hex2:hex3:hex4:hex5:hex6:hex7:hex8 where:


hex1 - hex8


Hexadecimal word 1 - 8


Hexadecimal numeral 0-FFFF

Privacy Profile Register (PPR) address

PPRID

Integer 0-255

Privacy Profile Register address identifier

RID

Numeral 0-31, see HLR Subscriber Data Type Definitions, Reference [6].

Region Identifier

USRF

Text String values LCS or STE


LCS Location Services


STE Spatial Triggers

User function

3.4.2   HEMSGLP Result File Schema

The following is a result file schema for HEMSGLP:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
 targetNamespace="http://schemas.ericsson.com/pg/hlr/13.5/" elementFormDefault="qualified"
 attributeFormDefault="qualified">
 <xs:element name="LocationServicesAddressData">
  <xs:complexType>
   <xs:sequence>
    <xs:choice>
     <xs:element name="GMLCAddressData">
      <xs:complexType>
       <xs:sequence>
        <xs:element name="gmlca" type="xs:string" />
        <xs:element name="gmlcid" type="xs:integer" />
        <xs:element name="msisdn" type="xs:string" minOccurs="0" maxOccurs="unbounded" />
       </xs:sequence>
      </xs:complexType>
     </xs:element>
     <xs:element name="HomeGMLCAddressData">
      <xs:complexType>
       <xs:sequence>
        <xs:element name="hgmlca" type="xs:string" />
        <xs:element name="hgmlcid" type="xs:integer" />
        <xs:element name="msisdn" type="xs:string" minOccurs="0" maxOccurs="unbounded" />
       </xs:sequence>
      </xs:complexType>
    </xs:element>
     <xs:element name="PrivacyProfileRegisterAddressData">
      <xs:complexType>
       <xs:sequence>
        <xs:element name="ppra" type="xs:string" />
        <xs:element name="pprid" type="xs:integer" />
        <xs:element name="msisdn" type="xs:string" minOccurs="0" maxOccurs="unbounded" />
       </xs:sequence>
      </xs:complexType>
     </xs:element>
    </xs:choice>
   </xs:sequence>
  </xs:complexType>
 </xs:element>
</xs:schema>

The following table covers the attributes that can be received in a HEMSGLP response.

Table 14    Result Attributes

Attribute

Type

Description

gmlca

Text string, 3-15 digits


Each digit is 0-9.

Gateway Mobile Location Center (GMLC) address

gmlcid

Integer 0-255

GMLC address identifier

hgmlca

Text string


This parameter allows either an Internet Protocol (IP) version 4 or an IP version 6 address.


IP version 4 (IPv4) address:


Text string 7-15 characters


Expressed as oc1, oc2, oc3, oc4 where:


oc1 - oc4


Octet 1 - 4


Integer 0-255


IP version 6 (IPv6) address:


Text string 2-39 characters


Expressed as hex1:hex2:hex3:hex4:hex5:hex6:hex7:hex8 where:


hex1 - 4


Hexadecimal word 1 - 8


Hexadecimal numeral 0-FFFF

Home GMLC (HGMLC) address

hgmlcid

Integer 0-255

Home GMLC address identifier

msisdn

Text string, 5-15 digits


Each digit is 0-9.

Mobile Station International PSTN/ISDN Number

pdpid

Integer 1-50

PDP context ID

ppra

Text string


This parameter allows either an Internet Protocol (IP) version 4 or an IP version 6 address.


IP version 4 (IPv4) address:


Text string 7-15 characters


Expressed as oc1, oc2, oc3, oc4 where:


oc1 - oc4


Octet 1 - 4


Integer 0-255


IP version 6 (IPv6) address:


Text string 2-39 characters


Expressed as hex1:hex2:hex3:hex4:hex5:hex6:hex7:hex8 where:


hex1 - 4


Hexadecimal word 1 - 8


Hexadecimal numeral 0-FFFF

Privacy Profile Register (PPR) address

pprid

Integer 0-255

Privacy Profile Register address identifier

3.5   Print GSM Service Control Function Address (HEMSGSP)

The GSM Service Control Function Address CLI allows requesting of the following data:

3.5.1   HEMSGSP Request

Command Description:

                                                            
                                                          
                     usrf                                 
        GSA=ALL,USRF=                                     
                     ALL                                  
                                                          
                                                          
                                                        
HEMSGSP:                                              ;
                          MSISDNALL[,RID=rid...]      
                                                      
                     usrf,MSISDNS=msisdns[,RID=rid...]
        GSA=gsa,USRF=                                 
                          CSP                         
                                                      
                                                        
                     ALL

 
Note:  
CSP is only applicable if USRF=CAMEL.

Example of a HEMSGSP command

HEMSGSP:GSA=56789,USRF=CAMEL,MSISDNALL;

This CLI command obtains all MSISDN with a CAMEL subscription profile that uses the GSM service control function address 56789.

The following table explains the attributes that can be used in a HEMSGSP request:

Table 15    Command Attributes

Attribute

Type

Description

CSP

This parameter has no value.

CAMEL subscription profile


CSP is only applicable if USRF=CAMEL.

GSA

Digit string, 3-15 digits


Each digit is 0-9.

GSM service control function address

MSISDNALL

This parameter has no value.

If given, all subscribers using the entered GSM service control function address data, are fetched

MSISDNS

Digit string, 1-15 digits


Each digit is 0-9.

MSISDN number series

The beginning of an MSISDN number. The search will match all MSISDNnumbers beginning with the specified digits.

RID

Numeral 0-31, see HLR Subscriber Data Type Definitions, Reference [6].

Region Identifier

USRF

Text String values ALL, CAMEL or MMINT


ALL= All user functions


CAMEL= Customized Applications for Mobile Networks Enhanced Logic


MMINT= Mobility Management Intelligent Network Triggering

User function

3.5.2   HEMSGSP Result File Schema

The following is a result file schema for HEMSGSP:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
 targetNamespace="http://schemas.ericsson.com/pg/hlr/13.5/" elementFormDefault="qualified"
 attributeFormDefault="qualified">
 <xs:element name="GSMServiceControlFunctionAddressData">
  <xs:complexType>
   <xs:sequence>
    <xs:element name="GSMServiceControlFunctionAddress" minOccurs="0" maxOccurs="unbounded">
     <xs:complexType>
      <xs:sequence>
       <xs:element name="gsa" type="xs:string" />
       <xs:element name="usrf" type="xs:string" minOccurs="0" maxOccurs="unbounded" />
       <xs:element name="msisdn" type="xs:string" minOccurs="0" maxOccurs="unbounded" />
       <xs:element name="csp" type="xs:integer" minOccurs="0" maxOccurs="unbounded" />
      </xs:sequence>
     </xs:complexType>
    </xs:element>
   </xs:sequence>
  </xs:complexType>
 </xs:element>
</xs:schema>

The following table covers the attributes that can be received in a HEMSGSP response.

Table 16    Result Attributes

Attribute

Type

Description

csp

Integer 1-8160

CAMEL subscription profile

gsa

Digit string, 3-15 digits


Each digit is 0-9.

GSM service control function address

msisdn

Text string, 5-15 digits


Each digit is 0-9.

Mobile Station International PSTN/ISDN Number

usrf

Text string


CAMEL= Customized Applications for Mobile Networks Enhanced Logic


MMINT= Mobility Management Intelligent Network Triggering

User function

3.6   Print IMSI Changeover (HEMSICP)

The IMSI Changeover CLI allows requesting of the following data:

3.6.1   HEMSICP Request

Command Description:

                                
                            
        NIMSIS=nimsis PEND  
HEMSICP:             ,EXEC  [,RID=rid...];
        NIMSIALL      FORCED

 

Example of a HEMSICP command

HEMSICP:NIMSIALL,EXEC;

This CLI command obtains the changeover data for all mobile subscribers with a procedure for IMSI changeover already executed.

The following table explains the attributes that can be used in a HEMSICP request.

Table 17    Command Attributes

Attribute

Type

Description

EXEC

This parameter has no value.

The changeover procedure has been executed. The new SIM-card has already been used.

FORCED

This parameter has no value.

The changeover procedure has been forced to execution because the mobile subscriber has not used the new card yet.

NIMSIS

Digit string, 1-15 digits


Each digit is 0-9.

New IMSI number series

NIMSIALL

This parameter has no value.

Data for all subscribers with an ongoing Changeover procedure.

PEND

This parameter has no value.

The changeover procedure has been initiated, but not yet executed. This could be because of the expiry date has not been reached, or the new SIM-card has not been used yet.

RID

Numeral 0-31, see HLR Subscriber Data Type Definitions, Reference [6].

Region Identifier

3.6.2   HEMSICP Result File Schema

The following is a result file schema for HEMSICP:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
 targetNamespace="http://schemas.ericsson.com/pg/hlr/13.5/" elementFormDefault="qualified"
 attributeFormDefault="qualified">
 <xs:element name="IMSIChangeoverData">
  <xs:complexType>
   <xs:sequence>
    <xs:element name="IMSIChangeover" minOccurs="0" maxOccurs="unbounded">
     <xs:complexType>
      <xs:sequence>
       <xs:element name="msisdn" type="xs:string" />
       <xs:element name="imsi" type="xs:string" />
       <xs:element name="nimsi" type="xs:string" />
       <xs:element name="state" type="xs:string" />
       <xs:element name="date" type="xs:string" />
       <xs:element name="authd" type="xs:string" minOccurs="0" />
       <xs:element name="IMPIData" minOccurs="0">
        <xs:complexType>
         <xs:sequence>
          <xs:element name="impi” type=”xs:string” />
          <xs:element name="nimpi” type=”xs:string” />
         </xs:sequence>
        </xs:complexType>
       </xs:element>
       <xs:element name="IMPUData" minOccurs="0">
        <xs:complexType>
         <xs:sequence>
          <xs:element name=”impu” type=”xs:string” />
          <xs:element name=”nimpu” type=”xs:string” />
         </xs:sequence>
        </xs:complexType>
       </xs:element>
      </xs:sequence>
     </xs:complexType>
    </xs:element>
   </xs:sequence>
  </xs:complexType>
 </xs:element>
</xs:schema>

The following table covers the attributes that can be received in a HEMSICP response.

Table 18    Result Attributes

Attribute

Type

Description

msisdn

Text string, 5-15 digits


Each digit is 0-9.

Mobile Station International PSTN/ISDN Number

imsi

Text string, 6-15 digits


Each digit is 0-9.

International Mobile Subscriber Identity

nimsi

Text string, 6-15 digits


Each digit is 0-9.

New International Mobile Subscriber Identity

state

Text string


PEND Pending (old card active)


EXEC Executed (new card active)


FORC Forced (expiry date reached and new card never used)

Status of the changeover

date

Text string

Date for expiry or execution of the Changeover procedure

authd

Text string


AVAIL Authentication data available


NOIMSI No IMSI in authentication center at the last attempt to get authentication data for this mobile subscriber


NOACC No access to authentication center at the last attempt to get authentication data for this mobile subscriber

Authentication data(1)

impi

String, 5- 70

Identifies the Private Identity.

nimpi

String, 5 - 70

Identifies the new Private Identity.

impu

String

Identifies the Public Identity. It is derived from IMSI.


Examples:


  • sip -
    sip:IMSI@ims.mncXXX.mccXXX.

nimpu

String

Identifies the new Public Identity. It is derived from IMSI.


Examples:


  • sip -
    sip:IMSI@ims.mncXXX.mccXXX.

(1)  AUTHD is only available if subscriber earlier has initiated an Authentication Procedure ("Send Authentication Information" MAP operation has been received for a specific subscriber).


3.7   Print Subscriber Location Services Data (HEMSLDP)

The Subscriber Location Services Data CLI allows requesting of the following data:

3.7.1   HEMSLDP Request

Command Description:

HEMSLDP:MSISDNS=msisdns[,RID=rid...];

Example of a HEMSLDP command

HEMSLDP:MSISDNS=9133921;

This CLI command obtains the LCS data defined for the mobile subscribers with MSISDN belonging to number series 9133921.

The following table explains the attributes that can be used in a HEMSLDP request.

Table 19    Command Attributes

Attribute

Type

Description

MSISDNS

Digit string, 1-15 digits


Each digit is 0-9.

MSISDN number series

The beginning of an MSISDN number. The search will match all MSISDNnumbers beginning with the specified digits.

RID

Numeral 0-31, see HLR Subscriber Data Type Definitions, Reference [6].

Region Identifier

3.7.2   HEMSLDP Result File Schema

The following is a result file schema for HEMSLDP:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
 targetNamespace="http://schemas.ericsson.com/pg/hlr/13.5/" elementFormDefault="qualified"
 attributeFormDefault="qualified">
 <xs:element name="SubscriberLocationServicesData">
  <xs:complexType>
   <xs:sequence>
    <xs:element name="SubscriberLocationServices" minOccurs="0" maxOccurs="unbounded">
     <xs:complexType>
      <xs:sequence>
       <xs:element name="msisdn" type="xs:string" />
       <xs:element name="PrivacyLCSClassData" minOccurs="0">
        <xs:complexType>
         <xs:sequence>
          <xs:annotation>
           <xs:element name="UniversalLocationServices" type="xs:boolean" minOccurs="0" />
           <xs:element name="CallRelatedLocationServices" minOccurs="0">
            <xs:complexType>
             <xs:sequence>
              <xs:element name="notf" type="xs:integer" />
              <xs:element name="ExternalAddress" minOccurs="0" maxOccurs="unbounded">
               <xs:complexType>
                <xs:sequence>
                 <xs:element name="eadd" type="xs:string" />
                 <xs:element name="gres" type="xs:boolean" minOccurs="0" />
                 <xs:element name="notf" type="xs:integer" />
                </xs:sequence>
               </xs:complexType>
              </xs:element>
             </xs:sequence>
            </xs:complexType>
           </xs:element>
          <xs:element name="CallUnrelatedLocationServices" minOccurs="0">
           <xs:complexType>
            <xs:sequence>
             <xs:element name="notf" type="xs:integer" />
             <xs:element name="ExternalAddress" minOccurs="0" maxOccurs="unbounded">
              <xs:complexType>
               <xs:sequence>
                <xs:element name="eadd" type="xs:string" />
                <xs:element name="gres" type="xs:boolean" minOccurs="0" />
                <xs:element name="notf" type="xs:integer" />
               </xs:sequence>
              </xs:complexType>
             </xs:element>
            </xs:sequence>
           </xs:complexType>
          </xs:element>
          <xs:element name="PLMNOperatorLocationServices" minOccurs="0">
           <xs:complexType>
            <xs:sequence>
             <xs:element name="intid" type="xs:integer" minOccurs="0" maxOccurs="unbounded" />
            </xs:sequence>
           </xs:complexType>
          </xs:element>
          <xs:element name="PrivacyServiceTypeData" minOccurs="0">
           <xs:complexType>
            <xs:sequence>
             <xs:element name="PrivacyServiceType" maxOccurs="unbounded">
              <xs:complexType>
               <xs:sequence>
                <xs:element name="servt" type="xs:integer" />
                <xs:element name="gres" type="xs:boolean" minOccurs="0" />
                <xs:element name="notf" type="xs:integer" />
               </xs:sequence>
              </xs:complexType>
             </xs:element>
            </xs:sequence>
           </xs:complexType>
          </xs:element>
         </xs:sequence>
        </xs:complexType>
       </xs:element>
       <xs:element name="MobileOriginatingLCSClass" minOccurs="0">
        <xs:complexType>
         <xs:sequence>
          <xs:element name="mocl" type="xs:string" maxOccurs="unbounded" />
         </xs:sequence>
        </xs:complexType>
       </xs:element>
      </xs:sequence>
     </xs:complexType>
    </xs:element>
   </xs:sequence>
  </xs:complexType>
 </xs:element>
</xs:schema>

UniversalLocationServices is printed if the attribute UNIV is found and not set to the default value.

CallRelatedLocationServices is printed if the attribute CREL is found and not set to the default value.

CallUnrelatedLocationServices is printed if the attribute CUNREL is found and not set to the default value.

PLMNOperatorLocationServices is printed if the attribute PLMNO is found and not set to the default value.

If none of the attributes UNIV, CREL, CUNREL, or PLMO are found in the search, the parent element, PrivacyLCSClassData, is not printed.

The following table covers the attributes that can be received in a HEMSLDP response.

Table 20    Result Attributes

Attribute

Type

Description

eadd

Text string

External address

gres

Boolean


0 (False) = Only GMLCs defined in subscriber GMLC address list


1 (True) = Any GMLC in the home country

Restriction on the Gateway Mobile Location Center (GMLC)

intid

Integer 0-4


Type of LCS client that is allowed to locate the mobile subscriber:


0 = LCS client broadcasting location-related information


1 = Operation and Maintenance (O) LCS client in the Home Public Land Mobile Network (HPLMN)


2 = O LCS client in the Visited Public Land Mobile Network (VPLMN)


3 = LCS client recording anonymous location information


4 = LCS client supporting a bearer service, teleservice, intelligent network service, or supplementary service to the mobile subscriber

Internal Identity

mocl

Text string


ASL = Semi-autonomous self location


BSL = Basic self location


TTP = Transfer to third party

LCS mobile originating class

msisdn

Text string, 5-15 digits.


Each digit is 0-9.

Mobile Station International PSTN/ISDN Number

notf

Integer 0-4


0 = Location request allowed without notification (call/session related LCS privacy class, external LCS client address, and service type) or location request not allowed (call/session unrelated LCS privacy class)


1= Location request allowed with notification


2 = Location request with notification and privacy verification allowed if no response


3 = Location request with notification and privacy verification restricted if no response


4 = Location request not allowed (call/session related LCS privacy class)

Location request restriction related to the notification to the mobile subscriber

servt

Integer 0-127


Service type for which an LCS client is allowed to locate the mobile subscriber:


0 = Emergency services


1 = Emergency alert services


2 = Person tracking


3 = Fleet management


4 = Asset management


5 = Traffic congestion reporting


6 = Roadside assistance


7 = Routing to nearest commercial enterprise


8 = Navigation


9 = City sightseeing


10 = Localized advertising


11 = Mobile yellow pages


12 = Traffic and public transportation information


13 = Weather


14 = Asset and service finding


15 = Gaming


16 = Find your friend


17 = Dating


18 = Chatting


19 = Route finding


20 = Where-am-I


64-127 = Operator-specific service types

Service Type

3.8   Print Conditional Subscriber List (HEMSLIP)

The Conditional Subscriber List CLI allows requesting of the following information:

3.8.1   HEMSLIP Request

Command Description:

                                              
                                            
        MSISDNS=msisdns                     
                       [,SUD=sud...][,COUNT]
HEMSLIP:+IMSIS=imsis                         +[,RID=rid...];
                                            
                                              
        SUD=sud...

 

Example of a HEMSLIP command

HEMSLIP:MSISDNS=3456,SUD=OFA-1&BICRO-1;

This CLI command obtains the MSISDN and IMSI numbers of the mobile subscribers that fulfill the following conditions:

The following table explains the attributes that can be used in a HEMSLIP request.

Table 21    Command Attributes

Attribute

Type

Description

IMSIS

Digit string, 1-15 digits


Each digit is 0-9.

IMSI number series

The beginning of an IMSI number. The search will match all IMSI numbers beginning with the specified digits.

MSISDNS

Digit string, 1-15 digits


Each digit is 0-9.

MSISDN number series

The beginning of an MSISDN number. The search will match all MSISDNnumbers beginning with the specified digits.

RID

Numeral 0-31, see HLR Subscriber Data Type Definitions, Reference [6].

Region Identifier

SUD

String, see HLR Subscriber Data Type Definitions, Reference [6].

Subscriber Data SUD

COUNT

This parameter has no value.

If the COUNT parameter is provided in the request, only the statistics are printed, not the subscriber list.

3.8.2   HEMSLIP Result File Schema

The following is a result file schema for HEMSLIP:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
 targetNamespace="http://schemas.ericsson.com/pg/hlr/13.5/" elementFormDefault="qualified"
 attributeFormDefault="qualified">
 <xs:element name="ConditionalSubscriberList">
  <xs:complexType>
   <xs:sequence>
    <xs:element name="SubscriberConditions">
     <xs:complexType>
      <xs:sequence>
       <xs:choice minOccurs="0">
        <xs:element name="msisdns" type="xs:string" />
        <xs:element name="imsis" type="xs:string" />
       </xs:choice>
       <xs:element name="sud" type="xs:string" minOccurs="0" 
       maxOccurs="unbounded" />
      </xs:sequence>
     </xs:complexType>
    </xs:element>
    <xs:choice>
     <xs:element name="SubscriberList" minOccurs="0" maxOccurs="unbounded">
      <xs:complexType>
       <xs:sequence>
        <xs:element name="msisdn" type="xs:string" />
        <xs:element name="imsi" type="xs:string" />
       </xs:sequence>
      </xs:complexType>
     </xs:element>
     <xs:element name="MassiveSearchStatistics" minOccurs="0" maxOccurs="1">
      <xs:complexType>
       <xs:sequence>
        <element name="starttime" type="xs:string" />
        <element name="stoptime" type="xs:string" />
        <element name="NumberOfFoundSubscribers" type="xs:integer" />
       </xs:sequence>
      <xs:complexType>
     </xs:element>
    </xs:choice>
   </xs:sequence>
  </xs:complexType>
 </xs:element>
</xs:schema>

The following table covers the attributes that can be received in a HEMSLIP response.

Table 22    Result Attributes

Attribute

Type

Description

imsi

Text string, 6-15 digits


Each digit is 0-9.

International Mobile Subscriber Identity

imsis

Digit string, 1-15 digits


Each digit is 0-9.

IMSI number series


The first digits of an IMSI number

msisdn

Text string, 5-15 digits


Each digit is 0-9.

Mobile Station International ISDN Number

msisdns

Digit string, 1-15 digits


Each digit is 0-9.

MSISDN number series


The first digits of an MSISDN number

sud

String, see HLR Subscriber Data Type Definitions, Reference [6].

Subscriber Data SUD

starttime

Text string


Date format is yyyy-MM-dd HH:mm:ss.

The starttime parameter indicates the command start time of the HEMSLIP.

stoptime

Text string


Date format is yyyy-MM-dd HH:mm:ss.

The stoptime parameter indicates the command stop time of the HEMSILP.

NumberOfFoundSubscribers

Integer

The NumberOfFoundSubscribers parameter indicates the number of subscribers that fulfill the search conditions.

3.9   Print Monitoring Call Forwarding Registration Data (HEMSMRP)

The Monitoring Call Forwarding Registration Data CLI allows requesting of the following data:

3.9.1   HEMSMRP Request

Command Description:

                       
        MSISDNS=msisdns
HEMSMRP:               [,RID=rid...];
        MSISDNALL

 

Example of a HEMSMRP command

HEMSMRP:MSISDNS=3491339;

This CLI command obtains the monitoring of call forwarding registration indicator, the call forwarding registration counter, and the MSISDN for each mobile subscriber within the MSISDN number series 3491339 with the function active.

The following table explains the attributes that can be used in a HEMSMRP request:

Table 23    Command Attributes

Attribute

Type

Description

MSISDNALL

This parameter has no value.

If given, all subscribers with the function activate are fetched

MSISDNS

Digit string, 1-15 digits


Each digit is 0-9.

MSISDN number series

The beginning of an MSISDN number. The search will match all MSISDNnumbers beginning with the specified digits.

RID

Numeral 0-31, see HLR Subscriber Data Type Definitions, Reference [6].

Region Identifier

3.9.2   HEMSMRP Result File Schema

The following is a result file schema for HEMSMRP:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
 targetNamespace="http://schemas.ericsson.com/pg/hlr/13.5/" elementFormDefault="qualified"
 attributeFormDefault="qualified">
 <xs:element
  name="MonitoringCallForwardingRegistrationData">
  <xs:complexType>
   <xs:sequence>
    <xs:element name="MonitoringCallForwardingRegistration" minOccurs="0" maxOccurs="unbounded">
     <xs:complexType>
      <xs:sequence>
       <xs:element name="msisdn" type="xs:string" />
       <xs:element name="mcf" type="xs:integer" />
       <xs:element name="cfr" type="xs:integer" />
      </xs:sequence>
     </xs:complexType>
    </xs:element>
   </xs:sequence>
  </xs:complexType>
 </xs:element>
</xs:schema>

The following table covers the attributes that can be received in a HEMSMRP response.

Table 24    Result Attributes

Attribute

Type

Description

cfr

Integer 0-20

Call Forwarding Registration counter

mcf

Integer 1-2


1 = International forwarded-to number registrations


2 = All forwarded-to number registrations

Monitoring of call forwarding registration indicator

msisdn

Text string, 5-15 digits


Each digit is 0-9.

Mobile Station International ISDN Number

3.10   Print Multiple Subscription Data (HEMSMSP)

The Multiple Subscription Data CLI allows requesting of the following data:

Note:  
If there are several subscriptions in the series that belong to the same multiple subscription, the multiple subscription data is only printed once.

3.10.1   HEMSMSP Request

Command Description:

HEMSMSP:MSISDNS=msisdns[,RID=rid...];

Example of a HEMSMSP command

HEMSMSP:MSISDNS=1234567;

This CLI command obtains the MSISDN, IMSI of all the subscriptions associated in a multiple subscription containing a subscription identified by an MSISDN belonging to 1234567 series and which one is the active subscription and which MSISDN is the master one and the activation mechanism for the multiple subscription.

The following table explains the attributes that can be used in a HEMSMSP request:

Table 25    Command Attributes

Attribute

Type

Description

MSISDNS

Digit string 1-15 digits. Each digit is 0-9

MSISDN number series

The beginning of an MSISDN number. The search will match all MSISDNnumbers beginning with the specified digits.

RID

Numeral 0-31, see HLR Subscriber Data Type Definitions, Reference [6].

Region Identifier

3.10.2   HEMSMSP Result File Schema

The following is a result file schema for HEMSMSP:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
 targetNamespace="http://schemas.ericsson.com/pg/hlr/13.5/" elementFormDefault="qualified"
 attributeFormDefault="qualified">
 <xs:element name="MultipleSubscriptionDataList">
  <xs:complexType>
   <xs:sequence>
    <xs:element name="MultipleSubscriptionData" minOccurs="0" maxOccurs="unbounded">
     <xs:complexType>
      <xs:sequence>
       <xs:element name="mch" type="xs:string" />
       <xs:element name="SubscriptionData" minOccurs="2" maxOccurs="10">
        <xs:complexType>
         <xs:sequence>
          <xs:element name="msisdn" type="xs:string" />
          <xs:element name="imsi" type="xs:string" />
          <xs:element name="active" type="xs:boolean" />
          <xs:element name="master" type="xs:boolean" />
         </xs:sequence>
        </xs:complexType>
       </xs:element>
      </xs:sequence>
     </xs:complexType>
    </xs:element>
   </xs:sequence>
  </xs:complexType>
 </xs:element>
</xs:schema>

The following table covers the attributes that can be received in a HEMSMSP response.

Table 26    Result Attributes

Attribute

Type

Description

active

Boolean

Indicates if this is the active subscription in the multiple subscription. true means active subscription.

master

Boolean

Indicates if this is the master subscription in the multiple subscription. true means master subscription

msisdn

Digit string 5-15 digits. Each digit is 0-9

MSISDN

imsi

Digit string 6-15 digits. Each digit is 0-9

International Mobile Subscriber Identity (IMSI)

mch

One of the following strings:

Multiple subscription activation mechanism.


  • LOC -
    Location updating mechanism.

  • USSD -
    Subscriber procedure based on Unstructured Supplementary Service Data (USSD).

3.11   Print Subscriber PDP Context (HEMSPDP)

The Subscriber PDP Context CLI allows requesting of the following data:

3.11.1   HEMSPDP Request

Command Description:

                       
        MSISDNS=msisdns
HEMSPDP:               [,RID=rid...];
        IMSIS=imsis

 

Example of a HEMSPDP command

HEMSPDP:MSISDNS=9133921;

This CLI command obtains the subscriber PDP context data of the connected subscribers with MSISDNS belonging to series 9133921 with any subscriber PDP context defined.

The following table explains the attributes that can be used in a HEMSPDP request.

Table 27    Command Attributes

Attribute

Type

Description

IMSIS

Digit string, 1-15 digits


Each digit is 0-9.

IMSI number series

The beginning of an IMSI number. The search will match all IMSI numbers beginning with the specified digits.

MSISDNS

Digit string, 1-15 digits


Each digit is 0-9.

MSISDN number series

The beginning of an MSISDN number. The search will match all MSISDNnumbers beginning with the specified digits.

RID

Numeral 0-31, see HLR Subscriber Data Type Definitions, Reference [6].

Region Identifier

3.11.2   HEMSPDP Result File Schema

The following is a result file schema for HEMSPDP:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
 targetNamespace="http://schemas.ericsson.com/pg/hlr/13.5/"
 elementFormDefault="qualified"
 attributeFormDefault="qualified">
 <xs:element name="SubscriberPDPContextData">
  <xs:complexType>
   <xs:sequence>
    <xs:element name="SubscriberGPRSData" minOccurs="0" maxOccurs="unbounded">
     <xs:complexType>
      <xs:sequence>
       <xs:element name="msisdn" type="xs:string" />
       <xs:element name="imsi" type="xs:string" />
       <xs:element name="pdpcp" type="xs:integer" minOccurs="0" />
       <xs:element name="SubscriberPDPContext" minOccurs="0" maxOccurs="unbounded">
        <xs:complexType>
         <xs:sequence>
          <xs:element name="apnid" type="xs:integer" minOccurs="0" />
          <xs:element name="pdpadd" type="xs:string" minOccurs="0" />
          <xs:element name="eqosid" type="xs:integer" />
          <xs:element name="vpaa" type="xs:boolean" />
          <xs:element name="pdpch" type="xs:string" minOccurs="0" />
          <xs:element name="pdpty" type="xs:string" />
          <xs:element name="epdpind" type="xs:boolean" minOccurs="0"/>
          <xs:element name="epdpadd" type="xs:string" minOccurs="0" />
          <xs:element name="pdpid" type="xs:integer" />
         </xs:sequence>
        </xs:complexType>
       </xs:element>
      </xs:sequence>
     </xs:complexType>
    </xs:element>
   </xs:sequence>
  </xs:complexType>
 </xs:element>
</xs:schema>

The PDPCH attribute is printed only if the PDP context charging characteristics validity indicator (PDPCHVID) identifies it as a valid PDP context charging characteristics.

The following table covers the attributes that can be received in a HEMSPDP response.

Table 28    Result Attributes

Attribute

Type

Description

apnid

Integer 0-16383

Access Point Name (APN) identifier

epdpadd

One of the following types:

Extended PDP context address

epdpind

Boolean

Extended PDP context type indicator

eqosid

Integer 0-4095

Extended QOS identifier

imsi

Text string, 6-15 digits


Each digit is 0-9.

International Mobile Subscriber Identity

msisdn

Text string, 5-15 digits


Each digit is 0-9.

Mobile Station International PSTN/ISDN Number

pdpadd

Text string


IPv4 or IPv6 address

PDP address

pdpch

Text string in the format of <pdppi>-<pdpgb>


<pdppi> = PDP context charging characteristics profile index


Integer 0-15


<pdpgb> = PDP context charging characteristics profile General Packet Radio Service (GPRS) support node behavior index


Integer 0-4095

PDP context charging characteristics

pdpcp

Integer 0-8160

PDP context profile

pdpid

Integer 1-50

PDP context identifier

pdpty

One of the following strings:


  • IPV4

  • PPP

  • IPV6

PDP context type

vpaa

Boolean


True = APN allowed to be used in the domain of VPLMN


False = APN not allowed to be used in the domain of VPLMN

Visited PLMN address allowed

3.12   Print PDP Context Profile (HEMSPPP)

The PDP Context Profile CLI allows requesting of the following information:

3.12.1   HEMSPPP Request

Command Description:

HEMSPPP[:PDPCP=pdpcp...];

Example of a HEMSPPP command

HEMSPPP:PDPCP=2&35;

This CLI command obtains the PDP contexts data within PDP context profiles number 2 and 35.

The following table explains the attributes that can be used in a HEMSPPP request:

Table 29    Command Attributes

Attribute

Type

Description

PDPCP

Integer 0-8160

PDP context profile


If no pdpcp is specified, all PDP context profiles are printed.

3.12.2   HEMSPPP Result File Schema

The following is a result file schema for HEMSPPP:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
 targetNamespace="http://schemas.ericsson.com/pg/hlr/13.5/" elementFormDefault="qualified"
 attributeFormDefault="qualified">
 <xs:element name="PDPContextProfileData">
  <xs:complexType>
   <xs:sequence>
    <xs:element name="PDPContextProfile" maxOccurs="unbounded">
     <xs:complexType>
      <xs:sequence>
       <xs:element name="pdpcp" type="xs:integer" />
       <xs:element name="PDPContext" maxOccurs="unbounded">
        <xs:complexType>
         <xs:sequence>
          <xs:element name="pdpid" type="xs:integer" />
          <xs:element name="apnid" type="xs:integer" minOccurs="0" />
          <xs:element name="eqosid" type="xs:integer" />
          <xs:element name="vpaa" type="xs:boolean" />
          <xs:element name="pdpch" type="xs:string" minOccurs="0" />
          <xs:element name="pdpty" type="xs:string" />
          <xs:element name="epdpind" type=xs:boolean" minOccurs="0" />
         </xs:sequence>
        </xs:complexType>
       </xs:element>
      </xs:sequence>
     </xs:complexType>
    </xs:element>
   </xs:sequence>
  </xs:complexType>
 </xs:element>
</xs:schema>

The PDPCH attribute is printed only if the PDP context charging characteristics validity indicator (PDPCHVID) identifies it as a valid PDP context charging characteristics.

The following table covers the attributes that can be received in a HEMSPPP response.

Table 30    Result Attributes

Attribute

Type

Description

apnid

Integer 0-16383

APN ID

epdpind

Boolean

Extended PDP context type indicator

eqosid

Integer 0-4095

Extended QOS ID

pdpch

Text string in the format of <pdppi>-<pdpgb>


<pdppi> = PDP context charging characteristics profile index


Integer 0-15


<pdpgb> = PDP context charging characteristics profile General Packet Radio Service (GPRS) support node behavior index


Integer 0-4095

PDP context charging characteristics

pdpcp

Integer 0-8160

PDP context profile

pdpid

Integer 1-50

PDP context ID

pdpty

One of the following strings:


  • IPV4

  • PPP

  • IPV6

PDP context type

vpaa

Boolean


True = APN allowed to be used in the domain of VPLMN


False = APN not allowed to be used in the domain of VPLMN

Visited PLMN address allowed

3.13   Print Service Center Survey (HEMSSCP)

The Service Center Survey CLI allows requesting of the following information:

Note:  
No Service Center addresses are retrieved for subscribers that belong to Multiple Subscriptions.

3.13.1   HEMSSCP Request

Command Description:

HEMSSCP:[RID=rid...];

Example of a HEMSSCP command

HEMSSCP;

This CLI command obtains all Service Center addresses and the corresponding number of subscribers.

The following table explains the attributes that can be used in a HEMSSCP request:

Table 31    Command Attributes

Attribute

Type

Description

RID

Numeral 0-31, see HLR Subscriber Data Type Definitions, Reference [6].

Region Identifier

3.13.2   HEMSSCP Result File Schema

The following is a result file schema for HEMSSCP:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
 targetNamespace="http://schemas.ericsson.com/pg/hlr/13.5/" elementFormDefault="qualified"
 attributeFormDefault="qualified">
 <xs:element name="ServiceCenterSurvey">
  <xs:complexType>
   <xs:sequence>
    <xs:element name="ServiceCenter" minOccurs="0" maxOccurs="unbounded">
     <xs:complexType>
      <xs:sequence>
       <xs:element name="scadd" type="xs:string" />
       <xs:element name="nsub" type="xs:integer" />
      </xs:sequence>
     </xs:complexType>
    </xs:element>
   </xs:sequence>
  </xs:complexType>
 </xs:element>
</xs:schema>

The following table covers the attributes that can be received in a HEMSSCP response.

Table 32    Result Attributes

Attribute

Type

Description

nsub

Integer

Number of subscribers whose Message Waiting Data list contains this SC address

scadd

String in the format of <na>-<ai>


<na> is Nature of Address, and can have value 3 for National and 4 for International.


<ai> is address information; digit string with acceptable characters 0-9.

SC address

3.14   Print Subscriber Data (HEMSSDP)

The Subscriber Data CLI allows requesting of the following information:

3.14.1   HEMSSDP Request

Command Description:

                               
        MSISDN=msisdn...     
                         ALL 
        MSISDNS=msisdns  SUDA
HEMSSDP:                ,SSDA[,RID=rid...];
        IMSI=imsi...     LOC 
                         PDP 
        IMSIS=imsis

 
Note:  
If no optional parameter is given, the value ALL is used.

Example of a HEMSSDP command

HEMSSDP:MSISDNS=3491339,SSDA;

This CLI command obtains the subscriber identity, the permanent subscriber data, and the supplementary service subscriber data of the connected subscribers with MSISDN belonging to MSISDN number series 3491339.

The following table explains the attributes that can be used in a HEMSSDP request.

Table 33    Command Attributes

Attribute

Type

Description

ALL

Text string

All subscriber data

IMSI

Text string, 6-15 digits


Each digit is 0-9.


If a&&b is specified, then a and b must contain the same number of digits.

International Mobile Subscriber Identity (IMSI)

IMSIS

Digit string, 1-15 digits


Each digit is 0-9.

IMSI number series

The beginning of an IMSI number. The search will match all IMSI numbers beginning with the specified digits.

LOC

Text string

Subscriber location data

MSISDN

Text string, 5-15 digits


Each digit is 0-9.


If a&&b is specified, then a and b must contain the same number of digits

Mobile Station ISDN (MSISDN)

MSISDNS

Digit string, 1-15 digits


Each digit is 0-9.

MSISDN number series

The beginning of an MSISDN number. The search will match all MSISDNnumbers beginning with the specified digits.

PDP

Text string

Packet Data Protocol (PDP) context subscriber data

RID

Numeral 0-31, see HLR Subscriber Data Type Definitions, Reference [6].

Region Identifier

SSDA

Text string

Permanent and supplementary service subscriber data

SUDA

Text string

Permanent subscriber data

3.14.2   HEMSSDP Result File Schema

The following is a result file schema for HEMSSDP:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
 targetNamespace="http://schemas.ericsson.com/pg/hlr/13.5/" elementFormDefault="qualified"
 attributeFormDefault="qualified">
 <xs:element name="SubscriberData">
  <xs:complexType>
   <xs:sequence>
    <xs:element name="Subscriber" minOccurs="0" maxOccurs="unbounded">
     <xs:complexType>
      <xs:sequence>
       <xs:element name="SubscriberIdentity">
        <xs:complexType>
         <xs:sequence>
          <xs:element name="msisdn" type="xs:string" minOccurs="0" />
          <xs:element name="imsi" type="xs:string" minOccurs="0" />
          <xs:element name="state" type="xs:string" />
          <xs:element name="authd" type="xs:string" minOccurs="0" />
          <xs:element name="nam" type="xs:integer" minOccurs="0" />
          <xs:element name="imeisv" type="xs:string" minOccurs="0" />
          <xs:element name="rid" type="xs:integer" minOccurs="0" />
         </xs:sequence>
        </xs:complexType>
       </xs:element>
       <xs:element name="PermanentSubscriberData" minOccurs="0">
        <xs:complexType>
         <xs:sequence>
          <xs:element name="sud" type="xs:string" maxOccurs="unbounded" />
          <xs:element name="AdditionalMSISDNData" minOccurs="0" maxOccurs="unbounded">
           <xs:complexType>
            <xs:sequence>
             <xs:element name="amsisdn" type="xs:string" />
             <xs:element name="bs" type="xs:string" minOccurs="0" />
             <xs:element name="bc" type="xs:integer" />
            </xs:sequence>
           </xs:complexType>
          </xs:element>
         </xs:sequence>
        </xs:complexType>
       </xs:element>
       <xs:element name="SupplementaryServiceData" minOccurs="0">
        <xs:complexType>
         <xs:sequence>
          <xs:element name="BasicServiceGroup" minOccurs="0" maxOccurs="unbounded">
           <xs:complexType>
            <xs:sequence>
             <xs:element name="bsg" type="xs:string" />
             <xs:element name="SupplementaryService" maxOccurs="unbounded">
              <xs:complexType>
               <xs:sequence>
                <xs:element name="ss" type="xs:string" />
                <xs:element name="status" type="xs:string" />
                <xs:element name="ForwardData" minOccurs="0">
                 <xs:complexType>
                  <xs:sequence>
                   <xs:element name="fnum" type="xs:string" />
                   <xs:element name="sadd" type="xs:string" minOccurs="0" />
                  </xs:sequence>
                 </xs:complexType>
                </xs:element>
                <xs:element name="time" type="xs:integer" minOccurs="0" />
               </xs:sequence>
              </xs:complexType>
             </xs:element>
            </xs:sequence>
           </xs:complexType>
          </xs:element>
          <xs:element name="passwordbarred" type="xs:boolean" minOccurs="0" />
          <xs:element name="mcfactive" type="xs:boolean" minOccurs="0" />
         </xs:sequence>
        </xs:complexType>
       </xs:element>
       <xs:element name="LocationData" minOccurs="0">
        <xs:complexType>
         <xs:sequence>
          <xs:element name="CSLocationData" minOccurs="0">
           <xs:complexType>
            <xs:sequence>
             <xs:element name="vlraddress" type="xs:string" />
             <xs:element name="msrn" type="xs:string" minOccurs="0" />
             <xs:element name="mscnumber" type="xs:string" minOccurs="0" />
             <xs:element name="lmsid" type="xs:string" minOccurs="0" />
             <xs:element name="mscarearestricted" type="xs:boolean" minOccurs="0" />
             <xs:element name="mspurgedinvlr" type="xs:boolean" minOccurs="0" />
             <xs:element name="ServicesRestrictedInVLR" minOccurs="0" >
              <xs:complexType>
               <xs:sequence>
                <xs:element name="rsp" type="xs:string" />
               </xs:sequence>
              </xs:complexType>
             </xs:element>
            </xs:sequence>
           </xs:complexType>
          </xs:element>
          <xs:element name="PSLocationData" minOccurs="0">
           <xs:complexType>
            <xs:sequence>
             <xs:element name="sgsnnumber" type="xs:string" />
             <xs:element name="mspurgedinsgsn" type="xs:boolean" minOccurs="0" />
             <xs:element name="ServicesRestrictedInSGSN" minOccurs="0" >
              <xs:complexType>
               <xs:sequence>
                <xs:element name="rsp" type="xs:string" />
               </xs:sequence>
              </xs:complexType>
             </xs:element>
            </xs:sequence>
           </xs:complexType>
          </xs:element>
         </xs:sequence>
        </xs:complexType>
       </xs:element>
       <xs:element name="PDPContextData" minOccurs="0">
        <xs:complexType>
         <xs:sequence>
          <xs:element name="PDPContext" minOccurs="0" maxOccurs="unbounded">
           <xs:complexType>
            <xs:sequence>
             <xs:element name="apnid" type="xs:integer" minOccurs="0" />
             <xs:element name="pdpadd" type="xs:string" minOccurs="0" />
             <xs:element name="eqosid" type="xs:integer" />
             <xs:element name="vpaa" type="xs:boolean" />
             <xs:element name="pdpch" type="xs:string" minOccurs="0" />
             <xs:element name="pdpty" type="xs:string" />
             <xs:element name="pdpid" type="xs:integer" />
            </xs:sequence>
           </xs:complexType>
          </xs:element>
         </xs:sequence>
        </xs:complexType>
       </xs:element>
      </xs:sequence>
     </xs:complexType>
    </xs:element>
   </xs:sequence>
  </xs:complexType>
 </xs:element>
</xs:schema>

The PDPCH attribute is printed only if the PDP context charging characteristics validity indicator (PDPCHVID) identifies it as a valid PDP context charging characteristics.

The following table covers the attributes that can be received in a HEMSSDP response.

Table 34    Result Attributes

Attribute

Type

Description

amsisdn

Text string, 5-15 digits


Each digit is 0-9.

Additional Mobile Station ISDN Number

apnid

Integer 0-16383

Access Point Name (APN) identifier

authd

Text string


  • AVAILABLE = Authentication data is available.

  • NO IMSI IN AUC = Authentication data not available. No International Mobile Subscriber Identity (IMSI) in Authentication Center (AUC) in the last attempt to get authentication data for this mobile subscriber.

  • NO ACCESS TO AUC = Authentication data not available. No access to AUC in the last attempt to get authentication data for this mobile subscriber.

Authentication data(1)

bc

Integer 0-65534

Public Land Mobile Network (PLMN) Bearer Capability (BC) number

bs

Text string, see HLR Subscriber Data Type Definitions, Reference [6]

Basic Service

bsg

Text string, see HLR Subscriber Data Type Definitions, Reference [6]

Basic Service Group (BSG)

eqosid

Integer 0-4095

Extended Quality of Service (QOS) identifier

fnum

Text string maxlength=15

Forwarded-to number

imeisv

Text string of 16 characters


Digits 0-9 and character F are allowed

International Mobile Equipment Identity and Software Version

imsi

Text string, 6-15 digits


Each digit is 0-9.

International Mobile Subscriber Identity

lmsid

Text string, 0-16 characters

Location Mobile Station Identity (LMSID)

mcfactive

Boolean

Monitoring of Call Forwarding is Active


true means the call forwarding registrations initiated by the mobile subscriber are being monitored

mscarearestricted

Boolean

MSC-area restricted


true means that the MSC area is restricted

mscnumber

Text string, 0-16 characters

Mobile Switching Center (MSC) number

msisdn

Text string, 5-15 digits


Each digit is 0-9.

Mobile Station International PSTN/ISDN Number

msm

Text string, 0-16 characters

Mobile Station Roaming Number (MSRN)

mspurgedinsgsn

Boolean

MS Purged in SGSN


true means that the MS has been purged from the SGSN

mspurgedinvlr

Boolean

MS purged in VLR


true means that the MS has been purged from the VLR

nam

Integer 0-2


0 = Both GPRS and non-GPRS


1 = Non-GPRS


2 = GPRS

Network Access Mode

pdpadd

IPv4 or IPv6 address

PDP address

pdpch

Text string in the format of <pdppi>-<pdpgb>


<pdppi> = PDP context charging characteristics profile index


Integer 0-15


<pdpgb> = PDP context charging characteristics profile General Packet Radio Service (GPRS) support node behavior index


Integer 0-4095

PDP context charging characteristics

pdpid

Integer 1-50

PDP context identifier

pdpty

IPv4 or IPv6 address


Point-to-Point Protocol (PPP)

PDP context type

passwordbarred

Boolean

Password is Barred


true means that the mobile subscriber is barred from using password controlled procedures because of password misuse

rsp

Text string, 0-16 characters

Roaming service profile

rid

Integer


Value range is 0–31.

Region Identifier

sadd

Text String in the format of typesadd-subadd


Typesadd = Type of subaddress


  • 0 NSAP

  • 1 User specified and even indicator

  • 2 User specified and odd indicator


Subadd = Subaddress

Forwarded-to subaddress information

sgsnnumber

Text string in the format of <na>-<ai>


<na> = Nature of address


3 = National


4 = International


<ai> = Address information


The value of sgsnnumber can also be UNKNOWN, RESTRICTED, or BARRED

Serving General Packet Radio Service (GPRS) Support Node (SGSN) address

ss

Text string, see HLR Subscriber Data Type Definitions, Reference [6].

Supplementary Service

state

Text string


  • CONNECTED = Subscriber connected

  • ADDITIONAL = Additional MSISDN given

State of mobile subscriber

statu

Text string


  • ACTIVE-OP = The SS is active and operative.

  • ACTIVE-QS = The SS is active and quiescent (that is, temporarily inhibited).

  • NOT ACTIVE = The SS is not active and not operative.

Status of the SS

sud

String, see HLR Subscriber Data Type Definitions, Reference [6].

Subscriber Data

time

Integer 5-30

No reply condition time in seconds

vlraddress

Text string in the format of <na>-<ai>


<na> = Nature of address


3 = National


4 = International


<ai> = Address information


The value of vlraddress can also be UNKNOWN, RESTRICTED, or BARRED

Visitor Location Register (VLR) address

vpaa

Boolean

Visited Public Land Mobile Network (VPLMN) address allowed


true means APN is allowed to be used in the domain of VPLMN


false means APN is not allowed to be used in the domain of VPLMN

(1)  AUTHD is only available if subscriber earlier has initiated an Authentication Procedure ("Send Authentication Information" MAP operation has been received for a specific subscriber).


3.15   Print Subscriber Location Services Address (HEMSSGP)

The Subscriber Location Services Address CLI allows requesting of the following information:

3.15.1   HEMSSGP Request

Command Description:

HEMSSGP:MSISDNS=msisdns[,GMLC][,HGMLC][,PPR][,RID=rid...];

Example of a HEMSSGP command

HEMSSGP:MSISDNS=349133921,HGMLC,PPR;

This CLI command obtains the Home GMLC address, the privacy profile register address, and its corresponding identifiers, for the connected subscribers with MSISDN belonging to series 349133921 with any address defined.

The following table explains the attributes that can be used in a HEMSSGP request.

Table 35    Command Attributes

Attribute

Type

Description

GMLC

Text string

Gateway Mobile Location Center (GMLC)

HGMLC

Text string

Home GMLC (HGMLC)

MSISDNS

Digit string, 1-15 digits


Each digit is 0-9

MSISDN number series

The beginning of an MSISDN number. The search will match all MSISDNnumbers beginning with the specified digits.

PPR

Text string

Privacy Profile Register (PPR)

RID

Numeral 0-31, see HLR Subscriber Data Type Definitions, Reference [6].

Region Identifier

3.15.2   HEMSSGP Result File Schema

The following is a result file schema for HEMSSGP:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
 targetNamespace="http://schemas.ericsson.com/pg/hlr/13.5/" elementFormDefault="qualified"
 attributeFormDefault="qualified">
 <xs:element name="SubscriberLocationServicesAddressData">
  <xs:complexType>
   <xs:sequence>
    <xs:element name="SubscriberLocationServicesAddress" minOccurs="0" maxOccurs="unbounded">
     <xs:complexType>
      <xs:sequence>
       <xs:element name="msisdn" type="xs:string" />
       <xs:element name="GMLCAddressData" minOccurs="0" maxOccurs="unbounded">
        <xs:complexType>
         <xs:sequence>
          <xs:element name="gmlcid" type="xs:integer" />
          <xs:element name="gmlca" type="xs:string" />
         </xs:sequence>
        </xs:complexType>
       </xs:element>
       <xs:element name="HomeGMLCAddressData" minOccurs="0">
        <xs:complexType>
         <xs:sequence>
          <xs:element name="hgmlcid" type="xs:integer" />
          <xs:element name="hgmlca" type="xs:string" />
         </xs:sequence>
        </xs:complexType>
       </xs:element>
       <xs:element name="PrivacyProfileRegisterAddressData" minOccurs="0">
        <xs:complexType>
         <xs:sequence>
          <xs:element name="pprid" type="xs:integer" />
          <xs:element name="ppra" type="xs:string" />
         </xs:sequence>
        </xs:complexType>
       </xs:element>
      </xs:sequence>
     </xs:complexType>
    </xs:element>
   </xs:sequence>
  </xs:complexType>
 </xs:element>
</xs:schema>

The following table covers the attributes that can be received in a HEMSSGP response.

Table 36    Result Attributes

Attribute

Type

Description

gmlca

Text string, 3-15 digits


Each digit is 0-9.

Gateway Mobile Location Center (GMLC) address

gmlcid

Integer 0-255

GMLC address identifier

hgmlca

Text String


This parameter allows either an Internet Protocol (IP) version 4 or an IP version 6 address.


IP version 4 (IPv4) address:Text string 7-15 characters


Expressed as oc1, oc2, oc3, oc4 where:


oc1 - oc4


Octet 1 - 4


Integer 0-255


IP version 6 (IPv6) address:


Text string 2-39 characters


Expressed as hex1:hex2:hex3:hex4:hex5:hex6:hex7:hex8 where:


hex1 - hex 8


Hexadecimal word 1 - 8


Hexadecimal numeral 0-FFFF

Home GMLC (HGMLC) address

hgmlcid

Integer 0-255

Home GMLC address identifier

msisdn

Text string, 5-15 digits


Each digit is 0-9.

Mobile Station International PSTN/ISDN Number

ppra

Text String


This parameter allows either an Internet Protocol (IP) version 4 or an IP version 6 address.


IP version 4 (IPv4) address:


Text string 7-15 characters


Expressed as oc1, oc2, oc3, oc4 where:


oc1 - oc4


Octet 1 - 4


Integer 0-255


IP version 6 (IPv6) address:


Text string 2-39 characters


Expressed as hex1:hex2:hex3:hex4:hex5:hex6:hex7:hex8 where:


hex1 - hex8


Hexadecimal word 1 - 8


Hexadecimal numeral 0-FFFF

Privacy Profile Register (PPR) address

pprid

Integer 0-255

Privacy Profile Register address identifier

3.16   Print Subscriber Tracing (HEMSSTP)

The Subscriber Tracing CLI allows requesting of the following information:

3.16.1   HEMSSTP Request

Command Description:

                   
        IMSIS=imsis
HEMSSTP:           [,RID=rid...];
        IMSIALL

 

Example of a HEMSSTP command

HEMSSTP:IMSIS=349133921;

This CLI command obtains the initiated trace data, the information related to the subscriber location and the VLR subscriber trace status for the connected subscribers with IMSI belonging to series 349133921 with trace data initiated.

The following table explains the attributes that can be used in a HEMSSTP request.

Table 37    Command Attributes

Attribute

Type

Description

IMSIALL

This parameter has no value.

If IMSIALL is used, all IMSI with initiated trace data is printed.

IMSIS

Digit string, 1-15 digits


Each digit is 0-9.

IMSI number series

The beginning of an IMSI number. The search will match all IMSI numbers beginning with the specified digits.

RID

Numeral 0-31, see HLR Subscriber Data Type Definitions, Reference [6].

Region Identifier

3.16.2   HEMSSTP Result File Schema

The following is a result file schema for HEMSSTP:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
 targetNamespace="http://schemas.ericsson.com/pg/hlr/13.5/" elementFormDefault="qualified"
 attributeFormDefault="qualified">
 <xs:element name="SubscriberTracingData">
  <xs:complexType>
   <xs:sequence>
    <xs:element name="SubscriberTracing" minOccurs="0" maxOccurs="unbounded">
     <xs:complexType>
      <xs:sequence>
       <xs:element name="imsi" type="xs:string" />
       <xs:element name="tref" type="xs:integer" />
       <xs:element name="omcid" type="xs:string" minOccurs="0" />
       <xs:element name="bssrt" type="xs:string" />
       <xs:element name="ieg" type="xs:string" />
       <xs:element name="pri" type="xs:string" />
       <xs:element name="vlrts" type="xs:string" />
       <xs:element name="location" type="xs:string" />
      </xs:sequence>
     </xs:complexType>
    </xs:element>
   </xs:sequence>
  </xs:complexType>
 </xs:element>
</xs:schema>

The following table covers the attributes that can be received in a HEMSSTP response.

Table 38    Result Attributes

Attribute

Type

Description

bssrt

Text string


  • BASIC = Basic record

  • HOVER = Handover record

  • RADIO = Radio record

Base Station System (BSS) record type

ieg

Text string


  • ALL

  • CM

  • MM

Invoking event group


ALL means both Connection Management (CM) and Mobility Management (MM) related events.

imsi

Text string, 6-15 digits


Each digit is 0-9.

International Mobile Subscriber Identity

location

Text string


  • BARRED

  • KNOWN

  • PURGED

  • RESTRICTED

  • UNKNOWN

Subscriber location

omcid

Text string in the format of <na>-<npi>-<num>.


<na> = Nature of address.


0 = Unknown


1 = International number


2 = National significant number


3 = Network-specific number


4 = Subscriber number


6 = Abbreviated number


<npi> = Numbering plan indicator.


0 = Unknown


1 = ISDN or telephony numbering plan


3= Data numbering plan


4 = Telex numbering plan


6 = Land mobile numbering plan


8 = National numbering plan


9 = Private numbering plan


<num> = The digits of the address.

Operation and Maintenance Center (OMC) address

pri

Text string


Y = Priority


N = No priority

Priority indication

tref

Integer 0-65535

Trace reference

vlrts

Text string ACTIVE or DEACT

Visitor Location Register (VLR) subscriber trace status


Indicates if the subscriber trace status is active in VLR (if the trace data initiated for a mobile subscriber are activated in VLR)

3.17   Print PRP Data (HESDCDP)

Command prints application common data PRP counters.

3.17.1   HESDCDP Request

Command Description:

                                   
                                 
                       ,GPRS     
                                 
HESDCDP:CC=cc[,CID=cid],RDP=rdp  [,RID=rid...];
                                 
                       ,GRDP=grdp

 

The following table explains the attributes that can be used in a HESDCDP request. RID parameter is only to be used for "Administration of BSS access capacity" purposes.

Table 39    Command Attributes

Attribute

Type

Description

CC=cc

Digit string 1 - 3 digits


ALL - All countries with roaming distribution data

Country code

CID=cid

Numeral 0 - 31

Country identifier


Only needed when CC=1 or CC=7

GPRS

  

General Packet Radio Service (GPRS) roaming distribution data

GRDP=grdp

Numeral 1 - 4


ALL - All GPRS roaming distribution profiles

GPRS roaming distribution profile identifier


It is not allowed to enter the value ALL at the same time in parameters GRDP and CC

RID

Numeral 0-31, see HLR Subscriber Data Type Definitions, Reference [6].

Region Identifier


The RID parameter is optional but is not to be used unless the Administration of BSS Access Capacity is present. If the Administration of BSS Access Capacity is not used, providing the RID parameter leads to empty results.

RDP=rdp

Numeral 1 - 4


ALL - All roaming distribution profiles

Roaming distribution profile identifier


It is not allowed to enter the value ALL at the same time in parameters RDP and CC

3.17.2   HESDCDP Result File Schema

The following is a result file schema for HESDCDP:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
 targetNamespace="http://schemas.ericsson.com/pg/hlr/13.5/" elementFormDefault="qualified"
 attributeFormDefault="qualified">
 <xs:element name="CurrentRoamingDistributionData">
  <xs:complexType>
   <xs:sequence>
    <xs:element name="TypeOfRoamingDistributionData" type="xs:string">
     <xs:annotation>
      <xs:documentation>
       Allowed value for TypeOfRoamingDistributionData is GPRS or NON-GPRS
      </xs:documentation>
     </xs:annotation>
    </xs:element>
    <xs:element name="CurrentRoamingDistribution" minOccurs="0" 
    maxOccurs="unbounded">
     <xs:complexType>
     <xs:sequence>
      <xs:element name="cc" type="xs:string"/>
      <xs:element name="cid" type="xs:integer" minOccurs="0"/>
      <xs:choice minOccurs="0">
       <xs:element name="rdp" type="xs:string"/>
       <xs:element name="grdp" type="xs:string"/>
      </xs:choice>
       <xs:element name="ccsubscnt" type="xs:integer"/>
       <xs:element name="RoamingPLMNData" minOccurs="0" maxOccurs="unbounded">
        <xs:complexType>
         <xs:sequence>
          <xs:element name="plmnid" type="xs:string"/>
          <xs:element name="plmnsubscnt" type="xs:integer"/>
          <xs:element name="percsubs" type="xs:decimal"/>
         </xs:sequence>
        </xs:complexType>
       </xs:element>
      </xs:sequence>
     </xs:complexType>
    </xs:element>
   </xs:sequence>
  </xs:complexType>
 </xs:element>
</xs:schema>

The following table covers the attributes that can be received in a HESDCDP response.

Table 40    Result Attributes

Attribute

Type

Description

ccsubscnt

Numeral

Number of subscribers roaming in a country

 

cid

Numeral 0 - 31

Country identifier


Only needed when CC=1 or CC=7

 
 

GPRS

String

General Packet Radio Service (GPRS) roaming distribution data

 

NON-GPRS

String

Non-General Packet Radio Service (GPRS) roaming distribution data

 

grdp

Numeral 1 - 4

GPRS roaming distribution profile identifier

 

rdp

Numeral 1 - 4

Roaming distribution profile identifier

 

percsubs

Numeral

Percentage of subscribers roaming in the PLMN. It is calculated using ccsubscnt and plmnsubscnt.

 

plmnid

Numeral

PLMN identifier

 

plmnsubscnt

Numeral

Number of subscribers roaming in the PLMN

 

3.18   Print Subscriber Roaming Data (HEMSRLP)

The Subscriber Roaming Data CLI presents a list of all the subscriber identities, the VLR addresses, the SGSN addresses, and the region identifiers of subscribers located out of the HPLMN (outside the country or outside HPLMN but inside country).

3.18.1   HEMSRLP Request

Command Description:

HEMSRLP:[RID=rid...][,GPRS];

Examples of HEMSRLP commands

HEMSRLP:RID=rid,GPRS;

This CLI command provides a list of all the subscriber identities, the RID and the SGSN addresses of subscribers located out of HPLMN.

HEMSRLP:RID=rid;

This CLI command provides a list of all the subscriber identities, the RID and the VLR addresses of subscribers located out of HPLMN.

HEMSRLP;

This CLI command provides a list of all the subscriber identities, the RID, the VLR addresses and the SGSN numbers of subscribers located out of HPLMN.

The following table explains the attributes that can be used in a HEMSRLP request.

Table 41    Command Attributes

Attribute

Type

Description

GPRS

  

General Packet Radio Service (GPRS)


If given, only SGSN addresses are returned. Otherwise, only VLR addresses are returned.

RID

Numeral 0-31, see HLR Subscriber Data Type Definitions, Reference [6].

Region Identifier

3.18.2   HEMSRLP Result File Schema

The following is a result file schema for HEMSRLP:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
 targetNamespace="http://schemas.ericsson.com/pg/hlr/13.5/" elementFormDefault="qualified"
 attributeFormDefault="qualified">
 <xs:element name="SubscriberRoamingData">
  <xs:complexType>
   <xs:sequence>
    <xs:element name="SubscriberRoaming" minOccurs="0" maxOccurs="unbounded">
     <xs:complexType>
      <xs:sequence>
       <xs:element name="imsi" type="xs:string"/>
       <xs:element name="msisdn" type="xs:string"/>
       <xs:element name="vlraddr" type="xs:string" minOccurs="0" />
       <xs:element name="sgsnnum" type="xs:string" minOccurs="0" />
       <xs:element name="rid" type="xs:string" minOccurs="0" />
      <xs:sequence>
     </xs:complexType>
    </xs:element>
   </xs:sequence>
  </xs:complexType>
 </xs:element>
</xs:schema>

The following table covers the attributes that can be received in a HEMSRLP response.

Table 42    Result Attributes

Attribute

Type

Description

IMSI

Text string, 6-15 digits


Each digit is 0-9

International Mobile Subscriber Identity

MSISDN

Text string, 5-15 digits


Each digit is 0-9

Mobile Station International ISDN Number

VLRADDR

Text String expressed as <na>-<ai>


<na> is the Nature of Address where 3 means National and 4 means International.


<ai> is address information.

VLR Address

SGSNNUM

Text String expressed as <na>-<ai>


<na> is the Nature of Address where 3 means National and 4 means International.


<ai> is address information.

SGSN Address

RID

Numeral 0-31, see HLR Subscriber Data Type Definitions, Reference [6].

Region Identifier

3.19   Print Subscribers Location Based on Geographic Area (HEMSSLP)

The Print Subscribers Location based on Geographic Area CLI command presents a list of subscribers (MSISDN, IMSI) located in a specific geographical area.

3.19.1   HEMSSLP Request

Command Description:

                       
        SGSNNUM=number 
HEMSSLP:+               + [,RID=rid...];
        VLRADD=address

 

Example of an HEMSSLP command

HEMSSLP:VLRADD=3-123456;

HEMSSLP:SGSNNUM=4-123456,RID=1;

The following table explains the attributes that can be used in a HEMSSLP request:

Table 43    Command Attributes

Attribute

Type

Description

SGSNNUM

String expressed as <na> or <ai>.


<na> is the Nature of Address where 3 means National and 4 means International


<ai> is the address information (2-15 digits where each is 0-9).

SGSN Number

VLRADD

String expressed as <na>-<ai>.


<na> is the Nature of Address where 3 means National and 4 means International


<ai> is the address information (2-15 digits where each is 0-9).

VLR Address

RID

Numeral 0-31, see HLR Subscriber Data Type Definitions, Reference [6].

Region Identifier

3.19.2   HEMSSLP Result File Schema

The following is the result file schema for HEMSSLP:

<?xml version="1.0" encoding="UTF-8"?>
 <xs:schema xmlns:xs=http://www.w3.org/2001/XMLSchema
  targetNamespace="http://schemas.ericsson.com/pg/hlr/13.5/" 
  elementFormDefault="qualified" attributeFormDefault="qualified"> 
  <xs:element name="SubscriberLocationData">
   <xs:complexType>
    <xs:sequence>
     <xs:choice>
      <xs:element name="vlradd" type="xs:string" /> 
      <xs:element name="sgsnnum" type="xs:string" />
     </xs:choice>
     <xs:element name="Subscriber" minOccurs="0" maxOccurs="unbounded"> 
      <xs:complexType>
       <xs:sequence>
        <xs:element name="msisdn" type="xs:string" /> 
        <xs:element name="imsi" type="xs:string" />
       </xs:sequence>
      </xs:complexType>
     </xs:element>
    </xs:sequence>
   </xs:complexType>
  </xs:element>
 </xs:schema>

The following table covers the attributes that can be received in a HEMSSLP response:

Table 44    Result Attributes

Attribute

Type

Description

sgsnnum

String expressed as <na>-<ai>.


<na> is the Nature of Address where 3 means National and 4 means International


<ai> is the address information (2-15 digits where each is 0-9).

SGSN Number

vlradd

String expressed as <na>-<ai>.


<na> is the Nature of Address where 3 means National and 4 means International


<ai> is the address information (2-15 digits where each is 0-9).

VLR Address

msisdn

Digit String. 5-15 digits, each digit 0-9.

Mobile subscriber ISDN Number

imsi

Digit String. 6-15 digits, each digit 0-9.

International Mobile Subscriber Identity

4   MNP Conditional Search Commands

This section covers all MNP conditional search commands available through the Dynamic Activation CLI. All Conditional Search commands generate response files, rather than printing the answer directly to the client.

The following MNP search command is available for printing MNP or FAM data:

4.1   Print MNP Subscriber Data (HEMSNTP)

The MNP CLI allows to request the MSISDN, the subscription type, the network prefix, and optionally the subscriber condition and network address, to be used towards the output network for the following cases:

4.1.1   HEMSNTP Request

Command Description:

                                                           
                                                       
          MSISDN=msisdn             IMPORTED           
                                ,   EXPORTED           
          MSISDNS=msisdns           OTHER              
                                    ADDRESS=address    
                                                       
                                                           
HEMSNTP:                                                    ;
                                                         
                                      IMPORTED           
            MSISDN=ALL            ,   EXPORTED           
                                      OTHER              
                                      ADDRESS=address

 

Example of HEMSNTP command

HEMSNTP:MSISDN=1234567&&1234569,IMPORTED;

This CLI command obtains the MSISDN, subscription type, and network prefix for the imported subscribers defined in CUDB with MSISDN from 1234567 up to 1234569

The following table explains the attributes that can be used in a HEMSNTP request.

Table 45    Command Attributes

Attribute

Type

Description

MSISDN

ALL


Digit strings joined by ampersands (& or &&)


Each digit string consists of 5–15 digits. Each digit is 0–9.

If the value is ALL, all subscribers are fetched.


If the value contains two ampersands (&&), the search matches all MSISDN between the two given digits.


If the value contains several ampersands (&), the search matches these specified digits.


Only one MSISDN is allowed.

MSISDNS

Digit string, 1–15 digits


Each digit is 0–9.

MSISDN number series


The beginning of an MSISDN number. The search matches all MSISDN numbers beginning with the specified digits.

IMPORTED

This parameter has no value.

If the parameter is given, all subscribers with IMPORTED subtype are fetched.

EXPORTED

This parameter has no value.

If the parameter is given, all subscribers with EXPORTED subtype are fetched.

OTHER

This parameter has no value.

If the parameter is given, all subscribers with OTHER subtype are fetched.

ADDRESS

Digit string, 5-28 digits


Each digit is 0–9 or #10-#14

Network address.

4.1.2   HEMSNTP Result File Schema

The following is a Result File schema for HEMSNTP:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
 targetNamespace="http://schemas.ericsson.com/pg/ma/hlr/" elementFormDefault="qualified"
 attributeFormDefault="qualified">
 <xs:element name="MNPSubscriptionData">
  <xs:complexType>
   <xs:sequence>
    <xs:element name="MobileNumberPortability" minOccurs="0" maxOccurs="unbounded">
     <xs:complexType>
      <xs:sequence>
       <xs:element name="msisdn" type="xs:string"/>
       <xs:element name="subtype" type="xs:string"/>
       <xs:element name="nprefix" type="xs:string"/>
       <xs:element name="subcond" type="xs:string" minOccurs="0"/>
       <xs:element name="address" type="xs:string" minOccurs="0"/>
      </xs:sequence>
     </xs:complexType>
    </xs:element>
   </xs:sequence>
  </xs:complexType>
 </xs:element>
</xs:schema>

The following table covers the attributes that can be received in a HEMSNTP response.

Table 46    Result Attributes

Attribute

Type

Description

msisdn

Digit string, 5–15 digits


Each digit is 0–9.

Mobile Station International PSTN/ISDN Number

subtype

Text string


  • HOME (1)

  • IMPORTED = Imported form another network

  • EXPORTED = Exported to another network

  • OTHER = Ported between other networks

Subscriber type

nprefix

Digit string 1-10 digits


Each digit is 0–9 or #10–#14.

Network prefix (used for routing towards an output network)

subcond

Text string


  • GSM/WCDMA

  • PSTN/ISDN

Subscriber condition

address (2)

Digit string, 5-28 digits


Each digit is 0–9 or #10-#14

Network address.

(1)  HOME is only possible if MSISDN belongs to a FAM subscription.

(2)  This parameter is returned if MSISDN belongs to a FAM subscription.


5   AUC Massive Update Commands

This section covers all AUC Massive Update commands. These commands have the purpose of updating the settings of many subscribers. All Massive Update commands generate response files, rather than echoing the answer directly back to the client.

The following AUC Massive Update commands are available:

5.1   Change Authentication and Key Agreement Algorithm (AEMSAAC)

The Change Authentication and Key Agreement Algorithm CLI allows requesting of the following information:

5.1.1   AEMSAAC Request

Command Description:

                      
        IMSIS=imsis   
AEMSAAC:              ,AKAALGIND=akaalgind[,RID=rid...];
        IMSIALL

 

Example of a AEMSAAC command

AEMSAAC:IMSIS=349255,AKAALGIND=2;

This CLI command updates the AKA algorithm indicator to value 2 of all subscribed WCDMA IMSI numbers of the IMSI number series 349255 with associated FSET supporting two algorithm framework.

The following table explains the attributes that can be used in a AEMSAAC request.

Table 47    Command Attributes

Attribute

Type

Description

AKAALGIND

Text String


1 AKA algorithm


2 AKA algorithm

Authentication and Key Agreement (AKA) algorithm indicator

IMSIALL

This parameter has no value.

If IMSIALL is used, all IMSI with initiated trace data is printed.

IMSIS

Digit string, 1-15 digits


Each digit is 0-9.

IMSI number series

The beginning of an IMSI number. The search will match all IMSI numbers beginning with the specified digits.

RID

Numeral 0-31, see HLR Subscriber Data Type Definitions, Reference [6].

Region Identifier

5.1.2   AEMSAAC Result File Schema

The following is a Result File schema for AEMSAAC:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
 targetNamespace="http://schemas.ericsson.com/pg/auc/13.5/" elementFormDefault="qualified"
 attributeFormDefault="qualified">
 <xs:element name="AKAAlgorithmSubscriptionDataLogData" minOccurs="0">
  <xs:complexType>
   <xs:sequence>
    <xs:element name="MassiveUpdateConditions">
     <xs:complexType>
      <xs:sequence>
       <xs:choice>
        <xs:element name="imsis" type="xs:string" />
        <xs:element name="IMSIALL" />
       </xs:choice>
       <xs:element name="akaalgind" type="xs:string" />
      </xs:sequence>
     </xs:complexType>
    </xs:element>
    <xs:element name="FailedSubscriberUpdates" minOccurs="0">
     <xs:complexType>
      <xs:sequence>
       <xs:element name="Subscriber" maxOccurs="unbounded">
        <xs:complexType>
         <xs:sequence>
          <xs:element name="imsi" type="xs:string" />
          <xs:element name="FaultReason">
           <xs:complexType>
            <xs:sequence>
             <xs:element name="code" type="xs:integer" />
             <xs:element name="message" type="xs:string" />
             <xs:element name="additionalinfo" type="xs:string" minOccurs="0" />
            </xs:sequence>
           </xs:complexType>
          </xs:element>
         </xs:sequence>
        </xs:complexType>
       </xs:element>
      </xs:sequence>
     </xs:complexType>
    </xs:element>
    <xs:element name="PendingSubscriberUpdates" minOccurs="0">
     <xs:complexType>
      <xs:sequence>
       <xs:element name="SubscriberRange" minOccurs="0" maxOccurs="unbounded">
        <xs:complexType>
         <xs:sequence>
          <xs:element name="imsi" type="xs:string" />
         </xs:sequence>
        </xs:complexType>
       </xs:element>
       <xs:element name="Subscriber" minOccurs="0" maxOccurs="unbounded">
        <xs:complexType>
         <xs:sequence>
          <xs:element name="imsi" type="xs:string" />
         </xs:sequence>
        </xs:complexType>
       </xs:element> 
      </xs:sequence>
     </xs:complexType>
    </xs:element>
    <xs:element name="MassiveUpdateStatistics">
     <xs:complexType>
      <xs:sequence>
       <xs:element name="starttime" type="xs:string" />
       <xs:element name="stoptime" type="xs:string" />
       <xs:element name="NumberOfChangedSubscribers" type="xs:integer" />
       <xs:element name="NumberOfFailedSubscribers" type="xs:integer" />
      </xs:sequence>
     </xs:complexType>
    </xs:element>
   </xs:sequence>
  </xs:complexType>
 </xs:element>
</xs:schema>

The following table covers the attributes that can be received in a AEMSAAC response.

Note:  
Error codes printed in the FaultReason element are related to the update of authentication subscription data for a single subscriber. These errors do not stop the massive update.

If an error stops the massive update, that error code is returned in the generic XML structure, which is outside the previous schema. The generic XML structure for file responses is specified in document Generic CLI Interface Specification, Reference [1].


Table 48    Result Attributes

Attribute

Type

Description

additionalinfo

Text string

Additional info about the error

akaalgind

Text string


  • "1"

  • "2"

  • "N/A"

Authentication and Key Agreement (AKA) algorithm indicator

code

Integer

The error code

imsi

Digit string, 6-15 digits


Each digit is 0-9.

International Mobile Subscriber Identity

IMSIALL

This parameter has no value.

If IMSIALL is used, all IMSI with initiated trace data is printed.

imsis

Digit string, 1-15 digits


Each digit is 0-9

IMSI number series


Printed if given as input parameter to the command

message

Text string

The error message

NumberOfChangedSubscribers

Integer

Number of successfully updated subscribers

NumberOfFailedSubscribers

Integer

Number of subscribers where the change failed

starttime

Text string

The start time for the massive change

stoptime

Text string

The stop time for the massive change

5.2   Change Subscription (AEMSSUC)

The Change Subscription CLI allows requesting of the following information:

5.2.1   AEMSSUC Request

Command Description:

                      
        IMSIS=imsis   
AEMSSUC:              ,AMF=amf,FSETIND=fsetind[,RID=rid...];
        IMSIALL

 

Example of a AEMSSUC command

AEMSSUC:IMSIS=349283,AMF=14532,FSETIND=2;

This CLI updates the AMF to value 14532 of the subscribed WCDMA IMSI numbers of the IMSI number series 349283 and FSETIND 2.

The following table explains the attributes that can be used in a AEMSSUC request.

Table 49    Command Attributes

Attribute

Type

Description

AMF

Integer 0-65535

Authentication Management Field (AMF).

FSETIND

Integer 0-31

Function set indicator

IMSIALL

This parameter has no value.

If IMSIALL is used, all IMSI with initiated trace data is printed.

IMSIS

Digit string, 1-15 digits


Each digit is 0-9.

IMSI number series

The beginning of an IMSI number. The search will match all IMSI numbers beginning with the specified digits.

RID

Numeral 0-31, see HLR Subscriber Data Type Definitions, Reference [6].

Region Identifier

5.2.2   AEMSSUC Result File Schema

The following is a Result File schema for AEMSSUC:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
 targetNamespace="http://schemas.ericsson.com/pg/auc/13.5/" elementFormDefault="qualified"
 attributeFormDefault="qualified">
 <xs:element name="SubscriptionDataLogData" minOccurs="0">
  <xs:complexType>
   <xs:sequence>
    <xs:element name="MassiveUpdateConditions">
     <xs:complexType>
      <xs:sequence>
       <xs:choice>
        <xs:element name="imsis" type="xs:string" />
        <xs:element name="IMSIALL" />
       </xs:choice>
       <xs:element name="amf" type="xs:integer" />
       <xs:element name="fsetind" type="xs:integer" />
      </xs:sequence>
     </xs:complexType>
    </xs:element>
    <xs:element name="FailedSubscriberUpdates" minOccurs="0">
     <xs:complexType>
      <xs:sequence>
       <xs:element name="Subscriber" maxOccurs="unbounded">
        <xs:complexType>
         <xs:sequence>
          <xs:element name="imsi" type="xs:string" />
          <xs:element name="FaultReason">
           <xs:complexType>
            <xs:sequence>
             <xs:element name="code" type="xs:integer" />
             <xs:element name="message" type="xs:string" />
             <xs:element name="additionalinfo" type="xs:string" minOccurs="0" />
            </xs:sequence>
           </xs:complexType>
          </xs:element>
         </xs:sequence>
        </xs:complexType>
       </xs:element>
      </xs:sequence>
     </xs:complexType>
    </xs:element>
    <xs:element name="MassiveUpdateStatistics">
     <xs:complexType>
      <xs:sequence>
       <xs:element name="starttime" type="xs:string" />
       <xs:element name="stoptime" type="xs:string" />
       <xs:element name="NumberOfChangedSubscribers" type="xs:integer" />
       <xs:element name="NumberOfFailedSubscribers" type="xs:integer" />
       <xs:element
      </xs:sequence>
     </xs:complexType>
    </xs:element>
   </xs:sequence>
  </xs:complexType>
 </xs:element>
</xs:schema>

The following table covers the attributes that can be received in a AEMSSUC response.

Note:  
Error codes printed in the FaultReason element are related to the update of authentication subscription data for a single subscriber. These errors do not stop the massive update.

If an error stops the massive update, that error code is returned in the generic XML structure, which is outside the previous schema. The generic XML structure for file responses is specified in document Generic CLI Interface Specification, Reference [1].


Table 50    Result Attributes

Attribute

Type

Description

additionalinfo

Text string

Additional info about the error

amf

Integer 0-65535

Authentication Management Field (AMF).

code

Integer

The error code

fsetind

Integer 0-31

Function set indicator

imsi

Digit string, 6-15 digits


Each digit is 0-9.

International Mobile Subscriber Identity

IMSIALL

This parameter has no value.

If IMSIALL is used, all IMSI with initiated trace data is printed.

imsis

Digit string, 1-15 digits


Each digit is 0-9.

IMSI number series


Printed if given as input parameter to the command

message

Text string

The error message

NumberOfChangedSubscribers

Text string

Number of successfully updated subscribers

NumberOfFailedSubscribers

Text string

Number of subscribers where the change failed

starttime

Text string

The start time for the massive change

stoptime

Text string

The stop time for the massive change

6   HLR Massive Update Commands

This section covers all HLR Massive Update commands. These commands have the purpose of updating the settings of many subscribers. All Massive Update commands generate response files, rather than echoing the answer directly back to the client.

The following HLR Massive Update commands are available:

6.1   Initiate Massive Change of Subscriber Data (HEMSMCI)

The Massive Change of Subscriber Data CLI operates on Standard HLR Subscription for Standard Subscriber Type and allows requesting of the following information:

For more information, see Function Specification Layered HLR, Reference [4].

6.1.1   HEMSMCI Request

Command Description:

                                      
                                    
        MSISDNS=msisdns             
                       [,SUD=sud...]
HEMSMCI:IMSIS=imsis                 ,NEWSUD=newsud...[,UPDATENET][,RID=rid...];
                                    
                                      
        SUD=sud...

 

Example of a HEMSMCI command

HEMSMCI:IMSIS=3491683,SUD=BOIC-1,NEWSUD=CFU-1,UPDATENET;

This CLI command provides supplementary service Call Forwarding Unconditional for the connected subscribers that fulfill the following conditions:

The VLRs and SGSNs where subscribers are located are updated with the new SUD.

The following table explains the attributes that can be used in a HEMSMCI request.

Table 51    Command Attributes

Attribute

Type

Description

IMSIS

Digit string, 1-15 digits


Each digit is 0-9.

IMSI number series

The beginning of an IMSI number. The search will match all IMSI numbers beginning with the specified digits.

Condition to find subscribers for which to update SUDs

MSISDNS

Digit string, 1-15 digits


Each digit is 0-9.

MSISDN number series

The beginning of an MSISDN number. The search will match all MSISDNnumbers beginning with the specified digits.

Condition to find subscribers for which to update SUDs

NEWSUD

String, see HLR Subscriber Data Type Definitions, Reference [6].

New SUD or the new value of an existing SUD

RID

Numeral 0-31, see HLR Subscriber Data Type Definitions, Reference [6].

Region Identifier

SUD

String, see HLR Subscriber Data Type Definitions, Reference [6].

Subscriber Data


Condition to find subscribers for which to update SUDs

UPDATENET

This parameter has no value.

If UPDATENET is given, an order is sent to update the VLR and SGSN after making the changes

6.1.2   HEMSMCI Result File Schema

The following is a Result File Schema for HEMSMCI:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
 targetNamespace="http://schemas.ericsson.com/pg/hlr/13.5/" elementFormDefault="qualified"
 attributeFormDefault="qualified">
 <xs:element name="MassiveChangeOfSubscriberDataLogData" minOccurs="0">
  <xs:complexType>
   <xs:sequence>
    <xs:element name="MassiveUpdateConditions">
     <xs:complexType>
      <xs:sequence>
       <xs:element name="newsud" type="xs:string" maxOccurs="unbounded" />
       <xs:choice minOccurs="0">
        <xs:element name="msisdns" type="xs:string" />
        <xs:element name="imsis" type="xs:string" />
       </xs:choice>
       <xs:element name="sud" type="xs:string" minOccurs="0" maxOccurs="unbounded" />
       <xs:element name="NetworkUpdatingRequested" type="xs:boolean" minOccurs="0" />
      </xs:sequence>
     </xs:complexType>
    </xs:element>
    <xs:element name="FailedSubscriberUpdates" minOccurs="0">
     <xs:complexType>
      <xs:sequence>
       <xs:element name="Subscriber" maxOccurs="unbounded">
        <xs:complexType>
         <xs:sequence>
          <xs:element name="msisdn" type="xs:string" />
          <xs:element name="imsi" type="xs:string" />
          <xs:element name="FaultReason">
           <xs:complexType>
            <xs:sequence>
             <xs:element name="code" type="xs:integer" />
             <xs:element name="message" type="xs:string" />
             <xs:element name="additionalinfo" type="xs:string" minOccurs="0" />
            </xs:sequence>
           </xs:complexType>
          </xs:element>
         </xs:sequence>
        </xs:complexType>
       </xs:element>
      </xs:sequence>
     </xs:complexType>
    </xs:element>
    <xs:element name="MassiveUpdateStatistics">
     <xs:complexType>
      <xs:sequence>
       <xs:element name="starttime" type="xs:string" />
       <xs:element name="stoptime" type="xs:string" />
       <xs:element name="NumberOfChangedSubscribers" type="xs:integer" />
       <xs:element name="NumberOfFailedSubscribers" type="xs:integer" />
       <xs:element name="NumberOfRemainingSubscribers" type="xs:integer" />
      </xs:sequence>
     </xs:complexType>
    </xs:element>
   </xs:sequence>
  </xs:complexType>
 </xs:element>
</xs:schema>

The following table covers the attributes that can be received in a HEMSMCI response.

Note:  
Error codes printed in the FaultReason element are related to the update of data for a single subscriber. These errors do not stop the massive update.

If an error stops the massive update, that error code is returned in the generic XML structure, which is outside the schema above. The generic XML structure for file responses is specified in document Generic CLI Interface Specification, Reference [1].


Table 52    Result Attributes

Attribute

Type

Description

additionalinfo

Text string

Additional info about the error

code

Integer

The error code

imsi

Digit string, 6-15 digits


Each digit is 0-9.

International Mobile Subscriber Identity

imsis

Digit string, 1-15 digits


Each digit is 0-9.

IMSI number series


Printed if given as input parameter to the command

message

Text string

The error message

msisdn

Digit string, 5-15 digits


Each digit is 0-9.

Mobile station ISDN or ISDN number

msisdns

Digit string, 1-15 digits


Each digit is 0-9.

MSISDN number series


Printed if given as input parameter to the command

NetworkUpdatingRequested

Boolean

true if UPDATENET was given as input parameter to the command

newsud

String, see HLR Subscriber Data Type Definitions, Reference [6].

New SUD or the new value of an existing SUD


Contains the same values that were sent as input to this command

NumberOfChangedSubscribers

Text string

Number of successfully updated subscribers

NumberOfFailedSubscribers

Text string

Number of subscribers where the change failed

NumberOfRemainingSubscribers

Text string

Number of subscribers remaining when the cancel was executed

starttime

Text string

The start time for the massive change

stoptime

Text string

The stop time for the massive change

sud

String, see HLR Subscriber Data Type Definitions, Reference [6].

Subscriber Data


Printed if given as input parameter to the command

6.1.3   SUD and NEWSUD Rules for HEMSMCI

The following rules apply for HEMSMCI command:

6.2   End Monitoring Call Forwarding Registration (HEMSMRE)

The End Monitoring Call Forwarding Registration CLI allows requesting of the following information:

6.2.1   HEMSMRE Request

Command Description:

HEMSMRE:MSISDNS=msisdns[,RID=rid...];

Example of a HEMSMRE command

HEMSMRE:MSISDNS=3492783;

This CLI command deactivates the monitoring of call forwarding registration for connected mobile subscribers within the MSISDN number series 3492783.

The following table explains the attributes that can be used in a HEMSMRE request.

Table 53    Command Attributes

Attribute

Type

Description

MSISDNS

Digit string, 1-15 digits


Each digit is 0-9.

MSISDN number series

The beginning of an MSISDN number. The search will match all MSISDNnumbers beginning with the specified digits.

Condition to find subscribers for which to update SUDs

RID

Numeral 0-31, see HLR Subscriber Data Type Definitions, Reference [6].

Region Identifier

6.2.2   HEMSMRE Result File Schema

The following is a Result File schema for HEMSMRE:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
 targetNamespace="http://schemas.ericsson.com/pg/hlr/13.5/" elementFormDefault="qualified"
 attributeFormDefault="qualified">
 <xs:element name="MonitoringCallForwardingRegistrationDataLogData" minOccurs="0">
  <xs:complexType>
   <xs:sequence>
    <xs:element name="MassiveUpdateConditions">
     <xs:complexType>
      <xs:sequence>
       <xs:element name="msisdns" type="xs:string" />
      </xs:sequence>
     </xs:complexType>
    </xs:element>
    <xs:element name="FailedSubscriberUpdates" minOccurs="0">
     <xs:complexType>
      <xs:sequence>
       <xs:element name="Subscriber" maxOccurs="unbounded">
        <xs:complexType>
         <xs:sequence>
          <xs:element name="msisdn" type="xs:string" />
          <xs:element name="imsi" type="xs:string" />
          <xs:element name="FaultReason">
           <xs:complexType>
            <xs:sequence>
             <xs:element name="code" type="xs:integer" />
             <xs:element name="message" type="xs:string" />
             <xs:element name="additionalinfo" type="xs:string" minOccurs="0" />
            </xs:sequence>
           </xs:complexType>
          </xs:element>
         </xs:sequence>
        </xs:complexType>
       </xs:element>
      </xs:sequence>
     </xs:complexType>
    </xs:element>
    <xs:element name="MassiveUpdateStatistics">
     <xs:complexType>
      <xs:sequence>
       <xs:element name="starttime" type="xs:string" />
       <xs:element name="stoptime" type="xs:string" />
       <xs:element name="NumberOfChangedSubscribers" type="xs:integer" />
       <xs:element name="NumberOfFailedSubscribers" type="xs:integer" />
      </xs:sequence>
     </xs:complexType>
    </xs:element>
   </xs:sequence>
  </xs:complexType>
 </xs:element>
</xs:schema>

The following table covers the attributes that can be received in a HEMSMRE response.

Note:  
Error codes printed in the FaultReason element are related to the monitoring call forwarding registration activation or deactivation for a single subscriber. These errors do not stop the massive update.

If an error stops the massive update, that error code is returned in the generic XML structure, which is outside the previous schema. The generic XML structure for file responses is specified in document Generic CLI Interface Specification, Reference [1].


Table 54    Result Attributes

Attribute

Type

Description

msisdns

Digit string, 1-15 digits


Each digit is 0-9.

MSISDN number series


Printed if given as input parameter to the command

mcf

Integer 1-2

Monitoring of call

msisdn

Digit string, 5-15 digits


Each digit is 0-9.

Mobile station ISDN or ISDN number

imsi

Digit string, 6-15 digits


Each digit is 0-9.

International Mobile Subscriber Identity

code

Integer

The error code

message

Text string

The error message

additionalinfo

Text string

Additional info about the error

starttime

Text string

The start time for the massive change

stoptime

Text string

The stop time for the massive change

NumberOfChangedSubscribers

Text string

Number of successfully updated subscribers

NumberOfFailedSubscribers

Text string

Number of subscribers where the change failed

6.3   Initiate Monitoring Call Forwarding Registration (HEMSMRI)

The Initiate Monitoring Call Forwarding Registration CLI allows requesting of the following information:

6.3.1   HEMSMRI Request

Command Description:

HEMSMRI:MSISDNS=msisdns,MCF=mcf[,RID=rid...];

Example of a HEMSMRI command

HEMSMRI:MSISDNS=3492783,MCF=2;

This CLI command activates the monitoring of call forwarding registration for all forwarded-to number registrations, for connected mobile subscribers within the MSISDN number series 3492783.

The following table explains the attributes that can be used in a HEMSMRI request.

Table 55    Command Attributes

Attribute

Type

Description

MCF

Integer 1-2


1 = International forwarded-to number registrations


2 = All forwarded-to number registrations

Monitoring of call forwarding registration indicator

MSISDNS

Digit string, 1-15 digits


Each digit is 0-9.

MSISDN number series

The beginning of an MSISDN number. The search will match all MSISDNnumbers beginning with the specified digits.

Condition to find subscribers for which to update SUDs

RID

Numeral 0-31, see HLR Subscriber Data Type Definitions, Reference [6].

Region Identifier

6.3.2   HEMSMRI Result File Schema

The following is a Result File schema for HEMSMRI:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
 targetNamespace="http://schemas.ericsson.com/pg/hlr/13.5/" elementFormDefault="qualified"
 attributeFormDefault="qualified">
 <xs:element name="MonitoringCallForwardingRegistrationDataLogData" minOccurs="0">
  <xs:complexType>
   <xs:sequence>
    <xs:element name="MassiveUpdateConditions">
     <xs:complexType>
      <xs:sequence>
       <xs:element name="msisdns" type="xs:string" />
       <xs:element name="mcf" type="xs:integer" />
      </xs:sequence>
     </xs:complexType>
    </xs:element>
    <xs:element name="FailedSubscriberUpdates" minOccurs="0">
     <xs:complexType>
      <xs:sequence>
       <xs:element name="Subscriber" maxOccurs="unbounded">
        <xs:complexType>
         <xs:sequence>
          <xs:element name="msisdn" type="xs:string" />
          <xs:element name="imsi" type="xs:string" />
          <xs:element name="FaultReason">
           <xs:complexType>
            <xs:sequence>
             <xs:element name="code" type="xs:integer" />
             <xs:element name="message" type="xs:string" />
             <xs:element name="additionalinfo" type="xs:string" minOccurs="0" />
            </xs:sequence>
           </xs:complexType>
          </xs:element>
         </xs:sequence>
        </xs:complexType>
       </xs:element>
      </xs:sequence>
     </xs:complexType>
    </xs:element>
    <xs:element name="MassiveUpdateStatistics">
     <xs:complexType>
      <xs:sequence>
       <xs:element name="starttime" type="xs:string" />
       <xs:element name="stoptime" type="xs:string" />
       <xs:element name="NumberOfChangedSubscribers" type="xs:integer" />
       <xs:element name="NumberOfFailedSubscribers" type="xs:integer" />
      </xs:sequence>
     </xs:complexType>
    </xs:element>
   </xs:sequence>
  </xs:complexType>
 </xs:element>
</xs:schema>

The following table covers the attributes that can be received in a HEMSMRI response.

Note:  
Error codes printed in the FaultReason element are related to the monitoring call forwarding registration activation or deactivation for a single subscriber. These errors do not stop the massive update.

If an error stops the massive update, that error code is returned in the generic XML structure, which is outside the previous schema. The generic XML structure for file responses is specified in document Generic CLI Interface Specification, Reference [1].


Table 56    Result Attributes

Attribute

Type

Description

additionalinfo

Text string

Additional info about the error

code

Integer

The error code

imsi

Digit string, 6-15 digits


Each digit is 0-9.

International Mobile Subscriber Identity

message

Text string

The error message

msisdn

Digit string, 5-15 digits


Each digit is 0-9.

Mobile station ISDN or ISDN number

msisdns

Digit string, 1-15 digits


Each digit is 0-9.

MSISDN number series


Printed if given as input parameter to the command

NumberOfChangedSubscribers

Text string

Number of successfully updated subscribers

NumberOfFailedSubscribers

Text string

Number of subscribers where the change failed

starttime

Text string

The start time for the massive change

stoptime

Text string

The stop time for the massive change

6.4   Massive Change of Primary HLR Identity (HEMSPIC)

The HEMSPIC command performs a massive change of multiple redundancy primary HLR identity for subscribers.

6.4.1   HEMSPIC Request

Command Description:

HEMSPIC[:MRDPID=mrdpid];

The HEMSPIC command triggers the following procedure:

A search is generated to fetch all subscribers with condition MRDMCH = 1. If the optional parameter MRDPID is present, only subscribers belonging to the given HLR identity and matching the condition are fetched. For each found subscriber a change request is sent towards the HLR server to generate a new Number Series Analysis that results in a new MRDPID for the given subscriber. The subscriber is updated with the new MRDPID value.

MRDMCH is a SUD data and MRDMCH =1 indicates that the Primary HLR identity is assigned using the Number Series Analysis Function. See HLR Subscriber Data Type Definitions, Reference [6], for more information.

Examples of a HEMSPIC command

HEMSPIC:MRDPID=2-10;

This CLI command triggers an update of the MRDPID for all subscribers with MRDPID =2-10 (Redundancy group= 2 and HLR identity in the group =10) and MRDMCH = 1.

HEMSPIC;

This CLI command triggers an update of the MRDPID for all subscribers with MRDMCH = 1.

The following table explains the attributes that can be used in a HEMSPIC request.

Table 57    Command Attributes

Attribute

Type

Description

MRDPID

String


Expressed as <a>- <b> where a is Redundancy Group with valid numerical values 1-15 and b is HLR Identity with valid numerical values 1-32.


For example 3-18 where 3 refers to Redundancy Group and 18 refers to HLR Identity.

Multiple Redundancy Primary HLR Identity

6.4.2   HEMSPIC Result File Schema

The following is a Result File schema for HEMSPIC:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
 targetNamespace="http://schemas.ericsson.com/pg/hlr/13.5/" elementFormDefault="qualified"
 attributeFormDefault="qualified">
 <xs:element name="MassiveChangeOfPrimaryHLRIdentity" minOccurs="0">
  <xs:complexType>
   <xs:sequence>
    <xs:element name="MassiveUpdateConditions" minOccurs="0" >
     <xs:complexType>
      <xs:sequence>
       <xs:element name="mrdpid" type="xs:string" />
      </xs:sequence>
     </xs:complexType>
    </xs:element>
    <xs:element name="FailedSubscriberUpdates" minOccurs="0">
     <xs:complexType>
      <xs:sequence>
       <xs:element name="Subscriber" maxOccurs="unbounded">
        <xs:complexType>
         <xs:sequence>
          <xs:element name="msisdn" type="xs:string" />
          <xs:element name="imsi" type="xs:string" />
          <xs:element name="FaultReason">
           <xs:complexType>
            <xs:sequence>
             <xs:element name="code" type="xs:integer" />
             <xs:element name="message" type="xs:string" />
             <xs:element name="additionalinfo" type="xs:string" minOccurs="0" />
            </xs:sequence>
           </xs:complexType>
          </xs:element>
         </xs:sequence>
        </xs:complexType>
       </xs:element>
      </xs:sequence>
     </xs:complexType>
    </xs:element>
    <xs:element name="MassiveUpdateStatistics">
     <xs:complexType>
      <xs:sequence>
       <xs:element name="starttime" type="xs:string" />
       <xs:element name="stoptime" type="xs:string" />
       <xs:element name="NumberOfChangedSubscribers" type="xs:integer" />
       <xs:element name="NumberOfFailedSubscribers" type="xs:integer" />
      </xs:sequence>
     </xs:complexType>
    </xs:element>
   </xs:sequence>
  </xs:complexType>
 </xs:element>
</xs:schema>

The following table covers the attributes that can be received in a HEMSPIC response.

Note:  
Error codes printed in the FaultReason element are related to the update of data for a single subscriber. These errors do not stop the massive update.

If an error stops the massive update, that error code is returned in the generic XML structure, which is outside the previous schema. The generic XML structure for file responses is specified in document Generic CLI Interface Specification, Reference [1].


Table 58    Result Attributes

Attribute

Type

Description

additionalinfo

Text string

Additional info about the error

code

Integer

The error code

imsi

Digit string, 6-15 digits


Each digit is 0-9

International Mobile Subscriber Identity

 

message

Text String

The error message

mrdpid

String


Expressed as <a>- <b> where a= 1-15 = Redundancy Group and b = 1-32 = HLR Identity

Multiple Redundancy Primary HLR Identity

 
 

msisdn

Digit string, 5-15 digits


Each digit is 0-9

Mobile Station ISDN or ISDN number

 

NumberOfChangedSubscribers

Text string

Number of successfully updated subscribers

NumberOfFailedSubscribers

Text string

Number of subscribers where the change failed

starttime

Text string

The start time for the massive change

stoptime

Text string

The stop time for the massive change

7   Faults or Errors

The CLI error codes can appear both directly in the prompt, and in the result files. Besides the generic and common error codes, the CLI commands can also return some more specific error codes.

7.1   General CLI Errors

The following table covers Dynamic Activation internal error codes. They can appear in any CLI responses.

Table 59    General Dynamic Activation Internal Error Codes

Error Code

Error Message

1001

Invalid resource.

1002

Invalid XPath.

1003

Unrecognized namespace. No data view associated.

1004

Access denied. Invalid principal or credentials.

1005

Not authorized to perform current operation on selected data view.

1006

Invalid parameter.

1007

The XPath failed to match any data in the processed XML.

1008

Failed to provision data.

1009

Unsupported operation.

1093

Could not process request because of limit of maximum number of concurrent ongoing CLI transactions reached.

1095

Communication error while interacting with a Network Element.

1096

Time-out expired during wait for answer from Network Element.

1097

Failure during processing of the request.

1098

Could not process request because of resource limitation.

1099

System error.

1100

Execution was canceled

1101

External error

1103

License error

7.2   Command Mapped Errors

This section covers UDC HLR/AUC Activation Interface errors that are mapped towards certain commands. The errors listed in this section can be assumed to be stopping, unless "(not stopping)" is stated. The errors are listed along with the commands that can return them.

Table 60    Command Mapped Errors

Error Code

Error Message

Command

2001

Format error

All CLI commands

2002

UNREASONABLE VALUE

All commands starting with AEMS

All commands starting with HEMS except HEMSSCP and HEMSSLP

2003

FUNCTION BUSY

AEMSAAC

AEMSSUC

HEMSMCI

HEMSMRE

HEMSMRI

2004

DATABASE UPDATE ERROR

AEMSAAC (not stopping)

AEMSSUC (not stopping)

HEMSMCI (not stopping)

HEMSMRE (not stopping)

HEMSMRI (not stopping)

2005

STORAGE IO FAILURE

All commands starting with HEMS except HEMSSCP and HEMSSLP

All commands starting with AEMS

2013

NO LOG FILE EXIST

AEMSAAC

AEMSSUC (not stopping)

HEMSMCI (not stopping)

HEMSMRI (not stopping)

HEMSMRE (not stopping)

7.3   HLR Errors

This section covers HLR errors that can be sent through UDC HLR/AUC/MNP Activation Interface. The error codes can only appear in certain commands. The commands listed in this section can be assumed to be stopping, unless "(not stopping)" is stated. The following table lists the HLR error codes for CLI.

Table 61    HLR Error Codes

Error Code

Error Message

Command

 

10014

MSISDN NOT DEFINED

HEMSMCI (not stopping)

HEMSMRE (not stopping)

HEMSMRI (not stopping)

HEMSPIC (not stopping)

10015

SUBSCRIBER DATA NOT RECOGNIZED

HEMSMCI

10031

SUBSCRIBER DATA INCLUDED MORE THAN ONCE

HEMSMCI

10032

SUBSCRIBER DATA NOT APPLICABLE

HEMSMCI

10075

FUNCTIONALITY NOT SUPPORTED BY THIS EXCHANGE

HEMSMRE

HEMSMRI

10096

ZONE CODE SET NOT DEFINED

HEMSMCI

10122

PICI-IXC RELATION DOES NOT EXIST

HEMSMCI

10149

STORAGE SHORTAGE IN GPRS DATA FILE

HEMSMCI

10151

STORAGE SHORTAGE IN FACSIMILE TRANSMISSION DATA FILE

HEMSMCI

10153

STORAGE SHORTAGE IN DATA CIRCUIT ASYNCHRONOUS DATA FILE

HEMSMCI

10154

STORAGE SHORTAGE IN DATA CIRCUIT SYNCHRONOUS DATA FILE

HEMSMCI

10176

NEW SUBSCRIBER DATA VALUE INCOMPATIBLE

HEMSMCI

10182

GENERAL BEARER SERVICE NOT SUBSCRIBED

HEMSMCI (not stopping)

10189

PARAMETER VALUE NOT SUPPORTED BY THIS EXCHANGE

HEMSMCI

10201

NO SUBSCRIBER WITH THE GIVEN CONDITIONS

HEMSMCI (not stopping)(1)

HEMSMRE

HEMSMRI

10210

APN NOT VALID

HEMSAPP

10211

APN NOT DEFINED

HEMSAPP

10220

SUBSCRIBER NETWORK ACCESS MODE HAS ALREADY THAT VALUE

HEMSMCI (not stopping)

10221

SUBSCRIBER DATA INCOMPATIBLE WITH STORED SUBSCRIBER DATA

HEMSMCI (not stopping)

HEMSPIC (not stopping)

10320

NO MORE NEW SUD ACCEPTED WITH GIVEN NEW SUD

HEMSMCI

10383

NAM VALUE NOT ALLOWED

HEMSMCI (not stopping)

10517

NO ROAMING DISTRIBUTION DATA

HESDCDP

10534

CENTRALIZED USER DATABASE NOT REACHABLE

HEMSMCI

HEMSMRE

HEMSMRI

HEMSPIC

10535

RESOURCE LIMITATION

HEMSMCI

HEMSMRE

HEMSMRI

HEMSPIC

10536

PROVISIONING PROCESS NOT FOUND

HEMSMCI (not stopping)

10600

SUBSCRIBER NOT DEFINED IN THE REGION

HEMSMCI (not stopping)

HEMSMRI (not stopping)

HEMSMRE (not stopping)

10803

SUBSCRIBER DATA NOT APPLICABLE FOR THIS SUBSCRIBER

HEMSMCI (not stopping)

(1)  This error can appear both as stopping and not stopping.


7.4   AUC Errors

This section covers AUC errors that can be sent through UDC HLR/AUC Activation Interface. The error codes can only appear in certain commands. The commands listed in this section can be assumed to be stopping, unless "(not stopping)" is stated. The following table lists the AUC error codes for CLI.

Table 62    AUC Error Codes

Error Code

Error Message

Command

 

11010

KEY DATA OPERATION IN PROGRESS

AEMSAAC

AEMSSUC

11011

IMSI NOT SUBSCRIBED

AEMSAAC (not stopping)

AEMSSUC (not stopping)

11013

SUBSCRIPTION OPERATION IN PROGRESS

AEMSAAC

11016

KEY DATA CHANGE IN PROGRESS

AEMSAAC

AEMSSUC

11020

CUSTOMER KEY OPERATION IN PROGRESS

AEMSAAC

AEMSSUC

11024

FUNCTIONALITY NOT SUPPORTED BY THIS EXCHANGE

AEMSAAC

AEMSSUC

11026

PARAMETER VALUE NOT SUPPORTED BY THIS EXCHANGE

AEMSSUC

11027

FSETIND NOT SUPPORTED

AEMSSUC

11030

OP CHANGE IN PROGRESS

AEMSAAC

AEMSSUC

11032

AKA ALGORITHM CHANGE IN PROGRESS

AEMSSUC

11039

SUBSCRIPTION DATA CHANGE IN PROGRESS

AEMSAAC

11045

BOP CHANGE IN PROGRESS

AEMSAAC

AEMSSUC

11052

NO WCDMA SUBSCRIBER DEFINED FOR SPECIFIED FSET

AEMSAAC

AEMSSUC

11053

CENTRALIZED USER DATABASE NOT REACHABLE

AEMSAAC

AEMSSUC

11055

THE SUBSCRIBER DEFINED IS NOT WCDMA

AEMSAAC (not stopping)

AEMSSUC (not stopping)

11056

THE WCDMA SUBSCRIBER DEFINED HAS NOT THE SPECIFIED FSET

AEMSAAC (not stopping)

AEMSSUC (not stopping)

11060

SUBSCRIBER NOT DEFINED IN THE REGION

AEMSAAC (not stopping)

AEMSSUC (not stopping)

11257

TABLE READ RESTRICTED

AEMSAAC

11258

TABLE DOES NOT EXIST

AEMSAAC

11259

FIELD ACCESS RESTRICTED

AEMSAAC

11260

ACCESS TEMPORARILY RESTRICTED

AEMSAAC

11264

CONGESTION IN TABLE

AEMSAAC

11266

CONGESTION IN COMMAND HANDLER

AEMSAAC

11267

CONGESTION IN FORLOPP HANDLER

AEMSAAC

11275

WRONG TABLE TYPE

AEMSAAC

11280

CONGESTION IN APZ

AEMSAAC

11284

CONGESTION IN PRINTOUT HANDLER

AEMSAAC

11288

NO TABLE AREA DEFINED

AEMSAAC

11290

TABLE WORK AREA LOCKED

AEMSAAC

11292

EXTERNAL REPR VALUE NOT DEFINED

AEMSAAC

11293

ERROR AT ACCESS OF SYSTEM TABLE

AEMSAAC

11294

NO FIELD EXTERNALLY REPRESENTED

AEMSAAC

11295

BOTH REPR AND FORMAT UNALLOWED

AEMSAAC

11302

FILE ERROR

AEMSAAC

11303

VOLUME ERROR

AEMSAAC

11304

FILE CONGESTION

AEMSAAC

11305

DEVICE FAULT

AEMSAAC

11306

CONGESTION IN FILE SYSTEM

AEMSAAC

11307

BUFFER CONGESTION

AEMSAAC

11308

END OF MEDIA

AEMSAAC

11310

SYS TAB BUILD-UP IN PROGRESS

AEMSAAC

11311

FUNCTIONALITY NOT SUPPORTED

AEMSAAC

11802

COMMAND RESTRICTED DURING DUMP

AEMSAAC

AEMSSUC

8   Appendix - HLR Classic and HLR-FE Layered Incompatibilities

For information about incompatibilities between UDB R13.0/13.2 and UDC 11B Layered Configuration, see Reference [5].


Reference List

Ericsson Documents
[1] Generic CLI Interface Specification, 15/155 19-CSH 109 628 Uen
[2] Glossary of Terms and Acronyms, 0033-CSH 109 628 Uen
[3] Library Overview, 18/1553-CSH 109 628 Uen
[4] Function Specification Layered HLR, 4/155 17-CSH 109 628 Uen
[5] User Data Register (UDR) 11B, Network Impact Report from UDB R13.0/13.2 to UDR 11B Layered Configuration, 2/10948-FGC1011354 Uen
[6] HLR Subscriber Data Type Definitions, 1/198 18-CSH 109 628 Uen


Copyright

© Ericsson AB 2017. All rights reserved. No part of this document may be reproduced in any form without the written permission of the copyright owner.

Disclaimer

The contents of this document are subject to revision without notice due to continued progress in methodology, design and manufacturing. Ericsson shall have no liability for any error or damage of any kind resulting from the use of this document.

Trademark List
All trademarks mentioned herein are the property of their respective owners. These are shown in the document Trademark Information.

    Layered HLR AUC Massive Operations over CLI         Ericsson Dynamic Activation 1