Juniper Extension Toolkit Getting Started Guide

Transcription

1 Juniper Extension Toolkit Getting Started Guide Modified:

2 Juniper Networks, Inc Innovation Way Sunnyvale, California USA All rights reserved. Juniper Networks, Junos, Steel-Belted Radius, NetScreen, and ScreenOS are registered trademarks of Juniper Networks, Inc. in the United States and other countries. The Juniper Networks Logo, the Junos logo, and JunosE are trademarks of Juniper Networks, Inc. All other trademarks, service marks, registered trademarks, or registered service marks are the property of their respective owners. Juniper Networks assumes no responsibility for any inaccuracies in this document. Juniper Networks reserves the right to change, modify, transfer, or otherwise revise this publication without notice. Juniper Extension Toolkit Getting Started Guide All rights reserved. The information in this document is current as of the date on the title page. YEAR 2000 NOTICE Juniper Networks hardware and software products are Year 2000 compliant. Junos OS has no known time-related limitations through the year However, the NTP application is known to have some difficulty in the year END USER LICENSE AGREEMENT The Juniper Networks product that is the subject of this technical documentation consists of (or is intended for use with) Juniper Networks software. Use of such software is subject to the terms and conditions of the End User License Agreement ( EULA ) posted at By downloading, installing or using such software, you agree to the terms and conditions of that EULA. ii

3 Table of Contents About the Documentation vii Documentation and Release Notes vii Supported Platforms vii Documentation Conventions vii Documentation Feedback ix Requesting Technical Support x Self-Help Online Tools and Resources x Opening a Case with JTAC x Chapter 1 Overview JET Getting Started Overview Chapter 2 How to Use the JET VM Setting Up the JET Virtual Machine Downloading the Packages You Need Downloading Vagrant Downloading VirtualBox Downloading the JET Files from the Juniper Networks Download Site Launching the JET VM Updating the Build Environment Stopping the JET VM Using the JET IDE to Create an Application Chapter 3 JET Application Examples JET Firewall Application JET Interfaces Application JET Management Application iii

4 Juniper Extension Toolkit Getting Started Guide iv

5 List of Tables About the Documentation vii Table 1: Notice Icons viii Table 2: Text and Syntax Conventions viii v

6 Juniper Extension Toolkit Getting Started Guide vi

7 About the Documentation Documentation and Release Notes Documentation and Release Notes on page vii Supported Platforms on page vii Documentation Conventions on page vii Documentation Feedback on page ix Requesting Technical Support on page x Supported Platforms To obtain the most current version of all Juniper Networks technical documentation, see the product documentation page on the Juniper Networks website at If the information in the latest release notes differs from the information in the documentation, follow the product Release Notes. Juniper Networks Books publishes books by Juniper Networks engineers and subject matter experts. These books go beyond the technical documentation to explore the nuances of network architecture, deployment, and administration. The current list can be viewed at For the features described in this document, the following platforms are supported: MX104 MX2010 MX2020 MX240 MX480 MX80 MX960 Documentation Conventions Table 1 on page viii defines notice icons used in this guide. vii

8 Juniper Extension Toolkit Getting Started Guide Table 1: Notice Icons Icon Meaning Description Informational note Indicates important features or instructions. Caution Indicates a situation that might result in loss of data or hardware damage. Warning Alerts you to the risk of personal injury or death. Laser warning Alerts you to the risk of personal injury from a laser. Tip Indicates helpful information. Best practice Alerts you to a recommended use or implementation. Table 2: Text and Syntax Conventions Table 2 on page viii defines the text and syntax conventions used in this guide. Convention Description Examples Bold text like this Represents text that you type. To enter configuration mode, type the configure command: user@host> configure Fixed-width text like this Represents output that appears on the terminal screen. user@host> show chassis alarms No alarms currently active Italic text like this Introduces or emphasizes important new terms. Identifies guide names. Identifies RFC and Internet draft titles. A policy term is a named structure that defines match conditions and actions. Junos OS CLI User Guide RFC 1997, BGP Communities Attribute Italic text like this Represents variables (options for which you substitute a value) in commands or configuration statements. Configure the machine s domain name: [edit] root@# set system domain-name domain-name viii

