Cisco RAN Management System API Guide, Release 5 · Cisco Systems, Inc. 1 RAN Management System API Reference Guide Release 5.2 First Published: Nov 17, 2015 Revised: June 13, 2016

Cisco Systems, Inc. www.cisco.com

1

RAN Management System API Reference Guide Release 5.2

First Published: Nov 17, 2015 Revised: June 13, 2016

EDCS-1534065

http://www.cisco.com/

2

THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS. THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITH THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY. The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB’s public domain version of the UNIX operating sy stem. All rights reserved. Copy right © 1981, Regents of the University of California. NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED “AS IS” WITH ALL FAULTS. CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE. IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUT LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display output, network topology diagrams, and other figures included in the document are shown for illustrative purposes only . Any use of actual IP addresses or phone numbers in illustrative content is unintentional and coincidental. All printed copies and duplicate soft copies are considered un-Controlled copies and the original on-line version should be referred to for latest version. Cisco has more than 200 offices worldwide. Addresses, phone numbers, and fax numbers are listed on the Cisco website at www.cisco.com/go/offices. Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: www.cisco.com/go/trademarks. Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company . (1110R) © 2015-2016 Cisco Systems, Inc. All rights reserved.

3

Table of Contents

1 Preface .................................................................................................................... 7

1.1 Functional Overview ............................................................................................... 8

2 PMG Provisioning API........................................................................................ 10

2.1 Register .................................................................................................................. 10

2.1.1 Request Structure ............................................................................................. 10

2.1.2 Register Response ............................................................................................... 19

2.2 Update.................................................................................................................... 20

2.2.1 Request Structure ............................................................................................. 31

2.2.2 Re sponse ......................................................................................................... 33

2.3 Static Neighbors Configuration ............................................................................ 34

2.4 Shutdow n ............................................................................................................... 44

2.4.1 Re sponse Code ................................................................................................ 45

2.5 Activate .................................................................................................................. 45

2.5.1 Re sponse ......................................................................................................... 46

2.6 Deactivate .............................................................................................................. 46

2.6.1 Re sponse ......................................................................................................... 47

2.7 Delete ..................................................................................................................... 47

2.7.1 Re sponse ......................................................................................................... 47

2.8 Block....................................................................................................................... 48

2.8.1 Re sponse ......................................................................................................... 48

2.9 Unblock .................................................................................................................. 49

2.9.1 Re sponse ......................................................................................................... 49

2.9.2 Replace Message ............................................................................................. 50

2.10 UpdateIMSI ............................................................................................................ 51

2.10.1 Re sponse ......................................................................................................... 51

2.11 GetStoredData....................................................................................................... 53

2.11.1 Re sponse ......................................................................................................... 54

2.11.2 Re sponse Message .......................................................................................... 54

2.12 GetIDs .................................................................................................................... 56

2.12.1 Response Code ................................................................................................... 56

2.13 GetLiveData........................................................................................................... 57

2.13.1 Response ........................................................................................................... 57

2.14 SetLiveData ........................................................................................................... 57

4

2.14.1 Re sponse ......................................................................................................... 58

2.15 ConnectionRequest .............................................................................................. 58

2.15.1 Re sponse ......................................................................................................... 59

2.16 ResetCPEToFactory Defaults .............................................................................. 59

2.16.1 Re sponse ......................................................................................................... 60

2.17 RebootCPE ............................................................................................................ 60

2.17.1 Re sponse ......................................................................................................... 60

2.18 GetSoftw areVersion .............................................................................................. 61

2.18.1 Request ............................................................................................................ 62

2.18.2 Re sponse ......................................................................................................... 62

3 PMG Group Management API ........................................................................... 64

3.1 GetDeviceAssignmentByGroups ......................................................................... 64

3.1.1 Re sponse ......................................................................................................... 64

3.2 GetIDPoolsByGroups............................................................................................ 64

3.2.1 Re sponse ......................................................................................................... 64

3.3 GetIDPoolsByTypes .............................................................................................. 64

3.3.1 Re sponse ......................................................................................................... 65

3.4 ReassignDev ice .................................................................................................... 65

3.4.1 Re sponse ......................................................................................................... 65

3.5 CreateGroup .......................................................................................................... 65

3.6 UpdateGroup ......................................................................................................... 67

3.6.1 Re sponse ......................................................................................................... 69

3.7 DeleteGroup .......................................................................................................... 69

3.7.1 Re sponse ......................................................................................................... 69

3.8 CreateGroupType ................................................................................................. 70

3.9 UpdateGroupType................................................................................................. 71

3.9.1 Re sponse ......................................................................................................... 72

3.10 DeleteGroupType .................................................................................................. 72

3.10.1 Re sponse ......................................................................................................... 72

3.11 CreatePool ............................................................................................................. 73

3.11.1 Re sponse ......................................................................................................... 73

3.12 UpdatePool ............................................................................................................ 73

3.12.1 Re sponse ......................................................................................................... 75

3.13 DeletePool ............................................................................................................. 75

3.13.1 Re sponse ......................................................................................................... 75

5

3.14 CreatePoolType .................................................................................................... 75

3.14.1 Re sponse ......................................................................................................... 76

3.15 UpdatePoolType.................................................................................................... 76

3.15.1 Re sponse ......................................................................................................... 77

3.16 DeletePoolType ..................................................................................................... 77

3.16.1 Re sponse ......................................................................................................... 77

3.17 GetGroupNames ................................................................................................... 78

3.18 GetGroupsDetails .................................................................................................. 78

3.19 GetGroupTypeNames ........................................................................................... 78

3.20 GetGroupTypesDetails ......................................................................................... 79

3.21 GetPoolNames ...................................................................................................... 79

3.22 GetPoolsDetails ..................................................................................................... 79

3.23 GetPoolTypeNames .............................................................................................. 80

3.24 GetPoolTypesDetails ............................................................................................ 80

4 Event Subscription ............................................................................................. 82

4.1 Subscribe ............................................................................................................... 82

4.1.1 Events .............................................................................................................. 84

4.2 Unsubscribe......................................................................................................... 101

5 User Management NB API ............................................................................... 102

5.1 General ................................................................................................................ 102

5.1.1 Schema .......................................................................................................... 102

5.1.2 Accessing API ................................................................................................ 102

5.2 GetUMRoles ........................................................................................................ 102

5.2.1 Request .......................................................................................................... 104

5.2.2 Re sponse ....................................................................................................... 104

5.3 GetUMRoleAccessLevels ................................................................................... 108

5.3.1 Request .......................................................................................................... 109

5.3.2 Re sponse ....................................................................................................... 109

5.4 CreateUMRole..................................................................................................... 112

5.4.1 Request .......................................................................................................... 112

5.4.2 Re sponse ....................................................................................................... 113

5.5 UpdateUMRole .................................................................................................... 114

5.5.1 Request .......................................................................................................... 114

5.5.2 Re sponse ....................................................................................................... 115

5.6 DeleteUMRole ..................................................................................................... 115

6

5.6.1 Request .......................................................................................................... 115

5.6.2 Re sponse ....................................................................................................... 115

5.7 CreateUser .......................................................................................................... 115

5.7.1 Request .......................................................................................................... 116

5.7.2 Re sponse ....................................................................................................... 116

5.8 GetUsers .............................................................................................................. 116

5.8.1 Request .......................................................................................................... 116

5.8.2 Re sponse ....................................................................................................... 117

5.9 GetUserDetail ...................................................................................................... 117

5.9.1 Request .......................................................................................................... 117

5.9.2 Re sponse ....................................................................................................... 118

5.10 DeleteUser ........................................................................................................... 118

5.10.1 Request .......................................................................................................... 118

5.10.2 Re sponse ....................................................................................................... 120

5.11 UpdateUserPassw ord ......................................................................................... 120

5.11.1 Request .......................................................................................................... 120

5.11.2 Re sponse ....................................................................................................... 120

5.12 UpdateUserUMRole ............................................................................................ 120

5.12.1 Request .......................................................................................................... 121

5.12.2 Re sponse ....................................................................................................... 121

5.13 LockUser .............................................................................................................. 122

5.13.1 Request .......................................................................................................... 122

5.13.2 Re sponse ....................................................................................................... 122

5.14 UnLockUser ......................................................................................................... 123

5.14.1 Request .......................................................................................................... 123

5.14.2 Re sponse ....................................................................................................... 123

5.15 UpdateUser .......................................................................................................... 123

5.15.1 Request .......................................................................................................... 124

5.15.2 Re sponse ....................................................................................................... 125

6 Glossary.............................................................................................................. 126

7

1 Preface The Cisco Provisioning Management Gatew ay (PMG) is a generic provisioning and management application that provides the necessary w orkflow component betw een the Service Provider (SP) IT or Operations Support Systems (OSS) applications and the Cisco provisioning Broadband Access Center (BAC). These OSS applications include service management and custom care systems.

8

1.1 Functional Overview

PMG is an integration platform for the provisioning and management functions in the CISCO RMS solution. PMG enables the Service Provider (SP) Operations Support System (OSS) to send request messages, w hich can be provisioning f low messages or FAP/system management messages. All messages are XML over HTTP. Depending on the message, the PMG scriptable w orkflow engine takes care of coordinating the necessary message w orkflow among the various entities in the CISCO RMS solution.

The application provides an Extensible Markup Language (XML) interface over Hypertext Transfer Protocol (HTTP) based Application Programming Interface (API) to the OSS that hides the complexity of the BAC API. The PMG API addresses the needs of a given deployment by configuring the PMG profile that defines the elements of the API (such as messages, parameters, and so on) that are applicable.

Follow ing are a few features that the PMG supports:

• Register, Update, Delete, Activate, Shutdow n, Factory Reset, Block, UnBlock, Deactivate, Reboot and Replace of the Devices and so on.

• Group and Pool Management API

• Access to stored and live data of devices

• Event subscription

The PMG API is defined by a profile, w hich is an XML document that describes the inbound messages that the PMG supports. The XML schema provides a means for defining the structure, content, and semantics of the XML document. The XML schema for the profile specif ies the inbound requests, the required elements, excluded elements, ignored elements, and the applicable parameters. These parameter elements include name, type, readable, w ritable, deletable, and source type along w ith optional validation and source key.

Note: The particualr xml supported element parameters can be verified using the pmg-profile.xml file. The PMG API uses standard HTTP requests (POSTs) that allow the OSS to provision and manage devices. PMG acknow ledges to the requests w ith HTTP responses.

Each HTTP message includes XML as content and responses use HTTP status codes. PMG, for request messages accepts HTTP content-type of either application/xml or text/xml and the response HTTP content-type is alw ays text/xml.

Note: The RMS exposes PMG messages in "javascript" which the operator can modify if they need a different implementation.

9

Table 1-1 lists a few standard HTTP status codes used in validating the PMG messages:

Table 1-1 PMG HTTP Status Codes

Sl. No.

HTTP Status Codes Description

1. 200 OK PMG sends HTTP 200 OK status code for every PMG messages that are provessed by PMG. PMG message transaction status message is embedded in this response.

2. 400 Bad Request Occurs w hen the request received does not contain a valid PMG message (for example, w rong encoding).

3. 503 Service Unavailable Used w hen the service is unavailable, typically due to high load or PMG is in maintenance mode.

Note: The client can retry sending request after some time.

Follow ing is the URL for defining the HTTP POST messages to PMG:

http://<host name>:8083/pmg/

Where,

• <host name>: is the central node Eth1 IP address

• /pmg, is the pmg path.

Digest authentication is supported in PMG.

The default username for PMG digest authentication is ‘pmguser’ and it is defined in pmgServer.properties

Additional API users can be addedthrough the dcc_ui admin tab or the RMS-API. Two kinds of user roles are supported for PMG . pmgadmin - with admin access to create/delete or manage pmg users and read-write access to the API.The default user pmgadmin is present under this role to create/delete/update pmgusers through the UI or the RMS-API pmgreadonly – with read only access to the API.

10

2 PMG Provisioning API

The follow ing are the four major classif ications of PMG messages grouped w ith respect to functionalties. :

• Provisioning messages

• Device control messages

• Group Management messages

• Event Notif ication messages

The inbound request messages allow stored data manipulation such as Register, Update, Delete, as w ell as operations that directly interact w ith the CPE such as Reboot, Set live Data and Get Live Data. The stored data are pushed on to the device through connection request messages. The follow ing sections describe the available PMG messages based on the usage.

PMG XML API are synchronous API call w hich are send over HTTP Post method and respose is send back w ith HTTP respose 200 OK.

The PMG response codes are:

• 0- success

• 2xx- Warnings

• 4xxx – Errors

• 5xxx – Global error

Note: The Mandatory Parameters to be present in xml can be tracked using the “min occurs”. If the min occurs value is "1", and then it is a Mandatory parameter. PMG Messages are transported over HTTP w ith digest authentication support. HTTP pipelining and chunking are supported.

2.1 Register Register message is used to provision Small Cell device to RMS system.

This provide common interface for supporting UMTS and LTE devices for residential and enterprise deployment mode.

Register message contains multiple elements to configure different parameter w ith respect to RAT type.

2.1.1 Request Structure Follow ing is the Request structure:

<xs:complexType> <xs:all>

11

<xs:element name="TxnID" type="TxnIDType" minOccurs="1" maxOccurs="1"/> <xs:element name="EID" type="EIDType" minOccurs="1" maxOccurs="1"/> <xs:element name="SecondaryID" type="SecondaryIDType" minOccurs="0" maxOccurs="1"/> <xs:element name="SubscriberID" type="SubscriberIDType" minOccurs="0" maxOccurs="1"/> <xs:element name="UMTS" type="UMTSType" minOccurs="0" maxOccurs="1"/> <xs:element name="LTE" type="LTEType" minOccurs="0" maxOccurs="1"/> <xs:element name="DeploymentMode" type="DeploymentModeType" minOccurs="0" maxOccurs="1"/> <xs:element name="Activated" type="xs:boolean" minOccurs="0" maxOccurs="1"/> <xs:element name="ExpectedLocation" type="ExpectedLocationType" minOccurs="0" maxOccurs="1"/> <xs:element name="GroupMemberships" type="GroupsType" minOccurs="0" maxOccurs="1"/> <xs:element name="AccessControl" type="AccessControlType" minOccurs="0" maxOccurs="1"/> <xs:element name="Parameters" type="ParametersType" minOccurs="0" maxOccurs="1"/> </xs:all> </xs:complexType>

Register Paramter detials

Element Name Description UMTS/LTE

Applicable

TxnID Unique transaction ID of type string w ith max size of 100 characters. Ex,

<TxnID> Register-0202201412345 </TnxID>

This is mandatory parameter.

Both

12

EID Device equipment ID of LTE and UMTS device w hich contains OUI(6 characters length, allow ed chars 0-9A-F) and a SerialNumber of the form OUI-SerialNumber.

Ex,

<EID>00000C-ABC123456789<EID>


Both

SecondaryID A secondary identif ier for the CPE w hich is unique and

can be any FQDN w ith max size of 100. <SecondaryID>IND-KA-03EZ45451234</ SecondaryID>

This is optional parameter.

Both

SubscriberID Thi is a subscriber identif ier. Typically this is the primary telephone number of the subscriber. This is of type string w ith out any size limit. <SubscriberID>MyName1001</SubscriberID>


Both

13

UMTS Specif ies techonology type of the device is UMTS. It has group of UMTS related parameter that can be set optionally.

Ex. Just to specify the device technology type is UMTS.

<UMTS> </UMTS > Ex. Specify technology type is UMTS and also specify optional arguments.

<UMTS>

<SAI>

<MCC>405</MCC>

<MNC>40</MNC>

<LAC>1234</LAC>

<SAC>345</SAC>

</SAI>

<CID>34</CID>

</UMTS>

o SAI – A Service Area Identif ier (SAI). The concatenation of PLMN ID (MCC+MNC), LAC, and SAC uniquely identif ies the Service Area ID (SAI).

o CID – Cell Identif ier (C-id) that identif ies a cell w ithin an RNS.

By default It is considered as UMTS techlonogy type and SAI & CID is assigned by RMS w hen not specif ied.


UMTS

14

LTE Specif ies techonology type of the device is LTE. It has group of LTE related parameters that can be set optionally.

Ex. Just to specify the device technology type is LTE.

<LTE> </LTE>

Ex. Specify technology type is LTE and also specify below arguments.

<LTE>

<CellID>3412341</CellID>

</LTE>

• CellID – LTE Cell Identif ier

CellID is assigned by RMS if not specif ied.


LTE

DeploymentMode This is applicable only for enterprise AP registration.

This specif ies role and purpose of AP.

The supported AP roles are ‘ActiveEntry’, ‘IdleEntry’ and ‘Inner’. Supported Purpuse values are ‘Capacity’ and ‘Coverage’.

Ex.

<DeploymentMode>

<Role>ActiveEntry</Role>

<Purpose>Capacity</Purpose>

<DeploymentMode>

Default role is IdleEntry and default purpose is Coverage if not specif ied.

Note: When ‘Inner’ AP role is specif ied, purpose value selection is not applicable. It w ill be ignored if specif ied. This is optional parameter.

Both

Activated Specif ies if AP is to be activated.

<Activated>true</Activated>

Default value is false.


Both

15

ExpectedLocation The expected location specif ied by latitude/longitude and/or list of DNM (MCC/optional MNC) and/or list Radio neighbor ID(s).

Ex- GPS co-ordinates. This is also used for polygon lookup from PMG-DB if no Area Group association is found in Register message.

<ExpectedLocation>

<ExpectedLatitude>32.66390097</ExpectedLatitude>

<ExpectedLongitude>-6.904765</ExpectedLongitude>

</ExpectedLocation>

Ex- Radio neighbour: <EDNIDList>

<RadioNeighbor>

<Radio2GNeighborID>

<MCC>123</MCC>

<MNC>123</MNC>

<LAC>6500</LAC>

<CID>200</CID>

</Radio2GNeighborID>

</RadioNeighbor>

<RadioNeighbor>

<Radio3GNeighborID>

<MCC>123</MCC>

<MNC>321</MNC>

<RNCID>510</RNCID>

<CID>6500</CID>


</RadioNeighbor>

</EDNIDList>

Ex DNM list: <DNMIDList>

<DNM>

<MCC>250</MCC>

<MNC>210</MNC>

</DNM>

</DNMIDList>

Note: This is optional element.

Both

16

GroupMemberships RMS groups that need to be associated to the device are specif ied here. There are certain MANDATORY groups to be specif ied, based on w hether AP is deployed in residential or enterprise mode, and w hether it is UMTS or LTE.

Mandatory groups for UMTS:

For Residential mode, either Area (polygon) group OR lat-long (through ExpectedLocation element) must be specif ied. Lat-Long, if specif ied, w ill be used for polygon lookup from PMG-DB.

For Enterprise mode, Enterptise and Site group must be specif ied.

Mandatory groups for LTE:

LTE AP requires the same mandatory groups for Residential and Enterprise mode as specif ied above, in addition to LTEProvisioning Group.

Optional Groups:

In addition to above groups, other groups like Alarm, RFprofile, Management, etc can be optionally specif ied.

Example, <GroupMemberships>

<Group>

<Name>Cisco</Name>

<Ty pe>Enterprise</Ty pe>

