Acme IP Telephony

As an administrator, you can configure attributes listed in the table given here for monitoring the Acme IP telephony infrastructure discovered on the network. This topic includes the following sections:

To access the administration console:

  1. Log on to the NNMi console as an administrator.
  2. From the Workspaces navigation pane, click Configuration > iSPI for IP Telephony Configuration > Acme Configuration. The administration console for Acme IP telephony appears.

The administration console displays configuration options for the following attributes:

Attribute Description
Call Monitoring

Allows you to configure the call monitoring options of Acme IP Telephony devices.

You can also use this option to view the existing call monitoring configurations.

Data Access

Allows you to configure the NNM iSPI for IP Telephony to access the various categories of management data from the Acme IP Telephony servers in your deployment environment.

You can also use this option to view the existing data access configurations.

Polling

Allows you to configure the polling options of Acme IP Telephony device states and statistics.

You can also use this option to view the existing polling configurations.

Reporting

Allows you to configure the Call Details Record (CDR) reports for the Acme IP Telephony network.

You can also use this option to view the existing reporting configuration.

Configure Call Monitoring

You can use the NNM iSPI for IP Telephony Acme Call Monitoring Configuration form to configure the following:

  • Monitor the voice QOS metrics and MOS values for calls in the Acme IP Telephony network
  • The termination cause codes that need to be monitored for a specific call in the Acme IP Telephony network

Configure the QOS/MOS Threshold Values

The Call Monitoring Configuration link on the Acme Configuration pane enables you to configure the monitoring of voice QOS metrics and MOS values for calls in the Acme IP Telephony network. The Thresholds for QOS/MOS Monitoring tab on the NNM iSPI for IP Telephony Acme Call Monitoring Configuration form allows you to specify the threshold values. On violation of set threshold for any of these parameters for any monitored call, the NNM iSPI for IP Telephony generates an incident conveying the resulting values and the set threshold.

To configure the QOS/MOS monitoring threshold values for Acme IP telephony calls:

  1. On the NNM iSPI for IP Telephony Acme Configuration console, click Call Monitoring Configuration. The NNM iSPI for IP Telephony Acme Call Monitoring Configuration form opens.
  2. Click the Thresholds for QOS/MOS Monitoring tab. The Thresholds for QOS/MOS Monitoring tab page opens.
  3. Specify the required details in the fields provided under the Thresholds for QOS/MOS Monitoring section of the page. By default, no threshold values are set for these parameters and threshold-based monitoring is disabled. You can enable monitoring and incident generation when you specify the valid threshold values.The following table describes the fields that appear in the section:

    QOS/MOS Monitoring Parameter Description
    1Jitter The jitter threshold (in milliseconds) to be configured.
    1PPL The Percentage Packet Loss (PPL) threshold to be configured. For example, to specify a percentage packet loss threshold of 50%, type 50.
    1Latency The latency (in milliseconds) threshold to be configured.
    1RFactor The QoS R-Factor (in percentage) to be configured. This value must be within the range of 0 to 100.
    1Avg MOS The average Mean Opinion Source (MOS) value to be configured. This value must be within the range of 0.0 to 5.0.

    1To disable the monitoring, specify -1.0.

  4. Click Apply Changes. The NNM iSPI for IP Telephony updates the QOS/MOS monitoring configuration values.

Configure Session Director

The Add Session Director Specific QOS Configuration section on the Thresholds for QOS/MOS Monitoring tab page enables you to configure QOS and MOS monitoring threshold values for the specific Session Director (SD) of your choice. After you specify threshold values specific to an SD, the NNM iSPI for IP Telephony lists these threshold values in the Current Configurations section and uses them for the specific SD, instead of the threshold values specified in the Thresholds for QOS/MOS Monitoring section. You cannot modify the SD IP Address value. After removing the Session Director—specific threshold value configuration, the NNM iSPI for IP Telephony uses the values you provided in the system-wide Thresholds for QOS/MOS Monitoring section.

