SAE Plug-In Agents
SAE plug-in agents collect information about the subscribers and interfaces managed by an SAE. For example, an SAE plug-in agent can collect and make available mappings of subscribers' IP addresses to the VRs from which those subscribers connect to the network. An SAE plug-in agent can also obtain information about the managed interfaces on a router.
We recommend that you have state synchronization enabled for SAE plug-in agents and that you use NIC replication to maintain high availability for the NIC. SAE plug-in agents always have information that is current unless the agent is overloaded and has not processed some of the SAE events; then the unprocessed events are placed in a queue.
You do not need to configure redundancy for the SAE plug-in agent as in past releases. If you have an SAE plug-in agent that uses agent redundancy, we recommend that you enable state synchronization for the agent and use NIC replication.
Each SAE plug-in agent is composed of two parts: one part that publishes NIC events and another part that collects SAE events. You can use multiple SAE plug-in agents supported on a single host to share the part that collects events. In this case, the SAE regards the agents as one plug-in, although the NIC still regards the agents as separate entities. Figure 11 illustrates this concept.
For more information about SAE plug-ins, see SDX Subscribers and Subscriptions Guide, Chapter 6, How to Configure SAE Plug-Ins.
Reviewing the Configuration of SAE Plug-In Agents
To use SDX Configuration Editor to review the configuration for NIC SAE plug-in agents:
- In the navigation pane, select a NIC configuration file.
- Click the Agents tab, and expand the SAE Plug-In Agent section.
- Review the entries in the fields.
SAE Plug-In Agent Fields
In SDX Configuration Editor, you can modify the following fields in the SAE Plug-In Agent section of the Agents pane in a NIC configuration file.
Resolvers List
- Names of NIC resolvers to which this agent sends events.
- Value—Comma-separated list of paths to NIC resolvers relative to the Static Configuration object.
- Default—No value
- Example—/realms/assignedIp/C1
- Property name—pushToServer
Plug-in Event Type
- User—Agent supports user-tracking plug-in events.
- Interface—Agent supports interface-tracking plug-in events.
Key Attribute Name(s)
- List of plug-in attributes that provide information for the data key.
- Value—List of comma-separated plug-in attributes
- Guidelines—The list can contain one or more plug-in attributes.
If the format of the single plug-in attribute is not a string or you specify multiple plug-in attributes, the agent passes the data to the key processor to construct the data value in string format. In this case, you must specify the processor in the Key Attribute Processor field.
Key Attribute Processor
- Name of the Java class that the agent uses to generate the data key object.
- Value—Path to Java class
- Guidelines—Configure a key attribute processor if the agent acquires for the key value either a single plug-in attribute that is not in string format or multiple plug-in attributes.
- Default—No value
- Example—net.juniper.smgt.gateway.nic.agent.saeplugin.InterfaceIdProcessor
- Property name—key.processor.classname
Value Attribute Name(s)
- List of plug-in attributes that provide information for the data value.
- Value—List of comma-separated plug-in attributes
- Guidelines—The list can contain one or more plug-in attributes.
If the format of the single plug-in attribute is not a string or you specify multiple plug-in attributes, the agent passes the data to the value processor to construct the data value in string format. In this case, you must specify the processor in the Value Attribute Processor field.
Value Attribute Processor
- Name of the Java class that the agent uses to generate the data value object.
- Value—Path to Java class
- Guidelines—Configure a value attribute processor if the agent acquires for the data value either a single plug-in attribute that is not in string format or multiple plug-in attributes.
- Default—No value
- Example—net.juniper.smgt.gateway.nic.agent.saeplugin.InterfaceProcessor
- Property name—value.processor.classname
Naming Context
- CORBA naming context in which the agent publishes references.
- Value—String that must match the context name in the objectref property for this SAE plug-in
See Chapter 10, NIC Resolution Process.
- Guidelines—If you configure event sharing for multiple SAE plug-in agents, this setting must be identical for all those agents.
- Default—No value
- Example—nicsaetestDNOttawa
This example matches the context name of the following objectref property: corbaname::10.10.10.10:900/NameService#nicsaetestDNOttawa/saePort
- 10.10.10.10—Address of the machine running the CORBA naming server
- 900—TCP/IP port
- saePort—Name of plug-in (in this case, the agent eventing system)
Event Filter
- LDAP filter that restricts the events that the agent collects.
- Value—<pluginAttribute>=<attributeValue>
Share the Event System
- Specifies whether or not the agent shares the event system with other agents in the same host.
- Value
- Guidelines—If you configure event sharing for multiple SAE plug-in agents, this setting must be identical for all those agents.
- Default—No value
- Property name—eventSharingEnabled
Enable State Synchronization
- Specifies whether or not the state of the agent can be synchronized from the SAE. With state synchronization enabled, the state of the agent can be synchronized at any time.
- Value—Yes or No
- Guidelines—When you enable state synchronization, the agent uses NIC host redundancy.
- Default—No value
- Property name—stateSyncEnabled
Number of Events Sent in a Synchronization Call
- Number of events the SAE sends to the agent at one time during state synchronization.
- Value—Integer in the range 1—2147483647
- Guidelines—This value is used if Enable State Synchronization is set to Yes.
- Default—50
- Property name—stateSyncBulkSize
Event Database Filename
- File in which the agent stores event information.
- Value—Path, relative to the directory that contains the NIC software, to the file
- Guidelines—If you configure event sharing for multiple SAE plug-in agents, this setting must be identical for all those agents.
- Default—No value
- Example—var/evdbDNMontral
- Property name—eventDbFilename