1. Historical Data Recording Guide
  2. Configuring HDR
  3. Configuring HDR via the ACLI

Configuring HDR via the ACLI

This section provides procedures for configuring HDR. HDR configuration includes:

  • setting parameters to govern sample and push intervals, and start/end times for collection
  • setting parameters to support HDR across a high availability (HA) node
  • setting group parameters to inform the Oracle Communications Session Border Controller (OCSBC), which groups of records to collect, when to start and stop collecting, and how often to sample for a specific group.
  • setting push receivers that transport the records forwarded by the OCSBC

    Note:

    If you modify the HDR configuration parameters using the ACLI, the changed parameters DO NOT take affect until you reboot the OCSBC

Enabling HDR Collection

You access the parameters that enable and support HDR using the ACLI system-config path.

To enable HDR collection:

  1. In Superuser mode, type configure terminal and press Enter. 
    ORACLE# configure terminal
  2. Type system and press Enter. 
    ORACLE(configure)# system
ORACLE(system)#
  3. Type system-config and press Enter. 
    ORACLE(system)# system-config
ORACLE(system-config)#
  4. Enter collect and press Enter. From here, you can type a question mark (?) to see individual parameters for the configuration. 
    ORACLE(system-config)# collect
ORACLE(collect)#

Setting Global Collection

You access the collection configuration through the ACLI system-configuration menu. Once in the collection configuration, you can establish the global settings for HDR collection.

To set HDR global collection:

  1. In Superuser mode, navigate to the collect parameter level in the ACLI.
    ORACLE# configure terminal
ORACLE(configure)# system
ORACLE(system)# system-config
ORACLE(system-config)# collect
ORACLE(collect)#
  2. Set global collection parameters as applicable. Parameters include:

    • sample-interval—Enter the time in minutes for how often you want the OCSBC to sample data records. The default is 5. The valid range is:

      • Minimum—1
      • Maximum—120

    • push-interval—Enter the time in minutes for how often you want the OCSBC to send collected records to push receiver(s). The default is 15. The valid range is:

      • Minimum—1
      • Maximum—120

    • boot-state—Set this parameter to enabled to start group collection, or to disabled to prevent the OCSBC from collecting HDR statistics. This parameter does not go into effect until the system is rebooted. You can also use the ACLI request collect start command to start collection; using this command, you can start collection for all groups, or for one specified group. The default is disabled. Valid values are:

      • enabled | disabled

    • start-time—Enter the exact date and time (for your local timezone) when you want the OCSBC to start HDR collection. You can enter now to set the start-time to the current time, or you can specify a time in the future. If you specify a time, it must be in the format yyyy-mm-dd-hh:mm:ss, where: yyyy is the year, mm is the month, dd is the day, hh in the hour, mm is the minutes, and ss is the second (24-hour clock). The default is now.

    • end-time—Enter the exact date and time (for your local timezone) when you want the OCSBC to finish HDR collection. You can enter never to set the time to never end, or you can specify an end time in the future. If you specify a time, it must be in the format yyyy-mm-dd-hh:mm:ss, where: yyyy is the year, mm is the month, dd is the day, hh in the hour, mm is the minutes, and ss is the second (24-hour clock). The default is never.

    • push-success-trap-state—Set this parameter to enabled if you want the OCSBC to send a trap confirming successful data pushes to HDR servers. Default is disabled. Valid values are:

      • enabled | disabled

Setting HDR for an HA Node

If you are using the HDR feature on a High Availability (HA) node (or redundant pair of OCSBCs), several parameters in the collection configuration must be set for HDR to perform properly.

Oracle recommends strongly that you do not change these parameters from their defaults for a normal HA node configuration. Therefore, if you need to change them to support HDR, you should do so with caution.

To set HDR support across an HA node:

  1. In Superuser mode, navigate to the collect parameter level in the ACLI. 
    ORACLE# configure terminal
ORACLE(configure)# system
ORACLE(system)# system-config
ORACLE(system-config)# collect
ORACLE(collect)#
  2. Set HDR collection parameters for an HA node as applicable. Parameters include:

    • red-collect-state—The Red-collect-state parameter enables the HDR data files to be replicated from the Active to the standby. This functionality ensures no data loss in case the HDR files are not pushed off of the Active before a failover. The data that is pushed to the Standby is generated on the Active SBC and reflects the Active's operating state .

      Set the state of HA support for the collector function. The default is disabled. Valid values are:

      • enabled | disabled

      Note:

      Changing the red-collect-state setting does not take effect until SBC is rebooted. This parameter is not RTC supported.

    • red-max-trans—Enter the maximum number of HA synchronized transactions to maintain on the active system in the HA node. The default is 1000. The valid range is:

      • Minimum—0
      • Maximum—999999999

    • red-sync-start-time—Enter the amount of time, in milliseconds, that the active OCSBC checks to confirm that it is still the active system in the HA node. If the active system is still adequately healthy, this timer resets itself. If for any reason the active has become the standby, it starts to checkpoint with the newly active system when this timer expires. The default is 5000. The valid range is:

      • Minimum—0
      • Maximum—999999999

    • red-sync-comp-time—Enter amount of time, in milliseconds, that determines how frequently after synchronization the standby OCSBC checkpoints with the active OCSBC. The first interval occurs after initial synchronizations of the systems; this is the timeout for subsequent synchronization requests. The default is 1000. The valid range is:

      • Minimum—0
      • Maximum—999999999

