Layered EIR Massive Operations over CLI
Ericsson Dynamic Activation 1

Contents

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

2
EIR Conditional Search Commands
2.1Print Cloned Handset Users (EEMSCLP)
2.1.1EEMSCLP Request
2.1.2EEMSCLP Result File Schema
2.2Print Equipment (EEMSEQP)
2.2.1EEMSEQP Request
2.2.2EEMSEQP Result File Schema
2.3Print Search Order (EEMSSOP)
2.3.1EEMSSOP Request
2.3.2EEMSSOP Result File Schema
2.4Print Fixed SIMs (EEMSFSP)
2.4.1EEMSFSP Request
2.4.2EEMSFSP Result File Schema

3
Faults or Errors
3.1General CLI Errors
3.2Command Mapped Errors

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 Layered Equipment Identity Register (EIR), conditional search commands.

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

1.2   Target Group

The target group for this document is as follows:

For more information regarding the different target groups, see Library Overview, Reference [2].

1.3   Typographic Conventions

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

For information about abbreviations used throughout this document refer to Glossary of Terms and Acronyms, Reference [1].

2   EIR Conditional Search Commands

This section covers all EIR 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 EIR search commands are available:

2.1   Print Cloned Handset Users (EEMSCLP)

This command prints all cloned handset users.

2.1.1   EEMSCLP Request

Command Description:

EEMSCLP;

Example of an EEMSCLP command

EEMSCLP;

This CLI command prints all cloned handset users.

The following table covers the attributes that can be received in Cloned Handset Users Result File.

Note:  
The Check Digit in the IMEI value is not supported.

Table 1    Attributes

Attribute

Type

Description

Occurrence

imsi

Numeric string pattern value="[0-9]*"


minLength value="6"


maxLength value="15"

This attribute contains the IMSI associated to the equipment.

Mandatory

ClonedImei

Sub MO

Maximum five cloned IMEIs can be retrieved

Mandatory

 

imei

Numeric String Pattern value=[0-9]{2}


minLength value="14"


maxLength value="14"

This attribute contains the IMEI associated with the equipment

Mandatory

svn

String


Pattern value="[0-9]{2}"

This attribute contains the Software Version Number associated with the equipment.


SVN value 99 is reserved for future use.

Optional

2.1.2   EEMSCLP Result File Schema

Example 1   EEMSCLP Result File Schema

<xs:element name="ClonedHandsetUserData">
	<xs:complexType>
		<xs:sequence>
			<xs:element name="ClonedHandsetUser" minOccurs="0" maxOccurs="unbounded">
				<xs:complexType>
					<xs:sequence>
						<xs:element name="imsi" type="imsiType"/>
						<xs:element name="ClonedImei" maxOccurs="5">
							<xs:complexType>
								<xs:sequence>
									<xs:element name="imei" type="imeiType"/>
									<xs:element name="svn" type="svnType" minOccurs="0"/>
								</xs:sequence>
							</xs:complexType>
						</xs:element>
					</xs:sequence>
				</xs:complexType>
			</xs:element>
		</xs:sequence>
	</xs:complexType>
</xs:element>

2.2   Print Equipment (EEMSEQP)

This command prints all equipment.

2.2.1   EEMSEQP Request

Command Description:

EEMSEQP:IMEIALL[,LIST=list];

Example of an EEMSEQP command

EEMSEQP:IMEIALL,LIST=6;

This CLI command prints all IMEIs that are present in equipment list 6.

The following table covers the attributes that can be received in Equipment Result File.

Note:  
The Check Digit in the IMEI value is not supported.

Table 2    Attributes

Attribute

Type

Description

Occurrence

imei

Numeric String Pattern value=[0-9]{2}


minLength value="14"


maxLength value="14"

This attribute contains the IMEI associated with the equipment

Mandatory

svn

String


Pattern value="[0-9]{2}"

This attribute contains the Software Version Number associated with the equipment.