</Group>

<Group>

<Name>INDBGL25</Name>

<Ty pe>Site</Ty pe>

</Group>

</GroupMemberships>


Both

17

AccessControl Specif ies access control for the CPE.

AccessMode is either ‘Open’ or ‘Closed’.

AccessControlList contails list of IMSIs for those CPE access to be granded.

Example, <AccessControl>

<AccessMode>Closed</AccessMode>

<AccessControlList>

<IMSI>123456789012345</IMSI>

<IMSI>123456789012346</IMSI>

<IMSI>123456789012347</IMSI>

</AccessControlList>

</AccessControl>

This is optional parameter, by def ault access mode is ‘Open’.

NOTE: As of now, only open-mode is supported for LTE AP. For UMTS, both Open and Closed mode are supported.

Both

Parameters In addition to stanadard Register message elements, Parameters element provides option to provision other parameters on AP via RMS custom properties. <Parameters>

<Parameter>

<Name>FC-REM-3G-ARFCN-LIST</Name>

<Value>345,567</Value>

</Parameter>

<Parameter>

<Name>MAX-UL-TX-POWER </Name>


</Parameter>

</Parameters>

This is optional element.

Both

i) UMTS Residential sample registration w ith ONLY mandatory elements: <Register xmlns="http:/ /www.cisco.com/ca/sse/PM GMessages- v3_0_0">

<TxnID>Register-TxnID- 7666< /T xnID>

<EID>000000-00000000000001</EID>

<UMTS></UMTS>

<GroupMemberships>

<Group>

18

<Name>Area-1</Name>

<Type>Area</Type>

</Group>

</GroupMemberships>

</Register>

ii) UMTS Enterprise sample registration w ith ONLY mandatory elements: <Register xmlns="http:/ /www.cisco.com/ca/sse/PM GMessages- v3_0_0">


<EID>000000-00000000000001</EID>

<UMTS></UMTS>

<GroupMemberships>

<Group>

<Name>ATT</Name>

<Type>Enterprise</T ype>

</Group>

<Group>

<Name>CA-building21</N ame>

<Type>Site</Type>

</Group>

</GroupMemberships>

<DeploymentMode>

<Purpose>Cover age</Pur pose>

<Role>ActiveEntr y</R ole>

</DeploymentMode>

</Register>

iii) LTE Residential sample registration w ith ONLY mandatory elements: <Register xmlns="http:/ /www.cisco.com/ca/sse/PM GMessages- v3_0_0">


<EID>000000-00000000000001</EID>

<GroupMemberships>

<LTE></LTE>

<Group>

<Name>Santa-Clara</N ame>

<Type>Area</Type>

</Group>

</GroupMemberships>

<Parameter>

<Name>FC-TAC-ID</Name>

<Value>1234</Value>

</Parameter>

19

</Parameters>

</Register>

iv) LTE Enterprise sample registration w ith ONLY mandatory elements: <Register xmlns="http:/ /www.cisco.com/ca/sse/PM GMessages- v3_0_0">


<EID>000000-00000000000001</EID>

<LTE></LTE>

<GroupMemberships>

<Group>

<Name>ATT</Name>

<Type>Enterprise</T ype>

</Group>

<Group>

<Name>CA-building21</N ame>

<Type>Site</Type>

</Group>

</GroupMemberships>

<Parameter>

<Name>FC-TAC-ID</Name>

<Value>1234</Value>

</Parameter>

</Parameters>

<DeploymentMode>

<Purpose>Cover age</Pur pose>

<Role>ActiveEntr y</R ole>

</DeploymentMode>

</Register>

2.1.2 Register Response These are the supported status code for the register request.

0 Success

202 Some elements have been ignored

401 Missing required element

402 Excluded element found

403 Unknown parameter name

404 Invalid parameter value

407 RDU unavailable

411 Unknown group

412 No Area found for expected location

20

415 Unexpected error

416 Could not assign id(s) property

501 Batch request timed out from BAC RDU

RegisterResponse XML <RegisterResponse xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0">

<TxnID>Register-TxnID-7666</TxnID>

<Status><Code>0</Code><Message> Success</Message></Status>

</RegisterResponse>

2.2 Update Update message is used to update any property or group of the registered device. The follow ing is the XSD format of the update message. This message has separate section to add/update or remove StaticNeighbors.

The follow ing is the XSD structure of of update message

<xs:element name="Update"> <xs:complexType> <xs:sequence> <xs:element name="TxnID" type="TxnIDType" minOccurs="1" maxOccurs="1"/> <xs:choice minOccurs="1" maxOccurs="1"> <xs:element name="EID" type="EIDType"/> <xs:element name="Secondary ID" type="SecondaryIDType"/> </xs:choice> <xs:element name="Updates" minOccurs="0" maxOccurs="1"> <xs:complexType> <xs:all> <xs:element name="Secondary ID" type="SecondaryIDType" minOccurs="0" maxOccurs="1"/> <xs:element name="Subscriber ID" type="SubscriberIDType" minOccurs="0" maxOccurs="1"/> <xs:element name="UMTS" type="UMTSType" minOccurs="0" maxOccurs="1"/> <xs:element name="LTE" type="LTEType" minOccurs="0" maxOccurs="1"/> <xs:element name="DeploymentMode" type="DeploymentModeType" minOccurs="0" maxOccurs="1"/> <xs:element name="AccessControl" type="AccessControlType" minOccurs="0" maxOccurs="1"/> <xs:element name="ExpectedLocation" type="ExpectedLocationType"

21

minOccurs="0" maxOccurs="1"/> <xs:element name="GroupMemberships" type="GroupsType" minOccurs="0" maxOccurs="1"/> <xs:element name="Parameters" type="ParametersType" minOccurs="0" maxOccurs="1"/> <xs:element name="StaticNeighbors" type="StaticNeighborsType" minOccurs="0" maxOccurs="1"/> </xs:all> </xs:complexType> </xs:element> <xs:element name="Removals" minOccurs="0" maxOccurs="1"> <xs:complexType> <xs:all> <xs:element name="Secondary ID" minOccurs="0" maxOccurs="1"/> <xs:element name="Subscriber ID" minOccurs="0" maxOccurs="1"/> <xs:element name="AccessControl" type="AccessControlType" minOccurs="0" maxOccurs="1"/> <xs:element name="ExpectedLocation" minOccurs="0" maxOccurs="1"/> <xs:element name="GroupMemberships" type="GroupsType" minOccurs="0" maxOccurs="1"/> <xs:element name="ParameterNames" type="ParameterNamesType" minOccurs="0" maxOccurs="1"/> <xs:element name="StaticNeighbors" type="StaticNeighborsType" minOccurs="0" maxOccurs="1"/> </xs:all> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element>

Note: If the same parameter or element present in both <updates> and <removals> section, <updates> takes the precedence. Update message provides the option to modify/delete the device provisioning parameters such as group, IDs, whitelist information, and so on.

There are tw o sections in the update message:

a) Updates section The Update section contains the elements that can be added and modif ied.

b) Removals section

22

Remove section contains the elements that can be removed.

The follow ing table describes elements for Updates section in Update message

Element Name Description UMTS/LTE

<Updates></Updates> The elements to be added or modif ied w ill be specif ied inside <Updates></Updates> element.

SecondaryID A secondary identif ier for the CPE w hich is unique and can be any string w ith max size of 100. Existing SecondaryID values w ill be replaced by specif ied values here.

<SecondaryID>IND-KA-03EZ45451234</ SecondaryID>

White Spaces are not allow ed & Case Sensitivity is Considered.

Both

SubscriberID Thi is a subscriber identif ier. Typically this is the primary telephone number of the subscriber. This is of type string w ith out any size limit.

<SubscriberID>MyName1001</SubscriberID>

Both

23

UMTS It specif ies UMTS specif ic parameters like SAI and CID that can be updated.

Ex. Technology type is UMTS and specif ies optional arguments. <UMTS>

<SAI>

<MCC>405</MCC>

<MNC>40</MNC>

<LAC>1234</LAC>

<SAC>345</SAC>

</SAI>

<CID>34</CID>

</UMTS>

o SAI – A Service Area Identif ier (SAI). The concatenation of PLMN ID (MCC+MNC), LAC, and SAC uniquely identif ies the Service Area ID (SAI).

o CID – Cell Identif ier (C-id) that identif ies a cell w ithin an RNS.

SAI and CID are optional, and are only supported UMTS specific parameters at present.

Note: Technology type of the device can’t be changed and only umts supported params are updated.

UMTS

24

LTE It specif ies LTE specif ic parameters like ECGI and TAC that can be updated.

Ex. Technology type is LTE and specif ies optional arguments.

<LTE>


</LTE>

CellID – LTE Cell Identif ier


<LTE>


</LTE>

• CellID – LTE Cell Identif ier


Note: Technology type of the device can’t be changed and only LTE supported params are updated.

LTE

DeploymentMode This is applicable only for Enterprise APs.

This specif ies role of AP and pupose of AP.

The supported AP roles are ‘ActiveEntry’, ‘IdleEntry’ and ‘Inner’. Supported Purpuse values are ‘Capacity’ and ‘Coverage’.

Ex.

<DeploymentMode>

<Role> ActiveEntry </Role>

<Purpose>Capacity</Purpose>

<DeploymentMode>

Note: When ‘Inner’ AP role is specif ied, purpose value is not applicable.

Both

25

Activated Specif ies if AP to be activated(true) or deactivated(false).

<Activated> true</Activated>

Both


AccessMode is either ‘Open’ or ‘Closed’.

AccessControlList contails list of IMSIs for those CPE access to be granted.

If the access control mode is Open, <AccessControlList> is not applicable.


<AccessMode>Closed</AccessMode>

<AccessControlList>

<IMSI>123456789012345</IMSI>

<IMSI>123456789012346</IMSI>

<IMSI>123456789012347</IMSI>


</AccessControl>

Both

26

ExpectedLocation The expected location specif ied by latitude/longitude and/or list of DNM (MCC/optional MNC) and/or list Radio neighbor ID(s).

Ex- GPS co-ordinates. <ExpectedLocation> <ExpectedLatitude>32.663907</ExpectedLatitude> <ExpectedLongitude>-6.90476</ExpectedLongitude>

</ExpectedLocation>

Note: ExpectedLatitude & ExpectedLongitude are decimal ty pe.

Ex- Radio neighbour <EDNIDList>

<RadioNeighbor>

<Radio2GNeighborID>

<MCC>123</MCC>

<MNC>123</MNC>

<LAC>6500</LAC>

<CID>200</CID>


</RadioNeighbor>

<RadioNeighbor>

<Radio3GNeighborID>

<MCC>123</MCC>

<MNC>321</MNC>

<RNCID>510</RNCID>

<CID>6500</CID>


</RadioNeighbor>

</EDNIDList>

Ex DNM list <DNMIDList>

<DNM>

<MCC>250</MCC>

<MNC>210</MNC>

</DNM>

</DNMIDList>


Both

27

GroupMemberships The groups w hich are previously associated to the device can be replaced by another group of the same grouptype.

Entirely new group instance w hose type w as not previous associated to the device can also be specif ied.

For Residential mode, Area group of the device can be replaced by another group. Meaning, Device can be moved from one Area to another Area.

Similarly, Device can be moved to another Site belong to same Enterproise group.

For LTE, Device can be moved to another LTEProvisioning Group.

In Addition to above groups, other groups like Alarm, RFprofile, Management, etc can be associated.


<Group>

<Name>Cisco</Name>

<Ty pe>Enterprise</Ty pe>

</Group>

<Group>

<Name>INDBGL25</Name>

<Ty pe>Site</Ty pe>

</Group>

</GroupMemberships>

Both

28

Parameters In addition to standard Update message elements, Parameters element provides option to provision other parameters on AP via RMS custom properties. <Parameters>

<Parameter>

<Name>FC-REM-3G-ARFCN-LIST</Name>


</Parameter>

<Parameter>

<Name>MAX-UL-TX-POWER </Name>


</Parameter>

</Parameters>

This is optional element.

Both

StaticNeighbors Static neighbour is described in section “

2.3 Static Neighbors Configuration”

The follow ing table describes Removals elements of the Update message

Elements name in Removals

Description UMTS/LTE

SecondaryID This element indicates SecondaryID to be removed from Device.

<SecondaryID></SecondaryID>

This is optional paramter

Both

SubscriberID This element indicates that SubscriberID to be removed from Device.

< SubscriberID></ SubscriberID>

Both

29


AccessControlList contails list of IMSIs for those CPE access to be disabled.

If the access control mode is Open, <AccessControlList> is not applicable.


<AccessControlList>

<IMSI>123456789012345</IMSI>

<IMSI>123456789012346</IMSI>

<IMSI>123456789012347</IMSI>


</AccessControl>

AccessMode can’t be removed and w ill be ignored if specif ied.

Both

ExpectedLocation This element indicates all previously specif ied ExpectedLocation to be removed from Device. <ExpectedLocation></ExpectedLocation>

Expected Locations are GPS, DNM and EDN list.


Both

30

GroupMemberships RMS groups that need to be disassociated from the device are specif ied here. There are certain MANDATORY groups that CAN’T be disassociated.

The UMTS mandatory groups like Area, Enterptise, Site and FemtoGatew ay groups can’t be disassociated.

Similarly, the LTE mandatory groups like LTEProvisioningGroup, Area, Enterprise, Site and HeNB-Gatew ay groups can’t be disassociated.

Any custom defined groups like Alarm, RFprofile, Management, etc can be specif ied.


<Group>

<Name>cisco-pc1</Name>

<Ty pe>Alarm</Ty pe>

</Group>

<Group>

<Name>rf prof ile1</Name>

<Ty pe>RFprof ile</Ty pe>

</Group>

</GroupMemberships>

This group disassiation removes the properties specif ied in the groups from Devices.

Both

ParameterNames This specif ies the parameters names w hich are to be removed from Device. Only the custom properties defined at the device level can be removed. The custom properties defined at the hierarchy (group) level can’t be removed through this section.

Both

StaticNeighbors Static neighbour is described in section “

2.3 Static Neighbors Configuration”

31

2.2.1 Request Structure <xs:sequence> <xs:element name="TxnID" type="TxnIDType" minOccurs="1" maxOccurs="1"/> <xs:choice minOccurs="1" maxOccurs="1"> <xs:element name="EID" type="EIDType"/> <xs:element name="SecondaryID" type="SecondaryIDType"/> </xs:choice> <xs:element name="Updates" minOccurs="0" maxOccurs="1"> <xs:complexType> <xs:all> <xs:element name="SecondaryID" type="SecondaryIDType" minOccurs="0" maxOccurs="1"/> <xs:element name="SubscriberID" type="SubscriberIDType" minOccurs="0" maxOccurs="1"/> <xs:element name="UMTS" type="UMTSType" minOccurs="0" maxOccurs="1"/> <xs:element name="LTE" type="LTEType" minOccurs="0" maxOccurs="1"/> <xs:element name="DeploymentMode" type="DeploymentModeType" minOccurs="0" maxOccurs="1"/>

<xs:element name="AccessControl" type="AccessControlType" minOccurs="0" maxOccurs="1"/> <xs:element name="ExpectedLocation" type="ExpectedLocationType" minOccurs="0" maxOccurs="1"/> <xs:element name="GroupMemberships" type="GroupsType" minOccurs="0" maxOccurs="1"/> <xs:element name="Parameters" type="ParametersType" minOccurs="0" maxOccurs="1"/> <xs:element name="StaticNeighbors" type="StaticNeighborsType" minOccurs="0" maxOccurs="1"/> </xs:all> </xs:complexType> </xs:element>

32

<xs:element name="Removals" minOccurs="0" maxOccurs="1"> <xs:complexType> <xs:all> <xs:element name="SecondaryID" minOccurs="0" maxOccurs="1"/> <xs:element name="SubscriberID" minOccurs="0" maxOccurs="1"/> <xs:element name="AccessControl" type="AccessControlType" minOccurs="0" maxOccurs="1"/> <xs:element name="ExpectedLocation" minOccurs="0" maxOccurs="1"/> <xs:element name="GroupMemberships" type="GroupsType" minOccurs="0" maxOccurs="1"/> <xs:element name="ParameterNames" type="ParameterNamesType" minOccurs="0" maxOccurs="1"/> <xs:element name="StaticNeighbors" type="StaticNeighborsType" minOccurs="0" maxOccurs="1"/> </xs:all> </xs:complexType> </xs:element> </xs:sequence>

33

2.2.2 Response 0 Success

201 CPE off line


204 HNB-GW unable to be contacted



403Unknow n parameter name

404Invalid parameter value

405 Unknow n CPE

406 Unknow n subscriber ID

407 RDU unavailable

408 Delete not permitted for Parameter

410 Update not permitted for Parameter

411 Unknow n group

415 Unknow n error

423 Duplicate primary key instance


Elements mentioned in the update section are the same as in the Register message. The only difference is that AccessModeType cannot be changed.

In remove section,

SAI – The entire SAI block properties w ill be removed. There is no option to remove MCC/MNC and SAC ID individually.

GroupMemberships – Area and FemtoGatew ay group cannot be removed for UMTS. Similarly, LTEProvisioning, HeNBGW group cannot be removed for LTE.

• ExpectedLocation – All the previously set expected location are removed.

• AccessControl - Specif ied IMSIs w ill be removed. Access control mode cannot be removed.

• ParameterNames – Specif ied parameters are removed.

NOTE: If the update of AP does not required the group change then that group membership should not be provided in updated request. e.g. if the Cell ID of the AP needs to be updated such that AP after updation of cell ID, w ill still remain in the same area then the update message should not be having the group memebership/or the area defined in the update request

34

2.3 Static Neighbors Configuration Static neighbors can be configured for enterprise APs, both for UMTS and LTE.

UMTS static neighbour can be of 2 types viz. inter-Frequency and inter-RAT neighbors.

LTE static neighbors can be of 3 types viz. inter-rat GSM, inter-rat UMTS, and LTE CELL neighbors.

The follow ing is the XSD specif ication for ADD/UPDA TE/DELETE operation of Static Neighbors. Static Neighbors need to be configured as part of Update message as per below XSD spec:

<xs:complexType name="StaticNeighborsType"> <xs:sequence> <xs:element name="StaticNeighboringFilteringEnable" type="xs:boolean" minOccurs="0" maxOccurs="1"/> <xs:element name="FemtoNeighboringFilteringEnable" type="xs:boolean" minOccurs="0" maxOccurs="1"/> <xs:choice minOccurs="1" maxOccurs="1"> <xs:element name="UMTSStaticNeighbor" type="UmtsStaticNeighborType"/> <xs:element name="LTEStaticNeighbor" type="LteStaticNeighborType"/> </xs:choice> </xs:sequence> </xs:complexType> <xs:complexType name="UmtsStaticNeighborType"> <xs:annotation> <xs:documentation> A list of inter-freq and inter-rat neighbors, and their associated parameter names and values. </xs:documentation> </xs:annotation> <xs:sequence> <xs:element name="InterFreq" type="NeighborType" minOccurs="0" maxOccurs="unbounded"/> <xs:element name="InterRat" type="NeighborType" minOccurs="0" maxOccurs="unbounded"/> </xs:sequence> </xs:complexType> <xs:complexType name="LteStaticNeighborType"> <xs:annotation> <xs:documentation>

