Have an account?

  •   Personalized content
  •   Your products and support

Need an account?

Create an account

Cisco RAN Management System Administration Guide, Release 5.1

Book Contents
Find Matches in This Book
Available Languages
Download Options

Book Title

Cisco RAN Management System Administration Guide, Release 5.1

Chapter Title

Managing Groups and ID Pools

Results

Updated:
July 6, 2017

Chapter: Managing Groups and ID Pools

Managing Groups and ID Pools

Overview of Managing Groups and ID Pools

You can manage your groups and ID pools from the Device Command and Control User Interface (DCC-UI). Click Groups and IDs to access the interface. You can view, add, update or delete groups, group types, ID pools and ID pool types. You can use the export option to view all defined parameters for your groups in one CSV file. You can use the import option to import parameters for multiple groups within a group type, using one CSV file.

The RMS manages devices according to their groupings. You can create any number of group types in the RMS. Devices can be assigned to one or multiple groups automatically during registration.

The significance of groups is the ability to set configuration or system operational parameters on group objects that are applied to all devices belonging to a group. The Femto Gateway groups determine the public IP address of the SeGW and private IP address of the HNB-GW. Area groups may determine settings that are specific to a country or other areas such as target frequencies, PLMN, etc.

The RMS supports the concept of automatic assignment of unique IDs for devices from a pool or range of available values. This feature can be used to assign unique Cell ID, SAC, CGI, Broadcast SAI, etc. A unique value is assigned from a pool and stored as a property in the RMS. This property is then referenced in configuration templates in order to configure devices. Until the device is de-commissioned, the assigned value remains reserved for this device.

You must have read-write permission to perform these operations. If you have read-only permission, you can export or view the information, only.

Recommended Order for Working with Pools and Groups

This task outlines the recommended procedure for working with pools and groups for RMS deployments:

