Extending Service Implementations with Script Services
You use services to provision policies on a number of systems across a network, including networks that do not contain a JUNOSe router or JUNOS routing platform. Script services provide an interface to call scripts that supply custom services. You can use script services to create custom service implementations, such as:
- Provisioning layer 2 devices, such as digital subscriber line access multiplexers (DSLAMs).
- Setting up network connections, such as MPLS tunnels.
- Provisioning policies for network devices that do not have a supported SAE device driver.
- Accessing functionality not currently supported by SAE device drivers but supported by other interfaces, such as RADIUS change of authorization (CoA) on JUNOSe routers and JunoScript provisioning on JUNOS routing platforms.
Perform the following to customize service implementations:
Writing Scripts for Script Services
The ScriptService service provider interface (SPI) provides a Java interface that a script service implements. For information about the ScriptService interface and the ServiceSessionInfo interface, see the script service documentation in the SRC software distribution in the folder SDK/doc/sae or in the SAE core API documentation on the Juniper Networks Web site at
http://www.juniper.net/techpubs/software/management/sdx/api-index.html
The implementation of the ScriptService interface activates the service. The SAE sends authentication and tracking events when it activates, modifies, or deactivates a script service session.
The SAE supports script services written in Java or Jython. For scripts written in Java, you must compile and package the implemented ScriptService to make it available for use by the SAE. A Java implementation can include more than one Java archive (JAR) file.
The SAE synchronizes methods used by the same instance of the ScriptService class. You do not need to provide synchronized implementation of the methods.
To write a script to be used by a script service:
- Create a class that provides a default constructor and that implements the ScriptService interface.
- Manage activation and manipulation of the service session by implementing the following ScriptService methods:
- activateSession()—Activates the script service session.
- deactivateSession()—Deactivates the script service session and returns any final accounting data for the script service session.
- modifySession()—If the counters were reset during the modification, modifies the script service session and returns any accounting data.
These methods are implemented by the script service. They perform the associated action (activate, deactivate, modify) when the SAE calls the method.
- (Optional) Get information about service sessions by using methods on the ServiceSessionInfo interface.
- (Optional) Provide accounting data, if used, by using the following ScriptService method:
getAccountingData()—Polls for current accounting data and returns any current accounting data.
getState()—Returns session data to be stored persistently on the router. The SAE does not use this data but provides it to the script when a service session is restored after failover.
- initState() —Initializes a recovered script service session after a state synchronization.
- discarded()—Provides notification that the service session has been discarded. Service sessions are discarded when the SAE loses connection to a router. A discarded service session continues to exist on the router and is restored after the connection to the router is reestablished by an SAE.
The script service session releases any resources associated with a discarded session, but must not take any action to disrupt the service session.
You can also use the stopService() method on the ServiceSessionInfo object to stop a service and remove the service from the SAE. For example, consider a script service that monitors a state that it creates outside the SAE. If the script detects that the service is not active, it can stop the service and remove it from the SAE. You could use this type of script service to start a daemon process and monitor the process to make sure that it is alive.
NOTE: The ScriptService SPI does not provide access to a router driver.
Example: Using the ScriptService SPI in Jython
The following example implements the ScriptService SPI in Jython.
class SampleService(ScriptService):def initSessionInfo(self, ssi):self.ssi = ssidef activateSession(self):print "Activating ServiceName %s" % ssi.serviceNamedef deactivateSession(self):print "Deactivating ServiceName %s" % ssi.serviceNamereturn Nonedef modifySession(self, ssi):self.ssi = ssiprint "Modifying ServiceName %s" % ssi.serviceNamereturn Nonedef getAccountingData(self):print "Getting accounting data for ServiceName %s" % ssi.serviceNamereturn Nonedef getState(self):return Nonedef initState(self, ssi, state):self.ssi = ssipassdef discarded(self):passExample: Using the ScriptService SPI in Java
The following example implements the ScriptService SPI in Java.
class SampleService implements ScriptService {private ServiceSessionInfo ssi;public SampleService() { }public void initSessionInfo(ServiceSessionInfo ssi) {this.ssi = ssi;}public void activateSession() {System.out.println("Activating ServiceName "+ssi.getServiceName());}public AccountingData deactivateSession() {System.out.println("Deactivating ServiceName "+ssi.getServiceName());return null;}public AccountingData modifySessionSession(ServiceSessionInfo ssi) {this.ssi = ssi;System.out.println("Modifying ServiceName "+ssi.getServiceName());return null;}public AccountingData getAccountingData() {System.out.println("Getting accounting data for ServiceName "+ssi.getServiceName());return null;}public byte[] getState() {return null;}public initState(ServiceSessionInfo ssi, byte[] state) {this.ssi = ssi;}public void discarded() {}}Configuring Script Services
Before you configure a script service, make sure that you know the location of the script file that the service will reference.
Use the following configuration statements to configure a script service in the global service scope:
services global servicename
script {script-type (url | python | java-class | java-archive); class-nameclass-name
; filefile
;}Use the following configuration statements to configure a script service in a service scope:
services scopename
servicename
script {script-type (url | python | java-class | java-archive); class-nameclass-name
; filefile
;}To configure a script service:
- Configure a normal service, but set the service type to
script
. See Adding a Normal Service.- From configuration mode, enter the service script configuration. In this sample procedure, the service called scriptService is configured in the scope configuration.
user@host#edit services scope script service scriptService script
- Configure the type of script that the script service uses.
[edit services scope script service scriptService script]user@host#set script-type
(url | python | java-class | java-archive)- For Java class and Python script services, configure the name of the class that implements the script service.
[edit services scope script service scriptService script]user@host#set class-name
class-name
- Configure the URL of the script service or the path and filename of the service.
[edit services scope script service scriptService script]user@host#set file
file
- (Optional) Verify your configuration.
[edit services scope script service scriptService script]user@host#show
script-type java-class;class-name net.juniper.smgt.script.service;file://opt/UMC/sae/var/scriptservice/script-service.jar;