35

 A list of inter-rat GSM, inter-rat UMTS, and LTE CELL neighbors, and their associated parameter names and values. </xs:documentation> </xs:annotation> <xs:sequence> <xs:element name="LteInterRatGsm" type="NeighborType" minOccurs="0" maxOccurs="unbounded"/> <xs:element name="LteInterRatUmts" type="NeighborType" minOccurs="0" maxOccurs="unbounded"/> <xs:element name="LteCell" type="NeighborType" minOccurs="0" maxOccurs="unbounded"/> </xs:sequence> </xs:complexType> <xs:complexType name="NeighborType"> <xs:annotation> <xs:documentation> A single instance of neighbor type, with its associated parameter names and values. </xs:documentation> </xs:annotation> <xs:sequence> <xs:element name="Parameter" type="ParameterType" minOccurs="1" maxOccurs="unbounded"/> </xs:sequence> </xs:complexType>

i) Sample XML for UMTS static neighbors (tw o Inter-Frequency and Tw o Inter-Rat neighbors), UPDATE and DELETE operation:

<?xml version="1.0" encoding="UTF-8"?> <Update xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:schemaLocation="http://www.cisco.com/ca/sse/PMGMessages- v3_0_0 pmg-messages-v3_0_0.xsd"> <TxnID>update-txn-1234567868</TxnID> <EID>123456-1234567899</EID> <Updates>

36

<StaticNeighbors> <StaticNeighboringFilteringEnable>true</StaticNeighboringFilteringEnable> <FemtoNeighboringFilteringEnable>false</FemtoNeighboringFilteringEnable>

<UMTSStaticNeighbor> <InterFreq> <Parameter> <Name>FC-SC-INTER-FREQ-1-UARFCDL</Name> <Value>10</Value> </Parameter> <Parameter> <Name>FC-SC-INTER-FREQ-1-SCRAMBLING-CODE</Name> <Value>510</Value> </Parameter> <Parameter> <Name>FC-SC-INTER-FREQ-1-ENABLE</Name> <Value>false</Value> </Parameter> </InterFreq> <InterFreq> <Parameter> <Name>FC-SC-INTER-FREQ-2-UARFCDL</Name> <Value>10</Value> </Parameter> <Parameter> <Name>FC-SC-INTER-FREQ-2-SCRAMBLING-CODE</Name> <Value>510</Value> </Parameter> <Parameter> <Name>FC-SC-INTER-FREQ-2-RNCID</Name> <Value>4000</Value> </Parameter> </InterFreq> <InterRat> <Parameter> <Name>FC-SC-INTER-RAT-1-BCCH- ARFCN</Name> <Value>1000</Value> </Parameter> <Parameter> <Name>FC-SC-INTER-RAT-1- ENABLE</Name>

37

<Value>true</Value> </Parameter> </InterRat> <InterRat> <Parameter> <Name>FC-SC-INTER-RAT-2-BCCH- ARFCN</Name> <Value>1000</Value> </Parameter> <Parameter> <Name>FC-SC-INTER-RAT-2- ENABLE</Name> <Value>true</Value> </Parameter> </InterRat> </UMTSStaticNeighbor> </StaticNeighbors> </Updates> <Removals> <StaticNeighbors> <FemtoNeighboringFilteringEnable>false </FemtoNeighboringFilteringEnable> <UMTSStaticNeighbor> <InterFreq> <Parameter> <Name>FC-SC-INTER-FREQ-20- UARFCDL</Name> <Value></Value> </Parameter> <Parameter> <Name>FC-SC-INTER-FREQ-20- SCRAMBLING-CODE</Name> <Value></Value> </Parameter> <Parameter> <Name>FC-SC-INTER-FREQ-20- ENABLE</Name> <Value>false</Value> </Parameter> </InterFreq> <InterFreq> <Parameter> <Name>FC-SC-INTER-FREQ-32- UARFCDL</Name> <Value>10</Value> </Parameter>

38

<Parameter> <Name>FC-SC-INTER-FREQ-32- SCRAMBLING-CODE</Name> <Value>510</Value> </Parameter> </InterFreq> <InterRat> <Parameter> <Name>FC-SC-INTER-RAT-31-BCCH- ARFCN</Name> <Value>1000</Value> </Parameter> <Parameter> <Name>FC-SC-INTER-RAT-31- ENABLE</Name> <Value></Value> </Parameter> </InterRat> <InterRat> <Parameter> <Name>FC-SC-INTER-RAT-4-BCCH- ARFCN</Name> <Value>1000</Value> </Parameter> <Parameter> <Name>FC-SC-INTER-RAT-4- ENABLE</Name> <Value></Value> </Parameter> </InterRat> </UMTSStaticNeighbor> </StaticNeighbors> </Removals> </Update>

ii) Sample XML for LTE static neighbors (one InterRatGsm, InterRatUmts and LteCell neighbor), UPDATE operation:

<?xml version="1.0" encoding="UTF-8" standalone="no"?> <Update xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0"> <TxnID>DCCtnr0e404815-f9ff-485f-a0c0-502384c85a88</TxnID> <EID>AAAAAA-10081</EID> <Updates>

<StaticNeighbors> <LTEStaticNeighbor>

<LteInterRatGsm>

39

<Parameter><Name>FC-LTE-NEIGHBOR-INTERRATCELL-GSM-1-BSIC</Name><Value>12</Value></Parameter><Parameter><Name>FC-LTE-NEIGHBOR-INTERRATCELL-GSM-1-PLMNID</Name><Value>123123</Value></Parameter><Parameter><Name>FC-LTE-NEIGHBOR-INTERRATCELL-GSM-1-BANDINDICATOR</Name><Value>GSM850</Value></Parameter><Parameter><Name>FC-LTE-NEIGHBOR-INTERRATCELL-GSM-1-BCCHARFCN</Name><Value>123</Value></Parameter><Parameter><Name>FC-LTE-NEIGHBOR-INTERRATCELL-GSM-1-CI</Name><Value>12</Value></Parameter><Parameter><Name>FC-LTE-NEIGHBOR-INTERRATCELL-GSM-1-ENABLE</Name><Value>true</Value></Parameter><Parameter><Name>FC-LTE-NEIGHBOR-INTERRATCELL-GSM-1-LAC</Name><Value>123</Value></Parameter><Parameter><Name>FC-LTE-NEIGHBOR-INTERRATCELL-GSM-1-MUSTINCLUDE</Name><Value>true</Value></Parameter>

</LteInterRatGsm> <LteInterRatUmts>

<Parameter><Name>FC-LTE-NEIGHBOR-INTERRATCELL-UMTS-1-PCPICH-TXPOWER</Name><Value>12</Value></Parameter><Parameter><Name>FC-LTE-NEIGHBOR-INTERRATCELL-UMTS-1-UARFCNUL</Name><Value>123</Value></Parameter><Parameter><Name>FC-LTE-NEIGHBOR-INTERRATCELL-UMTS-1-UARFCNDL</Name><Value>123</Value></Parameter><Parameter><Name>FC-LTE-NEIGHBOR-INTERRATCELL-UMTS-1-ENABLE</Name><Value>true</Value></Parameter><Parameter><Name>FC-LTE-NEIGHBOR-INTERRATCELL-UMTS-1-CID</Name><Value>123</Value></Parameter><Parameter><Name>FC-LTE-NEIGHBOR-INTERRATCELL-UMTS-1-RNCID</Name><Value>123</Value></Parameter><Parameter><Name>FC-LTE-NEIGHBOR-INTERRATCELL-UMTS-1-

40

MUSTINCLUDE</Name><Value>true</Value></Parameter><Parameter><Name>FC-LTE-NEIGHBOR-INTERRATCELL-UMTS-1-PCPICH-SCRAMBLINGCODE</Name><Value>123</Value></Parameter><Parameter><Name>FC-LTE-NEIGHBOR-INTERRATCELL-UMTS-1-LAC</Name><Value>123</Value></Parameter><Parameter><Name>FC-LTE-NEIGHBOR-INTERRATCELL-UMTS-1-RAC</Name><Value>123</Value></Parameter><Parameter><Name>FC-LTE-NEIGHBOR-INTERRATCELL-UMTS-1-PLMNID</Name><Value>123123</Value></Parameter><Parameter><Name>FC-LTE-NEIGHBOR-INTERRATCELL-UMTS-1-URA</Name><Value>123</Value></Parameter>

</LteInterRatUmts> <LteCell>

<Parameter><Name>FC-LTE-NEIGHBOR-LTECELL-1-QOFFSET</Name><Value>12</Value></Parameter><Parameter><Name>FC-LTE-NEIGHBOR-LTECELL-1-CIO</Name><Value>12</Value></Parameter><Parameter><Name>FC-LTE-NEIGHBOR-LTECELL-1-PLMNID</Name><Value>123123</Value></Parameter><Parameter><Name>FC-LTE-NEIGHBOR-LTECELL-1-MUSTINCLUDE</Name><Value>true</Value></Parameter><Parameter><Name>FC-LTE-NEIGHBOR-LTECELL-1-ENABLE</Name><Value>true</Value></Parameter><Parameter><Name>FC-LTE-NEIGHBOR-LTECELL-1-BLACKLISTED</Name><Value>true</Value></Parameter><Parameter><Name>FC-LTE-NEIGHBOR-LTECELL-1-RSTXPOWER</Name><Value>12</Value></Parameter><Parameter><Name>FC-LTE-NEIGHBOR-LTECELL-1-EUTRACARRIERARFCN</Name><Value>123</Value></Parameter><Parameter><Name>FC-LTE-NEIGHBOR-LTECELL-1-CISCO-TAC</Name><Value>123</Value></Parameter><Parameter><Name>FC-LTE-NEIGHBOR-LTECELL-1-PHYCELLID</Name><Value>123</Value></Parameter><Parameter><Name>FC-LTE-NEIGHBOR-LTECELL-1-CID</Name><Value>123</Value></Parameter>

</LteCell> </LTEStaticNeighbor>

</StaticNeighbors>

41

</Updates> </Update>

The allow ed UMTS and LTE neighbor parameters can be configured in pmg-profile as below . Profile is already populated w ith current allow ed parameters as per data model; new parameters in future can be added to this list. Neighbor parameters need to be configured in a regex format as show n:

i) UMTS Inter-freq params list:

<InterFreqParams> <NeighborParamDef> <Name>FC-SC-INTER-FREQ-\d{1,2}-UARFCDL</Name> <Type>int</Type> <SourceType>DeviceProperty</SourceType> <Writable>true</Writable> <Readable>true</Readable> <Deletable>true</Deletable> <Validation> <Type>range</Type> <Expression>[0:16383]</Expression> </Validation> </NeighborParamDef> <NeighborParamDef> <Name>FC-SC-INTER-FREQ-\d{1,2}-SCRAMBLING-CODE</Name> <Type>int</Type> <SourceType>DeviceProperty</SourceType> <Writable>true</Writable> <Readable>true</Readable> <Deletable>true</Deletable> <Validation> <Type>range</Type> <Expression>[0:511]</Expression> </Validation> </NeighborParamDef> </InterFreqParams>

ii) UMTS Inter-rat params list:

<InterRatParams> <NeighborParamDef> <Name>FC-SC-INTER-RAT-\d{1,2}-BCCH-ARFCN</Name> <Type>int</Type> <SourceType>DeviceProperty</SourceType> <Writable>true</Writable> <Readable>true</Readable> <Deletable>true</Deletable> <Validation>

42

<Type>range</Type> <Expression>[0:1023]</Expression> </Validation> </NeighborParamDef> <NeighborParamDef> <Name>FC-SC-INTER-RAT-\d{1,2}-ENABLE</Name> <Type>boolean</Type> <SourceType>DeviceProperty</SourceType> <Writable>true</Writable> <Readable>true</Readable> <Deletable>true</Deletable> </NeighborParamDef> </InterRatParams>

iii) LTE Inter-rat GSM params list:

<LteInterRatGsmParams> <NeighborParamDef> <Name>FC-LTE-NEIGHBOR-INTERRATCELL-GSM-\d{1,2}-BCCHARFCN</Name> <Type>int</Type> <SourceType>DeviceProperty</SourceType> <Writable>true</Writable> <Readable>true</Readable> <Deletable>true</Deletable> <Validation> <Type>range</Type> <Expression>[0:1023]</Expression> </Validation> </NeighborParamDef> <NeighborParamDef> <Name>FC-LTE-NEIGHBOR-INTERRATCELL-GSM-\d{1,2}-BSIC</Name> <Type>int</Type> <SourceType>DeviceProperty</SourceType> <Writable>true</Writable> <Readable>true</Readable> <Deletable>true</Deletable> <Validation> <Type>range</Type> <Expression>[0:255]</Expression> </Validation> </NeighborParamDef>

</LteInterRatGsmParams>

iv) LTE Inter-rat UMTS params list:

<LteInterRatUmtsParams>

43

<NeighborParamDef> <Name>FC-LTE-NEIGHBOR-INTERRATCELL-UMTS-\d{1,2}-CID</Name> <Type>int</Type> <SourceType>DeviceProperty</SourceType> <Writable>true</Writable> <Readable>true</Readable> <Deletable>true</Deletable> <Validation> <Type>range</Type> <Expression>[0:65535]</Expression> </Validation> </NeighborParamDef> <NeighborParamDef> <Name>FC-LTE-NEIGHBOR-INTERRATCELL-UMTS-\d{1,2}-ENABLE</Name> <Type>boolean</Type> <SourceType>DeviceProperty</SourceType> <Writable>true</Writable> <Readable>true</Readable> <Deletable>true</Deletable> </NeighborParamDef> </LteInterRatUmtsParams>

v) LTE Cell params list:

<LteCellParams> <NeighborParamDef> <Name>FC-LTE-NEIGHBOR-LTECELL-\d{1,2}-BLACKLISTED</Name> <Type>boolean</Type> <SourceType>DeviceProperty</SourceType> <Writable>true</Writable> <Readable>true</Readable> <Deletable>true</Deletable> </NeighborParamDef> <NeighborParamDef> <Name>FC-LTE-NEIGHBOR-LTECELL-\d{1,2}-CID</Name> <Type>int</Type> <SourceType>DeviceProperty</SourceType> <Writable>true</Writable> <Readable>true</Readable> <Deletable>true</Deletable> <Validation> <Type>range</Type> <Expression>[1:268435455]</Expression> </Validation>

44

</NeighborParamDef> </LteCellParams> NB: Above is just a small set of params for illustration. Complete set of supported params can be seen in pmg-profile.xml. Max allowed UMTS Inter-Freq and Inter-Rat neighbors are controlled by the below two configurations in dcc.properties: #Static-neighbors configuration max.interFreq.neighborcount=32 max.interRat.neighborcount=32

Max allowed LTE neighbors are controlled by below configurations in dcc.properties: max.lte.interRat.gsm.neighborcount=32 max.lte.interRat.umts.neighborcount=32 max.lte.ltecell.neighborcount=32

2.4 Shutdown The shutdow n message is used to deactivate already provisioned device and remove it from the provisioning system. Either EID or the SecondaryID of the CPE should be specif ied in the argument. The shutdow n message w ill initiate connection request w ith CPE.

<xs:sequence> <xs:element name="TxnID" type="TxnIDType" minOccurs="1" maxOccurs="1"/> <xs:choice minOccurs="1" maxOccurs="1"> xs:element name="EID" type="EIDType"/> <xs:element name="SecondaryID" type="SecondaryIDType"/> </xs:choice> </xs:sequence>

Sample Shutdow n message and response:

<Shutdown xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0"> <TxnID>DCCdccadmin468a05b2-4164-458b-93ae-81b7910c6ec1</TxnID> <EID>000000-00000000000001</EID> </Shutdown> <ShutdownResponse xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0"> <TxnID>DCCdccadmin468a05b2-4164-458b-93ae-81b7910c6ec1</TxnID>

45

<Status> <Code>0</Code> <Message>Success</Message> </Status> </ShutdownResponse>

2.4.1 Response Code 0 Success

201 CPE off line





405 Unknow n CPE

407 RDU unavailable




Note: Shutdown will not trigger Factory Reset to the device

2.5 Activate The Activate message activates the registered device by initiating management session w ith the CPE. This is used to bring the AP to service. Once this message is posted, the AP is brought to service (by setting TR-069 AdminState=True) if all the other prerequisites are met. Either EID or SecondaryID should be specif ied as argument in the message.

<xs:sequence> <xs:element name="TxnID" type="TxnIDType" minOccurs="1" maxOccurs="1"/> <xs:choice minOccurs="1" maxOccurs="1"> <xs:element name="EID" type="EIDType"/> <xs:element name="SecondaryID" ype="SecondaryIDType"/> </xs:choice> </xs:sequence> Sample Activate message and response: <Activate xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0"> <TxnID>DCCdccadmin468a05b2-4164-458b-93ae-81b7910c6ec1</TxnID> <EID>000000-00000000000001</EID> </Activate>

46

<ActivateResponse xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0"> <TxnID>DCCdccadmin468a05b2-4164-458b-93ae-81b7910c6ec1</TxnID> <Status> <Code>0</Code> <Message>Success</Message> </Status> </ActivateResponse> <ActivateResponse xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0"> <TxnID>DCCdccadmin468a05b2-4164-458b-93ae-81b7910c6ec1</TxnID> <Status><Code>201</Code><Message>CPE offline</Message></Status> </ActivateResponse>


201 CPE off line




405 Unknow n CPE

407 RDU unavailable

415 Unexpected error found w hile processing


2.6 Deactivate This message initiates a management session w ith the CPE to deactivate service. But the device is not removed from the provisioning system. Later CPE can be activated through Activate Message. Either EID or SecondaryID should be specif ied as argument in the message.

<xs:sequence> <xs:element name="TxnID" type="TxnIDType" minOccurs="1" maxOccurs="1"/> <xs:choice minOccurs="1" maxOccurs="1"> <xs:element name="EID" type="EIDType"/> <xs:element name="SecondaryID" type="SecondaryIDType"/> </xs:choice> </xs:sequence>

47


201 CPE off line




405 Unknow n CPE

407 RDU unavailable

415 Unexpected error found w hile processing


2.7 Delete This message deletes the specif ied device from the Provisioning system. But no management session w ill be established w ith the CPE.






405 Unknow n CPE

407 RDU unavailable

415 Unknow n error


Note: Ubiquisys FAP will not trigger Factory Restore when the “404 Not Found” message appears.

48

2.8 Block This message blocks service for a previously activated CPE. It initiates a management session w ith the CPE to disable service.

<xs:sequence> <xs:element name="TxnID" type="TxnIDType" minOccurs="1" maxOccurs="1"/> <xs:choice minOccurs="1" maxOccurs="1"> <xs:element name="EID" type="EIDType"/> <xs:element name="SecondaryID" type="SecondaryIDType"/> </xs:choice> </xs:sequence> Sample Block message and response: <Block xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0"> <TxnID>DCCdccadmin468a05b2-4164-458b-93ae-81b7910c6ec1</TxnID> <EID>000000-00000000000001</EID> </Block> <BlockResponse xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0"> <TxnID>DCCdccadmin468a05b2-4164-458b-93ae-81b7910c6ec1</TxnID> <Status> <Code>0</Code> <Message>Success</Message> </Status> </BlockResponse> <BlockResponse xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0"> <TxnID>DCCdccadmin468a05b2-4164-458b-93ae-81b7910c6ec1</TxnID> <Status><Code>201</Code><Message>CPE offline</Message></Status> </BlockResponse>


