Device Manager - · PDF fileDevice Manager...

Device Manager

You access the device manager by clicking the Device Manager tab in the DCC UI. The device managerprovides a consolidated interface to perform various tasks on an individual Customer Premises Equipment(CPE). Specifically it allows you to perform the functions:

• Device Provisioning, page 1

• View Information about a Device, page 15

• Log Uploads and Triggers , page 17

• Device Operations, page 19

• View and Update Live Data, page 23

• Device Manager Status Messages, page 26

Device ProvisioningYou can register and activate a new device at a time using the Register screen in the DCC UI. Alternatively,you can activate an already registered device using update button in the DCC UI.

Preparing to Register a DeviceUse this task to choose a 3G device to register.

Before You Begin

Before registering a device you should verify the following:

• Latest version of RMS is installed.

• Appropriate network connectivity is established between the RDU and the DPE, and between the DPEand the FAPs.

• The PMGDB is up and running.

• You can create groups from the DCC-UI Groups and IDs tab.

• The register button is activated when you enter in an identifier for a device in the Device Manager.

Cisco RAN Management System Administration Guide, Release 4.x OL-32398-01 1

After the post-installation steps are complete, do not use default Groups and Pools. Add the new Groupsand Pools.

Note

Before registering an Enterprise device, you must create all of the following:

• Enterprise group—the Enterprise group must be created before the Site group.

• Site group

• Area group

• Femto gateway group

• Cell pool

• SAI pool

Before registering a Residential device, you must create all of the following:

• Area group

• Femto gateway group

• Cell pool

• SAI pool

Procedure

Step 1 Log in to the DCC UI with valid credentials.The Device Command and Control screen is displayed.

Step 2 Select the Device Manager tab.Step 3 Enter a new device ID in the Select Device text box.

The device ID is a combination of themanufacturer OrganizationallyUnique Identifier (OUI) number (001B67),and the 15 digit serial number which is the International Mobile Equipment Identity (IMEI) number of theFAP (for example, 357539019690151).As you type the first few characters of the device ID, the Device Manager does an automatic lookup to findall device IDs beginning with that string instead of having to scroll down the entire list to find the device IDthat you are looking for.

Also, as you start typing a new device ID, a tooltip is displayed indicating that the device is not registeredand the Register button is enabled to allow for registering the device.

Step 4 Click Register.The Device Registration screen is displayed with the Device ID populated in the Device ID text box. ByDefault, the registration screen for Enterprise deployment is displayed. For Residential FAP registration,check the Residential Deployment check box.

The content of this dialog box is based on the dynamic screen configuration files:sdm-register-enterprise-screen-setup.xml andsdm-register-residential-screen-setup.xml. Refer to Configuring DCC DialogBoxes for information on customizing these.

Note

Cisco RAN Management System Administration Guide, Release 4.x2 OL-32398-01

Device ManagerPreparing to Register a Device

b_rms_user_guide_chapter_01.pdf#unique_45


Registering a Device in Enterprise ModeUse this task to register a 3G device in Enterprise mode after the Device Registration screen is displayed.

Before You Begin

You should have completed all prerequisites for registering an Enterprise device, including creating anyrequired groups and pools. Refer to Preparing to Register a Device, on page 1.

While registering an Enterprise Inner AP, Multicell Active EntryAP, and Multicell Idle Entry AP, grid shouldbe enabled for the selected site.

Grid should be disabled for Standalone Active Entry AP and Idle Entry AP.

Grid parameter for the corresponding site should be disabled.Note

Procedure

Step 1 Select the Enterprise to be assigned to the device from the Enterprise drop-down list.Step 2 Select the Site to be used from the Site drop-down list.Step 3 Optionally select the group name from the RF Profile drop-down list.

RF profile is used for RF tuning and configuration (power settings, handover rules, and so on). The numberof profiles existing by default is five. Currently, five RF profiles are applicable such asMulticell_Open_20dBm,Multicell_Open_24dBm, Standalone_Open_13dBm, Standalone_Open_20dBm, Standalone_Open_24dBm.

Step 4 Select the AP Role to be assigned to the device from the AP Role drop-down list.The drop-down list provides you with these three options:

• Active Entry AP—AP in this role offers full idle and connected mode mobility on par with M2M. Thenumber of APs is strictly limited by macro constraints (32 Inter RAT and Inter Frequency neighborstotal), because it requires configuration of unique AP PSC and Cell ID in macro neighbor list.

• Inner AP—AP in this role does not offer active M2F mobility in idle or connected mode, and hasconstrained or disabled F2M mobility. This concept is unique to Multi-Cell deployments. The APs inthis role support mobility with other APs in the Multi-Cell grid. The advantage of this role over IdleEntry AP is that Inner APs can use a larger set of PSCs that are unknown to Macro, thereby reducingPSC conflicts among those APs. Disable Inner AP role for Standalone Enterprise AP.

• Idle Entry AP—AP in this role offers full mobility with macro in idle and connected mode, with theexception of M2F HO which is disabled in macro. The advantage of such deployment is high scalingbecause of re-use of AP PSCs in the macro neighbor list. Primarily, Residential APs are deployed inthis role due to large quantities.

The AP usage role is assigned by theadministrator.

Note

Step 5 Select the AP Purpose for the device: Coverage or Capacity.APs are classified by their intended purpose to provide capacity or coverage.


Device ManagerRegistering a Device in Enterprise Mode

• Coverage—provides network connectivity at all desired locations.

• Capacity—provides sufficient bandwidth to satisfy the communication requirements of the client. APsclassified for capacity are assumed to be deployed in areas of sufficient macro coverage.

The default AP Purpose isCoverage.

Note

Step 6 Check the Activated check box.This option controls whether the device is allowed to activate its radio. If you do not select the Activatedcheck box while registering the device, you can activate the registered device later by clicking Provision andselecting Update.