To configure Session Director—specific QOS and MOS monitoring threshold values:

  1. On the Thresholds for QOS/MOS Monitoring tab page, go to Session Director Specific Thresholds for QOS/MOS Monitoring pane > Add Session Director Specific QOS Configuration section.
  2. Under the Add Session Director Specific QOS Configuration section, specify the required details in the fields provided. The following table describes the fields in the section:

    Field NameDescription
    SD IP Address

    The management IP address of the Session Director.

    JitterThe jitter threshold (in milliseconds) to be configured for the SD.
    PPLThe Percentage Packet Loss (PPL) threshold to be configured for the cluster. For example, to specify a percentage packet loss threshold of 50%, type 50.
    LatencyThe latency threshold (in milliseconds) to be configured for the SD.
    RFactorThe QoS R-Factor (in percentage) to be configured for the SD. This value must be within the range of 0 to 100.
    Avg MOSThe average Mean Opinion Source (MOS) value to be configured for the CM. This value must be within the range of 0.0 to 5.0.

    For more information about the QOS and MOS monitoring parameters, see Configuring the QOS and MOS Threshold Values for Call Monitoring.

  3. Click Add/Modify. This adds the configuration for the SD in the Current Configurations section.

To modify Session Director—specific QOS and MOS monitoring threshold values:

  1. From the Current Configurations section, select the Session Director—specific configuration that you want to modify .
  2. Click Modify.
  3. In the Add Session Director Specific QOS Configuration section, make the required changes.
  4. Click Add/Modify. The Session Director—specific configuration is updated with the new values.

To delete Session Director—specific QOS and MOS monitoring threshold values:

  1. From the Current Configurations section, select the Session Director—specific configuration that you want to delete.
  2. Click Delete. The Session Director—specific threshold values for the SD are deleted.

To export configurations to the Global Manager:

  • Click Export All Config to Global Manager. This sends all the available configuration information listed in the Current Configuration section, irrespective of the check boxes selected, to the Global Manager. If a global manager is not configured, the NNM iSPI for IP Telephony does not populate any data.

Configure the Call Termination Cause Codes to be Monitored

The Call Monitoring Configuration link on the Acme Configuration pane enables you to configure the termination cause codes that need to be monitored for a specific call in the Acme IP Telephony network. If there are a number of unprocessed Session Director Call Details Records (CDRs), configuring the cause codes, before configuring CDR data access, can generate several incidents.

You can specify the following types of call termination cause codes:

  • Success Cause Codes: Lists the cause codes for call terminations that occurred without a call failure. For example, 'Temporary failure', 'User busy'.
  • Failure Cause Codes: Lists the cause codes for call terminations that occurred due to a call failure. For example, 'No route destination', 'Service Unavailable'.

After you specify the codes that you want to be monitored, the NNM iSPI for IP Telephony generates the CallTerminationReason incident only when the call termination occurs due to one of the specified call termination cause codes.

To configure the monitoring of call termination cause codes:

  1. On the NNM iSPI for IP Telephony Cisco Configuration console, click Call Monitoring Configuration. The NNM iSPI for IP Telephony Acme Call Monitoring Configuration form opens.
  2. On the Call Termination Cause Monitoring tab page, from the types of call termination cause codes sections, select the codes that you want to monitor, and then click (the Move Items to Selected List icon). The sections displayed are as follows:
    • Success Cause Codes
    • Failure Cause Codes
    • To select multiple random cause codes, press the Ctrl key and select the required codes.

    • To select a series of cause codes, press the Shift key and the select the series of cause codes.
    • To move a selected cause code from the monitored cause code list back to the cause code selection list, select the cause code and click ( the Move Items to Non-selected List icon). The default version of the property file — AcmeCDRTerminationCauseCodes.properties — is available in the following directory:
    • /var/opt/OV/shared/ipt/conf/acme

    The property file can be used to add new termination cause codes that are not listed in the types of call termination cause codes section. After you add a new termination cause code, make sure to restart the IPT jboss application server to reflect the change.

  3. Click Apply to complete the configuration.

Configure Data Access

You can use the NNMi Data Access Configuration form to configure the following types of data for Acme Session Director:

  • Secure Shell (SSH)
  • Call Details Record (CDR)
  • Historical Data Recording (HDR)

You can also use this form to modify or delete an existing data access point.

Access the Acme Session Director with SSH

Configuring SSH access for the Acme Session Director enables the NNMi to discover the following features and determines the relationship of these features with each other:

  • Session Agent Group
  • Network Interface
  • Steering Pool
  • SIP Interfaces
  • SIP Port
  • Network Interfaces