9 About the Documentation Table 2: Text and Syntax Conventions (continued) Convention Description Examples Text like this Represents names of configuration statements, commands, files, and directories; configuration hierarchy levels; or labels on routing platform components. To configure a stub area, include the stub statement at the [edit protocols ospf area area-id] hierarchy level. The console port is labeled CONSOLE. < > (angle brackets) Encloses optional keywords or variables. stub <default-metric metric>; (pipe symbol) Indicates a choice between the mutually exclusive keywords or variables on either side of the symbol. The set of choices is often enclosed in parentheses for clarity. broadcast multicast (string1 string2 string3) # (pound sign) Indicates a comment specified on the same line as the configuration statement to which it applies. rsvp { # Required for dynamic MPLS only [ ] (square brackets) Encloses a variable for which you can substitute one or more values. community name members [ community-ids ] Indention and braces ( { } ) ; (semicolon) Identifies a level in the configuration hierarchy. Identifies a leaf statement at a configuration hierarchy level. [edit] routing-options { static { route default { nexthop address; retain; } } } GUI Conventions Bold text like this Represents graphical user interface (GUI) items you click or select. In the Logical Interfaces box, select All Interfaces. To cancel the configuration, click Cancel. > (bold right angle bracket) Separates levels in a hierarchy of menu selections. In the configuration editor hierarchy, select Protocols>Ospf. Documentation Feedback We encourage you to provide feedback, comments, and suggestions so that we can improve the documentation. You can provide feedback by using either of the following methods: Online feedback rating system On any page of the Juniper Networks TechLibrary site at simply click the stars to rate the content, and use the pop-up form to provide us with information about your experience. Alternately, you can use the online feedback form at ix

10 Juniper Extension Toolkit Getting Started Guide Send your comments to Include the document or topic name, URL or page number, and software version (if applicable). Requesting Technical Support Technical product support is available through the Juniper Networks Technical Assistance Center (JTAC). If you are a customer with an active J-Care or Partner Support Service support contract, or are covered under warranty, and need post-sales technical support, you can access our tools and resources online or open a case with JTAC. JTAC policies For a complete understanding of our JTAC procedures and policies, review the JTAC User Guide located at Product warranties For product warranty information, visit JTAC hours of operation The JTAC centers have resources available 24 hours a day, 7 days a week, 365 days a year. Self-Help Online Tools and Resources For quick and easy problem resolution, Juniper Networks has designed an online self-service portal called the Customer Support Center (CSC) that provides you with the following features: Find CSC offerings: Search for known bugs: Find product documentation: Find solutions and answer questions using our Knowledge Base: Download the latest versions of software and review release notes: Search technical bulletins for relevant hardware and software notifications: Join and participate in the Juniper Networks Community Forum: Open a case online in the CSC Case Management tool: To verify service entitlement by product serial number, use our Serial Number Entitlement (SNE) Tool: Opening a Case with JTAC You can open a case with JTAC on the Web or by telephone. Use the Case Management tool in the CSC at Call JTAC ( toll-free in the USA, Canada, and Mexico). x

11 About the Documentation For international or direct-dial options in countries without toll-free numbers, see xi

12 Juniper Extension Toolkit Getting Started Guide xii

13 CHAPTER 1 Overview JET Getting Started Overview JET Getting Started Overview on page 13 Juniper Extension Toolkit (JET) enables you to develop applications that run on any device running Junos OS and use Service APIs to interact with that device. Built-in Python support allows you to run the applications on the device. Because JET is based on the Interface Definition Language (IDL), you can also use other languages to write applications that you can run both on and off the device. The JET documentation set includes four guides: The Juniper Extension Toolkit Getting Started Guide offers a tutorial on building a JET application in Python and includes several example applications. The Juniper Extension Toolkit Developer Guide takes you through the developer workflow from installation of the JET packages to debugging of applications. For an overview of the JET product, see this guide. The Juniper Extension Toolkit API Guide includes overviews of the provided APIs and contains links to these APIs. The Juniper Extension Toolkit Applications Guide explains deploying applications on a device running Junos OS and how to configure the device to run a JET application. For a link to this guide and any of the others, see Juniper Extension Toolkit (JET). Related Documentation Setting Up the JET Virtual Machine on page 15 Using the JET IDE to Create an Application on page 18 JET Firewall Application on page 21 JET Interfaces Application on page 24 13

