SDX 6.4.x Network Guide > Reviewing the NIC Configuration > XML Agents

XML Agents

An XML agent retrieves information from a specified XML document and makes information available to NIC based on specified tags in the file. An XML agent provides information about one type of data or mappings.

Although an XML agent may be used by an SDX application, typically you do not need to configure it. If you want to use an XML agent with a configuration scenario, contact Juniper Networks Professional Services.

Configuring XML Agents

To use SDX Configuration Editor to configure XML agents:

1. In the navigation pane, select a NIC configuration file.
2. Select the Agents tab, and expand the XML Agent section.
3. Modify the entries in the fields.

See XML Agent Fields.

XML Agent Fields

In SDX Configuration Editor, you can modify the following fields in the XML Agent section of the Agents pane in a NIC configuration file.

Resolvers List

• Names of NIC resolvers to which this agent sends events.
• Value—List of paths to NIC resolvers; paths are relative to the Static Configuration object and are separated by commas
• Default—No value
• Example— /realms/staticRouteIp/C1
• Property name—pushToServer

Roles List

• Names of NIC roles.
• Value—List of roles, separated by commas, in the format <realmName>:<roleName>

• <realmName>—Name of realm
• <roleName>—Name of role

• Default—No value
• Property name—pushToRole

Data Source

• URI of the XML document that provides information about NIC events to the NIC system.
• Value—<URI>
• Guidelines—You must provide a URI for the XML document.
• Default—No value
• Property name—dataSource

Search Base

• Root XML element in the specified XML document at which the agent starts to search the XML document.
• Value—<XML element>
• If you do not specify an element for the search base, the agent starts searching at the top of the file.
• Default—No value
• Property name—base

Search Filter

• Search filter the agent uses to parse an XML document.
• Value—Search filter syntax defined in RFC 2254—The String Representation of LDAP Search Filters (December 1997)
• Default—No value

Search Scope

• Level at which the agent searches the XML document.
• Value

• Object—Searches the object defined by the search base entry.
• One level—Specifies objects at the same level as the object defined by the search base entry.
• Subtree—Searches objects subordinate to object defined by the search base entry.

• Default—No value

Element Types

• Types of XML elements that the agent will use.
• Value—List of XML elements, separated by commas.
• Guidelines—Elements in this list must contain the attributes that the agent makes available.
• Default—No value
• Property name—elementTypes

Key Attribute Name(s)

• Name of the directory attribute that the NIC agent uses for the network data object called key.
• Value—Name of an attribute in the directory
• Default—No value
• Example—virtualRouterName
• Property name—key.attrNames

Key Attribute Processor

• Java class that the NIC agent uses to generate the data key object.
• Value—Path to Java class
• Default—No value
• Example—net.juniper.smgt.gateway.nic.agent.dir.DnAttributeProcessor
• Property name—key.processor.classname

Value Attribute Name(s)

• Directory attribute that the NIC agent uses for the network data object called value.
• Value—Name of an attribute in the directory
• Guidelines—Specify only if the agent publishes mappings.
• Default—No value
• Example—SaeId
• Property name—value.attrNames

Value Attribute Processor

• Name of the Java class that the agent uses to generate the data value object.
• Value—Path to Java class
• Default—No value
• Property name—value.processor.classname

Network Data Types

• Attribute names for data that the agent collects in the format <key>, <value>
• Value

• <key>—Attribute name for the data key
• <value>—Attribute name for the data value

• Default—No value
• Example—Dn, Vr
• Property name—networkDataTypes

Publishing Interval

• Interval at which the NIC agent sends updates to the NIC resolvers.
• Value—Number of seconds in the range 0-2147483647
• Default—60
• Property name—publishingInterval

Event Life Expectancy

• Length of time that data is valid after the NIC proxy receives data associated with events published by this agent.
• Value—Number of seconds in the range 0-4294967295

• 0—Data does not expire
• Other values—Actual life expectancy of data

• Default—0
• Property name—eventLifeExpectancy

Enable Eventing

• Specifies whether or not the agent monitors changes to the XML document and sends events when changes occur.
• Value

• Yes—Agent sends events.
• No—Agent does not send events.

• Default—Yes
• Property name—enableEvents