To configure SSH access for Acme Session Director:

  1. On the NNMi Cisco Configuration console, click Data Access Configuration. The NNMi Acme Data Access Configuration form opens.
  2. Click the SSH Access tab.
  3. On the SSH Access tab page, under the Add/Modify SSH Configuration section, specify the required details in the fields provided on the page. The following table describes the fields on the page:
    Field NameDescription
    SD IP Address

    Indicates the IP address of the Acme Session Director (SD) for which you want to configure the SSH access.

    SSH Type

    Indicates the type of SSH application to be used to collect the session details. The NNMi uses the ACME_ACLI_DEFAULT application by default.

    User NameIndicates the user name to be used to establish an SSH connection.
    PasswordIndicates the password to be used for the user name.
    SSH Port

    Indicates the port number to be used for the SSH connection.

    SSH TimeoutIndicates the number of seconds to wait while attempting to execute a command before canceling the attempt.
    Host Key

    Indicates the SSH host key for the Acme Session Director.

  4. Click Add/Modify to complete the configuration. The NNMi lists the added configuration in the Current Configurations section.

To modify an existing SSH configuration for Acme Session Director:

  1. Select an existing SSH configuration from the Current Configurations section.
  2. Click Modify.
  3. In the Add/modify SSH Configuration section, make the required changes. You cannot modify the SD IP Address and the SSH Port values.
  4. Click Add/Modify to complete the configuration. The NNMi lists the modified configuration in the Current Configurations section.

To delete an existing SSH configuration for Acme Session Director:

  1. Select an existing SSH configuration from the Current Configurations section.
  2. Click Delete. The selected configuration is deleted from the Current Configurations section.

Access the CDR Data

Configuring the CDR  data access for the Acme Session Director enables the NNMi to provide the following reports:

  • Acme IP Telephony CDR reports

When the NNMi is configured as a push receiver, you can configure the CDR access only for one of the Sessions Directors of the redundant pair; which means that if you configure CDR access to the active Session Director of the redundant pair, you cannot configure access for the standby Session Director of the pair and vice versa. However, when an FTP server is configured to pull the CDR files from the Session Director, you must configure the CDR access for both the active and standby Session Directors of the redundant pair.

Prerequisites:

To access the CDR data for Acme Session Director when the NNMi is configured as a Push reciever, you must configure an FTP server on the NNMi management server (where the NNMi is installed).

To configure the FTP server on a standalone NNMi management server (a server that is not installed in an HA cluster):

  1. Set up an FTP server on the NNMi management server.
  2. Create a user on the NNMi management server with the read/write access to the following location:

    • Windows:%NnmDataDir%\shared\ipt\acmecdr
    • Linux: /var/opt/OV/shared/ipt/acmecdr
  3. Set up the home directory for the FTP server.

    • For Windows:Configure the %NnmDataDir%\shared\ipt\acmecdr directory as the home directory of the FTP server.
    • For Linux: Make sure that the / (root) directory is configured as the home directory of the FTP server.

To configure the FTP server on the NNMi management server in an HA cluster:

  1. Set up an FTP server on each NNMi management server in the HA cluster.
  2. Create a user on the NNMi management server with the read/write access to the following location:

    • Windows:<Shared_Drive>\NNM\dataDir\shared\ipt\acmecdr
    • Linux:/nnm_mount_point/NNM/dataDir/shared/ipt/acmecdr

    In this instance, <Shared_Drive> is the drive that is shared among the systems in the HA cluster. For the NNMi installed on Windows, the shared drive must be online when you create this new user. If required, create the acmecdr directory manually.

  3. Set up the home directory for the FTP server.

    • For Windows:Configure the <Shared_Drive>\NNM\dataDir\shared\ipt\acmecdr directory as the home directory of the FTP server.
    • For Linux: Make sure that the / (root) directory is configured as the home directory of the FTP server.

