Configuration Guide for Event-Based Monitoring

Ericsson Service-Aware Policy Controller

1	Configure Event-Based Monitoring Overview
1.1	Typographic Conventions
1.2	Other Conventions
2	Configuration Prerequisites
3	Configure EBM Function
4	Configure EBM Servers
5	Configure Reporting Events

1 Configure Event-Based Monitoring Overview

Figure 1 shows the main parts related to configuring the SAPC.

Figure 1 Configuration and Provisioning Overview

The purpose of this document is to provide guidelines to configure the Event-Based Monitoring (EBM) function in the Ericsson Service-Aware Policy Controller (SAPC) by providing configuration examples.

This document does not intend to be a complete guide for configuring all possibilities related to the EBM function in the SAPC.

The complete parameter list and details of all configured options of the SAPC are included in separate documents, refer to Managed Object Model (MOM).

1.1 Typographic Conventions

For detailed information about the typographic and document conventions, see Typographic Conventions.

1.2 Other Conventions

This document refers to some configuration data.

To clarify which detailed data is managed by COM, this document uses the following conventions:

Configuration: whenever referring to Managed Object Class (MOC).
Example: set enableReauthsOnSubsChange attribute in class AppConfig.

The detailed description of the objects and attributes can be found in Managed Object Model (MOM).

The tools or interfaces to manage these data in the SAPC are:
1. NETCONF interface, refer to Ericsson NETCONF Interface.
  The configuration examples show the NETCONF file contents, using the following syntax:
```
<edit-config>
  ...
  <config>
  <ManagedElement xmlns="urn:com:ericsson:ecim:ComTop">
  <managedElementId>1</managedElementId>
       ...
  </ManagedElement>
  </config>
</edit-config>
```
2. COM CLI, refer to Ericsson Command-Line Interface.

2 Configuration Prerequisites

Before configuring the SAPC in an operating network, make sure that:

CBA components are installed
The SAPC product software is installed
The SAPC user performing configuration changes has thorough knowledge of the function

Do!

Before performing the associated configuration task in the SAPC, see Event-Based Monitoring.

3 Configure EBM Function

The EBM function can be enabled or disabled using the EventBasedMonitoring class.

To enable EBM events to be sent, set the enable attribute to true
To disable EBM events, set the enable attribute to false

Note:: It is mandatory to set the enable attribute. The default value is false.

The SAPC always checks the value of the enable attribute before executing the EBM event reporting function.

If EBM is disabled, the SAPC stops the event reporting function
If EBM is enabled, the SAPC restarts the event reporting function

Example 1 EBM Function Configuration

<edit-config>
    <target>
    <running />
    </target>
    <config>
   <ManagedElement xmlns="urn:com:ericsson:ecim:ComTop">
    <managedElementId>1</managedElementId>
    <dnPrefix>dc=ManagedElement</dnPrefix>
    <networkManagedElementId>1</networkManagedElementId>
    <userLabel>Managed Element</userLabel>
   <PolicyControlFunction xmlns="urn:com:ericsson:ecim:sapcmom">
      <policyControlFunctionId>1</policyControlFunctionId>  
      <EventBasedMonitoring xmlns="urn:com:ericsson:ecim:eventbasedmonitoringmom">
        <eventBasedMonitoringId>1</eventBasedMonitoringId>
        <enable>true</enable>
      </EventBasedMonitoring>
   </PolicyControlFunction>
   </ManagedElement>
   </config>
</edit-config>

4 Configure EBM Servers

For connecting the SAPC to EBM servers, configure each EBM server under the EbmServers class:

Define the EbmServer class attributes
- Set the value of ebmServerId to the identifier of the EBM server
- Set the value of ipAddress to the IP address of the EBM server
- Set the value of port to the port number of the EBM server
Note:
It is mandatory to define all the EbmServer class attributes.

Example 2 EBM Server Configuration

<edit-config>
    <target>
    <running />
    </target>
    <config>
   <ManagedElement xmlns="urn:com:ericsson:ecim:ComTop">
    <managedElementId>1</managedElementId>
    <dnPrefix>dc=ManagedElement</dnPrefix>
    <networkManagedElementId>1</networkManagedElementId>
    <userLabel>Managed Element</userLabel>
   <PolicyControlFunction xmlns="urn:com:ericsson:ecim:sapcmom">
      <policyControlFunctionId>1</policyControlFunctionId>  
      <Network xmlns="urn:com:ericsson:ecim:networkmom">
         <networkId>1</networkId>
         <EbmServers>
            <ebmServersId>1</ebmServersId>
            <EbmServer>
               <ebmServerId>EBM_Server1</ebmServerId>
               <ipAddress>10.5.6.34</ipAddress>
               <port>32010</port>
            </EbmServer>
         </EbmServers>
      </Network>
   </PolicyControlFunction>
   </ManagedElement>
   </config>
</edit-config>

5 Configure Reporting Events

To send events to the EBM server, modify the EbmBusinessEvent class of the specific event under the EbmBusinessEvents class:

Set the value of the enable attribute to true to send a specific event
Note:
It is mandatory to set the enable attribute.
Set the value of ebmServerIds to the identifier of the server where the event is sent:
ebmServerIds [0..]

Note:
If empty, the event is sent to all EBM servers configured in Section 4 Configure EBM Servers.

All EBM events are preinstalled, they are not allowed to be created or deleted by the operator.

The operator is allowed to configure the enabling and disabling of each event, and the list of EBM servers where each event is sent to.

Example 3 Reporting Event Configuration

<edit-config>
    <target>
    <running />
    </target>
    <config>
   <ManagedElement xmlns="urn:com:ericsson:ecim:ComTop">
    <managedElementId>1</managedElementId>
    <dnPrefix>dc=ManagedElement</dnPrefix>
    <networkManagedElementId>1</networkManagedElementId>
    <userLabel>Managed Element</userLabel>
   <PolicyControlFunction xmlns="urn:com:ericsson:ecim:sapcmom">
      <policyControlFunctionId>1</policyControlFunctionId>  
      <EventBasedMonitoring xmlns="urn:com:ericsson:ecim:eventbasedmonitoringmom">
        <eventBasedMonitoringId>1</eventBasedMonitoringId>
        <enable>true</enable>
        <EbmBusinessEvents xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0" nc:operation="merge">
          <ebmBusinessEventsId>1</ebmBusinessEventsId>
          <EbmBusinessEvent>
            <ebmBusinessEventId>GX_CCR_CCA_TRANSACTION</ebmBusinessEventId>
            <enable>true</enable>
            <ebmServerIds>EBM_Server1</ebmServerIds>
          </EbmBusinessEvent>
          <EbmBusinessEvent>
            <ebmBusinessEventId>RULE_INSTALLED</ebmBusinessEventId>
            <enable>true</enable>
            <ebmServerIds>EBM_Server1</ebmServerIds>
          </EbmBusinessEvent>
        </EbmBusinessEvents>
      </EventBasedMonitoring>
   </PolicyControlFunction>
   </ManagedElement>
   </config>
</edit-config>