Step 7 Click Register in the Device Registration dialog box.After registering the device, the successfully registered device message is displayed at the top left corner ofthe screen along with the dashboard.

Registering a Device in Residential ModeUse this task to register a 3G device in Residential mode after the Device Registration screen is displayed.

Before You Begin

You should have completed all prerequisites for registering an Enterprise device, including creating anyrequired groups and pools. Refer to Preparing to Register a Device, on page 1.

Procedure

Step 1 Check the Residential Deployment check box.Step 2 Check the Select Area Manually check box, to manually enter the area, then select the area to be assigned

to the device from the Area drop-down list box.Step 3 Alternatively, uncheck the Select Area Manually check box, and specify the Latitude and Longitude value

to get the area. To do this configure the PMG DB and connect it to the Central Node. Refer to the RMS 4.0Installation Guide, Section 2.3.3 Configuration of PMGDB with Central node for more details.

Step 4 Optionally select the group name from the RF Profile drop-down list.RF profile is used for RF tuning and configuration (power settings, handover rules, and so on). The numberof profiles existing by default is five. However, only one can be assigned to the device.

Step 5 Check the Activated check box.This option controls whether the device is allowed to activate its radio. If you do not select the Activatedcheck box while registering the device, you can activate the registered device later by clicking Provision andselecting Update.

Step 6 Select the check box Closed mode to register a device in closed mode access.Step 7 Update the details such asWhite list, ACL. ACL is the access control list which holds IMSI of the UE of 14

to 15 digits.Step 8 Click Remove selected to remove the added White lists/ ACL.Step 9 Click Register in the Device Registration dialog box.


Device ManagerRegistering a Device in Residential Mode

After registering the device, the successfully registered device message is displayed at the top left corner ofthe screen along with the dashboard.

Re-registering the Device with a New GroupIf a device is already registered to an existing group, then you need to re-register the device with the newgroup to attach the device to the group. Use this task to re-register the device with a newly created group.

1 Navigate to Device Manager and select the device which has to be provisioned with the newly createdgroup.

2 Click on Provision --> Shutdown.3 Provide the device ID in the select device field and click Register.

4 Select the newly created group on which the AP has to be provisioned and register the device. See Preparingto Register a Device, on page 1, Registering a Device in Enterprise Mode, on page 3, and Registeringa Device in Residential Mode, on page 4 for more details on device registration.

For enterprise registration a direct group association with the device is not possible. Therefore, pair thesite associated with the device and newly created group.

AP Site ReassignmentUse this task to associate the AP to a different site.

1 Log in DCC_UI.2 Navigate to Groups and IDs and create a site under the same Enterprise.3 Select the AP which has to be reassigned.4 Click Provision --> Update.5 Select the site from the drop-down list.

You can perform the above steps by using httpclient, or poster (OSS) via update AP XMLs by providinga different site.

Note

Area Site ReassignmentUse this task to assign the Site to a different area.

1 Log in DCC_UI.2 Navigate to Groups and IDs and select an existing site.3 Click Update.4 Change the Area or latitude/longitude co-ordinates of the Area to which the Site/AP has to be associated.


Device ManagerRe-registering the Device with a New Group

You can perform the above steps by using httpclient, or poster (OSS) via update AP XMLs by providinga different Area.

Note

Updating a DeviceUse this task to activate a registered device or to manipulate the values such as RF Profile, AP Role, APPurpose (for Enterprise mode) and white list, ACL (for Residential mode) specified during registration.

The dialog box displayed for updating a device depends on whether the device is registered in Residential orEnterprise mode. If the device is associated with an Enterprise and Site group, the Enterprise update screenis displayed, otherwise the Residential update screen is displayed.

You can customize the Enterprise and Residential update dialog boxes using dynamic configurations. Referto Configuring DCC Dialog Boxes.

Procedure

Step 1 Select a registered Device ID from the Select Device drop-down list box in the Device Manager screen.The latest ten AP EIDs are displayed in the drop down configuration. Providing the first few characters ofthe device EID displays all the relevant EIDs.

Step 2 Select the Provision tab, and select Update from the drop-down list.The Update Device Registration dialog box is displayed with the selected Device ID value automaticallypopulated in the Device ID text box. The dialog box displayed for updating a device depends on whether thedevice is registered in Residential or Enterprise mode.

Step 3 Select Activated.Select this option only if the device was not activated during registration.Note