To configure CDR access for Acme Session Director:

  1. On the NNMi Acme Configuration console, click Data Access Configuration. The NNMi Acme Data Access Configuration form opens.
  2. Click the CDR Access tab.
  3. On the CDR Access page, under the Add/Modify Configuration for Accessing CDR from Acme Session Directors section, specify the required details in the fields provided on the page. The following table describes the fields on the page:
    Field NameDescription
    Acme SD IP AddressIndicates the Management IP address of the Acme Session Director.
    Format Specification File

    Indicates the fully qualified path of the property file that describes the fields of the STOP record in the CDR file.

    The default version of the property file—AcmeStopCDRRecordFormat.properties—is available in the following folders:

    • For Windows: %NNMDataDir%\shared\ipt\conf\acme
    • For Linux: /var/opt/OV/shared/ipt/conf/acme

    The cdr-output-inclusive parameter (disabled by default), in the account configuration file of the Session Director, must be enabled to ensure that the empty fields in the local CDR files are filled with zeros (0s). Else, the NNMi cannot process the Acme CDRs due to the CDR-field mismatch between the fields defined in the default AcmeStopCDRRecordFormat.properties file and the fields in the CDR files of the Session Director. If the cdr-output-inclusive parameter cannot be enabled for some reason, make sure that you edit the AcmeStopCDRRecordFormat.properties file manually—to include only the non-empty CDR fields from the CDR file of the Session Director in your environment.

    CDR Files Download Path

    Indicates the path of the directory to which the CDR files are downloaded.

    When the NNMi server is configured as a push receiver, this path is configured on the Session Director so that it can push the CDR files.

    When an FTP server is configured to pull the CDR files from the Session Director, the files are sent to this path.

    The CDR Files Download Path creates the following folders for each Session Director:

    • Working: Contains the CDR files that are in process.
    • Rejected: Contains the files that fail parsing. A new incident is generated for the first CDR file that fails parsing and is moved to this folder. Subsequently, an incident is generated for every 10th CDR file that is moved to the folder after it fails parsing. Make sure that you correct the parsing error—such as by editing the respective property file. Else, the IP Telephony Server can run out of disk space as the parsing-failed CDR files continuously get accumulated in the folder. The folder for the CDR files to be downloaded for the redundant pair of the Acme Session Director must be created under the following:
    • For Windows:%NNMDataDir%\shared\ipt\acmecdr

      • For Linux:/var/opt/OV/shared/ipt/acmecdr

      The folder for the CDR files to be downloaded for the redundant pair of the Acme Session Director must be created under the following:

      • For Windows:%NNMDataDir%\shared\ipt\acmecdr
      • For Linux:/var/opt/OV/shared/ipt/acmecdr
    Is IPT SPI Server configured as a push receiver?

    Select True if the NNMi server is configured as a Push receiver on the Session Director.

    When the NNMi is configured as a Push receiver, the raw CDR data of the Acme Session Director is lost.

    Select False if the NNMi server is not a push receiver. This allows you to configure the FTP credentials to pull the CDR files from the Session Director. To configure the FTP credentials, specify the following details:

    • Is it a Secure FTP?: By default, this field displays False. Specify the following credentials:
      • User Name: The FTP server user name.
      • Password: The password of the FTP server user name.
      • CDR File Remote Path: The full path of the directory on the Session Director from where the CDR files are downloaded.
      • CDR Polling Interval: The interval (in minutes) at which the NNMi performs an FTP connect to the Acme Session Director to collect the CDR files. Specify an interval between 2 – 60 minutes. The polling interval is a system-wide configuration and is used for all the configured non-push-receiver-based Session Directors for which the NNMi downloads CDR files using FTP. When the Session Directors are deployed in a pair, the polling occurs only on the active Session Director of the pair; and the NNMi downloads CDR files—using FTP—only from the active Session Director.
  4. Click Add/Modify to complete the configuration. The NNMi lists the added configuration in the Current Configurations section.

To modify an existing CDR Access configuration for Acme Session Director:

  1. Select an existing CDR Access configuration from the Current Configurations section.
  2. Click Modify.
  3. Specify the required values for the configuration in the Add/Modify Configuration for Accessing CDR from Acme Session Directors section. You cannot modify the Acme SD IP Address value.
  4. Click Add/Modify to complete the configuration.

To delete an existing CDR Access configuration for Acme Session Director:

  1. Select an existing CDR Access configuration from the Current Configurations section.
  2. Click Delete. The selected configuration is deleted from the Current Configurations section:

The default versions of the property files — AcmeCDRCallSuccessByISDNAndSIPCode.properties and AcmeCDRStopRecordParser.properties — are available in the following directory:

  • /var/opt/OV/shared/ipt/conf/acme

While the AcmeCDRCallSuccessByISDNAndSIPCode.properties file can be used to add the various SIP and ISDN codes to determine if the call can be considered as a successful call in the reports, the AcmeCDRStopRecordParser.properties file can be used to add all the possible Acme-Session-Discposition, Acme-Disconnect-Initiator, Acme-Disconnect-Cause and Acme-SIP-Status field values from the Acme CDR Stop Record. After you edit either of the files, make sure to restart the IPT jboss application server to reflect the change.

Access the HDR Data for Acme Session Director

Configuring the HDR access for Acme Session Director enables the NNMi to provide Acme IP Telephony reports based on the following statistics:

  • SIP sessions
  • Media set up errors
  • ACL (Access Control List) operations
  • Transactions
  • SIP client operations
  • SIP server operations
  • Invites