Procedure
    Step 1   Create an SAI pool:
    1. In the Groups and IDs interface, click ID Pools in the left navigation bar.
    2. Click the SAI-POOL tab.
    3. Click Add and refer to: Adding an ID Pool Instance.
    Step 2   Create a Cell pool:
    1. Click the CELL-POOL tab.
    2. Click Add and refer to: Adding an ID Pool Instance.
    Step 3   Create a UMTS Security Gateway group:
    1. In the Groups and IDs interface, click Groups in the left navigation bar.
    2. Click the UMTSSecGateway tab.
    3. Click Add and refer to: Adding a Group Instance.
    Step 4   Create a Femto Gateway group:
    1. Click the FemtoGateway tab.
    2. Click Add and refer to: Adding a Group Instance.
    3. Select the Cell ID pool to be associated with the Femto Gateway group.
    Step 5   Create an LTE Cell pool:
    1. Click the LTE-CELL-POOL tab.
    2. Click Add and refer to: Adding an ID Pool Instance.
    Step 6   Create an LTE Security Gateway group:
    1. Click the LTESecGateway tab.
    2. Click Add and refer to: Adding a Group Instance.
    Step 7   Create a HeNB Gateway group:
    1. Click the HeNBGW tab.
    2. Click Add and refer to: Adding a Group Instance.
    3. Select the LTE Cell ID pool to be associated with the HeNB Gateway group.
    Step 8   Create a Region group:
    1. Click the Region tab.
    2. Click Add and refer to: Adding a Group Instance.
    3. Select the LTE Cell ID pool to be associated with the Region group.
    Step 9   Create an Area group:
    1. Click the Area tab.
    2. Click Add and refer to: Adding a Group Instance.
    3. Select the Region group to be associated with the Area.
    4. Select the Femto Gateway group to be associated with the Area.
    5. Select the HeNB Gateway group to be associated with the Area.
    6. Select the SAI pool to be associated with the Area.
    Step 10   Create an Enterprise group:
    1. In the Groups and IDs interface, click Groups in the left navigation bar.
    2. Click the Enterprise tab.
    3. Click Add and refer to: Adding a Group Instance and skip Step 4 and Step 5
    Step 11   Create a Site group:
    1. In the Groups and IDs interface, click Groups in the left navigation bar.
    2. Click the Site tab.
    3. Click Add and refer to: Adding a Group Instance.
    Step 12   As required, create Sub Sites
    1. In the Groups and IDs interface, click Groups in the left navigation bar.
    2. Click the SubSite tab.
    3. Click Add and refer to: Adding a Group Instance.

    Managing Group Types

    To manage group types, click the Group Types tab in the left navigation pane of the Group and ID Pools interface. Any defined group types are displayed and you can add, update, delete, import or export group types using the buttons at the bottom of the display.

    Groups are defined within the context of a group type, so you must have group types defined before you can create groups. These group types are created by default during the RMS installation:

    • Alarm

    • Area

    • Enterprise

    • FemtoGateway—Applicable for 3G devices only

    • HeNB Gateway—Applicable for LTE devices only

    • LTESecGateway—Applicable for LTE devices only

    • UMTSSecGateway—Applicable for 3G devices only

    • RF Profile

    • RFProfile-LTE—Applicable for LTE devices only

    • Site

    • SubSite

    • Region

    These pool types and group types are associated by default:

    • The Area group type is associated with the SAI-POOL type.

    • The FemtoGateway group type is associated with the CELL-POOL type.

    • The Region Group type is associated with the LTE-CELL-POOL type.

    In addition, note these guidelines:

    • The RF Profile group type should not be associated with any group type or ID pool type.

    • The Enterprise group type can be associated with the Site group type; it should not be associated with any pool type.

    Alarm Groups

    The Alarm Profile group is used for associating alarms with devices. An Alarm Profile group can be associated with an Area, in which case, all devices belonging to the Area have the same alarm profile.

    If you use the DCC user interface, tool tips are provided so that you know what values to provide for each field. Refer to RMS Configurable Parameters for a list of all the properties that can be specified for Alarm groups in the CSV file used with the Import option.

    Area Groups

    An Area group determines the settings that are specific to a country or other areas such as target frequencies, PLMN, etc. A device is registered with an Area group and other groups such as FemtoGateway. CELL-POOL and SAI-POOL association is done by the RMS.

    If you use the DCC user interface, tool tips are provided so that you know what values to provide for each field. Refer to RMS Configurable Parameters for a list of all the properties that can be specified for Area groups in the CSV file used with the Import option.


    Note

    The Area cannot support more than 65535 devices. This is because two Pools having the same range cannot be assigned to the Area Group.

    Enterprise Groups

    An Enterprise group type is created by default during the RMS installation. Enterprise is a top level group type. An Enterprise group type is linked to an Enterprise ID Pool that is responsible for assigning a unique ID to enterprise groups within the solution.

    If you use the DCC user interface, tool tips are provided so that you know what values to provide for each parameter. Refer to RMS Configurable Parameters for a list of all the parameters that can be specified for Enterprise groups in the CSV file used with the Import option.

    FemtoGateway Groups

    The Femto Gateway groups determine the public IP address of the Security Gateway (SecGW) and the private IP address of the Home Node Base Station Gateway (HNB-GW).


    Note

    By default, the Femto Gateway group type is associated with the CELL pool type.

    By default, the Area group type is associated with the Femto Gateway group type.

    If you use the DCC user interface, tool tips are provided so that you know what values to provide for each field. Refer to RMS Configurable Parameters for a list of all the parameters that can be specified for Femto Gateway groups in the CSV file.

    HeNB Gateway Group

    HeNB gateway groups determine the public IP address of the Security Gateway (SecGW) and the MME.


    Note
    An area should be associated with an HeNBGW group type.

    LTE Security Gateway Group

    If a device is going to use IPv6 addressing, verify that the FC-FC-IPSEC-IP-TYPE field is set to IPv6 in the Add or Edit dialog box for the appropriate LTE Security Gateway group.

    Region Groups

    The region group defines common properties across a deployment. The region group must exist before a new area can be created.

    The LTE-CELL-POOL must exist before a region group can be created. This is for allocation of the LTE CELL-ID. The LTE-Cell-Pool needs to be associated with new region groups when they are created. A region group must be associated with an area when it is created.

    RF Profile Groups

    The RF profile is used to determine the RF tuning and configuration (power settings, handover rules, and so on). The number of profiles existing by default is one. By default, the RF profile is installed through the BAC configuration. However, the DCC UI provides the functionality to modify the RF profile group instance properties. See Updating a Group Type, Group Instance, ID Pool Type, or ID Pool Instance for more details.

    If you use the DCC user interface, tool tips are provided so that you know what values to provide for each parameter. Refer to RF Profile Configurable Parameters for a list of the RF Profile group parameters that can be defined using a CSV file and the Import option. All of these properties are persistent. And none of these properties require a reboot.

    Site Groups

    A Site group is a middle-tier group. An Enterprise can have 16777215 sites . However, a site can connect to only one enterprise. A Site group type is linked to a Site ID Pool that is responsible for assigning a unique ID to site groups within the Enterprise.

    If you use the DCC user interface, tool tips are provided so that you know what values to provide for each parameter. Refer to RMS Configurable Parameters for a list of all the parameters that can be specified for Site groups in the CSV file used with the Import option.

    Subsite Groups

    Subsite groups are created within site groups. A maximum of 20 subsites can be created under a single site. The use of subsites is useful if a site is large with multiple entrances, for example, a shopping mall.

    Subsites are supported on UMTS enterprise access points. To use subsite groups, the following requirements must be met:

    • The Enterprise group type must be created.

    • The Site group type must be created with these attributes defined.

      • Latitude and Longitude coordinates set.

      • Grid Enabled is set.

      • CIG Enabled is set.

      For more information, refer to Adding a Group Instance.

    • A subsite group must be created in the Groups and ID Pools interface.

    • The subsite group needs to be associated with an existing site.

    • In the associated Region group type, these attributes must be set:

      • CIG Location Verification Methods List must be set to GPS.

      • FC-ANCHOR_AP-LV-LIST must be set to GPS.

      • FC-GPS-TIME-OUT must be set to 180 (in other words, 3 minutes).

    • On the BAC, under Group Area, configure these parameters:

      • FC-GPS-ENABLE must be set to True.

      • FC-GPS-TOLERANCE must be set to 10000000.

    Managing Groups

    To manage groups, select the Groups tab in the left navigation bar of the Groups and ID Pools interface. You can view, add, update, import, export or delete a group instance with read-write permission.


    Note

    The default Area group should not be used for Device Registration.

    Groups are created within the framework of a group type which defines the parameters that the groups can have. Each pre-defined group type has one default group created during installation. Use the default group as a template to create additional groups within the same group type. To create a new group:

    • Click Add in the Groups tab and provide all requested parameter values.

    • Create a CSV file containing the same parameters as the default group, and then click Import in the Groups tab. This option can be used to import multiple groups in one CSV file.


      Tip

      The easiest way to create a group CSV file is to click Export in the Groups tab and export the default group. The CSV file is downloaded to your local drive where you can open it and edit as required. Save this file and then use it in the Import operation. For more information, refer to Importing a Group Type, Group Instance, ID Pool Type or ID Pool Instance.

    Managing ID Pool Types

    To manage ID pool types, click the ID Pool Types tab in the left navigation pane of the Group and ID Pools interface. Information regarding the defined ID pool types is displayed and you can add, update, delete, import or export ID pool types using the buttons at the bottom of the display.

    The main difference between the adding of ID pool types and that of adding group types is the association to group or ID pools, respectively. Where group types can have multiple associations with ID pool types, ID pool types can have only one association with group types.

    The following pool types are pre-configured during the RMS installation:

    • SAI-POOL
    • CELL-POOL

    • LTE-CELL-POOL


    Note

    • If the SAI-POOL, CELL-POOL, or LTE-CELL-POOL is in the Active state, they cannot be deleted.

    • If the SAI-POOL, CELL-POOL, or LTE-CELL-POOL is in the Deactive or Planned state, it can be deleted only if devices are not associated with the pool.

    • If devices are associated with the SAI-POOL, CELL-POOL, or LTE-CELL-POOL, run the Reassign script to move the devices to other pools and then delete the pools.

    SAI Pools

    Service Area Identifier (SAI)-POOL is used to uniquely track APs, especially for billing purposes. It contains a Location Area Code (LAC). Specifically, the SAI is equal to the PLMN + LAC + Service Area Code (SAC).

    There is a distinction in the solution between the Over-The-Air (OTA) LAC and the SAI LAC. The SAI LAC is used in the SAI contained in Radio Access Network Application Part (RANAP) messages. The OTA-LAC is used by the FAP on the Air Interface.

    The SAI-POOL gives a unique SAC-ID of SAI for every new device during registration. The RMS maps the SAC-ID selected to the below Ubiquisys data model: InternetGatewayDevice.Services.FAPService.1.CellConfig.UMTS.CN.SAC

    If you use the DCC user interface, tool tips are provided so that you know what values to provide for each parameter. This table describes all the properties that can be specified for SAI pools in the CSV file used with the Import option.

    Table 1 Default SAI Pool Properties
    Property Required Description

    id Pool Type

    Yes

    Name of the pool type: SAI-POOL.

    Pool Name

    Yes

    Name of the SAI pool should be unique. The DEFAULT-SAI-POOL is created during the RMS installation.

    State

    Yes

    Active— RMS selects only those SAI-POOL's for SAC-ID assignment which are in the Active state1

    Planned— RMS does not select SAI pools which are in the Planned state for SAC-ID Assignment. SAI pools are created in this state and if Active pools are exhausted then SAI pools in this State are made Active.2

    Deactive— RMS does not select SAI pools which are in the Deactive State for SAC-ID assignment. SAI pools are moved to this state before they can be deleted. 3

    Note    SAI pools must be in the Deactive state before they can be deleted.

    FC-IUSAC-DEFAULT-ID

    Yes

    This SAC value is used if device is not associated with any INSEE or there is no SAC mapping for this INSEE or 2G\3G macro cell IDs are not detected.

    Range

    Yes

    Represents the SAC-ID of the SAI. Values should be 1..65535. The format for a range is x..y, for example 1..100. The format for a set of single values is x,y, for example 1,2,3. Both range and a set of single values can be given, for example 1..100,101,102.

    Groups

    Yes

    For SAI-POOL the options show the list of Area groups to which this pool can be associated. The format is {name :AreaGroupName, type :Area},{name : AreaGroupName, type :Area}

    FC-LAC-ID

    Yes

    		SAI LAC value. The SAI LAC is used in SAI contained in RANAP messages. This LAC is used by the core network, so it has to be obtained from core network configuration.
    1 A SAI pool in the Active State cannot be Deleted.
    2 This is a guideline for clean assignment of SAC-IDs within a SAI pool. You can create SAI pools in the Active State.
    3 This is a guidelines only. You can even delete a SAI pool which is in the Planned State. The RMS does not allow deletion of Deactive or Planned SAI pools if devices are associated with the pool. You should run the Reassign script to move devices to another SAI pool.

    An example CSV file is shown here:

    Table 2 ID Pool Instance CSV File
    ID Pool Type Pool Name STATE RANGE GROUPS FC-LAC-ID
    SAI-POOL CHILE-SAI-POOL-2 Planned 500..600 {name :Band_1, type :Area},{name :Band_2_5, type :Area} 1023

    CELL Pools

    For Ubiquisys, the UC-Id and RNC-Id are used in the configuration which is applied via TR-069 to the HNB. Cell-POOL gives the C-ID needed for the UC-Id calculation.

    The UC-Id is equal to the Concatenation[Hex(RNCID), Hex(C-ID)]. The RMS maps the UC-Id to this Ubiquisys data model parameter: InternetGatewayDevice.Services.FAPService.1.CellConfig.UMTS.RAN. CellID.

    If you use the DCC user interface, tool tips are provided so that you know what values to provide for each parameter. This table describes all the properties that can be specified for CELL pools in the CSV file used with the Import option.

    Table 3 Default CELL Pool Properties
    Property Required Description

    id Pool Type

    Yes

    Name of the pool type: CELL-POOL.

    Pool Name

    Yes

    Name of the CELL pool should be unique. The DEFAULT-CELL-POOL is created during the RMS installation.

    State

    Yes

    Active—RMS selects only those CELL pools for C-ID Assignment which are in this State.4

    Planned—RMS does not select CELL pools which are in Planned state for C-ID assignment. CELL pools are created in this state and if Active pools are exhausted then a CELL pool in this State are made Active. 5

    Deactive—RMS does not select CELL pools which are in the Deactive State for C-ID assignment. The CELL pools are moved to this state before deleting the CELL pool. 6

    Note    CELL pools must be in the Deactive state before they can be deleted.

    Range

    Yes

    Represents the C-ID of the UC-Id. Values should be 1..65535. The format for a range is x..y, for example 1..100. The format for a set of single values is x,y, for example 1,2,3. Both range and a set of single values can be given, for example 1..100,101,102.

    Groups

    Yes

    For CELL-POOL the options show the list of FemtoGateway groups to which this pool can be associated. The format is {name :FemtoGroupName, type :FemtoGateway},{name : FemtoGroupName, type :FemtoGateway}

    4 Cell pools in the Active State cannot be deleted.
    5 This is only a guideline for clean assignment of the C-ID within a Cell pool. You can still create a Cell pool in the Active State.
    6 This is again a guideline. You can even delete a Cell pool in the Planned state. RMS does not allow deletion of Deactive or Planned Cell pools if devices are associated with this Cell pool. You should run the Reassign script to move devices to another Cell pool.

    An example CSV file is shown here:

    Table 4 CELL Pool CVS File
    ID Pool Type Pool Name STATE RANGE GROUPS
    CELL-POOL CHILE-CELL-POOL-2 Planned 500..600 {name :Band_1, type :Area},{name :Band_2_5, type :Area}

    LTE Cell Pools

    For LTE deployments you must have an LTE cell pool. This is the ECGI-ID-POOL. It is associated with the HeNB gateway. An LTE cell pool must be created before you create a region group so that you can associate it with the region.

    Managing ID Pools

    You can create ID pool instances in the Group and ID Pool interface. Click on the ID Pools tab in the left navigation bar of the interface. All existing ID pools are displayed in the right pane of the display.

    To add, update or delete an ID pool, you must have read-write permissions.

    You must associate each SAI pool with at least one Area group and each CELL pool with at least one FemtoGateway group. Initially associate the SAI pool with the default Area and the CELL pool with the default FemtoGateway as no other groups would initially be created. When a new Area instance is created and associated with the SAI pool, automatic assignment of the SAI pool happens. So the SAI pool created above has two associations: one with the default Area and another with the newly created Area. You can update the SAI pool to remove the association with the default Area after the new Area association is completed.

    The LTE-CELL-POOL must be associated with a Region.


    Note

    The default Area group should not be used for Device Registration.

    Changing Group Type, Group Instance, ID Pool Type or IP Pool Instance

    You can change groups and group types or ID pools and pool types using the DCC-UI graphic interface, or using the XML interface.

    Adding a Group Type

    Procedure
      Step 1   In the left navigation pane of the Group and ID interface, select Group Types and click Add.
      Step 2   Enter the name of the new group type.
      Note   

      The name must be unique. If you try to give the name which is already existing but in different case (upper case or lower case), you will get an error message.

      Only the alphanumeric characters and other characters such as underscore (_) and hyphen (-) are allowed.

      Step 3   In the Group Type screen, enter a priority for the group type.

      Values can range from 1 to 100.

      Step 4   Check the Reassignable check box if you want to reassign the device in this group type to other group types.
      Step 5   Specify the number of devices that can be assigned to this Group type. Specifying no value here defaults to '0', which indicates an unlimited number of devices.
      Step 6   Select the ID Pool types that are to be associated with this Group type. For example, SAI-POOL and CELL-POOL. This field is optional.
      Step 7   Select Group Types that are to be associated with the existing Group type.
      Note   

      The Area group type should be associated with the FemtoGateway group type for registering a device and relating a device from one group to another group of the same group type.

      Step 8   Click Add to add the group type.
      Note   

      The Add button is enabled only when you specify all the required details.

      What to Do Next

      After you add a group type, you need to define the parameters that you want to be available for groups of this type. To do this, refer to Configuring DCC Dialog Boxes. This customizes the interface to include the parameters that you specify in all groups of this type.

      Adding a Group Instance

      There are two ways to add a group. You can use this task to add the group using the DCC UI screens. You need to provide all of the required information in the Add dialog box. Alternatively, you can use the Import option to import a previously created CSV file with one or more groups defined. For more information regarding the import option, refer to Importing a Group Type, Group Instance, ID Pool Type or ID Pool Instance.

      Procedure
        Step 1   From the Group and ID interface, select Groups from the left navigation pane. Select the required group from the Groups window and click Add.

        The Add Group Instance dialog box for Site group is displayed by default. You can select the required group from Groups screen.

        Step 2   Enter the name of the new group.
        Note   

        The name must be unique. If you try to give the name which is already existing but in different case (upper case or lower case), you will get an error message.

        Only alphanumeric characters and other characters such as underscore (_) and hyphen (-) are allowed.

        Step 3   Enter the state of the group.

        A group can be in any of Planned, Active, or Deactive states.

        Note    Groups and Pools must be moved to Deactive state before deletion.
        Step 4   Select any ID Pools that are to be associated with this Group.
        Step 5   Select any Groups that are to be associated with the existing Group.
        Note   

        The Group Instance of Area has to be associated with the Group Instance of FemtoGateway for registering a device and relating a device within the Group Type.

        Step 6   Click Add to add the group instance.

        Adding a Device to New Group

        A device can be added to a newly created group in three ways:
        1. Using the ops-tools reassign script (reassignDevices.sh). For more details, refer to reassignDevices.
        2. Re-registering the AP with the newly created group. For more details refer to Register a Device with a New Group.
        3. Reassigning a device to a new group by using the DCC_UI import operation. To perform this export the group with export type as related EIDs and change the group name to the newly added group. Then import the .csv file by following steps in Importing a Group Type, Group Instance, ID Pool Type or ID Pool Instance.

        Adding ID Pool Types

        Use this task to create a new ID pool type.

        Procedure
          Step 1   From the Group and ID interface, select ID Pool Types from the left navigation pane and click Add.

          The Add ID Pool Type dialog box is displayed.

          Step 2   Enter the name of the new ID Pool type.
          Note   

          The name must be unique. If you try to give a name which already exists in different case (upper case or lower case), you receive an error message.

          Only the alphanumeric characters and other characters such as underscore (_) and hyphen (-) are allowed.

          Step 3   Enter the pool type priority. This value can range from 1 to 100 and corresponds to this pool type’s priority.
          Step 4   Select the Group Type to be associated with this ID pool type.
          Step 5   Select the Property name to be associated with this ID pool type.
          Step 6   Click Add to add the ID pool type.

          Adding an ID Pool Instance

          Procedure
            Step 1   In the left navigation pane of the Group and ID interface, select ID Pools. Select the required pool from ID Pools window and click Add.
            Step 2   Enter the name of the new pool instance.
            Note   

            The name must be unique. If you try to give the name which is already existing but in different case (upper case or lower case), you will get an error message.

            Only alphanumeric characters and other characters such as underscore (_) and hyphen (-) are allowed.

            Step 3   Enter the state of the pool.

            A pool can be in any of the Planned, Active, Deactive states.

            Step 4   Enter the Range of IDs this Pool can be assigned to.

            Range consists of a single number or two numbers separated by two periods or a combination of both each being separated by a comma. For example: [1,2..10,300..400].

            Step 5   Select the Groups that are to be associated with this ID Pool.
            Step 6   Click Add to add the ID Pool.
            Note   

            The Add button is enabled only when you specify all required details.

            Updating a Group Type, Group Instance, ID Pool Type, or ID Pool Instance

            Use this task to edit a group type, group instance, ID pool type or ID pool instance that you have previously created.

            Procedure
              Step 1   In the left navigation pane of the Group and ID Pools interface, select the tab for the object type that you want to update. Values are Group Type, Groups (for group instance), ID Pool Types or ID Pools (for ID pool instances).
              Step 2   From the list of available objects in the right display pane, select the object that you want to edit and click Update.

              The Update dialog box is displayed.

              Note   

              The Update button is enabled only after you select an object in the right pane of the display.

              Step 3   Edit any of the values in the Update dialog box.

              The name of the object is displayed in the dialog box, but cannot be edited.

              Step 4   Click Update.
              Note   

              The Update button is enabled only after you specify all the required details.


              Note

              • If the Cell pool or SAI pool is updated (increase in CID or SAC Id range), then a resynch.sh script must be run from the Central node before adding, deleting, or modifying any new or existing FAP. To run the resynch.sh script, see resync.sh.

              • If the current Cell pool or SAI pool is saturated (number of APs registered = pool range), it is recommended that a new SAI or Cell pool is created and associated with the same area or femto gateway respectively to support more APs instead of increasing the pool range of existing pools.

              resync.sh

              The resync.sh tool performs resync of FRM with BAC. The details regarding Whitelist, groups, and IDs data are considered for resync. The request to resync is through PMG.


              Note

              Only one instance of resync.sh tool is allowed to execute at a time. resync.sh <-help | <-start> [-force] >

              resync.sh <-help | <-start> [-force] >

              Syntax Description

              -help

              Optional. This argument produces a console output of the tool's syntax, arguments, description.

              If this option is selected with no other arguments, -help will print out to the console and the tool does not run.

              -start

              Option to instruct PMG to start resync FRM with BAC. The Start option is required for the tool to execute.

              -force

              Optional. If the argument is specified, the tool executes irrespective of other operational tools currently executing.

              Usage Guidelines

              The tool only allows one instance of the resync to run at a time.

              The tool periodically reports the progress information (number complete, number failed, and rate) to the console. The summary information is produced at the result. The tool produces a file containing a list of devices for which the connection requests failed. The administrator can decide to retry executing the tool using this file at a later point.

              If the connection request fails with an error code indicating a provisioning system issue, the error is reported to the console and in the error logs. Failures due to the devices being offline are not flagged as errors.

              A sample output of the resync.sh tool is shown below: 

              $ resync.sh -start