Setting Multiple Collection Groups

You can configure the OCSBC to collect multiple groups of statistics. Collection group settings are accessible through the collection configuration. For specific group names, group statistics, and values, see HDR Groups and Group Statistics.

The sample-interval, start-time, and end-time parameters that you set for multiple collection groups override the same parameters set for global collection.

Note:

For multiple collection groups, the sample-interval value must always be smaller than the global collection parameter value for push-interval.

To set multiple collection groups:

  1. Access the group-settings configuration element. 
    ORACLE# configure terminal
ORACLE(configure)# system
ORACLE(system)# system-config
ORACLE(system-config)# collect
ORACLE(collect)#group-settings
ORACLE(group-settings)#
  2. group-name—Enter the group name corresponding to the records that you want to collect; there are 25 possible groups for which the OCSBC can collect data. The system group name is the default for this parameter. For additional group names, see HDR Groups and Group Statistics.
  3. sample-interval—Enter the time in minutes for how often you want the OCSBC to sample data records for the specified group. The default is 5. The valid range is:
    • Minimum—1
    • Maximum—120
  4. boot-state—Set this parameter to enabled to start group collection, or to disabled to prevent the OCSBC from collecting HDR statistics for this group. This parameter does not go into effect until the system is rebooted. You can also use the ACLI request collect start command to start collection; using this command, you can start collection for all groups, or for one specified group. The default is disabled. Valid values are:
    • enabled | disabled
  5. start-time—Enter the exact date and time (for your local timezone) when you want the OCSBC to start collecting records for this group. You can enter now to set the start-time to the current time, or you can specify a time in the future. If you specify a time, it must be in the format yyyy-mm-dd-hh:mm:ss, where: yyyy is the year, mm is the month, dd is the day, hh in the hour, mm is the minutes, and ss is the second (24-hour clock). The default is now.
  6. end-time—Enter the exact date and time (for your local timezone) when you want the OCSBC to stop collecting records for this group. You can enter never to set the time to never end, or you can specify an end time in the future. If you specify a time, it must be in the format yyyy-mm-dd-hh:mm:ss, where: yyyy is the year, mm is the month, dd is the day, hh in the hour, mm is the minutes, and ss is the second (24-hour clock). The default is never.
  7. Type done to save your configuration.

Setting Servers as Push Receivers

You can configure multiple push receivers that represent FTP or SFTP destination servers for which the OCSBC pushes records. Push receiver settings are accessible through the collection configuration.

If you configure more than one server, the OCSBC sends data to all of the servers. If one server fails, the OCSBC generates an SNMP trap. The OCSBC makes 3 attempts to send data to the failed server. If the server cannot receive the data, the OCSBC clears the data for that server. For example, if there are four servers configured, and the OCSBC successfully pushes data to three of them, the OCSBC generates a trap indicating the fourth server is down and after 3 attempts to send the data, the data is cleared.

To set servers as push receivers:

  1. In Superuser mode, navigate to the collect parameter level in the ACLI. 
    ORACLE# configure terminal
ORACLE(configure)# system
ORACLE(system)# system-config
ORACLE(system-config)# collect
ORACLE(collect)#
  2. Access the push receiver (push-receiver) parameters. 
    ORACLE(collect)# push-receiver
ORACLE(push-receiver)#

    • address—Enter the IP address of the push receiver (server) to which you want records sent. The default for this parameter is 0.0.0.0.

    • username—Enter the username that the OCSBC uses when it tries to send records to this push server using FTP. There is no default for this parameter.

    • password—Enter the password (corresponding to the username) that the OCSBC uses when it sends records to this push server using FTP. There is no default for this parameter. Enter this password parameter using the following procedure:

      • Type the parameter name password, and then press Enter. 

        ORACLE(push-receiver)# password

      • Enter the password that the OCSBC uses to send records to the push server. The display does not echo the password you enter. 

        Enter password: [enter the password]

      • Enter the password again to confirm that you entered the password correctly. If the passwords match, the user prompt displays to continue the push server configuration. 

        Enter password again: [enter the password again]
ORACLE(push-receiver)#

        If the passwords do not match, an error message displays. Repeat Steps a through c to set the password. 

        Error:  Password mismatch - aborted.
ORACLE(push-receiver)#

    • data-store—Enter the absolute path on the remote server where you want the collected data placed. There is no default for this parameter.

    • protocol—Set this parameter to the protocol with which to send HDR collection record files. Default is FTP. Valid values are:

      • FTP | SFTP

    Note:

    Public key authentication is not available when you choose SFTP. Instead, the OCSBC uses password authentication. However, for SFTP to work, it is still required that you load the SFTP’s host public key on the OCSBC.

SSH Keys

For managing SSH keys, see the "Manage SSH Keys" section in the ACLI Configuration Guide.