You can configure the HDR access only for one of the sessions directors of the redundant pair; which means that if you configure HDR access to the active session director of the redundant pair, you cannot configure access for the standby session director of the pair and vice versa.

To configure HDR access for Acme Session Director:

  1. On the NNMi Acme Configuration console, click Data Access Configuration. The NNMi Acme Data Access Configuration form opens.
  2. Click the HDR Access tab.
  3. On the HDR Access page, under the Add/Modify Configuration for Accessing HDR from Acme Session Directorssection, specify the required details in the fields provided on the page. The following table describes the fields on the page:
    Field NameDescription
    Acme SD IP AddressThe Management IP address of the Acme Session Director.
    HDR Files Download Path

    The path of the directory to which the HDR files are downloaded.

    Each pair of Session Director must have a specific folder to which the HDR files are downloaded. When the NNMi server is configured as a Push receiver, this path is configured on the Session Director so that it can push the HDR files.

    The HDR files are pushed from the Session Director to the following directory:

    • For Windows – %NNMDataDir%\\shared\\ipt\\acmehdr\\<New_Directory>
    • For Linux – /var/opt/OV/shared/ipt/acmehdr/<New_Directory>
  4. Click Add/Modify to complete the configuration. The NNMi lists the added configuration in the Current Configurations section.

To modify an existing HDR Access configuration for Acme Session Director:

  1. Select an existing HDR Access configuration from the Current Configurations section.
  2. Click Modify.
  3. Specify the required values for the configuration in the Add/Modify Configuration for Accessing HDR from Acme Session Directors section. You cannot modify the Acme SD IP Address value.
  4. Click Add/Modify to complete the configuration.

To delete an existing HDR Access configuration for Acme Session Director:

  1. Select an existing HDR Access configuration from the Current Configurations section.
  2. Click Delete. The selected configuration is deleted from the Current Configurations section.

Configure Polling

You can use the NNM iSPI for IP Telephony Acme Polling Configuration form to enable the polling of the Acme IP telephony devices.

To configure the polling of Acme IP telephony devices:

  1. On the NNM iSPI for IP Telephony Acme Configuration console, click Polling Configuration. The NNM iSPI for IP Telephony Acme Polling Configuration form opens.
  2. In the Session Director Polling section, specify the required details in the fields provided on the page. The following table describes the fields on the page:
    Field NameDescription
    Configuration for Monitoring the State of Session Directors in HA Pairs or Standalone system

    Allows you to configure the continuous polling of the state of Acme Session Director HA pairs or a standalone system. The available options are as follows:

    • Enable Polling: Select this check box to enable the polling of the Acme Session Director.
    • Interval: Indicates the interval (in seconds) to poll the Acme Session Director. The default value is 300 seconds.
    Configuration for Monitoring the State of Realms of a Session Director

    Allows you to configure the continuous polling of the state of the Realms associated with an Acme Session Director. The available options are as follows:

    • Enable Polling: Select this check box to enable the polling of the Realms.
    • Interval: Indicates the interval (in seconds) to poll the Realms. The default value is 300 seconds.
    Configuration for Monitoring the State of Session Agents of a Session Director

    Allows you to configure the continuous polling of the state of the Session Agents associated with an Acme Session Director. The available options are as follows:

    • Enable Polling: Select this check box to enable the polling of the Session Agents.
    • Interval: Indicates the interval (in seconds) to poll the Session Agents. The default value is 300 seconds.
  3. Click Apply Changes.

Configure Reporting

The NNM iSPI for IP Telephony Reporting Configuration form on the Acme Configurationconsole enables you to configure CDR reporting for the Acme Session Directors on the Acme IP Telephony network. However, you have to install and enable the iSPI Performance for Metrics to enable CDR reporting by the NNM iSPI for IP Telephony.

To configure CDR Reporting for Acme Session Directors:

  1. On the NNM iSPI for IP Telephony Acme Configuration console, click Reporting Configuration. The NNM iSPI for IP Telephony Acme Reporting Configuration form opens.
  2. In the Reports Using CDR Data section, specify the required details. The following table describes the fields that appear in the section:
    Field NameDescription
    Enable ReportingSelect the check box to enable the collection and processing of CDRs for reports.
    Number of Calls to Write The number of processed calls to be sent to the Network Performance Server (NPS). The default value is 5000.
    Calling and Called Party Numbers in ReportsSelect the check box to display the calling party number and the called party numbers in the Call Completion Reports.
    Forward to Global ManagerSelect the check box if you want the processed call information to be sent from the current management server to the global manager. This option is enabled by default.
  3. Click Apply Changes.