Step 4 (Optional) Update the RF profile, closed mode, white list, ACL for a Residential device (refer to Registeringa Device in Residential Mode, on page 4). Or update the RF Profile, AP Role, AP Purpose for an Enterprisedevice (refer to Registering a Device in Enterprise Mode.

Step 5 Click Update to activate the registered device.After updating a device, the dashboard is displayed together with the successfully updated message at the topleft corner of the screen.

Enabling Location VerificationThe Location Verification (LV) is a part of provisioning flow in which before unlocking the HNB for RadioOn, its location is verified to ensure that HNB is still in the same location where it was registered.

RMS 4.0 supports five types of Location Verification:

1 Expected Detected Neighbors (EDN)

2 Detected Neighbor Location (DNL)

3 Detected Neighbor MCC/MNC (DNM)


Device ManagerUpdating a Device


4 IP address Subnet Match (ISM)

5 Detected Neighbor Benchmark (DNB)

All the five LV methods are configurable from RMS. By default, DNM and DNB LV methods are enabledas part of RMS installation. For enabling other LV methods, the properties need to be set manually from BACUI either at the group or device level.

In the case of no macro coverage, LV can be skipped by setting the property present at Area group level,FC-NO-LV to true and proceed with the AP registration with the HNB GW.

Note

Expected Detected Neighbor (EDN)EDN LV verifies the neighbors based on reported neighbors discovered during 2G and 3G REM scan.

Following are the properties required for enabling and configuring the EDN LV.

CommentsExpected ValueFormatProperty

This property enables theverification of EDN LV methodsduring Provisioning Flow.

True or falseBooleanFC-EDN-ENABLED

This is the list of expectedneighbors. If the list is notprovided then the LV returns thestatus as unknown.

Neighbor IDFor example,

3G3100110016935527,2G3100110016935527

Comma separatedValue where eachvalue defines theneighbor ID

FC-EDN-LIST

This property defines thetolerance, or threshold to pass theLV. The default value is 1. If thevalue is not configured then bydefault, the tolerance will beconsidered as 1.For example, if the value of thisproperty is 3 then minimum 3neighbors are expected to matchto pass EDN LV, else the resultof the LV methods is decidedbased on the next 2 properties(FC-EDN-NO-MATCH-STATUSandFC-EDN-NO-NEIGHBOR-STATUS).

IntegerSingle valueInteger

Fc-EDN-TOLERANCE


Device ManagerEnabling Location Verification

If none of the valid neighbors arematching and the detectedneighbor count is not zero thenthe result of the method isdetermined by the configuredvalue, either unknown or failure.The default value is failure. If thisproperty is not defined then bydefault, the flow considers it asfailure.

"unknown"/ "failure"StringFC-EDN-NO-MATCH-STATUS

If none of the valid neighbors arematching and the detectedneighbor count is zero, the resultof the method is determined bythe configured value, eitherunknown or failure. The defaultvalue is failure. If this property isnot defined then by default, theflow considers it as failure.

"unknown"/ "failure"StringFC-EDN-NO-NEIGHBOR-STATUS

Once the LVmethod is verified then at the device level, below two properties will automatically get configureddisplaying the EDN status.

• FC-EDN-STATUS = This is either “Valid Location”, “Wrong Location”, “Ignoring Wrong Location”,“Missing expected neighbors” or “Error: <cause>”.

• FC-EDN-STATUS-TS = This is a timestamp when the above state of the EDN status is changed.

See Appendix for more information on how to configure the Neighbor ID.

Below is the status and description of all the EDN:DescriptionEDN Status

EDN SuccessValid Location

EDN FailureWrong Location

No Matching neighbor, or no neighbors detected and the method is returningUnknown

Ignoring Wrong Location

EDN List is missing or not configured. The method returning unknownMissing expected neighbors

There is some issue in 2G or 3G REM scanError: <cause>

Detected Neighbor Location (DNL)DNL LV verifies the detected neighbor ID and then compares the location configured in the file with thatreported by the HNB. If the distance between latitude/longitude of the HNB and that configured in file iswithin the tolerance then the LV method passes.

Following are the properties required for enabling and configuring the DNL LV.



b_rms_admin_guide_appendix_01100.pdf#unique_76


This property enables the verificationof DNL LV methods duringProvisioning Flow.

True or falseBooleanFC-DNL-ENABLED

This is the filenamewhich contains theexpected neighbor ID along with thelatitude and longitude for locationverification. The file is added to RDUthrough BAC.See Appendix for more details on thisprocess.

FilenameFC-CELL-LOC-FILE

Expected Latitudeof HNB in integerformatFor example,900000

IntegerFC-EXP-LAT

ExpectedLongitude of HNBin integer format

IntegerFC-EXP-LONG

This property defines the tolerance orthreshold value in distance to pass theLV. The default value is 5000m.

GCD (Great CircleDistance) (inmeters)

IntegerFc-DNL-TOLERANCE

If none of the valid neighbors arematching and the detected neighborcount is not zero, then the result of themethod is determined by theconfigured value, either unknown orfailure. The default value is failure. Ifthis property is not defined then bydefault the flow considers it as failure.

"unknown"/"failure"

StringFC-DNL-NO-MATCH-STATUS

If none of the valid neighbors arematching and the detected neighborcount is zero, then the result of themethod is determined by theconfigured value, either unknown orfailure. The default value is failure. Ifthis property is not defined then bydefault the flow considers it as failure.

"unknown"/"failure"

StringFC-DNL-NO-NEIGHBOR-STATUS

The file entry for the DNL is as follows:

The cell location file is a text file comprised one entry per line. Each entry is comma separated and consistsof: <neighbor identifier>, <neighbor latitude>, <neighbor longitude>

Where,




• <neighbor identifier> is as per mentioned in REM Neighbor Identifier

• <neighbor latitude> is the latitude of the neighbor

• <neighbor longitude> is the longitude of the neighbor

For example:

2G3104101201015722,22142550,-80169470

3G3104101035010922,52142522,-80545470

DescriptionDNL Status

DNL SuccessValid Location

DNL FailureWrong Location

No Matching neighbor or no neighbors detected and the method isreturning Unknown


DNL expected neighbor File is missing . The method returningunknown

Missing cell location file

If the file does not have expected Latitude/ longitude/ Neighbor IDof the expected neighbors

Detected neighbors missing from celllocation file

If the HNB's latitude/ longitude is not configuredMissing expected location


Once the LV method is verified then at device level, below two properties will automatically get configureddisplaying the DNL status.

• FC-DNL-STATUS = This is either “Valid Location”, “Wrong Location”, “Ignoring Wrong Location”,“Missing cell location file”, “Detected neighbors missing from cell location file”, “Missing expectedlocation” or “Error: <cause>”

• FC-DNL-STATUS-TS = This is a timestamp when the above state of the DNL status is changed.

See Appendix for more information.

Below is the status and description of all the DNL:DescriptionDNL Status

DNL SuccessValid Location

DNL FailureWrong Location

No Matching neighbor or no neighbors detected and the method isreturning Unknown


DNL expected neighbor File is missing . The method returningunknown

Missing cell location file

If the file does not have expected Latitude/ longitude/ Neighbor IDof the expected neighbors

Detected neighbors missing from celllocation file




If the HNB's latitude/ longitude is not configuredMissing expected location


Detected Neighbor MCC/MNC (DNM)This LVmethod verifies by the location of HNB by validating the reported PLMNID of the detected neighbor.Following are the properties required for enabling and configuring this LV method.


This property enables theverification of DNM LVmethods during ProvisioningFlow

True or falseBooleanFC-DNM-ENABLED

This is the list of expectedneighbors. If the list is notprovided then the LV returnsthe status as unknown.

MCC and MNC ofthe expectedneighbor. E.g116113, where 116= MCC and 113 =MNC

Comma separatedValue where eachvalue defines thecombination ofMCC and MNC ofthe neighbor

FC-DNM-LIST

If none of the valid neighborsare matching and the detectedneighbor count is not zero,then the result of the methodis determined by theconfigured value, eitherunknown or failure. Thedefault value is failure. If thisproperty is not defined thenby default the flow considersit as failure.

"unknown"/"failure"

StringFC-DNM-NO-MATCH-STATUS

If none of the valid neighborsare matching and the detectedneighbor count is zero, thenthe result of the method isdetermined by the configuredvalue, either unknown orfailure. The default value isfailure. If this property is notdefined then by default theflow considers it as failure.

"unknown"/"failure"

StringFC-DNM-NO-NEIGHBOR-STATUS

The LVmethod is enabled by default as part of RMS installation. The DNM list can be configured throughDCC_UI in Area group.

Note



Once the LV method is verified then at device level, below two properties will automatically get configureddisplaying the DNM status.

• FC-DNM-STATUS = This is either “Valid Location”, “Wrong Location”, “Ignoring Wrong Location”and “Missing valid MCC/MNCs”

• FC-DNM-STATUS-TS = This is a timestamp when the above state of the DNM status is changed.


Below is the status and description of all the DNM:CommentsDNM Status

DNM SuccessValid Location

DNM FailureWrong Location

No Matching neighbor or no neighbors detected andthe method is returning Unknown


DNM List is missing or not configured. The methodreturning unknown

Missing valid MCC/MNCs


IP Address Subnet Match (ISM)The ISM LVmethod uses the source IP address subnet match defined in CIDR format of the sessions to verifyif the HNB is communicating with the allowed subnet.

Following are the properties required for enabling and configuring the ISM LV.


This property enables the verificationof ISM LV methods duringProvisioning Flow.

True or falseBooleanFC-ISM-ENABLED

This field is the filename whichcontains the allowed IPv4 Addresssubnets

FilenameFilenameFC-ISM-File

If the property is true and HNB IPdoes not match with the one'sconfigured in the File, then the LVmethod returns unknown. If theparameter is False and HNB IP doesnot match with the one's configuredin the File then the LVmethod returnsUnknown and logs the correct subnetas warning message for the operatorto configure correct value in the file,if required.

True or falseBooleanFC-ISM-REJECT-UNKNOWN




The IP address subnet match (DNL) file is a text file comprised of one entry per line. Each entry is a IPv4subnet defined as CIDR notation (<network address>/<mask bits>). For example, 192.168.0.0/24, 10.10.10.0/24.

Save the file with some name, for example ISM.txt and give the same name for the property FC-ISM-FILE.

Once the LV method is verified then at device level, below two properties will automatically get configureddisplaying the ISM status.

• FC-ISM-STATUS = This is either “Valid Location”, “Wrong Location”, “Missing ISM file” and “Unknownsubnet”

• FC-ISM-STATUS-TS = This is a timestamp when the above state of the ISM status is changed.


Below is the status and description of all the ISM:CommentsISM Status

ISM SuccessValid Location

ISM FailureWrong Location

When the file is missingMissing ISM file

If <FC-ISM-REJECT-UNKNOWN> is False, andHNB IP does not match with the one's configured inthe File, then the LV method returns Unknown andlogs the correct subnet as warning message for theoperator to configure the correct value in the file, ifrequired.

Unknown subnet

Detected Neighbor Benchmark (DNB)This LV method stores the benchmark when there is a first successful LV and after which it verifies thebenchmark on the subsequent flow. If the benchmark fails, but other LV methods configured for DNB passes,then the DNB updates its benchmark. This method is enabled by default as part of RMS installation.Following are the properties defined for DNB LV:


This property enables theverification of DNB LVmethods duringProvisioning Flow.

true or falseBooleanFC-DNB-ENABLED

This is the list ofexpected neighbors. Ifthe list is not providedthen the LV method willreturn unknown as thestatus.

MCC and MNC ofthe expectedneighbor. E.g116113, where 116= MCC and 113 =MNC

Comma separatedValue where eachvalue is acombination ofNeighborID|FrequencySignature|Power

FC-DNB




This property defines thetolerance or threshold topass the LV. The defaultvalue is 1. If the value isnot configured then bydefault, the tolerancewill be considered as 1.For example, if the valueof this parameter is 3then minimum 3neighbors are expectedto match to pass DNBLV.

IntegerSingle valueInteger

Fc-DNB-COUNT-TOLERANCE

This property defineswhether to match thefrequency signature ofthe neighboring HNB, orto skip the verificationof frequency signature.

true or falseBooleanFC-DNB-FREQ-MATCH

This property defineswhich all LV methodsshould be used for DNBlist population or DNBverification in case DNBis not passed. If theconfigured LV methodis enabled then that willbe used topopulate/update theDNB. This is a commaseparated value.

GPS,EDN,DNL,ISMStringFC-DNB-LV-METHOD-LIST

This property defines thethreshold for matchingthe power of neighboringHNB's to the power ofdefined HNB in theDNB list. If power iswithin this tolerance,then the neighbor is validfor DNB.

integerPower in dBmFC-DNB-POWER-TOLERANCE



This property defines thethreshold for thedetected 3G neighbors tobe considered for valid3G neighbor which isused for DNBverification. If the powerof detected 3G neighboris below this threshold,then that detectedneighbor will be ignoredand will not beconsidered forverification.

Power in dBmFC-DNB-TX-POWER-THRESHOLD

Once the LV method is verified then at device level, below two properties will automatically get configureddisplaying the DNB status.

• FC-DNB-STATUS = This will be either "Valid Location", "Wrong Location", "Not executed, noverification methods configured", "Not Running, Not ready", or it will not be updated if the DNB LVis "Unknown" .

• FC-DNB-STATUS-TS = This will be a timestamp when the above state of the DNB status is changed.

See Appendix for more information.

Below is the status and description of the DNB:

DescriptionDNB Status

DNB SuccessValid Location

DNB FailureWrong Location

This status shows when the DNB LV is enabled but"FC-DNB-LV-METHOD-LIST" property is not configuredwith anyLV methods

Not executed, no verificationmethodsconfigured

This status shows when the DNB LV is enabled but none of the LVmethods defined in "FC-DNB-LV-METHOD-LIST" is enabled

Not Running, Not ready

Additionally, if the DNB list is not present in the device, then it will get populated if the DNB LV is passed.

View Information about a DeviceThe device manager provides a device dashboard where you can view varied detailed information about thedevice.


Device ManagerView Information about a Device


Displaying the Device DashboardThe Device Dashboard displays device details in a combined view. The data which are displayed is fetchedfrom the Regional Distribution Unit (RDU) when the operation is performed.

The RDU data is divided into five parts:

• Registration Data—Displays the device registered area and activation status.

• Assigned Data—Displays the HNB GW info and MCC.MNC, LAC, RNC & SAC ID values.

• Activation Status—Displays the device service and location valid status with Timestamp values.

• Discovered Data—Displays the manufacturer information.

• Live Data—Displays details regarding the device admin, operational, RFTx status and firmware version.

Procedure

Step 1 Select a Device ID from the Select Device drop-down list in the Device Manager screen.Step 2 Click View and select Dashboard from the drop-down list.


Device ManagerDisplaying the Device Dashboard

After the device acknowledges the request, the RDU data and live data are displayed.

Figure 1: Device Dashboard

If the request fails, the data manager displays an error message.

Log Uploads and TriggersYou can configure log uploads depending on event triggers. You can also request an on-demand log upload.


Device ManagerLog Uploads and Triggers

Uploading a LogUse this task to upload of a log file on-demand from a device. This is in addition to any logs that are uploadedaccording to configured triggers.

Procedure

Step 1 Select a Device ID from the Select Device drop-down list in the Device Manager screen.Step 2 Click Perform and select On-Demand Log Upload from the drop-down list.

After the device acknowledges the upload request, you are prompted to select the destination server to whichto upload the log.

Step 3 Select a valid destination server from the Server drop-down list.Step 4 Select the appropriate Log Type, if available, and click Submit.

If the devices support more than one type of on-demand log uploads, for example, an Ubiquisys devicesupporting both Diagnostic and Performance logs, the screen is configurable to include multiple log types.Refer to Configuring DCC Dialog Boxes for more information.

The result of the upload is displayed as a page message with the appropriate icon and the URL to the uploadedfile is also displayed.

To access the link from the machine, there should be a static route added for the network of themachines with a gateway pointing to the core router.

Note

If the request to upload the file fails, the data manager displays an error message.

Setting Triggers to Upload the LogsUse this task to specify triggers to cause a log to be uploaded to the Log Upload Server (LUS).

Procedure

Step 1 Select a Device ID from the Select Device ID drop-down list in the Device Manager screen.Step 2 Click Provision and select Log Upload Triggers from the drop-down list.

After the device has acknowledged the request, the Update Log Upload Triggers screen is displayed withthe various triggers that can be selected.

Step 3 By default, Triggers managed by RMS is selected. To upload the logs periodically, uncheck the Triggersmanaged by RMS option . A tooltip is displayed to describe each trigger.

Step 4 Click Update to update the triggers.After the update process is complete, a message is displayed.


Device ManagerUploading a Log


Device OperationsYou can request to connect to a device. Alternatively, you can reboot, factory reset or shutdown a device.

Configuring Static NeighborsUse these tasks to add, update, or delete the static neighbors for a particular device post device registrationfrom DCC UI.

Adding or Updating Static NeighborsUse this task to add or update static neighbors for a device from the DCC UI.

Procedure

Step 1 Select a device from the Select Device drop-down list in the Device Manager screen.Step 2 Select Static Neighbors from the Provision drop-down list.Step 3 Select the Static Neighbor type and click either Add or Update.

Based on the selection of Static Neighbor type, one of two possible dialog boxes are displayed to add or updateInter-RAT or Inter Frequency static neighbors.

The content of these dialog boxes are based on the dynamic screen configuration files:sdm-inter-rat-static-neighbors.xml andsdm-inter-freq-static-neighbors.xml. Refer to Configuring DCC Dialog Boxes forinformation on customizing these.

Note

Step 4 Enter valid values in all the fields according to the tooltips provided.The Save and Submit buttons are enabled only after entering appropriate values in all thefields.

Note

Step 5 Click Save.The update operation is recorded locally, and the Submit Saved Changes button is enabled with a warning.

Step 6 Click Submit.The values are submitted for processing.

If you add a static neighbor with the primary key value the same as an already existing static neighbor,then an error message is displayed. The primary key for Inter-RAT is theBCCH-ARFCN parameter.For Inter-Frequency, the primary key is a combination of theUARFCNDL and Primary ScramblingCode parameters.

Note

Step 7 Click Cancel to cancel the request.

Updating Static Neighbor FilteringSelectUpdate Static Neighbor Filtering to edit additional settings related to static neighbors for the respectivedevice from DCC UI.


Device ManagerDevice Operations


Procedure

Step 1 Select a Device from the Select Device drop-down list in the Device Manager screen.Step 2 Select Static Neighbors from the Provision drop-down list.Step 3 Click Update Static Neighbor Filtering.

A Update Static Neighbor Filter dialog box opens.Step 4 Check the FEMTO-NEIGHBORING-FILTERING-ENABLE box, or

STATIC-NEIGHBORING-FILTERING-ENABLE box.FEMTO-NEIGHBORING-FILTERING-ENABLE enables the Automatic FemtoNeighbor FilteringMode,and STATIC-NEIGHBORING-FILTERING-ENABLE enables the Classification of Static NeighborsMode.

Step 5 Click Submit.The request is submitted immediately.

Figure 2: Update Static Neighbor Filtering Screen

Step 6 Click Cancel to cancel the request.

Deleting Static NeighborsUse this task to delete static neighbors for the Device from DCC UI.

Procedure

Step 1 Select a Device from the Select Device drop-down list in the Device Manager screen.Step 2 Select Static Neighbors from the Provision drop-down list.

A Static Neighbor provisioning screen is displayed for each Static Neighbor type:

• Inter_Rat Neighbors


Device ManagerConfiguring Static Neighbors

• Inter Freq Neighbors

Step 3 Select the Static Neighbor type and click Delete button.Based on the selection of Static Neighbor type, a delete Static neighbor confirmation box for a single instanceis displayed:

Step 4 Click Save.The delete operation is recorded locally, and Submit Saved Changes button is enabled with warning.

Step 5 Click Submit.A request is sent to BAC to delete the selected Static Neighbor.

Step 6 Click Cancel.The dialog box closes.

Replacing a DeviceUse this task to replace a faulty 3G or LTE device from DCC UI.

An operational device cannot be replaced. You can replace a device if the device is a misbehaving devicethat cannot be corrected by software/firmware upgrade, or if the device has malfunctioning hardware.

Note

Device replacement can replace devices of different flavors of AP. For example, USC 5310 for wifi+3G,USC 7330 for Enterprise, USC 3331 for Residential.

Note

Procedure

Step 1 Select a Device ID from the Select Device drop-down list in the Device Manager screen.Step 2 Select Device Replacement from the Provision drop-down list.

A Device Replacement screen is displayed with two fields:

• Old Device ID - Populated with the existing EID with the text box disabled.

• New Device ID - To enter the new valid EID as validated in PMG to replace the existing ID.

Figure 3: Device Replacement Screen for New Device ID


Device ManagerConfiguring Static Neighbors

TheReplace button will be enabled only after a valid NewDevice ID is entered.Note

Step 3 To replace the device, enter the new device ID and select Replace.The successful device replacement message is displayed with an appropriate page error message dependingon the PMG response.

After successful device replacement, the drop-down list gets updated with the new device id specified.

Note

Step 4 If the device replacement fails, the SDM list of EIDs is unaffected.You will be forwarded to the dashboard of old Device ID. The old device ID configuration will be unaffected.

Requesting a Connection to a DeviceUse this task to send a connection request to a device.

Procedure

Step 1 Select a Device ID from the Select Device drop-down list.Step 2 Click Perform, and select Connection Request from the drop-down list.

A confirmation dialog box is displayed.

Step 3 Click Confirm to confirm the connection request.If the connection request to the device is successful, the successful message is displayed. If the request fails,the data manager displays an error message.

Rebooting a DeviceUse this task to reboot on a device.

Procedure

Step 1 Select a Device ID from the Select Device ID drop-down list in the Device Manager screen.Step 2 Click Perform and select Reboot from the drop-down list.

A confirmation dialog box is displayed.

Step 3 Click Confirm to continue to reboot the device. Click Cancel to cancel the reboot operation.


Device ManagerRequesting a Connection to a Device

Resetting a DeviceUse this task to perform a factory reset on a device.

Procedure

Step 1 Select a Device ID from the Select Device ID drop-down list in the Device Manger screen.Step 2 Click Perform and select Factory Reset from the drop-down list.

A confirmation page is displayed.

Step 3 Click Confirm on the confirmation page.The success message of factory reset of device is displayed.

Shutting Down a DeviceUse this task to terminate the operation of a device.

Procedure

Step 1 Select a Device ID from the Select Device drop-down list in the Device Manager screen.Step 2 Click Provision and select Shutdown from the drop-down list.

A confirmation dialog box is displayed.Step 3 Click Confirm to shutdown the device.

The successful shut down message is displayed.

Once the shutdown complete, the device is permanently deleted in theBAC.

Note

View and Update Live DataThe device manager provides you the ability to view and update live data from a device. Additionally, youcan modify previously updated live data.

Displaying Live DataThe live data view of the device allows you to navigate through the data model (by object), querying thedevice for its values on demand.


Device ManagerResetting a Device

Procedure

Step 1 Select a registered Device ID from the Select Device drop-down list in the Device Manager screen.Step 2 Click View and select Live Data from the drop-down list.

After the device acknowledges the request, the object name of the specified device is displayed.

Step 3 You can navigate through the data model (by object). Check any of the check boxes and click Load/RefreshSelected Objects to refresh the view. A list of parameters set for the particular object and the device data isdisplayed,

Updating Live Data for a DeviceUse this task to update the live data for a device. These parameters are values that are configured on the BACand updated using the Data Manager user interface.

Procedure

Step 1 Select a Device ID from the Select Device drop-down list in the Data Manager screen.Step 2 Click Perform and select Set Live Data from the drop-down list.


Device ManagerUpdating Live Data for a Device

After the device has acknowledged the request, the live device details are displayed.

Figure 4: Set Live Data Display

Step 3 Select the desired properties check boxes and click Load/Refresh Selected Objects.Any selected properties are refreshed and a list of parameters set for the particular object and the device datais displayed.

Alternatively, you can expand the tree structure to view the devicedata.

Note

Step 4 Make any desired changes. Only fields that are not grayed out can be edited.Step 5 Click Submit to make the requested changes. The Submit button is enabled only after editing the parameters.

After the updated values are validated in the data model, a confirmation dialog box is displayed.Step 6 Click OK to confirm the changes.

The parameters are updated with the new values and a successful message is displayed. The Parameters areset on the device on the next contact.


Device ManagerUpdating Live Data for a Device

Updating Modified Live DataThe Set Modified Live Data feature allows you to write values and set the live data for a specified device.Specifically, this includes all the live parameters that have been modified previously.

Procedure

Step 1 Select a Device ID from the Select Device drop-down list in the Device Manager screen.Step 2 Click Perform and select Set Modified Live Data from the drop-down list.

After the device has acknowledged the request, the modified live data details are displayed.

You can now navigate through previously modified live data.

Step 3 Check the check boxes in front of Restore to Default to restore individual parameter values.Step 4 Click Submit. The Submit button is enabled only after checking a check box.Step 5 Alternatively, click on Restore All to Default to restore all parameter values at once.

After clicking on either of these buttons, a confirmation page is displayed to confirm the request to submitthese live data changes.

Step 6 Click OK, to continue with the live data modification. The success message should be displayed.

Device Manager Status MessagesThe device manager can display a variety of status messages depending on the operation being performedand the result of the operation.

Registering a Device: Status MessagesThis table lists the status messages that can be displayed while registering a device:


Device ManagerUpdating Modified Live Data

DescriptionUI Message

In case of known error codes, this message wll bedisplayed with specific-error message as returned byPMG.

Known error conditions are:

NO_AREA_FOUND_FOR_EXPECTED_LOCATION:

ASSIGNMENT_EXCEPTION:

MISSING_REQUIRED_ELEMENT:

EXCLUDED_ELEMENT_FOUND:

UNKNOWN_PARAMETER_NAME:

INVALID_PARAMETER_VALUE:

RDU_UNAVAILABLE:

UNKNOWN_GROUP

Failed to register device '<eid>'.<specific-error>

This is a generic error message that is displayed if anunknown error is propagated.

The ui_debug.log file should be examined for the exacterror.

Failed to register device '<eid>'.Operation error occurred. Please tryagain. If the problem persists pleasecontact your system administrator.

Device was successfully registered with RMS.Successfully registered device '<eid>'.

Activating a Device: MessagesThis table lists status messages that can be displayed while updating a device.

ReasonIconUI Message

Device could not be updated in RMS.ErrorFailed to update '<eid>'. Operationerror occurred. Please try again. Ifthe problem persists please contactyour system administrator.


Device ManagerActivating a Device: Messages

ReasonIconUI Message

In case of known error codes, this message wll bedisplayed with specific-error message as returnedby PMG.

Known error conditions are:

NO_AREA_FOUND_FOR_EXPECTED_LOCATION:

ASSIGNMENT_EXCEPTION:

MISSING_REQUIRED_ELEMENT:

EXCLUDED_ELEMENT_FOUND:

UNKNOWN_PARAMETER_NAME:

INVALID_PARAMETER_VALUE:

RDU_UNAVAILABLE:

UNKNOWN_GROUP

UNKNOWN_CPE:

UNKNOWN_SUBSCRIBER_ID:

DELETE_NOT_PERMITTED_FOR_PARAMETER:

UPDATE_NOT_PERMITTED_FOR_PARAMETER:

ErrorFailed to update '<eid>'.<specific-error>.

The UPDATE button was selected by the user butno change to already-existing.

InformationDevice '<eid>' did not requireupdating.

Device was successfully updated in RMS.SuccessSuccessfully updated '<eid>'.

Failed to load the update data for the device. Couldbe caused by failing to retrieve the data from PMG.

ErrorFailed to load update data for '<eid>'.Operation error occurred. Please tryagain. If the problem persists pleasecontact your system administrator.

Failed to load the update data for the device as itis unknown.

ErrorFailed to load update data for '<eid>'.Unknown device.

Displaying the Device Dashboard: MessagesThese success and error messages can be displayed when requesting to display the dashboard:


The deviceParamsDisplayConfig.xml file isinvalid or not present.

Failed to request dashboard for '<eid>'. Operationerror occurred. Please try again. If the problempersists please contact your system administrator.


Device ManagerDisplaying the Device Dashboard: Messages


Failed to communicate with BAC or PMG toretrieve the stored data.

Failed to retrieve dashboard stored data for '<eid>'.Operation error occurred. Please try again. If theproblem persists please contact your systemadministrator.

Device has been deleted and was not foundwhile retrieving data from PMG.

Failed to retrieve dashboard stored data for '<eid>'.Unknown device.

Failed to retrieve live data from the device.Does not include the device being offline.

Failed to retrieve dashboard live data for '<eid>'.Operation error occurred. Please try again. If theproblem persists please contact your systemadministrator.

Device has been deleted and was not foundwhile retrieving live data.

Failed to retrieve dashboard live data for '<eid>'.Unknown device.

Uploading a Log: MessagesThe following status messages can be displayed while performing an on-demand log upload of a file:


The upload server XML file is invalid or empty.Failed to retrieved log upload servers.Please try again. If the problem persistsplease contact your system administrator.

While waiting for the upload to finish, the user hasselected the Cancel button in the Progress dialog box.

Log upload for '<eid>' has not completed.File upload was Targeted at '<northboundupload URL>'.

When the number of polling attempts have ben exceededand the file upload is still not complete, the pollingoperation times out.

Log upload for '<eid>' has not completedwithin required time period. Targetuploaded file can be found at'<northbound upload URL>' uponcompletion.

When attempting to submit the log upload request, anerror occurred on the UI side.

Unable to request log upload for '<eid>'to '<server name>'. <cause>.

Generic error when polling request for the uploadcompletes but no status message was returned.

Failed to wait for log upload for '<eid>'.File upload was targeted at '<northboundupload URL>'.

When attempting to submit the poll request for theupload to complete, an error occurred on the UI side.

Unable to wait for log upload for '<eid>'.File upload was targeted at '<northboundupload URL>'. <cause>.


Device ManagerUploading a Log: Messages


When attempting to submit log upload request, the serveris unable to find the requested upload server details.

Failed to request log upload for '<eid>' to'<server>'. Server not found.

When attempting to submit a log upload request, thetarget server is offline.

Failed to request log upload for '<eid>' to'<server>'. Server offline.

Generic error when unable to submit log upload requestto device.

Failed to request log upload for '<eid>' to'<server name>'. Operation erroroccurred. Please try again. If the problempersists please contact your systemadministrator.

Log upload was successfully requested and hascompleted.

Log upload for '<eid>' was success.Uploaded file is '<northbound uploadURL>'.

Failed to request log upload because device is offline.Failed to request log upload for '<eid>' to'<server>'. Device offline.

Failed to request log upload because device has beendeleted.

Failed to request log upload for '<eid>' to'<server>'. Unknown device.

Updating Log Upload Triggers: MessagesThis table lists the status messages that can be displayed while updating the triggers for the log upload.


The request to update the device log upload triggers wassuccessfully sent.

Successfully updated log upload triggersfor '<eid>'

The UI was unable to successfully update the log uploadtriggers.

Failed to update log upload triggers for'<eid>'. Operation error occurred. Pleasetry again. If the problem persists pleasecontact your system administrator.

The request didn't change the log upload triggers so noaction was performed.

Device '<eid>' did not require updating.

The request to update the log uploads triggers failedbecause the device no longer exists.

Failed to update log upload triggers'<eid>'. Unknown device.


Device ManagerUpdating Log Upload Triggers: Messages

Connection Request: MessagesThe following status messages can be displayed when a connection request is sent:


Connection request is successful.Successfully performed connectionrequest for '<eid>'.

Device is not reachable. Includes device offline andunable to generate connection request URL using LeaseQuery. See the PMG and the DCC-UI debug logs fordetails.

Failed to perform connection request for'<eid>'. Device offline.

Unknown error occurred. See the debug log for details.Failed to perform connection request for'<eid>'. Operation error occurred. Pleasetry again. If the problem persists pleasecontact your system administrator.

Device does not exist because it has been deleted.Failed to perform connection request for'<eid>'. Unknown device.

Rebooting a Device: MessagesThis table lists the status messages that can be displayed while rebooting the device.


Request for reboot of device was successful.Successfully requested reboot for '<eid>'.

RMS tried to reboot the device but device is off-line andnot reachable so could not reboot.

Failed to request reboot for '<eid>'.Device offline.

RMS had encountered an unknown error and the devicecould not be rebooted. To understand the reason for theerror, see ui-debug.log.

Failed to request reboot for '<eid>'.Operation error occurred. Please tryagain. If the problem persists pleasecontact your system administrator.

The device has been deleted from the RMS.Failed to request reboot for '<eid>'.Unknown device.

Resetting a Device: MessagesThis table lists the status messages that can be displayed while requesting a factory reset of a device.


Device ManagerConnection Request: Messages


Request for factory reset of device was successful.Successfully requested factory reset for'<eid>'.

RMS tried to factory reset the device but the device isoff-line and not reachable so the factory reset was notperformed.

Failed to request factory reset for '<eid>'.Device offline.

RMS encountered an unknown error and the device couldnot perform the factory reset. To understand the reasonfor the error, look in the ui-debug.log.

Failed to request factory reset for '<eid>'.Operation error occurred. Please tryagain. If the problem persists pleasecontact your system administrator.

Shutting Down a Device: MessagesThis table lists the status messages that can be displayed while shutting down a device.


Error occurred during shutdown process.Failed to shutdown device '<eid>'. Operationerror occurred. Please try again. If the problempersists please contact your systemadministrator.

Device was successfully shutdown.Successfully shutdown device '<eid>'.

Device is unknown and shutdown failed.Failed to shutdown device '<eid>'. Unknowndevice.

Display Live Data: MessagesThis table lists the status message that can be displayed when displaying live data.


When requesting to view the device's livedata, it is found to be offline.

Failed to retrieve live data for 'eid'. The device isoffline.

Updating Live Data: MessagesThis table lists the status messages that can be displayed while setting the live data for a specified device.


Device ManagerShutting Down a Device: Messages


The requested live data parameters have beensuccessfully set.

Successfully set live data for '<eid>'.

The device is offline, therefore the live data cannot beset.

Failed to retrieve live data for '<eid>'. Thedevice is offline.

Updating Modified Live Data: MessagesThis table lists the status messages that can be displayed while updating the previously modified live data fora device.


The requested live data parameters have beensuccessfully set.

Successfully set live data for '<eid>'.

The live data of the device was not modified previously.There have been no modifications to thedevice's default live data.


Device ManagerUpdating Modified Live Data: Messages


Device ManagerUpdating Modified Live Data: Messages

Device Manager - · PDF fileDevice Manager...

Documents

Transcript of Device Manager - · PDF fileDevice Manager...