SVN value 99 is reserved for future use.

Optional

date

Date format is yyyy-mm-dd.

This attribute contains the date when the equipment is created.

Optional

time

Time format is hh:mm:ss.

This attribute contains the time when the equipment is created.

Optional

comment

String


minLength value="0"


maxLength value="255"

This attribute contains a comment related to why the equipment is created.

Optional

equipmentListNumber

Integer


minInclusive value="0"


maxInclusive value="9"

This attribute contains the lists for which the equipment is defined. One equipment can be included in up to 10 lists.

Optional

2.2.2   EEMSEQP Result File Schema

Example 2   EEMSEQP Result File Schema

<xs:schema xmlns="http://schemas.ericsson.com/ma/EIR/"
 xmlns:xs="http://www.w3.org/2001/XMLSchema" targetNamespace="http://schemas.ericsson.com
/ma/EIR/" elementFormDefault="qualified" attributeFormDefault="unqualified">
	<xs:include schemaLocation="../types/eirla_types.xsd"/>
	<xs:element name="EquipmentData">
		<xs:complexType>
			<xs:sequence>
				<xs:element name="Equipment" minOccurs="0" maxOccurs="unbounded">
					<xs:complexType>
						<xs:sequence>
							<xs:element name="imei" type="imeiType"/>
							<xs:element name="svn" type="svnType" minOccurs="0"/>
							<xs:element name="date" type="dateType" minOccurs="0"/>
							<xs:element name="time" type="timeType" minOccurs="0"/>
							<xs:element name="comment" type="commentType" minOccurs="0"/>
							<xs:sequence>
								<xs:element name="EquipmentListType" minOccurs="0">
									<xs:complexType>
										<xs:sequence>
											<xs:element name="equipmentListNumber" type="equipmentListNumberType"
											 minOccurs="0" maxOccurs="10"/>
										</xs:sequence>
									</xs:complexType>
								</xs:element>
							</xs:sequence>
						</xs:sequence>
					</xs:complexType>
				</xs:element>
			</xs:sequence>
		</xs:complexType>
	</xs:element>
</xs:schema>

2.3   Print Search Order (EEMSSOP)

This command prints all search orders.

2.3.1   EEMSSOP Request

Command Description:

EEMSSOP;

Example of an EEMSSOP command

EEMSSOP;

This CLI command prints all search orders.

The following table covers the attributes that can be received in search orders Result File.

Table 3    Attributes

Attribute

Type

Description

Occurrence

imsiPrefix

Numeric string pattern value="[0-9]*"


minLength value="2"


maxLength value="15"


Or


"Default"

This attribute contains the IMSI of the equipment being searched for.


A default search order must be present and is indicated by “Default” in this attribute

Mandatory

unknownResponse

Enumeration


value="Black"


value="Grey"


value="White"


value="Unknown"

This attribute contains the response returned if the IMEI being searched for is not found in any of the lists.

Mandatory

SearchOrderListEntry

Maximum five list entries can be defined

Optional

 

searchOrderListNumber

Integer


minInclusive value="1"


maxInclusive value=5"

This attribute contains the identifier of a list entry.

Mandatory

equipmentListNumber

Integer


minInclusive value="0"


maxInclusive value="9"

This attribute contains a reference to an equipment list to search.


See Equipment MO for details related to equipment lists

Mandatory

response

Enumeration


value="Black"


value="Grey"


value="White"


value="Unknown"

This attribute contains the response returned if the IMEI being searched for is found in the list identified by equipmentListNumber

Mandatory

2.3.2   EEMSSOP Result File Schema

Example 3   EEMSSOP Result File Schema

<xs:schema xmlns="http://schemas.ericsson.com/ma/EIR/"
 xmlns:xs="http://www.w3.org/2001/XMLSchema" targetNamespace="http://schemas.ericsson.com