Success
Done.

              Deleting a Group Type, Group Instance, ID Pool Type, or ID Pool Instance


              Note

              If the current cell pool or SAI pool is saturated (number of APs registered is equal to pool range) and there is a requirement to support more APs, it is recommended that a new SAI or Cell pool is created and associated with the same area or FemtoGateway respectively instead of increasing the pool range of the existing pools.

              Procedure
                Step 1   In the left navigation pane of the Group and ID Pools interface, select the tab for the object type that you want to delete. Values are Group Type, Groups (for group instance), ID Pool Types or ID Pools (for ID pool instances).
                Step 2   From the list of available objects in the right display pane, select the object that you want to delete and click Delete.
                Note   

                You cannot delete a group type if the group type has any group instances; nor can you delete an ID pool type if it has any ID pool instances.

                Step 3   Click Confirm to confirm the action.

                The object is deleted from the interface.

                Importing a Group Type, Group Instance, ID Pool Type or ID Pool Instance

                Use this task to import properties for group type, group instance, ID pool type or ID pool instance. To determine the format of the CSV file to import, you can export a file for a same-type group type or instance, or ID pool type or instance and use it as a template. The advantage of using the Import option as opposed to the Add option is that you can import multiple objects in a single CSV file.

                Procedure
                  Step 1   In the left navigation pane of the Group and ID interface, select the tab for the object type that you want to import. Values are Group Type, Groups (for group instance), ID Pool Types or ID Pools (for ID pool instances).
                  Step 2   Click Import.

                  The Import dialog box is displayed.

                  Step 3   Click Select CSV File. A dialog box is opened for you to specify the CSV file that you want to upload.
                  Step 4   Navigate to the location of the CSV file and click Open. The name of the file is displayed in the text box in the Import dialog box.
                  Step 5   Click Import.

                  The Import button is only activated after you select a CSV file to import.

                  Step 6   Click Confirm to confirm the action.
                  Once the import of the CSV file succeeds, a status message is displayed and the data is applied to the BAC.
                  Note   
                  • You can view and edit the .csv files in Microsoft Excel and import into the application. However, it is recommended to use a text editor to edit the .csv files. This is because Microsoft Excel does not remove commas when a cell value is deleted, which can cause import to malfunction and also lead to unintended formatting issues in the csv file values.

                  • Blank values are not permitted in the file. Operator must provide 'N/A' in case parameter values are not specified in the file or remove the parameter from the file. The import engine treats "N/A" as a parameter to be marked for deletion. Any parameter labeled 'N/A' is treated as 'blank' value and is marked for deletion during import. This is to intentionally discourage accidental deletion of parameters during import.

                  Sample CSV File

                  Table 5 ID Pool Instance
                  ID Pool Type Pool Name STATE RANGE GROUPS FC-LAC-ID
                  SAI-POOL CHILE-SAI-POOL-2 Planned 500..600 {name :Band_1, type :Area},{name :Band_2_5, type :Area} 1023

                  Importing the Exported Pools and Groups from the Previous Build to the New Build

                  This task outlines the steps to be followed for importing the exported pools and groups from previous build to the new build.


                  Note
                  Follow these steps only if you have exported the groups and pools in the previous build.
                  Procedure
                    Step 1   Import the SAI-POOL as described in Importing a Group Type, Group Instance, ID Pool Type or ID Pool Instance. Before Importing the SAI pool, edit the exported .csv file and make the following changes:
                    1. Change the Area to DefaultArea "{name:DefaultArea, type:Area}". The default area must be used in the SAI-POOL, as the intended area mentioned in the exported SAI-POOL is not created yet in the RMS.
                    2. If needed, change the range.

                      The default SAI pool range is 500.900. The maximum range is from 0 to 65535. Generally, you can make these changes in a standard text editor, but if a range is specified such as 3400..4000,23000, you must use Microsoft Excel to make the changes.

                    Step 2   Import the CELL-POOL as described in Importing a Group Type, Group Instance, ID Pool Type or ID Pool Instance. Before importing the Cell pool, edit the exported .csv file and make the following changes:
                    1. Change the FGW to Default FGW "{name:DefaultFGW, type:FemtoGateway}".

                      The default FGW must be used in the CELL pool, as the intended FGW mentioned in the exported CELL pool is not created yet in the RMS.

                    2. If needed, change the range.

                      The default CELL pool range is 1..400. The maximum range is from 0 to 65535. Generally, you can make these changes in a text editor, but if a range is specified as in 3400..4000,23000, you must use Microsoft Excel to make the changes.

                    Step 3   Import the FGW as described in Importing a Group Type, Group Instance, ID Pool Type or ID Pool Instance. Before importing the FGW group, verify the following:
                    1. All cell pools present in the exported FGW group are imported before importing the FGW group. Refer to Step 1.
                    2. If you see the ZAP Route property in the exported file for the FGW group, you must delete this column before importing the group. The reason for this is that the system throws an error on import when the property is not already configured in the pmg-profile.xml.
                    3. The Provisioning Group name is same in the present and previous build. If not, edit the Provisioning Group name in the exported .csv file to the one mentioned in the BAC UI.
                    Step 4   Import the AREA group as described in Importing a Group Type, Group Instance, ID Pool Type or ID Pool Instance. Import all SAI pools and FGW groups contained in the exported Area group before importing the AREA group. Follow Step 1 and Step 3 to import the FGW group and SAI pool. All the SAI pools and Cell pools get associated with the intended and Default Area and FGW respectively. APs are registered with the intended AREA and FGW. So the association of same pool (SAI-POOL or CELL-POOL) with different groups (Intended and Default Area and FGW) does not cause any issue.
                    Step 5   Import the Enterprise group group as described in Importing a Group Type, Group Instance, ID Pool Type or ID Pool Instance. Note:Remove the Groups Column from the csv before Importing the Exported file.
                    Step 6   Import the Site group group as described in Importing a Group Type, Group Instance, ID Pool Type or ID Pool Instance. Note:Import all the Area and Enterprise groups contained in the exported site group before importing the Site.

                    Exporting ID Pool or Group Types

                    Export the ID pool types or group types to view the parameters set for these, or to use them as a template to import a new ID pool type or group type.

                    Procedure
                      Step 1   From the Group and ID Pools interface, select ID Pool Types from the left navigation pane.
                      Step 2   Click Export.

                      A CSV text file containing the properties of all ID pool types is generated. A dialog box is displayed for you to open or save the generated file.

                      Step 3   Click Save File and specify a location for the file to be saved.
                      Step 4   Click OK to complete the export operation.

                      Following is a sample of the exported pool type data (including the header row): 

                      id Pool Type Name,Priority,Associated Group Type,BAC Property Name 