201 CPE off line



402 Excluded elements found

405 Unknow n CPE

49

407 RDU unavailable

415 Unknow n error


2.9 Unblock This message unblocks service for a previously blocked CPE. It initiates a management session w ith the CPE to enable service.


Sample Unblock message and response:

<Unblock xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0"> <TxnID>DCCdccadmin468a05b2-4164-458b-93ae-81b7910c6ec1</TxnID> <EID>000000-00000000000001</EID> </Unblock> <UnblockResponse xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0"> <TxnID>DCCdccadmin468a05b2-4164-458b-93ae-81b7910c6ec1</TxnID> <Status> <Code>0</Code> <Message>Success</Message> </Status> </UnblockResponse> <UnblockResponse xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0"> <TxnID>DCCdccadmin468a05b2-4164-458b-93ae-81b7910c6ec1</TxnID> <Status><Code>201</Code><Message>CPE offline</Message></Status> </UnblockResponse>


50

201 CPE off line




405 Unknow n CPE

407 RDU unavailable

415 Unknow n error


2.9.2 Replace Message Replace message is used to replace an already commissioned device on f ield because of one of the follow ing reasons.

1. Misbehaving device w hich cannot be solved using softw are or f irmw are upgrade

2. Hardw are malfunctioning.

For doing the same, PMG exposes an NBI API, w hich operator can use to replace a device w ith minimal information.

Below is the XSD file for reference specif ication for Replace message:

<xs:element name="Replace"> <xs:complexType> <xs:sequence> <xs:element name="TxnID" type="TxnIDType" minOccurs="1" maxOccurs="1"/> <xs:element name="OldEID" type="EIDType" minOccurs="1" maxOccurs="1"/> <xs:element name="NewEID" type="EIDType" minOccurs="1" maxOccurs="1"/> </xs:sequence> </xs:complexType> </xs:element>

Below is a sample Replace message.

<?xml version="1.0" encoding="UTF-8"?> <Replace xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:schemaLocation="http://www.cisco.com/ca/sse/PMGMessages v3_0_0 pmg-messages-v3_0_0.xsd">

51

<TxnID>update-txn-1234567868</TxnID> <OldEID>001B67-357539019692488</OldEID> <NewEID>001B01-111111111111111</NewEID> </Replace>

Replace device w ill retain all the configurations in the new device as it is except below :

1. FC-ACTIVATED property – this w ill be deleted from new device properties.

2. Discovered parameters – This w ill be cleared.

Note: Replace device w ill also set the class of service of new device to baseline. New device has to be explicitly activated by operator after replace. If the old device is already active during device replacement (w hich means the value of InternetGatewayDevice.Services.FAPService.1.FAPControl.OpState and InternetGatewayDevice.Services.FAPService.1.FAPControl.RFTxStatus are true in GetLiveData response), then PMG w ill throw an error “422-CPE Already Active “ to OSS.

Similarly, if a new device already exists in RMS, PMG w ill throw an error “422-CPE Already Active” to OSS”.

2.10 UpdateIMSI This message updates w hitelist value in the devices w hich have existing IMSI present in the w hitelist. Devices w ill have w hitelist in FC-ACL property. Existing IMSI and new IMSI w ill be specif ied in the argument.

<xs:sequence> <xs:element name="TxnID" type="TxnIDType" minOccurs="1" maxOccurs="1"/> <xs:element name="ExistingIMSI" type="IMSIType" minOccurs="1" maxOccurs="1"/> <xs:element name="NewIMSI" type="IMSIType" minOccurs="1" maxOccurs="1"/> </xs:sequence>



203 Unknow n IMSI



402 Excluded required found

405 Unknow n CPE

407 RDU unavailable

52

415 Unknow n error

53

2.11 GetStoredData This message returns the data for the given CPE stored in the provisioning system. This includes all registration data, discovered data from the CPE, as w ell as the stored CPE status data.


Sample GetSoredData and response:

<GetStoredData xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0"> <TxnID>DCCdccadmin468a05b2-4164-458b-93ae-81b7910c6ec1</TxnID> <EID>000000-00000000000001</EID> </GetStoredData> <GetStoredDataResponse xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0"> <TxnID>DCCdccadmin468a05b2-4164-458b-93ae-81b7910c6ec1</TxnID> <Status><Code>0</Code><Message>Success</Message></Status> <SubscriberID>12345566</SubscriberID> <EID>001B33-1234567890</EID> <RegisteredOn>2014-08-01T17:24:45.924Z</RegisteredOn> <AppearedOnline>false</AppearedOnline> <Blocked>false</Blocked> <Tampered>false</Tampered> <SAI><MCC>116</MCC><MNC>116</MNC><LAC>1024</LAC><SAC>615</SAC></SAI> <CID>125</CID> <AccessControl><AccessMode>Open</AccessMode></AccessControl> <Activated>true</Activated> <GroupMemberships><Group><Name>NEW-ENT-1</Name><Type>Enterprise</Type></Group><Group><Name>BGL-CELL-POOL-1</Name><Type>CELL-POOL</Type></Group><Group><Name>NEW-ENT-SITE-1</Name><Type>Site</Type></Group><Group><Name>BGL-SAI-POOL-1</Name><Type>SAI-

54

POOL</Type></Group><Group><Name>blr_area_band_2_5</Name><Type>Area</Type></Group><Group><Name>blr_fgw</Name><Type>FemtoGateway</Type></Group></GroupMemberships> <Parameters> <Parameter><Name>GPS-PERIODIC-TIME</Name><Value>2013-01-01T01:11:42Z</Value></Parameter> <Parameter><Name>/IPDevice/homeProvGroup</Name><Value>pg01</Value></Parameter> <Parameter><Name>FC-AP-ROLE</Name><Value>IdleEntry</Value></Parameter> <Parameter><Name>FC-IUSAC-ID</Name><Value>555</Value></Parameter> <Parameter><Name>FC-SAC-ID</Name><Value>615</Value></Parameter> <Parameter><Name>CELL-CONFIG-RAN-CELL-ID</Name><Value>7602301</Value></Parameter> <Parameter><Name>FC-JOB-ID</Name><Value>116</Value></Parameter> <Parameter><Name>PERIODIC-SCAN-RANDOM-TIME</Name><Value>2013-01-01T03:10:19Z</Value></Parameter> <Parameter><Name>FC-AP-PURPOSE</Name><Value>Capacity</Value></Parameter> <Parameter><Name>FC-NTP-SERVER-2</Name><Value>10.105.233.11</Value></Parameter> <Parameter><Name>FC-NTP-SERVER-1</Name><Value>10.105.233.60</Value></Parameter> </Parameters> </GetStoredDataResponse>




405 Unknow n CPE

407 RDU unavailable

415 Unknow n error


2.11.2 Response Message <xs:sequence> <xs:element name="SubscriberID" type="SubscriberIDType" minOccurs="0" maxOccurs="1"/> <xs:element name="EID" type="EIDType" minOccurs="0" maxOccurs="1"/>

55

<xs:element name="SecondaryID" type="SecondaryIDType" minOccurs="0" maxOccurs="1"/> <xs:element name="RegisteredOn" type="xs:dateTime" minOccurs="0" maxOccurs="1"/> <xs:element name="AppearedOnline" type="xs:boolean" minOccurs="0" maxOccurs="1"/> <xs:element name="Blocked" type="xs:boolean" minOccurs="0" maxOccurs="1"/> <xs:element name="Tampered" type="xs:boolean" minOccurs="0" maxOccurs="1"/> <xs:element name="SAI" type="SAIType" minOccurs="0" maxOccurs="1"/> <xs:element name="CID" type="CIDType" minOccurs="0" maxOccurs="1"/> <xs:element name="AccessControl" type="AccessControlType" minOccurs="0" maxOccurs="1"/> <xs:element name="ServiceStatus" type="xs:string" minOccurs="0" maxOccurs="1"/> <xs:element name="ServiceStatusTS" type="xs:dateTime" minOccurs="0" maxOccurs="1"/> <xs:element name="LocationValid" type="xs:boolean" minOccurs="0" maxOccurs="1"/> <xs:element name="LocationValidTS" type="xs:dateTime" minOccurs="0" maxOccurs="1"/> <xs:element name="Activated" type="xs:boolean" minOccurs="0" maxOccurs="1"/> <xs:element name="ExpectedLocation" type="ExpectedLocationType" minOccurs="0" maxOccurs="1"/> <xs:element name="LocationStatus" type="LocationStatusType" minOccurs="0" maxOccurs="1"/> <xs:element name="ActualGPS" type="GPSLocationType" minOccurs="0" maxOccurs="1"/> <xs:element name="DNBenchmark" type="DetectedNeighborBenchmarkListType" minOccurs="0" maxOccurs="1"/> <xs:element name="GroupMemberships" type="GroupsType" minOccurs="0" maxOccurs="1"/> <xs:element name="Parameters" type="ParametersType" minOccurs="0" maxOccurs="1"/> </xs:sequence>

• RegisteredOn - The Device registered date.

• AppearedOnline - First CPE appeared online date.

• AccessControl - Vales can be open or closed

• SAI - FC-LAC-ID is taken from SAI_POOL.

56

• ServiceStatus - Status of service, It can be Operational, Service Error.

• Parameters - All discovered parameters w ill present here.

2.12 GetIDs This message returns a list of IDs (equipment and secondary Id) for a given subscriber identif ier or Group.

<xs:sequence> <xs:element name="TxnID" type="TxnIDType" minOccurs="1" maxOccurs="1"/> <xs:choice> <xs:element name="SubscriberID" type="SubscriberIDType" minOccurs="1" maxOccurs="1"/> <xs:element name="InseeCode" type="InseeCodeType" minOccurs="1" maxOccurs="1" /> <xs:element name="Group" type="GroupType" minOccurs="1" maxOccurs="1"/> </xs:choice> </xs:sequence>

• SubscriberID – Subscriber ID of the FAP

• InseeCode - An INSEE identif ier.

• Group - A group is defined by its name and its type.

2.12.1 Response Code 0 Success




406 Unknow n subscriber ID

407 RDU unavailable

411 Unknow n group

415 Unknow n error


RESPO NSE MESSAGE: This message returns EID and the optional SecondaryID.

<xs:sequence>

<xs:element name="IDs" type="IDsType" minOccurs="0" maxOccurs="1"/>

57

</xs:sequence>

2.13 GetLiveData This message creates a management session (CWMP) w ith the CPE and then retrieves a specif ied set of parameters directly from the CPE.

<xs:sequence> <xs:element name="TxnID" type="TxnIDType" minOccurs="1" maxOccurs="1"/> <xs:choice minOccurs="1" maxOccurs="1"> <xs:element name="EID" type="EIDType"/> <xs:element name="SecondaryID" type="SecondaryIDType"/> </xs:choice> <xs:element name="ParameterNames" type="ParameterNamesType" minOccurs="0" maxOccurs="1"/> </xs:sequence> </xs:complexType>

ParameterNames – There are tw o types of parameters

• Actual TR-69 Parameters,




405 Unknow n CPE

407 RDU unavailable

409 CPE off line error

414 TR-069 fault

415 Unknow n error


The response w ill contain the actual TR-69 params.

<xs:sequence> <xs:element name="Parameters" type="ParametersType" minOccurs="0" maxOccurs="1"/> </xs:sequence>

2.14 SetLiveData This message creates a management session (CWMP) w ith the CPE and then sets the specif ied set of TR-069 parameters on CPE.

<xs:sequence>

58

<xs:element name="TxnID" type="TxnIDType" minOccurs="1" maxOccurs="1"/> <xs:choice minOccurs="1" maxOccurs="1">

<xs:element name="EID" type="EIDType"/> <xs:element name="SecondaryID" type="SecondaryIDType"/>

</xs:choice> <xs:element name="Parameters" type="ParametersType" minOccurs="1" maxOccurs="1"/> <xs:element name="ParameterKey" type="ParameterKeyType" minOccurs="0" maxOccurs="1" /> </xs:sequence>



403 Unknow n parameter name


405 Unknow n CPE

407 RDU unavailable


414 TR-069 fault

415 Unknow n error


2.15 ConnectionRequest Creates a management session (CWMP) w ith the CPE. This may cause the CPE to have its f irrmw are upgraded, the latest configuration applied, have its location verif ied, or its service provisioned and activated. It may also result in new notif ications via the PMG interface.


59

2.15.1 Response

0 Success

201 CPE off line




405 Unknow n CPE

407 RDU unavailable

414 TR-069 fault

415 Unknow n error


2.16 ResetCPEToFactory Defaults Creates a management session (CWMP) w ith the CPE and does Factory Reset/Recovery. Factory recovery is the customized feature for Ubi/Cisco Devices.

Follow ing are the different recover options possible to set on device:

0 -- Factory reset

1 -- Factory Recovery Immediate (default)

2 -- Factory Recovery In Least Busy Hour

3 -- Factory Recovery On Next Pow er Up

<xs:sequence> <xs:element name="TxnID" type="TxnIDType" minOccurs="1" maxOccurs="1"/> <xs:choice minOccurs="1" maxOccurs="1"> <xs:element name="EID" type="EIDType"/> <xs:element name="SecondaryID" type="SecondaryIDType"/>

<xs:element name="RecoveryOption" type="RecoveryType" minOccurs="0" maxOccurs="1"/>

</xs:choice> </xs:sequence>

Default behaviour (i.e w ithout RecoveryOption) of this API is Factory Reset.

Allowed values of RecoveryOption are: <xs:simpleType name="RecoveryType"> <xs:restriction base="xs:string"> <xs:pattern value="No Recovery|Immediate Recovery|Recovery In Least Busy Hour|Recovery On Next Power Up"/>

60

</xs:restriction> </xs:simpleType>




405 Unknow n CPE

407 RDU unavailable


414 TR-069 fault

415 Unknow n error


2.17 RebootCPE Creates a management session (CWMP) w ith the CPE and then reboots it. And Different kind of reboot options (Forced/Immediate/Delayed/Reboot) are possible for LTE Ubi/Cisco devices. This is customized feature on Ubi/Cisco devices.

<xs:sequence>

<xs:element name="TxnID" type="TxnIDType" minOccurs="1" maxOccurs="1"/> <xs:choice minOccurs="1" maxOccurs="1"> <xs:element name="EID" type="EIDType"/> <xs:element name="SecondaryID" type="SecondaryIDType"/> <xs:element name="RebootOption" type="RebootType" minOccurs="0" maxOccurs="1"/> </xs:choice> </xs:sequence> Allowed values for RebootOption are: <xs:simpleType name="RebootType"> <xs:restriction base="xs:string"> <xs:pattern value="Forced|Immediate|Delayed"/> </xs:restriction> </xs:simpleType>



405 Unknow n CPE

61

407 RDU unavailable


414 TR-069 fault

415 Unknow n error


2.18 GetSoftwareVersion This API SHALL return software version of all RMS components.

Follow ing is the schema snippet for GetSoftw areVersion API :

<xs:element name="GetSoftwareVersion"> <xs:complexType> <xs:sequence> <xs:element name="TxnID" type="TxnIDType" minOccurs="1" maxOccurs="1"/> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="GetSoftwareVersionResponse"> <xs:annotation> <xs:documentation> <ul> <li>0 Success</li> </ul> </xs:documentation> </xs:annotation> <xs:complexType> <xs:complexContent> <xs:extension base="ResponseType"> <xs:sequence> <xs:element name="Component" type="ComponentType" minOccurs="0" maxOccurs="unbounded"/> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> </xs:element> <xs:complexType name="ComponentType">

62

<xs:annotation> <xs:documentation> RMS Component name and details </xs:documentation> </xs:annotation> <xs:sequence> <xs:element name="Name" type="xs:string" minOccurs="1" maxOccurs="1"/> <xs:element name="Version" type="xs:anySimpleType" minOccurs="1" maxOccurs="1"/> <xs:element name="BuildId" type="xs:anySimpleType" minOccurs="0" maxOccurs="1"/> </xs:sequence> </xs:complexType>

2.18.1 Request Request Sample XML :

<GetSoftwareVersion xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:schemaLocation="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0 pmg-messages-v3_0_0.xsd"> <TxnID> GetSoftwareVersion-trans-1234567890</TxnID> </GetSoftwareVersion>

2.18.2 Response Sample Response :

<?xml version="1.0" encoding="UTF-8" standalone="no"?><GetSoftwareVersionResponse xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0"><TxnID>GetSoftwareVersion-trans-1234567890</TxnID><Status><Code>0</Code><Message>Success</Message></Status>

<Component>

<Name>Cisco Prime Access Registrar</Name><Version>6.1.2.3</Version><BuildId>1</BuildId></Component>

63

<Component>

<Name>OVA Install Utilities</Name><Version>5.1.0</Version><BuildId>305</BuildId></Component>

<Component><Name>Device Command and Control UI</Name><Version>5.1.0</Version><BuildId>475</BuildId></Component>

<Component><Name>Provisioning Management Gateway</Name><Version>5.1.0</Version><BuildId>434</BuildId></Component>

<Component><Name>Upload Server</Name><Version>9.3.0</Version><BuildId>83</BuildId></Component>

<Component><Name>BAC Tools</Name><Version>3.10.0.0</Version><BuildId>23</BuildId></Component>

<Component><Name>Fault Management Server</Name><Version>5.1.0</Version><BuildId>164</BuildId></Component>

<Component><Name>RAN Management System (RMS)</Name><Version>5.1.0.0</Version><BuildId>5.1.0-2F</BuildId></Component>

<Component><Name>Cisco Prime Network Registrar</Name><Version>8.3</Version><BuildId>1</BuildId></Component>

<Component><Name>Broadband Access Center (BAC)</Name><Version>3.10</Version><BuildId>201505061237_169</BuildId></Component>

<Component><Name>Baseline Config for BAC</Name><Version>5.1.0</Version><BuildId>403</BuildId></Component>

<Component><Name>Operations Tools</Name><Version>5.1.0</Version><BuildId>304</BuildId></Component>

</GetSoftwareVersionResponse>

64

3 PMG Group Management API PMG exposes group management API to OSS for creating, retrieving, updating, and deleting group and ID pool groups specif ied in the xsd f ile pmg-messages-v3_0_0.

3.1 GetDeviceAssignmentByGroups Return device assignment information for the groups requested.

<xs:sequence> <xs:element name="TxnID" type="TxnIDType" minOccurs="1" maxOccurs="1"/> <xs:element name="GroupIDs" type="FRMGroupIDsType" minOccurs="1" maxOccurs="1"/> </xs:sequence>


220 Unknow n instance

415 Unknow n error

3.2 GetIDPoolsByGroups Return pools usage information for the groups requested.

<xs:sequence> <xs:element name="TxnID" type="TxnIDType" minOccurs="1" maxOccurs="1"/> <xs:element name="GroupIDs" type="FRMGroupIDsType" minOccurs="1" maxOccurs="1"/> </xs:sequence>