/ma/EIR/" elementFormDefault="qualified" attributeFormDefault="unqualified">
	<xs:include schemaLocation="../types/eirla_types.xsd"/>
	<xs:element name="SearchOrderData">
		<xs:complexType>
			<xs:sequence>
				<xs:element name="SearchOrder" minOccurs="0" maxOccurs="unbounded">
					<xs:complexType>
						<xs:sequence>
							<xs:element name="imsiPrefix" type="imsiPrefixType"/>
							<xs:element name="unknownResponse" type="responseType"/>
							<xs:element name="SearchOrderListEntry" minOccurs="0" maxOccurs="5">
								<xs:complexType>
									<xs:sequence>
										<xs:element name="searchOrderListNumber"
										 type="searchOrderListNumberType"/>
										<xs:element name="equipmentListNumber" type="equipmentListNumberType"/>
										<xs:element name="response" type="responseType"/>
									</xs:sequence>
								</xs:complexType>
							</xs:element>
						</xs:sequence>
					</xs:complexType>
				</xs:element>
			</xs:sequence>
		</xs:complexType>
	</xs:element>
</xs:schema>

2.4   Print Fixed SIMs (EEMSFSP)

This command prints all Fixed SIMs.

2.4.1   EEMSFSP Request

Command Description:

EEMSFSP;

Example of an EEMSFSP command

EEMSFSP;

This CLI command prints all Fixed SIMs.

The following table covers the attributes that can be received in a Fixed SIMs Result File.

Note:  
The Check Digit in the IMEI value is not supported.

Table 4    Attributes

Attribute

Type

Description

Occurrence

imsi

Numeric string pattern value="[0-9]*"


minLength value="6"


maxLength value="15

This attribute contains the IMSI associated to the locked equipment.

Mandatory

LockedImei

 

imei

Numeric String Pattern value=[0-9]{2}


minLength value="14"


maxLength value="14"

This attribute contains the IMEI associated with the equipment

Mandatory

svn

String


Pattern value="[0-9]{2}"

This attribute contains the Software Version Number associated with the equipment that it is locked to".


SVN value 99 is reserved for future use.

Optional

2.4.2   EEMSFSP Result File Schema

Example 4   EEMSFSP Result File Schema

<xs:element name="FixedSimData">
		<xs:complexType>
			<xs:sequence>
				<xs:element name="FixedSim" minOccurs="0" maxOccurs="unbounded">
					<xs:complexType>
						<xs:sequence>
							<xs:element name="imsi" type="imsiType"/>
							<xs:element name="LockedImei">
								<xs:complexType>
									<xs:sequence>
										<xs:element name="imei" type="imeiType"/>
										<xs:element name="svn" type="svnType" minOccurs="0"/>
									</xs:sequence>
								</xs:complexType>
							</xs:element>
						</xs:sequence>
					</xs:complexType>
				</xs:element>
			</xs:sequence>
		</xs:complexType>
	</xs:element>

3   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.

3.1   General CLI Errors

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

Table 5    General PS Internal Error Codes

Error Code

Error Message

1001

Invalid resource ID.

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

3.2   Command Mapped Errors

This section covers EIR provisioning interface errors that are mapped towards certain commands. The commands listed in this section can be assumed to be stopping, unless "(not stopping)" is stated. They are listed in the following table along with the commands that can return them.

Table 6    Command Mapped Errors

Error Code

Error Message

Command

2001

FORMAT ERROR

EEMSCLP

EEMSEQP

EEMSSOP

EEMSFSP

2002

UNREASONABLE VALUE

EEMSEQP

2005

STORAGE IO FAILURE

EEMSCLP

EEMSEQP

EEMSSOP

EEMSFSP


Reference List

Ericsson Documents
[1] Glossary of Terms and Acronyms, 0033-CSH 109 628 Uen
[2] Library Overview, 18/1553-CSH 109 628 Uen
[3] Generic CLI Interface Specification, 15/155 19-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 EIR Massive Operations over CLI         Ericsson Dynamic Activation 1