14 Juniper Extension Toolkit Getting Started Guide 14

15 CHAPTER 2 How to Use the JET VM Setting Up the JET Virtual Machine Setting Up the JET Virtual Machine on page 15 Using the JET IDE to Create an Application on page 18 Download the following packages from Juniper Networks download site to setup the JET VM: Vagrant zip file JET bundle containing a backing sandbox and toolchain JET client IDL library To be ready to use the JET VM and integrated development environment (IDE) to create applications, complete the following tasks: Downloading the Packages You Need on page 15 Launching the JET VM on page 16 Updating the Build Environment on page 17 Stopping the JET VM on page 17 Downloading the Packages You Need Installing the JET VM on your development machine provides a complete development environment with tools for building and packaging applications. It also provides the eclipse IDE. Download and install the following packages: Downloading Vagrant on page 15 Downloading VirtualBox on page 16 Downloading the JET Files from the Juniper Networks Download Site on page 16 Downloading Vagrant Vagrant ( is a software that creates and configures virtual development environments. You can think of it as a higher-level wrapper around 15

16 Juniper Extension Toolkit Getting Started Guide virtualization software such as VirtualBox ( You can use Vagrant to manage the JET development virtual machine (VM). To download Vagrant: Go to and download Vagrant for your system s platform (Windows, Mac, or Linux). Downloading VirtualBox NOTE: For the JET VM, Juniper Networks supports only the VirtualBox hypervisor. To download and install VirtualBox: 1. Go to 2. Download and install the VirtualBox package for your platform and the VirtualBox extension package. 3. Enable hardware virtualization support on your machine BIOS if it is not already enabled. Downloading the JET Files from the Juniper Networks Download Site The JET VM is downloaded from the Juniper Networks download website at in the form of following packages: JET sandbox and toolchain file JET client IDL library JET-vagrant.zip file Launching the JET VM To launch the JET VM: 1. Create a jet-vagrant directory and extract the JET-vagrant.zip file you downloaded from the Juniper Networks download site to that directory. 2. Change to the jet-vagrant directory where you have extracted the JET-vagrant.zip file. 3. Issue the vagrant up command. If needed, use the following default login credentials: username: vagrant password: vagrant 16

17 Chapter 2: How to Use the JET VM Wait for the Ubuntu desktop screen to come up in Oracle VM VirtualBox. You will see the Eclipse icon. This is the icon you use for the JET IDE. 4. Double-click the Eclipse icon to start the JET IDE. Next, before starting to use the JET IDE, you must install the JET bundle containing backing sandbox and toolchain and the JET client IDL library. Updating the Build Environment To update the build environment: 1. Start the JET IDE. See the procedure Launching the JET VM on page 16 for details. 2. Change the perspective by selecting Juniper Extension Toolkit from the Window > Open perspective -> Other menu. 3. Once the perspective is change, select Juniper Extension Toolkit > Update build environment. 4. Point the input fields to downloaded JET bundle and client library and install them. Stopping the JET VM When you are done using the VM, stop and exit Vagrant. To stop and exit Vagrant and the IDE: 1. Go to the command-line prompt for your system. 2. In the jet-vagrant directory, issue the vagrant halt command. Related Documentation JET Getting Started Overview on page 13 Using the JET IDE to Create an Application on page 18 JET Firewall Application on page 21 JET Interfaces Application on page 24 17

18 Juniper Extension Toolkit Getting Started Guide Using the JET IDE to Create an Application This tutorial leads you through building a Juniper Extension Toolkit (JET) application that has no dependency on C or C++ modules. Its purpose is to familiarize you with the virtual machine (VM) and integrated development environment (IDE). This example walks you through where to put your files in the directory structure and how to configure the application on the router. Before you start writing code, you need to download the JET VM. For detailed procedures, see Setting Up the JET Virtual Machine in the Juniper Extension Toolkit Developer Guide. Normally, you need to install your certificate files before you develop applications. Since this example covers building an unsigned application, it skips the installation of the certificate files. To create a simple Python application: 1. Start the JET VM by using the vagrant up command. 2. In the VM, double-click the eclipse icon to open the JET IDE. 3. Select Juniper Extension Toolkit > Jet Project from the menu bar. 4. Name the project, select None from the Applications List, and click Finish. You will be able to see the sandbox directory in the left pane. 5. Create your Python application file. a. Select the python directory in the left pane, right-click to create new folder, and give this folder the name of your project. b. Select the new folder, right-click to create a new file, and name the file, for example, hello.py. 6. Select to accept the default preferences for PyDev. 7. Type a simple Python program such as the following and save: print hello world You can save in one of the following ways: select File > Save, press Ctrl+s, or click the diskette icon. 18

19 Chapter 2: How to Use the JET VM 8. Create the JSON file. The JSON file is created in a directory relative to the sandbox s src directory. a. Select the src directory in the left pane, right-click to create a file, and name it, for example, hello.json. If you do not see the JSON form, select the new.json file in the left pane and right-click to select Open with JSON Editor. b. Fill in the JSON form and do one of the following to save: select File > Save, press Ctrl+s, or click the diskette icon. 9. Select the project name in the left pane, and select Juniper Extension Toolkit > Run JET Configuration from the menu bar. 10. Deploy the application on a Junos OS device. Related Documentation JET Getting Started Overview on page 13 Setting Up the JET Virtual Machine on page 15 JET Firewall Application on page 21 JET Interfaces Application on page 24 19

20 Juniper Extension Toolkit Getting Started Guide 20

21 CHAPTER 3 JET Application Examples JET Firewall Application JET Firewall Application on page 21 JET Interfaces Application on page 24 JET Management Application on page 26 SampleFirewallApp.py illustrates the following functions of the firewall IDL: 1. Creates a firewall filter 2. Binds the filter to an interface 3. Unbinds the filter from an interface 4. Deletes the firewall filter The application uses the device IP and the interface on which the firewall filter has to be bound as the inputs. The application must be configured as shown in the example using: set system extensions extension-service application file samplefirewallapp.py arguments "-d ifl ge-0/0/0" Where is the IP of the device and ge-0/0/0 is the interface where the filter is created. import sys,time,os,argparse from grpc.beta import implementations import firewall_service_pb2,jnx_addr_pb2,authentication_service_pb2 from firewall_service_pb2 import * from jnx_addr_pb2 import * from authentication_service_pb2 import * from grpc.framework.interfaces.face.face import * parser = argparse.argumentparser() parser.add_argument('-d','--device', help='input host name',required=true) parser.add_argument('-ifl','--iflname', help='input interface name',required=true) args = parser.parse_args() device1 = args.device APP_USER = 'foo' APP_PASSWORD = 'bar' 21

22 Juniper Extension Toolkit Getting Started Guide port = client_id = '101' def pause(): programpause = raw_input("enter to continue...") print "Executing Python app" try: # Open the grpc channel channel = implementations.insecure_channel(host=device1, port=port) stub = authentication_service_pb2.beta_create_login_stub(channel) # Login with the credentials to authenticate the app to perform operations. login_response = stub.logincheck( authentication_service_pb2.loginrequest(user_name=app_user, password=app_password, client_id=client_id), 100) if (login_response.result == 1): print "Login to ", device1, "successful" else: print "Login to ", device1, "failed" raise SystemExit() fw = firewall_service_pb2.beta_create_aclservice_stub(channel) pause() flag = 0 res=[] # Configure the firewall filter. In this app source IP address is configured as and Destination IP address as with ACCEPT action IP1=IpAddress(addr_string=' ') IP2=IpAddress(addr_string=' ') matchip1=aclmatchipaddress(addr=ip1,prefix_len=32,match_op=acl_match_op_equal) matchip2=aclmatchipaddress(addr=ip2,prefix_len=32,match_op=acl_match_op_equal) term1match1=aclentrymatchinet(match_dst_addrs=[matchip2],match_src_addrs=[matchip1]) t=aclentryinetterminatingaction(action_accept = 1) nt=aclentryinetnonterminatingaction(action_count = AclActionCounter(counter_name="Match1"),action_syslog=1,action_log=1,action_sample=1) term1action1 = AclEntryInetAction(action_t=t, actions_nt=nt) adj=acladjacency(type=acl_adjacency_after) term1=aclinetentry(ace_name="t1",ace_op=acl_entry_operation_add,adjacency=adj,matches=term1match1,actions=term1action1) tlist1=aclentry(inet_entry=term1) filter=accesslist(acl_name = "f1",acl_type = ACL_TYPE_CLASSIC, acl_family = ACL_FAMILY_INET, acl_flag = ACL_FLAGS_NONE, ace_list=[tlist1]) 22

23 Chapter 3: JET Application Examples print filter # Call the api to create the firewall filter result = fw.accesslistadd(filter,10) print 'Invoking fw.accesslistadd \nreturn = ', result if result.status is ACL_STATUS_EOK : print "AccessListAdd RPC Passed" res.append("accesslistadd RPC Passed and returned %s" % (result)) else: print "AccessListAdd RPC Failed" res.append("accesslistadd RPC Failed and returned %s" % (result)) flag += 1 pause() # Configure filter to attach on 0th IFL in INPUT direction bind=accesslistobjbind(acl=filter,obj_type=acl_bind_obj_type_interface,bind_object=args.iflname + '.0',bind_direction=ACL_BIND_DIRECTION_INPUT,bind_family=ACL_FAMILY_INET) print bind # Call the API to bind the interface to a filter bindaddresult=fw.accesslistbindadd(bind,10) print 'Invoking fw.accesslistbindadd \nreturn = ', bindaddresult if bindaddresult.status is ACL_STATUS_EOK : print "AccessListBindAdd RPC Passed" res.append("accesslistbindadd RPC Passed and returned %s" % (bindaddresult)) else: print "AccessListBindAdd RPC Failed" res.append("accesslistbindadd RPC Failed and returned %s" % (bindaddresult)) flag += 1 pause() # Call the API to unbind the filter from the interface binddelresult = fw.accesslistbinddelete(bind,10) print 'Invoking fw.accesslistbinddelete \nreturn = ', binddelresult if binddelresult.status is ACL_STATUS_EOK : print "AccessListBindDelete RPC Passed" res.append("accesslistbinddelete RPC Passed and returned %s" % (binddelresult)) else: print "AccessListBindDelete RPC Failed" res.append("accesslistbinddelete RPC Failed and returned %s" % (binddelresult)) flag += 1 pause() # Call the API to delete the firewall filter filter = AccessList(acl_name="f1",acl_family = ACL_FAMILY_INET) print filter acldelresult = fw.accesslistdelete(filter,10) print 'Invoking fw.accesslistdelete \nreturn = ', acldelresult if acldelresult.status is ACL_STATUS_EOK : print "AccessListDelete RPC Passed" res.append("accesslistdelete RPC Passed and returned %s" % 23

24 Juniper Extension Toolkit Getting Started Guide (acldelresult)) else: (acldelresult)) print "AccessListDelete RPC Failed" res.append("accesslistdelete RPC Failed and returned %s" % flag += 1 pause() print "FINAL RESULT : \n" for i in res: print i if flag > 0: print "TEST FAILED" else: print "TEST PASSED" except Exception as tx: print '%s' % (tx.message) while True: import signal os.kill(os.getpid(), signal.sigterm) Related Documentation JET Interfaces Application on page 24 JET Management Application on page 26 JET Interfaces Application sampleinterfaceapp.py illustrates the following functions of the JET interfaces: 1. Creates an IFL object 2. Deletes an IFL object 3. Creates an IFA object 4. Deletes an IFA object The application uses the device IP and IFA address as the inputs. The application must be configured as shown in the example using: set system extensions extension-service application file sampleinterfaceapp.py arguments "-addr host " Where is the IP of the device and is the IFA address to be created. #!/usr/bin/env python from grpc.beta import implementations from dcd_service_pb2 import * import authentication_service_pb2 import dcd_service_pb2 import argparse import sys,signal,os,jcs GRPC_PORT = CLIENT_ID = 'G1_1175' 24

25 Chapter 3: JET Application Examples USER = 'foo' PASSWORD = 'bar' TIMEOUT = 5 def connect_to_jsd(args): channel = implementations.insecure_channel(host=args.hostip, port=grpc_port) stub = authentication_service_pb2.beta_create_login_stub(channel) login_response = stub.logincheck(authentication_service_pb2.loginrequest(user_name=user,password=password, client_id=client_id), TIMEOUT) if login_response.result!= True: print "grpc Server Connection failed!!!" dcd = dcd_service_pb2.beta_create_interfacesservice_stub(channel) return dcd def exe_op_test(dcd,args): #InterfaceLogicalCreate # Create IFL object for interface ge-0/0/1 unit 0 unit = Value32(unit=0) config = InterfaceLogicalConfig(port_name = "ge-0/0/1",ifl_unit = unit,operation = 1) Result = dcd.interfacelogicalcreate(config,timeout) print 'Invoked DCD logical create API Status return = ', Result.status print 'Invoked DCD logical create API Error message return = ', Result.error_message #InterfaceLogicalDelete # Delete IFL object for interface ge-0/0/1 unit 0 unit = Value32(unit=0) config = InterfaceLogicalConfig(port_name = "ge-0/0/1",ifl_unit = unit,operation = 2) Result = dcd.interfacelogicaldelete(config,timeout) print 'Invoked DCD logical delete API Status return = ', Result.status print 'Invoked DCD logical delete API Error message return = ', Result.error_message #InterfaceAddressCreate # Create IFA object for interface ge-0/0/1 unit 0 family inet address add = IpAddress(addr_string=args.address) unit = Value32(unit=0) config = InterfaceAddressConfig( port_name = "ge-0/0/1", ifl_unit = unit, operation = 1, family = 2, interface_address = add) Result = dcd.interfaceaddresscreate(config,timeout) print 'Invoked DCD InterfaceAddressCreate API Status return = ', Result.status print 'Invoked DCD InterfaceAddressCreate API Error message return = ', Result.error_message #InterfaceAddressDelete # Delete IFA object for interface ge-0/0/1 unit 0 family inet address add = IpAddress(addr_string=args.address) unit = Value32(unit=0) config = InterfaceAddressConfig( port_name = "ge-0/0/1", ifl_unit = unit, operation = 2, family = 2, interface_address = add) 25

26 Juniper Extension Toolkit Getting Started Guide Result = dcd.interfaceaddressdelete(config,timeout) print 'Invoked DCD InterfaceAddressDelete API Status return = ', Result.status print 'Invoked DCD InterfaceAddressDelete API Error message return = ', Result.error_message return def Main(): parser = argparse.argumentparser(description='this is a demo script by nixcraft.') parser.add_argument('-addr','--address',help='input Addres name', required=false) parser.add_argument('-host','--hostip',help='input Attribute type`', required=false) args = parser.parse_args() try: dcd = connect_to_jsd(args) exe_op_test(dcd,args) print "In finally statement" #raw_input("<enter to Close Client Session>") except Exception as tx: print tx #sys.exit(3) finally: #print "In finally statement" os.kill(os.getpid(), signal.sigterm) return if name == ' main ': Main() Related Documentation JET Firewall Application on page 21 JET Management Application on page 26 JET Management Application samplemanagementapp.py performs the following operations for OpenConfig: 1. Executes GetDataEncodings RPC 2. Executes GetModels RPC 3. Executes Get RPC 4. Executes Set RPC samplemanagementapp.py performs the following operations for management services: 1. Executes ExecuteOpCommand RPC to get software information 2. Executes GetEphemeralConfig RPC 26

27 Chapter 3: JET Application Examples 3. Executes EditEphemeral RPC to add an interface 4. Executes EditEphemeral RPC to delete an interface To run the application, update the following in the example: JSD_IP = ' ' - With IP address of the device USERNAME = 'foo' PASSWORD = '' #!/usr/bin/env python # # # # """ Sample application for testing the Management services exposed by Junos in management_service.proto and openconfig_service.proto files. Usage: $python samplemanagementapp.py --user <username> --password <password> --address <Router IP Address> --port <JSD Port> """ import argparse import os import logging import sys # Import Python GRPC module from grpc.beta import implementations # Import python modules generated from proto files import mgd_service_pb2 import openconfig_service_pb2 import authentication_service_pb2 # IMPORTANT: Following are the dummy parameters that will be used for testing # Please change these parameters for proper testing # Device details and login credentials JSD_IP = ' ' JSD_PORT = USERNAME = 'foo' PASSWORD = '' CLIENT_ID = 'test_client' _TIMEOUT_SECONDS = 20 # Enable Logging to a file #logging.basicconfig(filename=default_log_file_name, level=default_log_level) # To display the messages from junos-jet-api package on the screen uncomment the below lines """ myloghandler = logging.getlogger() myloghandler.setlevel(logging.info) logchoice = logging.streamhandler(sys.stdout) logchoice.setlevel(logging.debug) 27

28 Juniper Extension Toolkit Getting Started Guide formatter = logging.formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s') logchoice.setformatter(formatter) myloghandler.addhandler(logchoice) """ def EstablishChannel(args): channel = implementations.insecure_channel(args.address, args.port) login_stub = authentication_service_pb2.beta_create_login_stub(channel) login_request = authentication_service_pb2.loginrequest(user_name=args.user, password=args.password, client_id=args.client_id) login_response = login_stub.logincheck(login_request, _TIMEOUT_SECONDS) return channel def SetRPCs(channel): # Example to configure under interface with json configuration stub = openconfig_service_pb2.beta_create_openconfigrpcapi_stub(channel) jsoncfgvalue = """ <configuration-json> { "configuration" : { "interfaces" : { "interface" : [ { "name" : "ge-1/1/2", "unit" : [ { "name" : "0", "description" : "foo" } ] } ] } } }</configuration-json> """ jsoncfgrequest = openconfig_service_pb2.setrequest.configoperationlist(operation_id = "jcfg", operation = 0, path = "/", value = jsoncfgvalue) request = openconfig_service_pb2.setrequest(request_id = 1000, encoding = 1, config_operation = [jsoncfgrequest]) response = stub.set(request, _TIMEOUT_SECONDS) print response # Example to delete confiuration under interface with json jsondelcfgvalue = """ <configuration-json> { "configuration" : { "interfaces" : { "interface" : [ { "name" : "ge-1/1/2", "@": { "operation": "delete" } } ] } } } </configuration-json> """ 28

29 Chapter 3: JET Application Examples jsondelcfgrequest = openconfig_service_pb2.setrequest.configoperationlist(operation_id = "jdcfg", operation = 0, path = "/", value = jsondelcfgvalue) request = openconfig_service_pb2.setrequest(request_id = 1000, encoding = 1, config_operation = [jsondelcfgrequest]) response = stub.set(request, _TIMEOUT_SECONDS) print response # Example to configure under interface with xml def ManagementTests(channel): # All Mangement and Openconfig RPCs will be tested here. The function will # make use of the channel that is passed to it to execute the RPCs # Create a stub for Openconfig RPCs metadata = [(b'user', b'foo'), (b'password', b'bar')] stub = openconfig_service_pb2.beta_create_openconfigrpcapi_stub(channel) # Execute GetDataEncodings RPC getencodingsrequest = openconfig_service_pb2.getdataencodingsrequest(request_id = 1000) response = stub.getdataencodings(getencodingsrequest, _TIMEOUT_SECONDS, metadata=metadata) print response # Execute GetModels RPC getmodelsrequest = openconfig_service_pb2.getmodelsrequest(request_id = 1000) response = stub.getmodels(getmodelsrequest, _TIMEOUT_SECONDS, metadata=metadata) print response # Execute Get RPC getrequest = openconfig_service_pb2.getrequestlist(operation_id = "getreqconf", operation = 1, path = "/configuration") request = openconfig_service_pb2.getrequest(request_id = 1000, encoding = 0, get_request = [getrequest]) response = stub.get(request, _TIMEOUT_SECONDS, metadata=metadata) print response # Execute Set RPC SetRPCs(channel) # Create a stub for Management RPC stub = mgd_service_pb2.beta_create_managementrpcapi_stub(channel) # Execute ExecuteOpCommand RPC executeopcommandxmlrequest = mgd_service_pb2.executeopcommandrequest(xml_command = "<get-software-information></get-software-information>", out_format = 0, request_id = 1000) for response in stub.executeopcommand(executeopcommandxmlrequest, _TIMEOUT_SECONDS, metadata=metadata): print response # Execute GetEphemeralConfig RPC ephcfgrequest = mgd_service_pb2.ephconfigrequestlist (operation_id = "getephconf", path = "/configuration") request = mgd_service_pb2.getephemeralconfigrequest (request_id = 1000, encoding = 0, eph_config_requests = [ephcfgrequest]) 29

30 Juniper Extension Toolkit Getting Started Guide response = stub.getephemeralconfig (request, _TIMEOUT_SECONDS, metadata=metadata) print response # Execute EditEphemeral RPC xmlcfgvalue = """ <configuration> <interfaces> <interface> <name>ge-1/0/0</name> <unit> <name>0</name> <description>foo</description> </unit> </interface> </interfaces> </configuration>""" xmlcfgrequest = mgd_service_pb2.editephemeralconfigrequest.configoperationlist(operation_id = "xmlediteph", operation = 0, path = "/", xml_config = xmlcfgvalue) request = mgd_service_pb2.editephemeralconfigrequest (request_id = 1000, eph_config_operations = [xmlcfgrequest]) response = stub.editephemeralconfig(request, _TIMEOUT_SECONDS) print response xmlcfgdelvalue = """ <configuration> <interfaces> <interface delete="delete"> <name>ge-1/0/0</name> </interface> </interfaces> </configuration>""" xmlcfgdelrequest = mgd_service_pb2.editephemeralconfigrequest.configoperationlist(operation_id = "xmldeleph", operation = 0, path = "/", xml_config = xmlcfgdelvalue) request = mgd_service_pb2.editephemeralconfigrequest (request_id = 1000, eph_config_operations = [xmlcfgdelrequest]) response = stub.editephemeralconfig(request, _TIMEOUT_SECONDS) print response def Main(): parser = argparse.argumentparser(prog=os.path.basename( file ), description='sample JET application') parser.add_argument("--user", nargs='?', help="username for authentication by JSD (default:%(default)s)", type=str, default=username) parser.add_argument("--password", nargs='?', help="password for authentication by JSD (default:%(default)s", type=str, default=password) parser.add_argument("--address", nargs='?', help="address of the JSD server. (default: %(default)s)", type=str, default=jsd_ip) parser.add_argument("--port", nargs='?', help="port number of the JSD request-response server. (default: %(default)s)", type=int, default=jsd_port) parser.add_argument("--client-id", nargs='?', help="client Id to uniquely identify the client (default: %(default)s)", type=str, default=client_id) args = parser.parse_args() #Establish a connection and authenticate the channel channel = EstablishChannel(args) 30

31 Chapter 3: JET Application Examples ManagementTests(channel) if name == ' main ': Main() Related Documentation JET Firewall Application on page 21 JET Interfaces Application on page 24 31

32 Juniper Extension Toolkit Getting Started Guide 32