Parameters for DPI Script Service

Table 10 lists the parameters specified by the DPI script service, which is implemented by the /SDK/scriptServices/dpiScriptService/lib/dpiss.jar file found in the SDK+AppSupport+Demos+Samples.tar.gz file. The value assigned to the parameter must be enclosed by quotation marks. For example, dpiConfig="resource/dpiConf.xml" specifies the pathname for the configuration file.

Table 10: Parameter Substitutions for DPI Services

Parameter Name

Description

dpiConfig

Configuration file in the format of a URL or pathname. The script service handles each format as follows:

  • URL—String that starts with http:. The script service uses the value to download the configuration file.
  • pathname—String that does not start with http:. The script service uses the value as a path to a resource in the .jar file that contains the script service.

    We recommend using a pathname in a production environment.

If you do not supply a value, the default value is "resource/dpiConf.xml".

dpiConfigDebug

Reloads the configuration file specified by dpiConfig for each script service activation. Specify "on" to perform the reload. The default value is "off", where the script service uses the configuration file that is accessed for the first service activation until the SAE is restarted.

dpiAdminState

Used by the application to activate the service. By default, the value is set to "enabled". Set the value to "disabled" to deactivate the service.

Note: If you set the value to disabled, the service session continues to exist because the service is not deactivated. This behavior allows the application to monitor the operational state of the service so that the application knows when a configuration change has committed.

dpiOprState

Used by the application to determine the operational state of the service.

When you activate, deactivate, or change the parameters of the DPI script service, the operational state is set to commit pending. Once the commit succeeds, the operational state changes to committed.

Note: The dpiOprState parameter is reserved for the use of the DPI script service. Another application, such as an enterprise Web application, cannot use this parameter.

dpiMaintMode

Prevents the script service from making configuration changes. You can set this parameter in a service scope attached to a specific router so that it affects only that router. If you set this parameter in the service, the whole network is put in maintenance mode.

Specify "off" (the default value) to turn off maintenance mode.

You can specify "on" to allow the script service to continue recording configuration changes and to maintain the corresponding service sessions in the commit pending state until maintenance mode is set to "off".

dpiRules

Defines application rules as a list of map expressions that the policy template can use to bind variables in the policy template to values in this list. See the <for-each-rule> element in the configuration file.

The keys in the map expression must be valid identifiers for substitutions. For example, four or fewer hexadecimal digits are interpreted as parts of IPv6 addresses and cannot be used as identifiers.

If you do not supply a value, the default value is an empty list.

dpiInterfaceClasses

Specifies the policy templates that should be applied to the interface. See the <target> element in the configuration file.

This parameter lets you group your interfaces into classes so that you can specify for each interface which targets should be applied when the DPI script service is triggered. For example, you might have some interfaces with services provided entirely by an MX Series router and some interfaces that have a customer premises router. In your DPI script service configuration, you can have one target to configure the MX Series router with Junos XML management protocol commands and another target to configure the CPE router with Telnet commands.

The interface is normally specified as a list of strings in the subscriber hierarchy to define the interfaces affected by the service activation. If you do not supply a value, the default value is an empty list.

Related Documentation