SAI-POOL,50,Area,FC-SAC-ID 
CELL-POOL,50,FemtoGateway,FC-OTA-CELL-ID

                      Exporting Information about a Group or ID Pool Instance

                      Export information about a group or ID pool instance to view the various properties used. You can edit exported files to create new groups or ID pools. Use the Import option to import these groups or ID pool files into the RMS.
                      Procedure
                        Step 1   In the left navigation pane of the Group and ID Pools interface, select the Groups tab.
                        Step 2   Select one of the group types and click Export.
                        Step 3   Select a specific group for which to export information in the Group drop-down list.
                        Note   

                        The All Groups checkbox must be unchecked.

                        Step 4   In the Export Type drop-down list, select whether the export should include the group properties, or all related EIDs for the group.
                        Note   

                        By default, 'Properties' is selected as the Export Type.

                        Step 5   Click Export.

                        A CSV text file containing the properties of all the group instances of the selected group is generated and a dialog box is displayed for you to specify where to save the exported file.

                        • Related EIDs refer to all the devices associated with the selected pool type/pool(s).
                        • Properties refer to all the attributes associated with the selected pool type/pool(s).
                        Step 6   Navigate to the desired location and click Save File. The export is complete after you specify the location to which the file should be saved.

                        Note   

                        You can view and edit the exported .csv files in Microsoft Excel. However, it is recommended to use a text editor to edit the .csv files because Microsoft Excel does not remove commas when a cell value is deleted; this can cause the import to malfunction and lead to unintended formatting issues in the .csv file values.

                        Step 7   Click OK.

                        Groups and IP Pools: Messages

                        Adding a Group Type: Messages

                        This table lists the status messages that can be displayed when adding a group type:
                          UI Message Description

                        Successfully added group type 'groupTypeName'

                        		  

                        Failed to add group type 'groupTypeName'. RDU Unavailable.

                        When BAC RDU is not available.

                        Failed to add group type 'groupTypeName'. Unexpected error.

                        When the unexpected error occurs at Server.

                        Failed to add group type 'groupTypeName'. Operation error occurred. Please try again. If the problem persists please contact your system administrator.

                        Generic error message.

                        Updating a Group Type: Messages

                        This table lists the status messages that can be displayed when updating a group type:
                          UI Message Description

                        Successfully updated group type 'groupTypeName'

                        		  

                        Failed to update group type 'groupTypeName'. RDU Unavailable.

                        When BAC RDU is not available.

                        Failed to update group type 'groupTypeName'. Unexpected error.

                        When the unexpected error occurs at Server.

                        Failed to update group type 'groupTypeName'. Operation error occurred. Please try again. If the problem persists please contact your system administrator.

                        Generic error message.

                        Import Group Type, Group Instance, ID Pool Type and ID Pool Instance: Messages

                        This table lists the status messages that can be displayed when importing a group type, group instance, ID pool type or ID pool instance:
                          UI Message Description

                        CSV file successful imported and changes applied.

                        		  

                        You have cancelled applying the changes.

                        The user interrupted the import process by clicking the Cancel button.

                        Export Group Type: Messages

                        This table lists the status messages that can be displayed when exporting group types:
                          UI Message Description

                        Export of group types successful.

                        		  

                        The export of group types could not be completed.

                        Generic error message for such scenarios as the PMG is unavailable.

                        Adding or Updating a Group Instance: Messages

                        This table lists the status messages that can be displayed when adding or updating a group instance:
                          UI Message Description

                        Successfully added group '<groupName>'.

                        		  

                        Failed to add group '<groupName>'. Unknown Parameter <parameterName>

                        If the configured parameter is not recognized by PMG. It has to be present in pmg-profile.xml and BAC.

                        Failed to add group '<groupName>'. Invalid Parameter <parameterName>

                        If the parameter value is not valid..

                        Failed to add group '<groupName>'. RDU Unavailable

                        When BAC RDU is not available.

                        Failed to add group '<groupName>'. Unexpected error

                        When the unexpected error occurs at server.

                        Failed to add group '<groupName>'. Operation error occurred. Please try again. If the problem persists please contact your system administrator.

                        Generic Error Message.

                        Deleting a Group Instance: Messages

                        This table lists the status messages that can be displayed when deleting a group instance:
                          UI Message Description

                        Successfully deleted group '<groupName>'.

                        		  

                        Failed to delete group '<groupName>'. Unknown Instance.

                        When a group does not exists at BAC.

                        Failed to delete group '<groupName>'. Unexpected error.

                        When the unexpected error occurs at server like if .group is in active state

                        Failed to delete group '<groupName>'. RDU unavailable.

                        When BAC RDU is not available.

                        Failed to delete group '<groupName>'. Operation error occurred. Please try again. If the problem persists please contact your system administrator.

                        Generic Error Message.

                        Exporting Information about a Group Instance: Messages

                        This table lists the status messages that can be displayed when exporting information about a group instance:
                          UI Message Description

                        Export of group, '<groupName>', successful.

                        This message is presented to the user only if he selected a single group to export.

                        Export of all groups successful.

                        This message is presented to the user only if he chose to export all groups.

                        The export of group could not be completed.

                        Generic error message for such scenarios as the PMG is unavailable.

                        Adding an ID Pool: Messages

                        This table lists the status messages that can be displayed when adding an ID pool:
                          UI Message Description

                        Successfully added ID pool '<poolName>'.

                        		  

                        Failed to add ID pool '<poolName>'. Unknown Parameter <parameterName>

                        If the configured parameter is not recognized by PMG. It has to be present in pmg-profile.xml and BAC.

                        Failed to add ID pool '<poolName>'. Invalid Parameter <parameterName>

                        If the parameter value is not valid.

                        Failed to add ID pool '<poolName>'. RDU Unavailable

                        When the BAC RDU is not available.

                        Failed to add ID pool '<poolName>'. Unexpected error

                        When the unexpected error occurs at server.

                        Failed to add ID pool '<poolName>'. Operation error occurred. Please try again. If the problem persists please contact your system administrator.

                        Generic Error Message.

                        Deleting an ID Pool Type: Messages

                        This table lists the status messages that can be displayed when deleting an ID pool type:
                          UI Message Description

                        Successfully deleted ID pool type '<idPoolTypeName>'.

                        		  

                        Failed to delete ID pool type '<idPoolTypeName>''. Operation error occurred. Please try again. If the problem persists please contact your system administrator

                        Generic error message for such scenarios as the BAC is unavailable.

                        Exporting ID Pool Type: Messages

                        This table lists the status messages that can be displayed when exporting information about an ID pool type:
                          UI Message Description

                        Successfully exported details for all Pool types.

                        		  

                        You have cancelled the requested Export

                        The user interrupted the import process by pressing the "Cancel" button.

                        There has been a communication error with the server. Please try again. If the problem persists please contact your system administrator

                        Generic error message for such scenarios as the PMG is unavailable.

                        Export an ID Pool: Messages

                        This table lists the status messages that can be displayed when exporting an ID pool instance:
                          UI Message Description

                        Successfully exported details of <poolName>.

                        This message is presented to the user only if he selected a single pool to export.

                        Successfully exported details for all <poolType> pools.

                        This message is presented to the user only if he chose to export all pools.

                        You have cancelled the requested Export

                        The user interrupted the import process by pressing the "Cancel" button.

                        Please enter a Pool Instance or Select All Pools

                        This message is presented to the user only if he clicks on export button when no pool and no pools checkbox checked.

                        There has been a communication error with the server. Please try again. If the problem persists please contact your system administrator.

                        Generic error message for such scenarios as the PMG is unavailable.

                        EID modifications for <poolTypeName> are not supported. Export may proceed. For example: EID modifications for FemtoGateway are not supported. Export may proceed.

                        This pool type does not allow export.

                        Updating an ID Pool Instance: Messages

                        This table lists the status messages that can be displayed when updating an ID pool instance:
                          UI Message Description

                        Successfully updated ID pool '<poolName>'.

                        		  

                        Failed to update ID pool '<poolName>'. Unknown Parameter <parameterName>

                        If the configured parameter is not recognized by PMG. It has to be present in pmg-profile.xml and BAC

                        Failed to update ID pool '<poolName>'. Invalid Parameter <parameterName>

                        If the parameter value is not valid

                        Failed to update ID pool '<poolName>'. RDU Unavailable

                        When the BAC RDU is not available.

                        Failed to update ID pool '<poolName>'. Unexpected error

                        When the unexpected error occurs at server.

                        Failed to update ID pool '<poolName>'. Operation error occurred. Please try again. If the problem persists please contact your system administrator.

                        Generic Error Message

                        Updating an ID Pool Type: Messages

                        This table lists the status messages that can be displayed when updating an ID pool type:
                          UI Message Description

                        Successfully updated ID pool type '<idPoolTypeName>'.

                        		  

                        Failed to update ID Pool type '<idPoolTypeName >'. RDU Unavailable.

                        When the BAC RDU is not available.

                        Failed to update ID Pool type '<idPoolTypeName >'. Unexpected error.

                        When an unexpected error occurs at Server

                        Failed to update ID Pool type '<idPoolTypeName >'. Operation error occurred. Please try again. If the problem persists please contact your system administrator.

                        Generic error message.

                        Was this Document Helpful?

                        FeedbackFeedback

                        Contact Cisco

                        Related Cisco Community Discussions

                        About Us
                        Contact Us
                        Work with Us