220 Unknow n instance

415 Unknow n error

3.3 GetIDPoolsByTypes Returns pools usage information for the pools requested by type.

<xs:sequence> <xs:element name="TxnID" type="TxnIDType" minOccurs="1" maxOccurs="1"/> <xs:element name="PoolTypes" type="FRMPoolTypesName" minOccurs="1" maxOccurs="1"/> </xs:sequence>

65


415 Unknow n error

421 Unknow n type

3.4 ReassignDevice Note: If we make the assigned Group state to Deactive or Planned using this xml, we can reassign the Devices to other active Group.

Reassign device to the available group.

<xs:sequence> <xs:element name="TxnID" type="TxnIDType" minOccurs="1" maxOccurs="1"/> <xs:element name="EID" type="EIDType" minOccurs="1" maxOccurs="1"/> </xs:sequence>


405 Unknow n CPE

407 RDU unavaliable

417 FRM reassign failed



3.5 CreateGroup Creates a group of a particular type. It takes tw o mandatory parameters, name of the group and its type name.

Follow ing is the sample XML for CreateGroup:

<CreateGroup xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:schemaLocation="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0 pmg-messages-v3_0_0.xsd"> <TxnID>CreateGroup-trans-1234567890</TxnID> <Group> <GroupTypeName>newGroupTyeName</GroupTypeName> <Name>newGroupName</Name>

66

<State>Planned</State> <PoolIDs> <PoolID> <PoolTypeName>poolTypeName-1</PoolTypeName> <Name>name-1</Name> </PoolID> <PoolID> <PoolTypeName>poolTypeName-N</PoolTypeName> <Name>name-N</Name> </PoolID> </PoolIDs> <GroupIDs> <GroupID> <GroupTypeName>groupTypeName-1</GroupTypeName> <Name>name-1</Name> </GroupID> <GroupID> <GroupTypeName>groupTypeName-N</GroupTypeName> <Name>name-N</Name> </GroupID> </GroupIDs> <EnableGrid>true</EnableGrid> <Parameters> <Parameter> <Name>Parameter-1</Name> <Value xsi:type="xsd:boolean">true</Value> </Parameter> <Parameter> <Name>Parameter-N</Name> <Value xsi:type="xsd:string">value-N</Value> </Parameter> </Parameters> </Group> </CreateGroup>

67

3.6 UpdateGroup Updates group of a particular type. It takes tw o mandatory parameters, name of the group and its type name.

UpdateGroup has tw o options:

1. <update>: Any group properties or related group can be added or updated.

2. <remove>: Properties or related group to be removed to be added in <remove>.

Follow ing is the sample XML for UpdateGroup:

<UpdateGroup xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:schemaLocation="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0 pmg-messages-v3_0_0.xsd"> <TxnID>UpdateGroup-trans-1234567890</TxnID> <Group> <GroupTypeName>GroupTyeName</GroupTypeName> <Name>GroupName</Name> <Updates> <State>Planned</State> <EnableGrid>true</EnableGrid> <PoolIDs> <PoolID> <PoolTypeName>poolTypeName-1</PoolTypeName> <Name>name-1</Name> </PoolID> <PoolID> <PoolTypeName>poolTypeName-N</PoolTypeName> <Name>name-N</Name> </PoolID> </PoolIDs> <GroupIDs> <GroupID> <GroupTypeName>groupTypeName-1</GroupTypeName> <Name>name-1</Name> </GroupID> <GroupID>

68

<GroupTypeName>groupTypeName-N</GroupTypeName> <Name>name-N</Name> </GroupID> </GroupIDs> <Parameters> <Parameter> <Name>Parameter-1</Name> <Value xsi:type="xsd:boolean">true</Value> </Parameter> <Parameter> <Name>Parameter-N</Name> <Value xsi:type="xsd:string">value-N</Value> </Parameter> </Parameters> </Updates> <Removals> <PoolIDs> <PoolID> <PoolTypeName>poolTypeName-1</PoolTypeName> <Name>name-1</Name> </PoolID> <PoolID> <PoolTypeName>poolTypeName-N</PoolTypeName> <Name>name-N</Name> </PoolID> </PoolIDs> <GroupIDs> <GroupID> <GroupTypeName>groupTypeName-1</GroupTypeName> <Name>name-1</Name> </GroupID> <GroupID> <GroupTypeName>groupTypeName-N</GroupTypeName> <Name>name-N</Name> </GroupID> </GroupIDs> <Parameters>

69

<Name>Parameter-1</Name> <Name>Parameter-N</Name> </Parameters> </Removals> </Group> </UpdateGroup>

3.6.1 Response 0 Success 403 Unknow n parameter name 404 Invalid parameter value 407 RDU unavaliable 415 Unexpected error 421 Unknow n type 425 Missing Dependent Group 501 Batch request timed out from BAC RDU

3.7 DeleteGroup Removes the FRM Groups listed.

Follow ing is the sample XML for DeleteGroup:

<DeleteGroup xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:schemaLocation="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0 pmg-messages-v3_0_0.xsd"> <TxnID>DeleteGroup-trans-1234567890</TxnID> <GroupID> <GroupTypeName>Site</GroupTypeName> <Name>site_tnr2</Name> </GroupID> </DeleteGroup>

3.7.1 Response 0 Success 407 RDU unavaliable 415 Unexpected error 421 Unknow n type 501 Batch request timed out from BAC RDU

70

3.8 CreateGroupType Creates a new group type.

Follow ing is the sample XML for CreateGroupType:

<CreateGroupType xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:schemaLocation="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0 pmg-messages-v3_0_0.xsd"> <TxnID>CreateGroupType-trans-1234567890</TxnID> <GroupType> <Name>newGrouptypeName</Name> <Priority>20</Priority> <PoolTypeNames> <Name>poolType-1</Name> <Name>PoolType-N</Name> </PoolTypeNames> <FrmGroupTypeNames> <Name>GroupType-1</Name> <Name>GroupType-N</Name> </FrmGroupTypeNames> <MaxDevices>20000</MaxDevices> <Reassignable>true</Reassignable> <IDGeneratable>true</IDGeneratable> <GenerateId>123</GenerateId> <Parameters> <Parameter> <Name>Parameter-1</Name> <Value xsi:type="xsd:boolean">true</Value> </Parameter> <Parameter> <Name>Parameter-N</Name> <Value xsi:type="xsd:string">value-N</Value> </Parameter> </Parameters> </GroupType> </CreateGroupType>

71

3.9 UpdateGroupType Updates an existing group type.

Follow ing is the sample XML for UpdateGroupType:

<UpdateGroupType xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:schemaLocation="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0 pmg-messages-v3_0_0.xsd"> <TxnID>UpdateGroupType-trans-1234567890</TxnID> <GroupType> <Name>GrouptypeName</Name> <Updates> <Priority>20</Priority> <PoolTypeNames> <Name>poolType-1</Name> <Name>PoolType-N</Name> </PoolTypeNames> <FrmGroupTypeNames> <Name>GroupType-1</Name> <Name>GroupType-N</Name> </FrmGroupTypeNames> <MaxDevices>20000</MaxDevices> <Reassignable>true</Reassignable> <IDGeneratable>true</IDGeneratable> <GenerateId>123</GenerateId> <Parameters> <Parameter> <Name>Parameter-1</Name> <Value xsi:type="xsd:boolean">true</Value> </Parameter> <Parameter> <Name>Parameter-N</Name> <Value xsi:type="xsd:string">value-N</Value> </Parameter> </Parameters> </Updates> <Removals> <PoolTypeNames> <Name>poolType-1</Name>

72

<Name>PoolType-N</Name> </PoolTypeNames> <FrmGroupTypeNames> <Name>GroupType-1</Name> <Name>GroupType-N</Name> </FrmGroupTypeNames> <Parameters> <Name>Parameter-1</Name> <Name>Parameter-N</Name> </Parameters> </Removals> </GroupType> </UpdateGroupType>

3.9.1 Response 0 Success 403 Unknow n parameter name 404 Invalid parameter value 407 RDU unavaliable 415 Unexpected error 501 Batch request timed out from BAC RDU

3.10 DeleteGroupType Removes a group type if all the groups in that group type have been removed.

Follow ing is the sample XML for DeleteGroupType:

<DeleteGroupType xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:schemaLocation="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0 pmg-messages-v3_0_0.xsd"> <TxnID>DeleteGroupType-trans-1234567890</TxnID> <Name>GrpTypeName</Name> </DeleteGroupType>


73

3.11 CreatePool Creates a new pool w ith the passed group name and group type. Else it updates the pool elements.

Follow ing is the sample XML for CreatePool:

<CreatePool xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0" xsi:schemaLocation="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0 pmg-messages-v3_0_0.xsd"> <TxnID>SetFRMPools-trans-123456789</TxnID> <Pool> <PoolTypeName>PoolType</PoolTypeName> <Name>PoolName</Name> <State>Planned</State> <GroupIDs> <GroupID> <GroupTypeName>Enterprise</GroupTypeName> <Name>ENT-10</Name> </GroupID> </GroupIDs> <Range>1..234</Range> <Parameters> <Parameter> <Name>FC-LAC-ID</Name> <Value>4</Value> </Parameter> </Parameters> </Pool> </CreatePool>

3.11.1 Response 0 Success 403 Unknow n parameter name 404 Invalid parameter value 407 RDU unavaliable 415 Unexpected error 421 Unknow n type 501 Batch request timed out from BAC RDU

3.12 UpdatePool Updates the existing FRM Group.

Follow ing is the sample XML for UpdatePool:

74

<UpdatePool xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:schemaLocation="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0 pmg-messages-v3_0_0.xsd"> <TxnID>UpdatePool-trans-1234567890</TxnID> <Pool> <PoolTypeName>CELL-POOL</PoolTypeName> <Name>TEST1</Name> <Updates> <State>Planned</State> <GroupIDs> <GroupID> <GroupTypeName>FemtoGateway</GroupTypeName> <Name>ChileFGW</Name> </GroupID> </GroupIDs> <Parameters> <Parameter> <Name>Parameter-1</Name> <Value>true</Value> </Parameter> <Parameter> <Name>Parameter-N</Name> <Value>value-N</Value> </Parameter> </Parameters> </Updates> <Removals> <GroupIDs> <GroupID> <GroupTypeName>FemtoGateway</GroupTypeName> <Name>DefaultFGW</Name> </GroupID> </GroupIDs> <Parameters> <Name>Parameter-1</Name> <Name>Parameter-N</Name> </Parameters> </Removals> </Pool> </UpdatePool>

75

3.12.1 Response 0 Success 403 Unknow n parameter name 404 Invalid parameter value 407 RDU unavaliable 415 Unexpected error 421 Unknow n type 501 Batch request timed out from BAC RDU

3.13 DeletePool Removes the listed pool.

Follow ing is the sample XML for DeletePool:

<DeletePool xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:schemaLocation="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0 pmg-messages-v3_0_0.xsd"> <TxnID>san-4etFRMGroups-TxnID0</TxnID> <PoolID> <PoolTypeName>Enterprise</PoolTypeName> <Name>EntP1002</Name> </PoolID> </DeletePool>


3.14 CreatePoolType Creates a new pool type.

Follow ing is the sample XML for CreatePoolType:

<CreatePoolType xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0" xsi:schemaLocation="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0 pmg-messages-v3_0_0.xsd"> <TxnID>SetFRMPools-trans-123456789</TxnID> <PoolType>

76

<Name>TestPoolType</Name> <Priority>10</Priority> <GroupTypeName>Area</GroupTypeName> <PropertyName>FC-CSG-ID</PropertyName> <Parameters> <Parameter> <Name>ParameterName</Name> <Value>ParameterValue</Value> </Parameter> </Parameters> </PoolType> </CreatePoolType>

3.14.1 Response 0 Success 403 Unknow n parameter name 404 Invalid parameter value 407 RDU unavaliable 415 Unexpected error 501 Batch request timed out from BAC RDU

3.15 UpdatePoolType Creates a new pool type. Additionally, it is also used to update the pool type elements.

Follow ing is the sample XML for UpdatePoolType:

<UpdatePoolType xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:schemaLocation="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0 pmg-messages-v3_0_0.xsd"> <TxnID>UpdatePoolType-trans-1234567890</TxnID> <PoolType> <Name>PoolTypeName</Name> <Updates> <Priority>20</Priority> <GroupTypeName>sampleGrpTyp</GroupTypeName> <PropertyName>exPropertyName</PropertyName> <Parameters> <Parameter> <Name>Parameter-1</Name> <Value xsi:type="xsd:boolean">true</Value>

77

</Parameter> <Parameter> <Name>Parameter-N</Name> <Value xsi:type="xsd:string">value-N</Value> </Parameter> </Parameters> </Updates> <Removals> <GroupTypeName>sampleGrpTyp</GroupTypeName> <Parameters> <Name>Parameter-1</Name> <Name>Parameter-N</Name> </Parameters> </Removals> </PoolType> </UpdatePoolType>

3.15.1 Response 0 Success 403 Unknow n parameter name 404 Invalid parameter value 407 RDU unavailable 415 Unexpected error 415 Unexpected error501 Batch request timed out from BAC RDU

3.16 DeletePoolType Removes a pool type if all the groups for that pool type have been removed.

Follow ing is the sample XML for DeletePoolType:

<DeletePoolType xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:schemaLocation="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0 pmg-messages-v3_0_0.xsd"> <TxnID>san-4etFRMGroups-TxnID0</TxnID> <Name>TestPoolType</Name> </DeletePoolType>

3.16.1 Response 0 Success 407 RDU unavaliable

78

415 Unexpected error 420 Instances exist for type 421 Unknow n type 501 Batch request timed out from BAC RDU

3.17 GetGroupNames Returns all the FRM group names for the given group type.

Follow ing is the sample XML for GetGroupNames:

<GetGroupNames xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:schemaLocation="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0 pmg-messages-v3_0_0.xsd"> <TxnID>GetGroupNames-trans-1234567890</TxnID> <GroupTypeName>Area</GroupTypeName> </GetGroupNames>

3.18 GetGroupsDetails Returns all the elements for the FRM groups requested.

Follow ing is the sample XML for GetGroupsDetails:

<GetGroupsDetails xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:schemaLocation="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0 pmg-messages-v3_0_0.xsd"> <TxnID>GetGroupsDetails-trans-1234567890</TxnID> <GroupIDs> <GroupID> <GroupTypeName>Area</GroupTypeName> <Name>DefaultArea</Name> </GroupID> <GroupID> <GroupTypeName>Area</GroupTypeName> <Name>NEWAREA</Name> </GroupID> </GroupIDs> </GetGroupsDetails>

3.19 GetGroupTypeNames Returns all the FRM group type names.

79

Follow ing is the sample XML for GetGroupTypeNames:

<GetGroupTypeNames xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:schemaLocation="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0 pmg-messages-v3_0_0.xsd"> <TxnID>GetGroupTypeNames-trans-1234567890</TxnID> </GetGroupTypeNames>

3.20 GetGroupTypesDetails Returns all the elements for the existing FRM group type.

Follow ing is the sample XML for GetGroupTypesDetails:

<GetGroupTypesDetails xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:schemaLocation="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0 pmg-messages-v3_0_0.xsd"> <TxnID>GetGroupTypesDetails-trans-1234567890</TxnID> <GroupTypeNames> <Name>Area</Name> <Name>FemtoGateway</Name> </GroupTypeNames> </GetGroupTypesDetails>

3.21 GetPoolNames Returns all the FRM pool names for the given pool type

Follow ing is the sample XML for GetPoolNames:

<GetPoolNames xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:schemaLocation="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0 pmg-messages-v3_0_0.xsd"> <TxnID>GetPoolNames-trans-1234567890</TxnID> <PoolTypeName>SAI-POOL</PoolTypeName> </GetPoolNames>

3.22 GetPoolsDetails Returns all the elements for the FRM pools requested.

Follow ing is the sample XML for GetPoolsDetails:

80

<GetPoolsDetails xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:schemaLocation="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0 pmg-messages-v3_0_0.xsd"> <TxnID>GetPoolsDetails-trans-1234567890</TxnID> <PoolIDs> <PoolID> <PoolTypeName>SAI-POOL</PoolTypeName> <Name>CHILE-SAI-POOL-1</Name> </PoolID> <PoolID> <PoolTypeName>CELL-POOL</PoolTypeName> <Name>DEFAULT-CELL-POOL-1</Name> </PoolID> </PoolIDs> </GetPoolsDetails>

3.23 GetPoolTypeNames Returns all the FRM pool type names.

Follow ing is the sample XML for GetPoolTypeNames:

<GetPoolTypeNames xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:schemaLocation="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0 pmg-messages-v3_0_0.xsd"> <TxnID>GetPoolTypeNames-trans-1234567890</TxnID> </GetPoolTypeNames>

3.24 GetPoolTypesDetails Returns all the elements for an existing FRM pool type.

Follow ing is the sample XML for GetPoolTypesDetails:

<GetPoolTypesDetails xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:schemaLocation="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0 pmg-messages-v3_0_0.xsd"> <TxnID>GetPoolTypesDetails-trans-1234567890</TxnID> <PoolTypeNames> <Name>SAI-POOL</Name> <Name>CELL-POOL</Name>

81

</PoolTypeNames> </GetPoolTypesDetails>

82

4 Event Subscription Notif ication messages are the events received by PMG from BAC and sent to register OSS HTTP URL. These notif ications are resent a specif ied number of times w hen the HTTP 200 OK message is not received by PMG from OSS.

PMG event notif ication framew ork provides the facility to the subscribers for subscribing the events through subscriber.xml. Subscriber can send <unsubscribe> message to PMG for unsubscribing events.

4.1 Subscribe The subscriber sends the subscribe.xml to PMG for getting the notif ication for the selected events.

Subscription can be made to receive all the events or selected events. Subscriber can have more than one notif ication url, PMG w ill pick up one url and send the event. If the URL is not reachable, PMG pick up next url for event delivery.

Follow ing is the example of subscriber message:

<Subscribe xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:schemaLocation="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0 pmg-messages-v3_0_0.xsd" subscriber-name='OSS-1'> <TxnID>Subscribe-trans-1234567890</TxnID> <URL>http://10.105.233.87:8085/pmg</URL> <URL>http://10.105.233.12:8083/pmg</URL> <URL>http://10.105.233.38:8083/pmg</URL> <Events> <Event name='AssignedData' isEnabled='true'> </Event> <Event name='GroupCreated' isEnabled='true'> </Event> <Event name='GroupUpdated' isEnabled='true'> </Event> <Event name='GroupDeleted' isEnabled='true'> </Event> <Event name='FirmwareUpgraded' isEnabled='true'> </Event> <Event name='LocationStatus' isEnabled='true'> </Event> <Event name='Online' isEnabled='true'> </Event> <Event name='ServiceError' isEnabled='true'> </Event> <Event name='ServiceOperational' isEnabled='true'>

83

</Event> <Event name='Tampered' isEnabled='true'> </Event> <Event name='IpAddressUpdate' isEnabled='true'> </Event> </Events> </Subscribe>

The follow ing is the sample XML message for subscribing all Events.

