Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Navigation
Guide That Contains This Content
[+] Expand All
[-] Collapse All

    Configuring the SAE to Send Tracking Events to the SRC VTA (SRC CLI)

    The SRC VTA communicates with the SAE through the Enterprise JavaBean (EJB) adapter plug-in. This plug-in is an SAE plug-in and performs the following functions:

    • Filters SAE plug-in events for the SRC VTA.
    • Adapts internal SAE events to EJB-compatible methods.
    • Sends SAE tracking plug-in events to the SRC VTA.

    Use the following configuration statements to configure the SAE to send tracking events to the SRC VTA:

    shared sae configuration plug-ins name name ejb-adaptor {application-server-url application-server-url;jndi-sae-event-listener jndi-sae-event-listener; event-admitter event-admitter; socket-timeout socket-timeout; timeout timeout; use-primary-vta-if-available; attributes [attributes...];save-interim-events-in-failqueue save-interim-events-in-failqueue;}

    To configure the EJB adapter plug-in:

    1. From configuration mode, access the EJB adapter plug-in configuration. In this sample procedure, the EJB adapter plug-in called QuotaVTA is configured in the nw-area SAE group.
      user@host# edit shared sae group nw-area configuration plug-ins name QuotaVTA ejb-adapter
    2. Configure a list of all SRC VTAs to which SAE tracking events are sent.
      [edit shared sae group nw-area configuration plug-ins name QuotaVTA ejb-adapter] user@host# set application-server-url application-server-url

      Specify the application-server-url as a comma-separated list of SRC VTA IP addresses or hostnames. The prefix jnp:// and the suffix :1099 are allowed, but unnecessary. The default value is 127.0.0.1.

      Note: The setting of this option changes as of SRC software release 4.3.x. When upgrading from earlier releases of the SRC software to Release 4.3.x, it is mandatory that you configure this option. See the SRC Release Notes for Release 4.3 for the complete step-by-step upgrade procedure. It is very important that the upgrade procedure is followed exactly as described in the SRC Release Notes.

    3. Configure the JNDI name of the SAEEventListener EJB of the peer SRC VTA. Because multiple SRC VTA groups are supported, you must specify the SAEEventListenerBean for each SRC VTA group. Specify the SAEEventListenerBean in the following format:

      vta-VTA group name/SAEEventListenerBean

      For example, if you want a particular SAE to send events to a particular SRC VTA instance (group) called “apple”, set the jndi-sae-event-listener as follows:

      [edit shared sae group nw-area configuration plug-ins name QuotaVTA ejb-adapter] user@host# set jndi-sae-event-listener vta-apple/SAEEventListenerBean

      If you want a particular SAE to send some events to one SRC VTA instance (group) called “apple”, and some events (can be exactly the same events) to another SRC VTA instance called “orange”, configure two separate ejb-adapter plug-ins—one with the jndi-sae-event-listener set to “vta-apple/SAEEventListenerBean”, and the other with the jndi-sae-event-listener set to “vta-orange/SAEEventListenerBean.”

    4. (Optional) Configure the LDAP filter that determines the subscriber and service events that the EJB adapter plug-in sends to the SRC VTA. If you specify plug-in attributes in this field, you must include the same attributes in the attributes option.
      [edit shared sae group nw-area configuration plug-ins name QuotaVTA ejb-adapter] user@host# set event-admitter event-admitter

      Table 1 lists the values that you can use for LDAP filter strings.

      Table 1: Settings for Filter Strings

      Filter String

      Action

      ()

      Matches no objects

      (*)

      Matches all objects

      List of <attribute>= <value> pairs

      <attribute>—Name of a property or attribute <ldapAttributeName>

      <value>—One of the following:

      • * (asterisk)
      • Explicit string
      • String that contains an *

        Note: To define a special character (* & , ! | \ ) in a string, precede it with the backslash symbol (\).

      • If <value> is *, checks for any value.
      • If <value> is an explicit string, checks whether any value of the property matches the string, regardless of case.
      • If <value> is a string that contains a *, checks whether any value of the property contains the string, regardless of case.

      (&<filter><filter>...)

      True if all filters match

      (|<filter><filter>...)

      True if at least one filter matches

      (!<filter>)

      True if the filter does not match

      The variables in the filter include the names of plug-in attributes and a PluginEventType variable. The value of this variable is the name of the type of event, such as PE_START_SERVICE. For names of plug-in attributes and plug-in event types, see the SAE CORBA plug-in documentation on the Juniper Networks website at https://www.juniper.net/techpubs/software/management/src/api-index.html or in the SDK+AppSupport+Demos+Samples.tar.gz file on the Juniper website at https://www.juniper.net/support/products/src/index.html.

    5. (Optional) Specify the maximum number of milliseconds that the thread waits to read data from the socket connected to JNDI.
      [edit shared sae group nw-area configuration plug-ins name QuotaVTA ejb-adapter] user@host# set socket-timeout socket-timeout

      The default value is 0 ms, which means socket read operation is blocked.

    6. (Optional) Specify the maximum number of milliseconds that the thread waits to establish a connection to the EJB adapter plug-in through JNDI.
      [edit shared sae group nw-area configuration plug-ins name QuotaVTA ejb-adapter] user@host# set timeout timeout

      The default value is 3000 ms. If the value is set to 0, the thread waits until the client connector timeout is reached.

      Note: Even though the socket-timeout and timeout options are configured, the actual timeouts may happen after some period of time depending on the operating system timeout configurations. Configuring the socket-timeout and timeout options prevents the waiting situation on the SAE end and assures that the connection attempts to the application server will never get blocked.

    7. (Optional) Configure the plug-in attributes that the EJB adapter plug-in sends to the SRC VTA listener. If you do not define a list of attributes, the EJB adapter plug-in sends all plug-in attributes to the SRC VTA. Sending unnecessary plug-in attributes can adversely affect the performance of SRC components.
      [edit shared sae group nw-area configuration plug-ins name QuotaVTA ejb-adapter] user@host# set attributes [(host | router-name | interface-name | ...)...]

      Specify at least the following plug-in attributes: router-name, session-id, login-name, user-ip-address, ssp-host, domain, service-name, event-time, session-time, in-octets, out-octets, in-packets, out-packets, session-timeout, downstream-bandwidth, upstream-bandwidth, service-session-name, and subscription-name. You may need to add attributes if you use them for the event admitter.

    8. Configure how you want the SAE to send events to the SRC VTAs. Events can be sent using either the round-robin algorithm or the primary/backup algorithm.
      [edit shared sae group nw-area configuration plug-ins name QuotaVTA ejb-adapter] user@host# set use-primary-vta-if-available

      By default, the SAE communicates with the SRC VTAs by using the round-robin algorithm. To use the primary/backup algorithm for SAE-VTA communication, enable the use-primary-vta-if-available option.

    9. (Optional) Configure the attributes that stores the service interim events in SAE fail queue. Even though it requires more disk resources, the loss of interim events usage data during the VTA maintenance window is prevented by saving the interim events in fail queue.
      [edit shared sae group nw-area configuration plug-ins name QuotaVTA ejb-adapter] user@host# set save-interim-events-in-failqueue

      By default, the service interim events are not stored in SAE fail queue.

    Modified: 2016-05-19