<Subscribe xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:schemaLocation="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0 pmg-messages-v3_0_0.xsd" subscriber-name='CISCO-OSS-1'> <TxnID>Subscribe-trans-1234567890</TxnID> <URL>http://10.105.233.78:8083/pmg</URL> <URL>http://10.105.233.12:8083/pmg</URL> <URL>http://10.105.233.38:8083/pmg</URL> </Subscribe>

Note: If the subscriber does not want to receive the notification for the particular event, the event can be disabled either by setting event enabled value to “false” as shown in the example or removing the particular event: <Event name='AssignedData' isEnabled='false'> </Event>

84

4.1.1 Events The follow ings are the supported events for the notif ications and its structure.

1. AssignedData

2. Firmw areUpgrade

3. GroupCreate

4. GroupUpdate

5. GroupDelete

6. LocationStatus

7. Online

8. ServiceError

9. ServiceOperational

10. Tampered

11. IpAddressUpdate

4.1.1.1 AssignedData This notif ication is sent w hen the device assigned data is updated in the provisioning system.

The format of AssignedData event is,

<xs:element name="AssignedData"> <xs:annotation> <xs:documentation> Notifies of automatically assigned data in order to update IT systems such as a billing database. If the response is not acknowledged, PMG will resent this notification, typically upon the next interaction with the CPE. </xs:documentation> </xs:annotation> <xs:complexType> <xs:all> <xs:element name="TxnID" type="TxnIDType" minOccurs="1" maxOccurs="1"/> <xs:element name="EID" type="EIDType" minOccurs="1" maxOccurs="1"/>

85

<xs:element name="SecondaryID" type="SecondaryIDType" minOccurs="0" maxOccurs="1"/> <xs:element name="SubscriberID" type="SubscriberIDType" minOccurs="0" maxOccurs="1"/> <xs:element name="SAI" type="SAIType" minOccurs="0" maxOccurs="1"/> <xs:element name="CID" type="CIDType" minOccurs="0" maxOccurs="1"/> <xs:element name="LAC" type="LACType" minOccurs="0" maxOccurs="1"/> <xs:element name="ExpectedLatitude" type="LatitudeType " minOccurs="0" maxOccurs="1"/> <xs:element name="ExpectedLongitude" type="LongitudeType" minOccurs="0" maxOccurs="1"/> <xs:element name="GroupMemberships" type="GroupsType" minOccurs="0" maxOccurs="1"/> <xs:element name="OccuredOn" type="xs:dateTime" minOccurs="1" maxOccurs="1"/> <xs:element name="Parameters" type="ParametersType" minOccurs="0" maxOccurs="1"/> </xs:all> </xs:complexType> </xs:element>

Element Name Description

TxnID Unique transaction ID of type string w ith max size of 100 characters. Ex,

<TxnID> Register-0202201412345 </TnxID>


EID Device equipment ID of UMTS device w hich contains OUI (6 characters length, allow ed chars 0-9A-F) and a SerialNumber of the form OUI-SerialNumber.

Ex,

<EID>00000C-ABC123456789<EID>


SecondaryID A secondary identif ier for the CPE w hich is unique and

can be any FQDN w ith max size of 100.

<SecondaryID>IND-KA-03EZ45451234</ SecondaryID>


86

SubscriberID Thi is a subscriber identif ier. Typically this is the primary telephone number of the subscriber. This is of type string w ith out any size limit.

<SubscriberID>MyName1001</SubscriberID>


SAI A Service Area Identif ier (SAI). The concatenation of PLMN ID (MCC+MNC), LAC, and SAC uniquely identif ies the Service Area ID (SAI).

CID Cell Identif ier (C-id) that identif ies a cell w ithin an RNS.

LAC Location Area Code

ExpectedLatitude The expected latitude (FC-EXP-LAT) for this device.

ExpectedLongitude The expected longitude (FC-EXP-LONG) for this device.

GroupMemberships RMS groups associated to the device.

OccuredOn The time the notif ication w as raised in milliseconds since epoch.

Parameters Other set of parameters w hich hare populated in AssignedData notif ication. This generic parameter list enables PMG to support new parameter w ithout modifying the event XSD definition. Below are some of the parameters included in this:

a) DNPrefix

b) Technology Type – UMTS/LTE

c) AP Role (FC-AP-ROLE for enterprise APs)

d) AP Purpose (FC-AP-PURPOSE for enterprise APs)

e) UARFCN (FC-UARFCN-SINGLE for enterprise APs)

f) TAC (FC-TAC-ID for LTE)

g) eCGI (FC-ECGI- ID for LTE)

Sample AssignedData event: <AssignedData xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0"> <TxnID>DCCdccadmin468a05b2-4164-458b-93ae-81b7910c6ec1</TxnID> <EID>001B33-1234567890</EID> <SAI><MCC>116</MCC><MNC>116</MNC><LAC>1024</LAC><SAC>615</SAC></SAI> <LAC>1024</LAC> <GroupMemberships>

87

<Group><Name>NEW-ENT-1</Name><Type>Enterprise</Type></Group> <Group><Name>NEW-ENT-SITE-1</Name><Type>Site</Type></Group> <Group><Name>BGL-CELL-POOL-1</Name><Type>CELL-POOL</Type></Group> <Group><Name>BGL-SAI-POOL-1</Name><Type>SAI-POOL</Type></Group> <Group><Name>blr_area_band_2_5</Name><Type>Area</Type></Group> <Group><Name>blr_fgw</Name><Type>FemtoGateway</Type></Group> </GroupMemberships> <OccuredOn>2014-08-05T11:54:09Z</OccuredOn> <Parameters> <Parameter><Name>FC-DN-PREFIX</Name><Value>HNB-GW=,HNB-GW-SRV=blr_fgw,HeNB-GW=,HeNB-GW-SRV=, SeGW=,SeGW-SRV=blr_fgw,Area=blr_area_band_2_5,Enterprise=2,Site=1,Chassis ID=,RAT Type=,EID=001B33-1234567890,SecondaryID=,</Value></Parameter> <Parameter><Name>FC-AP-ROLE</Name><Value>IdleEntry</Value></Parameter> <Parameter><Name>FC-AP-PURPOSE</Name><Value>Capacity</Value></Parameter> <Parameter><Name>FC-UARFCN-SINGLE</Name><Value>10562</Value></Parameter> </Parameters> </AssignedData>

4.1.1.2 FirmwareUpgraded This notif ication is sent w hen a CPE first reports a f irmw are version that matches the NotifyOnFirmw areVersion element. If the CPE appears online w ith the desired f irmw are version each time, this notif ication w ill be generated.

<xs:element name="FirmwareUpgraded"> <xs:annotation> <xs:documentation> A notification that is emitted when a CPE first reports a firmware version that matches the NotifyOnFirmwareVersion element. If the Each time the CPE appears online with the desired firmware version this notification will be generated until an

88

FirmwareUpgradedResponse has been received that indicates the notification has been processed. </xs:documentation> </xs:annotation> <xs:complexType> <xs:sequence> <xs:element name="TxnID" type="TxnIDType" minOccurs="1" maxOccurs="1"/> <xs:element name="EID" type="EIDType" minOccurs="1" maxOccurs="1"/> <xs:element name="SecondaryID" type="SecondaryIDType" minOccurs="0" maxOccurs="1"/> <xs:element name="SubscriberID" type="SubscriberIDType" minOccurs="0" maxOccurs="1"/> <xs:element name="SAI" type="SAIType" minOccurs="0" maxOccurs="1"/> <xs:element name="CID" type="CIDType" minOccurs="0" maxOccurs="1"/> <xs:element name="OccuredOn" type="xs:dateTime" minOccurs="1" maxOccurs="1"/> </xs:sequence> </xs:complexType> </xs:element>

4.1.1.3 GroupCreated This event is generated by PMG w hen Groups are created through North Bound Interface (NBI). The subscriber can subscribe the event by specifying event type as GroupCreate. Optionally group type can be specif ied to receive the events of the particular group. By default, PMG w ill send the events for all group types.

<xs:element name="GroupCreated"> <xs:annotation> <xs:documentation> Notification sent to OSS after a group gets successfully created. </xs:documentation> </xs:annotation> <xs:complexType> <xs:sequence> <xs:element name="GroupName" type="xs:string" minOccurs="1" maxOccurs="1"/> <xs:element name="GroupTypeName" type="xs:string" minOccurs="1" maxOccurs="1"/>

89

<xs:element name="Parameters" type="ParametersType" minOccurs="0" maxOccurs="1"/> </xs:sequence> </xs:complexType> </xs:element>

Some of the parameters sent in GroupCreated notif ication include:

a) UARFCN

b) Expected Latitude (FC-EXP-LAT)

c) Expected Longitude (FC-EXP-LONG)

d) Site ID (FC-SITE- ID for Site Group creation)

Sample GroupCreated event:

<GroupCreated xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0">

<GroupName>CA-site12</GroupName><GroupTypeName>Site</GroupTypeName>

<Parameters>

<Parameter><Name>FC-SITE-ID</Name><Value>3</Value></Parameter>

<Parameter><Name>GROUPS</Name><Value>Enterprise:DefaultEnterprise,Area:DefaultArea,FemtoGateway:DefaultFGW</Value></Parameter>

<Parameter><Name>FC-UARFCN-SINGLE</Name><Value>9697</Value></Parameter>

</Parameters>

</GroupCreated>

Sample GroupCreated event response:

<GroupCreatedResponse xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0">

<TxnID>d98d5cd2-b4dc-424e-95f5-732b02c95635</TxnID>

<NotificationStatus>0</NotificationStatus>

</GroupCreatedResponse>

4.1.1.4 GroupUpdated This event is generated by PMG w hen Group is updated through NBI. The subscriber can subscribe this event by specifying the event type as GroupUpdate. Optionally group type can be

90

specif ied to receive the events of the particular group. By default, PMG w ill send the events for all group type.

<xs:element name="GroupUpdated"> <xs:annotation> <xs:documentation> Notification sent to OSS after a group gets updated with updated params. </xs:documentation> </xs:annotation> <xs:complexType> <xs:sequence> <xs:element name="GroupName" type="xs:string" minOccurs="1" maxOccurs="1"/> <xs:element name="GroupTypeName" type="xs:string" minOccurs="1" maxOccurs="1"/> <xs:element name="Parameters" type="ParametersType" minOccurs="0" maxOccurs="1"/> </xs:sequence> </xs:complexType> </xs:element>

Sample GroupUpdated event:

<GroupUpdated xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0"> <GroupName>CA-site12</GroupName> <GroupTypeName>Site</GroupTypeName> <Parameters> <Parameter><Name>GROUPS</Name><Value>Area:DefaultArea,Enterprise:DefaultEnterprise,FemtoGateway:DefaultFGW</Value></Parameter> <Parameter><Name>FC-UARFCN-SINGLE</Name><Value>9697</Value></Parameter> <Parameter><Name>FC_EXP_LAT</Name><Value>-34.56576</Value></Parameter> <Parameter><Name>FC_EXP_LONG</Name><Value>-14.3454</Value></Parameter> </Parameters> </GroupUpdated>

Sample GroupUpdated event response:

<GroupUpdatedResponse xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0">

91

<TxnID>d98d5cd2-b4dc-424e-95f5-732b02c95635</TxnID> <NotificationStatus>0</NotificationStatus> </GroupUpdatedResponse>

4.1.1.5 GroupDeleted This event is generated by PMG w hen a Group is deleted through NBI. The subscriber can subscribe this event by specifying event type as GroupDelete. Optionally group type can be specif ied to receive the events of that particular group. By default PMG w ill send the events for all group types.

<xs:element name="GroupDeleted"> <xs:annotation> <xs:documentation> Notification sent to OSS after a group gets deleted. </xs:documentation> </xs:annotation> <xs:complexType> <xs:sequence> <xs:element name="GroupName" type="xs:string" minOccurs="1" maxOccurs="1"/> <xs:element name="GroupTypeName" type="xs:string" minOccurs="1" maxOccurs="1"/> <xs:element name="Parameters" type="ParametersType" minOccurs="0" maxOccurs="1"/> </xs:sequence> </xs:complexType> </xs:element>

4.1.1.6 Location Status The LocationStatus notif ication is generated w hen the valid location f lag changes part of the location status has reached a notif ication value.

<xs:element name="LocationStatus"> <xs:annotation> <xs:documentation> Notifies that the CPE’s location status has changed or parts of it have reached notification values. The CPE's Valid Location flag is set to the content of the notification. The Radio Location Status is updated to the content of the notification (if included), as is the GPS Location Status.

92

The Service Activation Status may be set to "Enablement pending" if all pre-requisites are now met, otherwise will remain as "Pre-requisites not met". All updates only occur when the LocationStatusResponse has been received. The LocationStatus notification is generated when: <ul> <li>The Valid Location flag changes</li> <li>Part of the location status has reached a notification value</li> </ul> </xs:documentation> </xs:annotation> <xs:complexType> <xs:sequence> <xs:element name="TxnID" type="TxnIDType" minOccurs="1" maxOccurs="1"/> <xs:element name="EID" type="EIDType" minOccurs="1" maxOccurs="1"/> <xs:element name="SecondaryID" type="SecondaryIDType" minOccurs="0" maxOccurs="1"/> <xs:element name="SubscriberID" type="SubscriberIDType" minOccurs="0" maxOccurs="1"/> <xs:element name="SAI" type="SAIType" minOccurs="0" maxOccurs="1"/> <xs:element name="CID" type="CIDType" minOccurs="0" maxOccurs="1"/> <xs:element name="ExpectedLocation" type="ExpectedLocationType" minOccurs="0" maxOccurs="1"/> <xs:element name="GPS" type="GPSEventDataType" minOccurs="0" maxOccurs="1"/> <xs:element name="IPAddress" type="IPAddressType" minOccurs="0" maxOccurs="1"/> <xs:element name="ExpectedDetectedNeighbors" type="ExpectedDetectedNeighborEventDataType" minOccurs="0" maxOccurs="1"/> <xs:element name="DetectedNeighborLocation" type="DetectedNeighborLocationEventDataType" minOccurs="0" maxOccurs="1"/> <xs:element name="DetectedNeighborMCCMNC" type="DetectedNeighborMCCMNCEventDataType" minOccurs="0" maxOccurs="1"/>

93

<xs:element name="IPSubnetMatch" type="IPSubnetMatchEventDataType" minOccurs="0" maxOccurs="1"/> <xs:element name="DetectedNeighborBenchmark" type="DetectedNeighborBenchmarkEventDataType" minOccurs="0" maxOccurs="1"/> <xs:element name="DectectedRadioNeighbors" type="RadioNeighborsType" minOccurs="0" maxOccurs="1"/> <xs:element name="ValidLocation" type="xs:boolean" minOccurs="0" maxOccurs="1"/> <xs:element name="LocationVerification" type="xs:boolean" minOccurs="0" maxOccurs="1"/> <xs:element name="OccuredOn" type="xs:dateTime" minOccurs="1" maxOccurs="1"/> </xs:sequence> </xs:complexType> </xs:element>

Sample LocationStatus event:

i)

<?xml version="1.0" encoding="UTF-8" standalone="no"?><LocationStatus xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0"><TxnID>941f5f28-9c6c-4fae-be4c-757aa30c7a0c</TxnID><EID>001B67-357539015670272</EID><SubscriberID>sseadmin</SubscriberID><CID>618</CID><ExpectedLocation><ExpectedLatitude>57.999461</ExpectedLatitude><ExpectedLongitude>-134.19359</ExpectedLongitude></ExpectedLocation><GPS><Status>Valid location</Status><Latitude>57.999404</Latitude><Longitude>-134.194015</Longitude><Tolerance>300000</Tolerance><Locked>true</Locked><Distance>25</Distance></GPS><DetectedNeighborMCCMNC><Status>Valid location</Status><IDList><DNM><MCC>116</MCC><MNC>116</MNC></DNM></IDList></DetectedNeighborMCCMNC><DetectedNeighborBenchmark><Status>Valid location</Status></DetectedNeighborBenchmark><ValidLocation>true</ValidLocation><LocationVerification>true</LocationVerification><OccuredOn>2014-08-13T10:40:32Z</OccuredOn></LocationStatus>

ii) <?xml version="1.0" encoding="UTF-8" standalone="no"?><LocationStatus

94

xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0"><TxnID>1d0c8a4c-ef73-41d2-bd1d-2d02f0cd740f</TxnID><EID>001B67-357539017728995</EID><SubscriberID>sseadmin</SubscriberID><CID>619</CID><ExpectedLocation><EDNIDList><RadioNeighbor><Radio3GNeighborID><MCC>116</MCC><MNC>116</MNC><RNCID>00116</RNCID><CID>00618</CID></Radio3GNeighborID></RadioNeighbor></EDNIDList></ExpectedLocation><GPS><Locked>false</Locked></GPS><ExpectedDetectedNeighbors><Status>Valid location</Status><Tolerance>1</Tolerance><Matched>1</Matched></ExpectedDetectedNeighbors><DetectedNeighborLocation><Status>Valid location</Status><Tolerance>8000</Tolerance></DetectedNeighborLocation><DetectedNeighborMCCMNC><Status>Valid location</Status><IDList><DNM><MCC>116</MCC><MNC>116</MNC></DNM></IDList></DetectedNeighborMCCMNC><DetectedNeighborBenchmark><Status>Valid location</Status></DetectedNeighborBenchmark><ValidLocation>true</ValidLocation><LocationVerification>true</LocationVerification><OccuredOn>2014-08-18T15:14:27Z</OccuredOn></LocationStatus>

4.1.1.7 Online This notif ication is sent w hen a CPE first appears online.

<xs:element name="Online"> <xs:annotation> <xs:documentation> A notification that is emitted when a CPE first appears online. Using the Update inbound request message, the AppearedOnline flag can be reset which will cause the Online notification to be emitted again the next time the CPE appears online. Each time the CPE appears online this notification will be generated until an OnlineResponse has been received that indicates the notification has been processed.

95

 The CPE's Appeared Online flag is set to true. The Service Activation Status may be set to "Enablement pending" if all pre-requisites are now met, otherwise will remain as "Pre-requisites not met". </xs:documentation> </xs:annotation> <xs:complexType> <xs:sequence> <xs:element name="TxnID" type="TxnIDType" minOccurs="1" maxOccurs="1"/> <xs:element name="EID" type="EIDType" minOccurs="1" maxOccurs="1"/> <xs:element name="SecondaryID" type="SecondaryIDType" minOccurs="0" maxOccurs="1"/> <xs:element name="SubscriberID" type="SubscriberIDType" minOccurs="0" maxOccurs="1"/> <xs:element name="SAI" type="SAIType" minOccurs="0" maxOccurs="1"/> <xs:element name="CID" type="CIDType" minOccurs="0" maxOccurs="1"/> <xs:element name="OccuredOn" type="xs:dateTime" minOccurs="1" maxOccurs="1"/> </xs:sequence> </xs:complexType> </xs:element>

Sample Online event:

<Online xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0"> <TxnID>d98d5cd2-b4dc-424e-95f5-732b02c95635</TxnID> <EID>001B67-357539019247622</EID> <SAI><MCC>116</MCC><MNC>116</MNC><LAC>1024</LAC><SAC>615</SAC></SAI> <CID>129</CID> <OccuredOn>2014-08-05T22:00:08Z</OccuredOn> </Online>

Sample Online event response:

<OnlineResponse xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0">

96

<TxnID>d98d5cd2-b4dc-424e-95f5-732b02c95635</TxnID> <NotificationStatus>0</NotificationStatus> </OnlineResponse>

4.1.1.8 Service Error This notif ication is sent w hen there is an error in enabling service on the CPE (for example, unable to connect to gatew ay or interference issue). This is either an enablement error or configuration error.

<xs:element name="ServiceError"> <xs:annotation> <xs:documentation> Notifies that there has been an error enabling service on the CPE (e.g. unable to connect to gateway, or interference issue). This is either an enablement error or an error make service operational. The Service Activation Status is set to the included status (optionally with a cause). Only generated when the previous Service Activation Status value was not "Operational". </xs:documentation> </xs:annotation> <xs:complexType> <xs:sequence> <xs:element name="TxnID" type="TxnIDType" minOccurs="1" maxOccurs="1"/> <xs:element name="EID" type="EIDType" minOccurs="1" maxOccurs="1"/> <xs:element name="SecondaryID" type="SecondaryIDType" minOccurs="0" maxOccurs="1"/> <xs:element name="SubscriberID" type="SubscriberIDType" minOccurs="0" maxOccurs="1"/> <xs:element name="SAI" type="SAIType" minOccurs="0" maxOccurs="1"/> <xs:element name="CID" type="CIDType" minOccurs="0" maxOccurs="1"/> <xs:element name="OccuredOn" type="xs:dateTime" minOccurs="1" maxOccurs="1"/>

97

<xs:element name="ServiceActivationError" type="xs:string" minOccurs="0" maxOccurs="1"/> </xs:sequence> </xs:complexType> </xs:element>

Sample ServiceError event:

<ServiceError xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0"> <TxnID>d98d5cd2-b4dc-424e-95f5-732b02c95635</TxnID> <EID>001B67-357539019247622</EID> <SAI><MCC>116</MCC><MNC>116</MNC><LAC>1024</LAC><SAC>615</SAC></SAI> <CID>129</CID> <OccuredOn>2014-08-05T22:00:08Z</OccuredOn> <ServiceActivationError>Operation error : EventType:Communications Alarm ,ProbableCause:HNB-GW Communication Failure ,SpecificProblem:Radio Activation Failure</ServiceActivationError> </ServiceError>

Sample ServiceError event response:

<ServiceErrorResponse xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0"> <TxnID>d98d5cd2-b4dc-424e-95f5-732b02c95635</TxnID> <NotificationStatus>0</NotificationStatus> </ServiceErrorResponse>

4.1.1.9 Service Operational This event notif ies that service is operational on the CPE after it w as enabled.

<xs:element name="ServiceOperational"> <xs:annotation> <xs:documentation> Notifies that service is now operational on the CPE after it was enabled. The Service Activation Status is set to "Operational". Generated when: <ul> <li>

98

This is the first time it has been set to "Operational" or </li> <li> It was previously changed from "Operational" due to the CPE’s location becoming invalid; now CPE’s the location is valid </li> </ul> </xs:documentation> </xs:annotation> <xs:complexType> <xs:sequence> <xs:element name="TxnID" type="TxnIDType" minOccurs="1" maxOccurs="1"/> <xs:element name="EID" type="EIDType" minOccurs="1" maxOccurs="1"/> <xs:element name="SecondaryID" type="SecondaryIDType" minOccurs="0" maxOccurs="1"/> <xs:element name="SubscriberID" type="SubscriberIDType" minOccurs="0" maxOccurs="1"/> <xs:element name="SAI" type="SAIType" minOccurs="0" maxOccurs="1"/> <xs:element name="CID" type="CIDType" minOccurs="0" maxOccurs="1"/> <xs:element name="OccuredOn" type="xs:dateTime" minOccurs="1" maxOccurs="1"/> </xs:sequence> </xs:complexType> </xs:element>

Sample ServiceOperational event:

<ServiceOperational xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0"> <TxnID>d98d5cd2-b4dc-424e-95f5-732b02c95635</TxnID> <EID>001B67-357539019247622</EID> <SAI><MCC>116</MCC><MNC>116</MNC><LAC>1024</LAC><SAC>615</SAC></SAI> <CID>129</CID> <OccuredOn>2014-08-05T22:00:08Z</OccuredOn> </ServiceOperational>

99

Sample ServiceOperational event response:

<ServiceOperationalResponse xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0"> <TxnID>d98d5cd2-b4dc-424e-95f5-732b02c95635</TxnID> <NotificationStatus>0</NotificationStatus> </ServiceOperationalResponse>

4.1.1.10 Tampered This event notif ies that the reported CPE has been physically tampered.

A tampered CPE does not have its service provisioned.

<xs:element name="Tampered"> <xs:annotation> <xs:documentation> Notifies that the CPE has reported it has been physically tampered with. A tampered CPE does not have its service provisioned. Each time the CPE reports that it has been tampered this notification will be generated until a successful TamperedResponse has been received. The CPE's Tampered flag is set to true. The Service Activation Status is set to "Pre-requisites not met". </xs:documentation> </xs:annotation> <xs:complexType> <xs:sequence> <xs:element name="TxnID" type="TxnIDType" minOccurs="1" maxOccurs="1"/> <xs:element name="EID" type="EIDType" minOccurs="1" maxOccurs="1"/> <xs:element name="SecondaryID" type="SecondaryIDType" minOccurs="0" maxOccurs="1"/> <xs:element name="SubscriberID" type="SubscriberIDType" minOccurs="0" maxOccurs="1"/> <xs:element name="SAI" type="SAIType" minOccurs="0" maxOccurs="1"/> <xs:element name="CID" type="CIDType" minOccurs="0" maxOccurs="1"/> <xs:element name="OccuredOn" type="xs:dateTime" minOccurs="1" maxOccurs="1"/> </xs:sequence>

100

</xs:complexType> </xs:element>

4.1.1.11 IpAddressUpdate A notif ication w ill be sent to those OSS w ho has subscribed for this notif ication w ith the event name “IPAddressUpdate” w henever there is a change in the public/Natted IP address of the AP.

<xs:element name="IpAddressUpdate"> <xs:annotation> <xs:documentation> Whenever there is a cahnge in the IP Address of the CPE, this event notification will be sent. </xs:documentation> </xs:annotation> <xs:complexType> <xs:sequence> <xs:element name="TxnID" type="TxnIDType" minOccurs="1" maxOccurs="1"/> <xs:element name="EID" type="EIDType" minOccurs="1" maxOccurs="1"/> <xs:element name="CellID" type="xs:string" minOccurs="0" maxOccurs="1"/> <xs:element name="OldIpAddress" type="IPAddressType" minOccurs="0" maxOccurs="1"/> <xs:element name="NewIpAddress" type="IPAddressType" minOccurs="1" maxOccurs="1"/> <xs:element name="OccuredOn" type="xs:dateTime" minOccurs="1" maxOccurs="1"/> </xs:sequence> </xs:complexType> </xs:element>

Sample event:

Below is the sample notif ication sent to OSS w hen the AP w ill communicate w ith RMS for the f irst time :

<?xml version="1.0" encoding="UTF-8" standalone="no"?><IpAddressUpdate xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0"><TxnID>b9ae5825-bcaa-4cdc-b20e-d75d1f926a0e</TxnID><EID>001B67-

101

ABC00007</EID><CellID>614</CellID><NewIpAddress>10.5.2.36</NewIpAddress><OccuredOn>2015-04-14T05:38:46Z</OccuredOn></IpAddressUpdate> Below is the sample notif ication sent to OSS w hen the IP address of the already communicated AP is changed : <?xml version="1.0" encoding="UTF-8" standalone="no"?><IpAddressUpdate xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0"><TxnID>b9ae5825-bcaa-4cdc-b20e-d75d1f926a0e</TxnID><EID>001B67-ABC00007</EID><CellID>614</CellID><OldIpAddress>10.5.2.36</OldIpAddress><NewIpAddress>10.5.2.38</NewIpAddress><OccuredOn>2015-04-14T05:38:46Z</OccuredOn></IpAddressUpdate> The successful 200OK response of the IPAddress Update Notif ication as below : <?xml version="1.0" encoding="UTF-8"?><IpAddressUpdateResponse xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0"> <TxnID>b9ae5825-bcaa-4cdc-b20e-d75d1f926a0e</TxnID> <NotificationStatus>0</NotificationStatus> </IpAddressUpdateResponse>

4.2 Unsubscribe Subscriber can send <unsubscribe> message to PMG for unsubscribing events w ith the subscriber name.

The follow ing is the sample xml request for event unsubscribe,

<unsubscribe subscriber-name=”OSS-1” />

Follow ing is the example of Unsubscriber message:

<UnSubscribe subscriber-name="OSS-1" xsi:schemaLocation="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0 pmg-messages-v3_0_0.xsd" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0"> <TxnID>Subscribe-trans-1234567890</TxnID> </UnSubscribe>

http://www.cisco.com/ca/sse/PMGMessages-v3_0_0%22

102

5 User Management NB API

RMS user mananagement w as limited to DCC UI only. From RMS 5.1 release, RMS user mananagement can be carried out through PMG User Management NB API as w ell. Follow ing sections describes schema, sample requests and responses for each API. The schema xsd f ile includes definition of each API, validations and messages returned in response.

5.1 General 5.1.1 Schema Follow ing is a snippet of schema xsd f ile specif ic to the user management API. It is a part of pmg-messages-v3_0_0.xsd f ile.

5.1.2 Accessing API All other user management API other than UpdateUserPassw ord API need administrator privileges to get invoked. When a new user is created, he/she can access only UpdateUserPassw ord api and rest of the api can only be accessed once passw ord is changed using UpdateUserPassw ord api or through DCC UI if user has access to DCC UI.. The same is applicable to the default users (e.g. user “pmgadmin”) created during installation time. The default user “pmguser” is excluded as it is used internally by DCC components to access PMG.

5.2 GetUMRoles

The API returns a list of all User Management roles (UMRoles) available in RMS. It includes access levels keys associated w ith each role. The access level key maps to “Permission level” e.g. “Groups”, “Device Manager” etc. and “access type” e.g. Off, Read Only, Read-Write. The key description provides display text for the access level key. Additional details for any access level key can retrieved w ith the help of another API GetUMRoleAccessLevels.

The default roles present w ill be:

Role Access Levels Description

Superuser Device Manager - Read Write Advanced

Upgrade Monitor

Administration

Groups and IDs

103

Group Types - Read Write

Groups - Read Write Advanced

ID Pool Types - Read Write

Pools - Read Write

Configuration

Access PMG API

Dccadmin Device Manager - Read Write Advanced

Upgrade Monitor

Administration

Groups and IDs

Group Types - Read Write

Groups - Read Write Advanced

ID Pool Types - Read Write

Pools - Read Write

Configuration

Dccreadonly Groups - Read Only

Device Manager - Read Only

Pools - Read Only

Upgrade Monitor

ID Pool Types - Read Only

Group Types - Read Only

Groups and IDs

Pmgadmin Administration

Access PMG API

Pmgreadonly Access PMG API

104

5.2.1 Request <GetUMRoles xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0"> <TxnID>DCCdccadmin8fc0e57e-220e-4d07-8cd8-d2f228299968</TxnID> </GetUMRoles>

5.2.2 Response <?xml version="1.0" encoding="UTF-8" standalone="no"?> <GetUMRolesResponse xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0"> <TxnID>DCCdccadmin8fc0e57e-220e-4d07-8cd8-d2f228299968</TxnID> <Status> <Code>0</Code> <Message>Success</Message> </Status> <Roles> <Role> <Name>pmgadmin</Name> <PasswordLifetime>180</PasswordLifetime> <PasswordWarningPeriod>28</PasswordWarningPeriod> <PasswordGracePeriod>3</PasswordGracePeriod> <AccessLevelKeys> <Key> <Name>admin</Name> <Description>Administration</Description> </Key> <Key> <Name>accessPmgApi</Name> <Description>Access PMG API</Description> </Key> </AccessLevelKeys> </Role> <Role> <Name>dccadmin</Name> <PasswordLifetime>180</PasswordLifetime> <PasswordWarningPeriod>28</PasswordWarningPeriod> <PasswordGracePeriod>3</PasswordGracePeriod> <AccessLevelKeys> <Key> <Name>sdmRWAdvanced</Name> <Description>Device Manager - Read Write Advanced</Description>

105

</Key> <Key> <Name>admin</Name> <Description>Administration</Description> </Key> <Key> <Name>bulkGroupManager</Name> <Description>Groups and IDs</Description> </Key> <Key> <Name>grpTypeMgmtRW</Name> <Description>Group Types - Read Write</Description> </Key> <Key> <Name>grpMgmtAdvanced</Name> <Description>Groups - Read Write Advanced</Description> </Key> <Key> <Name>idPlTypeMgmtRW</Name> <Description>ID Pool Types - Read Write</Description> </Key> <Key> <Name>idPlMgmtRW</Name> <Description>Pools - Read Write</Description> </Key> <Key> <Name>config</Name> <Description>Configuration</Description> </Key> </AccessLevelKeys> </Role> <Role> <Name>dccreadonly</Name> <PasswordLifetime>180</PasswordLifetime> <PasswordWarningPeriod>28</PasswordWarningPeriod> <PasswordGracePeriod>3</PasswordGracePeriod> <AccessLevelKeys> <Key> <Name>sdmRO</Name>

106

<Description>Device Manager - Read Only</Description> </Key> <Key> <Name>bulkGroupManager</Name> <Description>Groups and IDs</Description> </Key> <Key> <Name>grpTypeMgmtRO</Name> <Description>Group Types - Read Only</Description> </Key> <Key> <Name>grpMgmtRO</Name> <Description>Groups - Read Only</Description> </Key> <Key> <Name>idPlTypeMgmtRO</Name> <Description>ID Pool Types - Read Only</Description> </Key> <Key> <Name>idPlMgmtRO</Name> <Description>Pools - Read Only</Description> </Key> </AccessLevelKeys> </Role> <Role> <Name>pmgreadonly</Name> <PasswordLifetime>180</PasswordLifetime> <PasswordWarningPeriod>28</PasswordWarningPeriod> <PasswordGracePeriod>3</PasswordGracePeriod> <AccessLevelKeys> <Key> <Name>accessPmgApi</Name> <Description>Access PMG API</Description> </Key> </AccessLevelKeys> </Role> <Role> <Name>superuser</Name> <PasswordLifetime>180</PasswordLifetime> <PasswordWarningPeriod>28</PasswordWarningPeriod>

107

<PasswordGracePeriod>3</PasswordGracePeriod> <AccessLevelKeys> <Key> <Name>sdmRWAdvanced</Name> <Description>Device Manager - Read Write Advanced</Description> </Key> <Key> <Name>admin</Name> <Description>Administration</Description> </Key> <Key> <Name>bulkGroupManager</Name> <Description>Groups and IDs</Description> </Key> <Key> <Name>grpTypeMgmtRW</Name> <Description>Group Types - Read Write</Description> </Key> <Key> <Name>grpMgmtAdvanced</Name> <Description>Groups - Read Write Advanced</Description> </Key> <Key> <Name>idPlTypeMgmtRW</Name> <Description>ID Pool Types - Read Write</Description> </Key> <Key> <Name>idPlMgmtRW</Name> <Description>Pools - Read Write</Description> </Key> <Key> <Name>config</Name> <Description>Configuration</Description> </Key> <Key> <Name>accessPmgApi</Name> <Description>Access PMG API</Description> </Key>

108

</AccessLevelKeys> </Role> </Roles> </GetUMRolesResponse>

5.3 GetUMRoleAccessLevels The API returns a list of all role access levels available in RMS w ith respective details of each access level. The details include respective “Permission level” e.g. “Groups”, “Device Manager” etc. and “access type” e.g. Off, Read Only, Read-Write.

The possible role access level values are:

Access Level Key Description Permission Level Access Type

UIDisplay

sdmRO Device Manager - Read Only

Device Manager Read Only Device Manager

sdmRWBasic Device Manager - Read Write Basic

Device Manager Read Write Basic

Device Manager

sdmRWAdvanced

Device Manager - Read Write Advanced

Device Manager Read Write Advanced

Device Manager

umt Upgrade Monitor Upgrade Monitor On Upgrade Monitor

admin Administration Administration On

bulkGroupManager Groups and IDs Groups and IDs Groups and IDs

Groups and IDs

grpTypeMgmtRO Group Types - Read Only

Groups and IDs Read Only Group Types

grpTypeMgmtRW Group Types - Read Write

Groups and IDs Read Write Group Types

grpMgmtRO Groups - Read Only Groups and IDs Read Only Groups

grpMgmtRW Groups - Read Write Basic

Groups and IDs Read Write Basic

Groups

grpMgmtAdvanced Groups - Read Write Advanced

Groups and IDs Read Write Advanced

Groups

109

idPlTypeMgmtRO ID Pool Types - Read Only

Groups and IDs Read Only ID Pool Types

idPlTypeMgmtRW ID Pool Types - Read Write

Groups and IDs Read Write ID Pool Types

idPlMgmtRO Pools - Read Only Groups and IDs Read Only Pools

idPlMgmtRW Pools - Read Write Groups and IDs Read Write Pools

Config Configuration Configuration On Configuration

accessPmgApi Access PMG API Access PMG API On Access PMG API

Note:

As roles and users created through User Management Api are reflecting same functionality as those created through DCC UI, there are some restrictions w hile associating Access Levels to a role.

1. Access Level data is a metadata created w hen application is installed and it is not meant to be changed through any interface.

2. Only one access type is allow ed for per Permission Level component (UIDisplay column in the table above).

3. While associating Groups and Ids access levels to a role, the base access level key “bulkGroupManager” and at least one other Groups and Ids access level key is required.

5.3.1 Request <GetUMRoleAccessLevels xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:schemaLocation="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0 pmg-messages-v3_0_0.xsd"> <TxnID> GetUMRoleAccessLevels-trans-1234567890</TxnID> </GetUMRoleAccessLevels>

5.3.2 Response <?xml version="1.0" encoding="UTF-8" standalone="no"?><GetUMRoleAccessLevelsResponse xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0"> <TxnID>GetUMRoleAccessLevels-trans-1234567890</TxnID><Status><Code>0</Code><Message>Success</Message></Status> <AccessLevels> <AccessLevel>

110

<Key>sdmRO</Key> <Description>Device Manager - Read Only</Description> <PermissionLevel>sdm</PermissionLevel> <PermissionLevelDesc>Device Manager</PermissionLevelDesc> <AccessType>Read Only</AccessType> <UIDisplay>Device Manager</UIDisplay> </AccessLevel> <AccessLevel> <Key>sdmRWBasic</Key> <Description>Device Manager - Read Write Basic</Description> <PermissionLevel>sdm</PermissionLevel> <PermissionLevelDesc>Device Manager</PermissionLevelDesc> <AccessType>Read Write Basic</AccessType> <UIDisplay>Device Manager</UIDisplay> </AccessLevel> <AccessLevel><Key>sdmRWAdvanced</Key> <Description>Device Manager - Read Write Advanced</Description> <PermissionLevel>sdm</PermissionLevel> <PermissionLevelDesc>Device Manager</PermissionLevelDesc> <AccessType>Read Write Advanced</AccessType> <UIDisplay>Device Manager</UIDisplay> </AccessLevel> <AccessLevel><Key>admin</Key> <Description>Administration</Description> <PermissionLevel>admin</PermissionLevel> <PermissionLevelDesc>Administration</PermissionLevelDesc> <AccessType>On</AccessType> <UIDisplay>Administration</UIDisplay> </AccessLevel> <AccessLevel><Key>bulkGroupManager</Key> <Description>Groups and IDs</Description> <PermissionLevel>bulkGroupManager</PermissionLevel> <PermissionLevelDesc>Groups and IDs</PermissionLevelDesc> <AccessType>Groups and IDs</AccessType> <UIDisplay>Groups and IDs</UIDisplay> </AccessLevel> <AccessLevel><Key>grpTypeMgmtRO</Key> <Description>Group Types - Read Only</Description> <PermissionLevel>groupTypeManagement</PermissionLevel> <PermissionLevelDesc>Groups and IDs</PermissionLevelDesc> <AccessType>Read Only</AccessType> <UIDisplay>Group Types</UIDisplay> </AccessLevel> <AccessLevel><Key>grpTypeMgmtRW</Key> <Description>Group Types - Read Write</Description> <PermissionLevel>groupTypeManagement</PermissionLevel> <PermissionLevelDesc>Groups and IDs</PermissionLevelDesc>

111

<AccessType>Read Write</AccessType> <UIDisplay>Group Types</UIDisplay> </AccessLevel> <AccessLevel><Key>grpMgmtRO</Key> <Description>Groups - Read Only</Description> <PermissionLevel>groupManagement</PermissionLevel> <PermissionLevelDesc>Groups and IDs</PermissionLevelDesc> <AccessType>Read Only</AccessType> <UIDisplay>Groups</UIDisplay> </AccessLevel> <AccessLevel><Key>grpMgmtRW</Key> <Description>Groups - Read Write Basic</Description> <PermissionLevel>groupManagement</PermissionLevel> <PermissionLevelDesc>Groups and IDs</PermissionLevelDesc> <AccessType>Read Write Basic</AccessType> <UIDisplay>Groups</UIDisplay> </AccessLevel> <AccessLevel><Key>grpMgmtAdvanced</Key> <Description>Groups - Read Write Advanced</Description> <PermissionLevel>groupManagement</PermissionLevel> <PermissionLevelDesc>Groups and IDs</PermissionLevelDesc> <AccessType>Read Write Advanced</AccessType> <UIDisplay>Groups</UIDisplay> </AccessLevel> <AccessLevel><Key>idPlTypeMgmtRO</Key> <Description>ID Pool Types - Read Only</Description> <PermissionLevel>idPoolTypeManagement</PermissionLevel> <PermissionLevelDesc>Groups and IDs</PermissionLevelDesc> <AccessType>Read Only</AccessType> <UIDisplay>ID Pool Types</UIDisplay> </AccessLevel> <AccessLevel><Key>idPlTypeMgmtRW</Key> <Description>ID Pool Types - Read Write</Description> <PermissionLevel>idPoolTypeManagement</PermissionLevel> <PermissionLevelDesc>Groups and IDs</PermissionLevelDesc> <AccessType>Read Write</AccessType> <UIDisplay>ID Pool Types</UIDisplay> </AccessLevel> <AccessLevel><Key>idPlMgmtRO</Key> <Description>Pools - Read Only</Description> <PermissionLevel>idPoolManagement</PermissionLevel> <PermissionLevelDesc>Groups and IDs</PermissionLevelDesc> <AccessType>Read Only</AccessType> <UIDisplay>Pools</UIDisplay> </AccessLevel> <AccessLevel><Key>idPlMgmtRW</Key> <Description>Pools - Read Write</Description>

112

<PermissionLevel>idPoolManagement</PermissionLevel> <PermissionLevelDesc>Groups and IDs</PermissionLevelDesc> <AccessType>Read Write</AccessType> <UIDisplay>Pools</UIDisplay> </AccessLevel> <AccessLevel><Key>config</Key> <Description>Configuration</Description> <PermissionLevel>config</PermissionLevel> <PermissionLevelDesc>Configuration</PermissionLevelDesc> <AccessType>On</AccessType> <UIDisplay>Configuration</UIDisplay> </AccessLevel> <AccessLevel><Key>accessPmgApi</Key> <Description>Access PMG API</Description> <PermissionLevel>accessPmgApi</PermissionLevel> <PermissionLevelDesc>Access PMG API</PermissionLevelDesc> <AccessType>On</AccessType> <UIDisplay>Access PMG API</UIDisplay> </AccessLevel> </AccessLevels> </GetUMRoleAccessLevelsResponse>

5.4 CreateUMRole The API is used to create a new User Management role in RMS. The access levels validations mentioned in section 9.3 GetUMRoleAccessLevels are applicable w hile creating roles. To be in sync w ith DCC UI functionality, Rolename is case sensitive, i.e. “superuser” and “SUPERuser” are treated as tw o different rolenames. This is also applicable to rolename used in other user management API. Now roles support three more attributes to facilitate passw ord expiration evaluation, below are the parameters through w hich values for these parameter can be provided:

1. Passw ordLifetime ( 180 days by default) (range 2 - 365)

2. Passw ordWarningPeriod ( 14 days by default) (range 1 - 28)

3. Passw ordGracePeriod (3 days by default) (range 0 - 7)

These parameters are optional. If the value of these parameters are not provided, then default values w ill be used. If the value of Passw ordLifetime is kept as 0 (zero), then the passw ord w ill never expire and hence the other tw o parameters, in that case, have no effect and shouldn't be provided.

5.4.1 Request <CreateUMRole xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0"> <TxnID>DCCdccadmine4c47b3e-8c6e-4617-8aac-e886aad8f5aa</TxnID> <Role>

113

<Name>test_role_1</Name> <PasswordLifetime>180</PasswordLifetime> <PasswordWarningPeriod>28</PasswordWarningPeriod> <PasswordGracePeriod>2</PasswordGracePeriod> <AccessLevelKeys> <Key> <Name>grpMgmtRW</Name> </Key> <Key> <Name>sdmRWBasic</Name> </Key> <Key> <Name>admin</Name> </Key> <Key> <Name>idPlMgmtRW</Name> </Key> <Key> <Name>idPlTypeMgmtRW</Name> </Key> <Key> <Name>grpTypeMgmtRW</Name> </Key> <Key> <Name>accessPmgApi</Name> </Key> <Key> <Name>bulkGroupManager</Name> </Key> </AccessLevelKeys> </Role> </CreateUMRole>

5.4.2 Response <?xml version="1.0" encoding="UTF-8" standalone="no"?> <CreateUMRoleResponse xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0"> <TxnID>DCCdccadmine4c47b3e-8c6e-4617-8aac-e886aad8f5aa</TxnID> <Status> <Code>0</Code> <Message>Success</Message> </Status> </CreateUMRoleResponse>

114

5.5 UpdateUMRole The API updates existing user management role for the access levels mentioned in the request. The API removes existing access levels associations and adds new access levels associations to the role. The access levels validations mentioned in section 9.3 GetUMRoleAccessLevels are applicable w hile updating roles.

5.5.1 Request <UpdateUMRole xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0"> <TxnID>DCCdccadmin8fc0e57e-220e-4d07-8cd8-d2f228299968</TxnID> <Role> <Name>test_role_1</Name> <PasswordLifetime>160</PasswordLifetime> <PasswordWarningPeriod>10</PasswordWarningPeriod> <PasswordGracePeriod>4</PasswordGracePeriod> <AccessLevelKeys> <Key> <Name>grpMgmtRW</Name> </Key> <Key> <Name>sdmRWAdvanced</Name> </Key> <Key> <Name>admin</Name> </Key> <Key> <Name>config</Name> </Key> <Key> <Name>idPlTypeMgmtRO</Name> </Key> <Key> <Name>grpTypeMgmtRW</Name> </Key> <Key> <Name>accessPmgApi</Name> </Key> <Key> <Name>bulkGroupManager</Name> </Key> </AccessLevelKeys> </Role> </UpdateUMRole>

115

5.5.2 Response <?xml version="1.0" encoding="UTF-8" standalone="no"?> <UpdateUMRoleResponse xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0"> <TxnID>DCCdccadmin8fc0e57e-220e-4d07-8cd8-d2f228299968</TxnID> <Status> <Code>0</Code> <Message>Success</Message> </Status> </UpdateUMRoleResponse>

5.6 DeleteUMRole The API deletes existing user management role from RMS. If the role is associated w ith any user, an appropriate error message is returned in the response.

5.6.1 Request <DeleteUMRole xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:schemaLocation="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0 pmg-messages-v3_0_0.xsd"> <TxnID>DeleteUMRole-trans-1234567890</TxnID> <RoleName>existingUMRole</RoleName> </DeleteUMRole >

5.6.2 Response <?xml version="1.0" encoding="UTF-8" standalone="no"?> <DeleteUMRoleResponse xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0"> <TxnID>DeleteUMRole-trans-1234567890</TxnID> <Status><Code>0</Code><Message>Success</Message></Status> </DeleteUMRoleResponse>

5.7 CreateUser The API creates a new user in RMS. The passw ord value w ould be in encrypted format. To be in sync w ith DCC UI functionality, the username entered in case (upper/mixed/low er) w ill be created in low ercase. So username is not case sensitive, i.e. “testuser” and “TESTuser” w ill be treated as same username. This is also applicable to username used in other user management API.

116

5.7.1 Request <CreateUser xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:schemaLocation="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0 pmg-messages-v3_0_0.xsd"> <TxnID>CreateUser-trans-1234567890</TxnID> <User> <UserName>newUserName</UserName> <Password>newPassword</Password> <RoleName>rolename</RoleName> </User> </CreateUser>

5.7.2 Response <?xml version="1.0" encoding="UTF-8" standalone="no"?> <CreateUserResponse xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0"> <TxnID>CreateUser-trans-1234567890</TxnID> <Status><Code>0</Code><Message>Success</Message></Status> </CreateUserResponse>

5.8 GetUsers The API returns a list of users available in RMS. The API accepts Locked/Unlocked f lag and rolename as f ilter attributes. If either of this f ilter attributes is not specif ied, the respective f ilter is ignored. If none of the f ilter attributes is specif ied, the API returns all users available in RMS system.

5.8.1 Request <GetUsers xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:schemaLocation="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0 pmg-messages-v3_0_0.xsd"> <TxnID>CreateUser-trans-1234567890</TxnID>  </GetUsers>

117

5.8.2 Response <?xml version="1.0" encoding="UTF-8" standalone="no"?><GetUsersResponse xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0"> <TxnID>CreateUser-trans-1234567890</TxnID> <Status><Code>0</Code> <Message>Success</Message></Status> <UserNames> <UserName>rmsadmin</UserName> <UserName>dccadmin</UserName> <UserName>pmgadmin</UserName> <UserName>pmguser</UserName> </UserNames> </GetUsersResponse>

5.9 GetUserDetail The API returns role details for specif ied user.

5.9.1 Request <GetUserDetail xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0"> <TxnID>DCCdccadmin8fc0e57e-220e-4d07-8cd8-d2f228299968</TxnID> <UserName>pmgadmin</UserName> </GetUserDetail>

118

5.9.2 Response <?xml version="1.0" encoding="UTF-8" standalone="no"?> <GetUserDetailResponse xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0"> <TxnID>DCCdccadmin8fc0e57e-220e-4d07-8cd8-d2f228299968</TxnID> <Status> <Code>0</Code> <Message>Success</Message> </Status> <UserDetail> <UserName>pmgadmin</UserName> <Role> <Name>pmgadmin</Name> <PasswordLifetime>180</PasswordLifetime> <PasswordWarningPeriod>28</PasswordWarningPeriod> <PasswordGracePeriod>3</PasswordGracePeriod> <AccessLevelKeys> <Key> <Name>admin</Name> <Description>Administration</Description> </Key> <Key> <Name>accessPmgApi</Name> <Description>Access PMG API</Description> </Key> </AccessLevelKeys> </Role> <IsLocked>false</IsLocked> <IsExtAuth>false</IsExtAuth> </UserDetail> </GetUserDetailResponse>

5.10 DeleteUser The API deletes user from RMS.

5.10.1 Request <DeleteUser xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"

119

xsi:schemaLocation="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0 pmg-messages-v3_0_0.xsd"> <TxnID>DeleteUser-trans-1234567890</TxnID> <UserName>userName</UserName> </DeleteUser>

120

5.10.2 Response <?xml version="1.0" encoding="UTF-8" standalone="no"?> <DeleteUserResponse xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0"> <TxnID>DeleteUser-trans-1234567890</TxnID> <Status><Code>0</Code><Message>Success</Message></Status> </DeleteUserResponse>

5.11 UpdateUserPassword The API updates passw ord for a RMS user. A user changing ow n passw ord should provide “Old passw ord”. A user w ho has admin privilege and changing passw ord for other user, “Old passw ord” need not have to be provided and if it is provided it w ill be ignored. The old and new passw ord values w ould be in encrypted format.

5.11.1 Request <UpdateUserPassword xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd=http://www.w3.org/2001/XMLSchema xsi:schemaLocation="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0 pmg-messages-v3_0_0.xsd"> <TxnID>UpdateUserPassword-trans-1234567890</TxnID> <UserName>testuser</UserName> <OldPassword>oldpwd</OldPassword> <NewPassword>newPwd</NewPassword> </UpdateUserPassword>

5.11.2 Response <?xml version="1.0" encoding="UTF-8" standalone="no"?> <UpdateUserPasswordResponse xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0"> <TxnID>UpdateUserPassword-trans-1234567890</TxnID> <Status><Code>0</Code><Message>Success</Message></Status> </UpdateUserPasswordResponse>

5.12 UpdateUserUMRole The api updates user management role associated w ith a RMS user.

http://www.w3.org/2001/XMLSchema

121

5.12.1 Request <UpdateUserUMRole xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:schemaLocation="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0 pmg-messages-v3_0_0.xsd"> <TxnID>UpdateUserUMRole -trans-1234567890</TxnID> <UserName>testuser</UserName> <RoleName>testrole1</RoleName> </UpdateUserUMRole >

5.12.2 Response <?xml version="1.0" encoding="UTF-8" standalone="no"?> <UpdateUserUMRoleResponse xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0"> <TxnID>UpdateUserUMRole-trans-1234567890</TxnID> <Status><Code>0</Code><Message>Success</Message></Status> </UpdateUserUMRoleResponse>

122

5.13 LockUser The api locks a RMS user. Once locked, the user cannot login to DCCUI or PMG unless administrator unlocks.

5.13.1 Request <LockUser xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:schemaLocation="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0 pmg-messages-v3_0_0.xsd"> <TxnID>LockUser-trans-1234567890</TxnID> <UserName>testuser</UserName> </LockUser >

5.13.2 Response <?xml version="1.0" encoding="UTF-8" standalone="no"?> <LockUserResponse xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0"> <TxnID>LockUser-trans-1234567890</TxnID> <Status><Code>0</Code><Message>Success</Message></Status> </LockUserResponse>

123

5.14 UnLockUser The api unlocks a RMS user. Once unlocked, the user can login to DCCUI and PMG.

5.14.1 Request <UnLockUser xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:schemaLocation="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0 pmg-messages-v3_0_0.xsd"> <TxnID>UnLockUser-trans-1234567890</TxnID> <UserName>testuser</UserName> </UnLockUser >

5.14.2 Response <?xml version="1.0" encoding="UTF-8" standalone="no"?> <UnLockUserResponse xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0"> <TxnID>UnLockUser-trans-1234567890</TxnID> <Status><Code>0</Code><Message>Success</Message></Status> </UnLockUserResponse>

5.15 UpdateUser The api updates RMS user details comprehensively . Follow ing is the schema snippet for UpdateUser API :

<xs:element name="UpdateUser"> <xs:annotation> <xs:documentation> Update User Details. </xs:documentation> </xs:annotation> <xs:complexType> <xs:sequence>

124

<xs:element name="TxnID" type="TxnIDType" minOccurs="1" maxOccurs="1"/> <xs:element name="UserName" type="UserNameType" minOccurs="1" maxOccurs="1"/> <xs:element name="RoleName" type="UMRoleNameType" minOccurs="0" maxOccurs="1"/> <xs:element name="PasswordReset" type="xs:boolean" minOccurs="0" maxOccurs="1"/> <xs:element name="IsLocked" type="xs:boolean" minOccurs="0" maxOccurs="1"/> <xs:element name="IsExtAuth" type="xs:boolean" minOccurs="0" maxOccurs="1"/> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="UpdateUserResponse" type="ResponseType"> <xs:annotation> <xs:documentation> The response message for UpdateUser. The following status codes are applicable: <ul> <li>0 Success</li> <li>427 Operation not permitted on RMS default user</li> <li>428 Not sufficient privilege</li> <li>429 User does not exist</li> <li>415 Unexpected error</li> </ul> </xs:documentation> </xs:annotation> </xs:element>

5.15.1 Request Sample Request for updating the user role to ‘superuser’ for the user ‘testuser’

<UpdateUser xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:schemaLocation="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0 pmg-messages-v3_0_0.xsd">

125

<TxnID>DCCnewusername2f410d4f1-111e-48e6-bf7e-3494341a98b4</TxnID> <UserName>testuser</UserName> <RoleName>superuser</RoleName> <PasswordReset>false</PasswordReset> <IsLocked>false</IsLocked> <IsExtAuth>false</IsExtAuth></UpdateUser>

5.15.2 Response <?xml version="1.0" encoding="UTF-8" standalone="no"?><UpdateUserResponse xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0"><TxnID>DCCnewusername2f410d4f1-111e-48e6-bf7e-3494341a98b4</TxnID><Status><Code>0</Code><Message>Success</Message></Status></UpdateUserResponse>

126

6 Glossary

TERM DESCRIPTION

ACL Access Control List, aka w hitelist

API Application Programming Interface

BAC Broadband Access Center

CPE Customer Premises Equipment

CSV Comma Separated Value

DPE Distributed Provisioning Engine

EAID Emergency Area ID

EID Equipment ID

GATEWAY Femto Gatew ay, aka HNB-GW, aka AC, aka FGW

HTTP Hypertext Transfer Protocol

LAC Location Area Code

MCC Mobile Country Code, 3 digits

MNC Mobile Netw ork Code, 3 digits

NBI North Bound Interface

OSS Operations Support Systems

PMG Provisioning Management Gatew ay

RAC Routing Area Code

RAT Radio Access Technology

RMS RAN Management System

RDU Regional Distribution Unit

SAC Service Area Code

SAI Service Area Identif ier, consists of the LAC + SAC + MCC + MNC

127

SP Service Provider

UARFCN UTRA Absolute Radio Frequency Channel Number

XML Extensible Markup Language

XSD XML Schema Definition

w hitelist Aka ACL

Documents

Cisco RAN Management System API Guide, Release 5 · Cisco Systems, Inc. 1 RAN Management System API Reference Guide Release 5.2 First Published: Nov 17, 2015 Revised: June 13, 2016