Junos Space. CLI Configlets. Release Modified: Copyright 2016, Juniper Networks, Inc.

Transcription

1 Junos Space CLI Configlets Release 14.1 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. Junos Space CLI Configlets 14.1 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 ix Documentation and Release Notes ix Supported Platforms ix Documentation Conventions ix Documentation Feedback xi Requesting Technical Support xii Self-Help Online Tools and Resources xii Opening a Case with JTAC xii Part 1 Overview Chapter 1 CLI Configlets CLI Configlets Overview Configlet Variables Default Variables User defined Variables Predefined Variables Velocity Templates Directives CLI Configlets Workflow Configlets User Roles Configlet Context Context of an Element Context filtering Nesting Parameters Chapter 2 Configuration Views Configuration Views Overview Configuration View Variables Configuration View Workflow Configuration Views User Roles XML Extensions Chapter 3 XPATH and Regex XPATH and Regex Overview Part 2 Configuration Chapter 4 CLI Configlets Creating a CLI Configlet iii

4 CLI Configlets Chapter 5 Configuration Views Creating a Configuration View Chapter 6 XPath and Regex Creating Xpath or Regex Chapter 7 Configuration Filters Creating a Configuration Filter Part 3 Administration Chapter 8 CLI Configlets Modifying CLI Configlets Viewing CLI Configlet Statistics Exporting CLI Configlets CLI Configlet Examples Example 1 - Setting the description of a physical interface Example 2 - Setting the vlan of a logical interface, where the vlan id is chosen from a predefined set of values Example 3 - Setting a description on all the interfaces of a device Example 4 - Need to set a configuration in all the PICs belonging to a device and certain configuration only on the first PIC of FPC Example 5 - Halting the description of a physical interface Example 6 - Deleting configuration from a physical interface Deleting CLI configlets Cloning a CLI Configlet Importing a CLI Configlet Applying a CLI Configlet to Devices Comparing CLI Configet Versions Marking and Unmarking CLI Configlets as Favorite Marking CLI Configlets as Favorite Unmarking CLI Configlets Marked as Favorite Chapter 9 Configuration Views Modifying a Configuration View Deleting Configuration Views Viewing Configuration Views Statistics Default Configuration Views Examples Default view Example XML view Example Form view Example Form view Chapter 10 XPath and Regex Modifying Xpath and Regex Deleting Xpath and Regex Chapter 11 Configuration Filters Modifying a Configuration Filter Deleting Configuration Filters iv

5 Table of Contents Part 4 Index Index v

6 CLI Configlets vi

7 List of Tables About the Documentation ix Table 1: Notice Icons x Table 2: Text and Syntax Conventions x Part 1 Overview Chapter 1 CLI Configlets Table 3: Parameters for a Configlet Table 4: Attributes of Configlet Parameters Table 5: Configlets User Roles Permissions Table 6: Commands to View XML from the CLI Part 2 Configuration Chapter 5 Configuration Views Table 7: Configuration Views Page Columns Part 3 Administration Chapter 9 Configuration Views Table 8: Parameters Table 9: Parameters Table 10: Parameters and Configured Value Xpath vii

8 CLI Configlets viii

9 About the Documentation Documentation and Release Notes Documentation and Release Notes on page ix Supported Platforms on page ix Documentation Conventions on page ix Documentation Feedback on page xi Requesting Technical Support on page xii 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: JA2500 JA1500 Documentation Conventions Table 1 on page x defines notice icons used in this guide. ix

10 CLI Configlets 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 x 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 Italic text like this Represents output that appears on the terminal screen. Introduces or emphasizes important new terms. Identifies guide names. Identifies RFC and Internet draft titles. user@host> show chassis alarms No alarms currently active 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 x

11 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 xi

12 CLI Configlets 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). xii

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

14 CLI Configlets xiv

15 PART 1 Overview CLI Configlets on page 3 Configuration Views on page 15 XPATH and Regex on page 21 1

16 CLI Configlets 2

17 CHAPTER 1 CLI Configlets CLI Configlets Overview CLI Configlets Overview on page 3 CLI Configlets Workflow on page 5 Configlets User Roles on page 8 Configlet Context on page 9 Nesting Parameters on page 13 CLI Configlets are configuration tools provided by Junos OS that enables the user to apply configuration onto the device by reducing configuration complexity. CLI Configlets contain Junos configuration as formatted ASCII text. Junos Space uses the NETCONF protocol to load and commit this configuration on devices. A CLI Configlet is a configuration template which is transformed to CLI configuration string before being applied to a device. The dynamic elements (strings) in configuration templates are defined using template variables. These variables act as an input to the process of transformation, to construct the CLI configuration string. These variables can contain anything; it can be the interface name, device name, description text or any such dynamic values. The value of these variables are either got from the user, system or given by the context at the time of execution. Velocity templates (VTL) are used to define CLI Configlets. CLI Configlets workspace can be accessed by selecting CLI Configlets from the left navigation. From the CLI Configlets workspace the following tasks can be performed: Viewing the statistics of the CLI Configlets present in Junos Space Network Management Platform. Creating, modifying, cloning, applying, or deleting a CLI configlet. Marking and unmarking CLI Configlets as favorites. Apart from the CLI Configlets workspace, CLI Configlets can be applied from the Devices workspace. It can be triggered from the actual elements for which the configuration has to be applied. The context of the element for which the CLI Configlet is being applied is called as an execution context. 3

18 CLI Configlets NOTE: CLI Configlets are not supported on SSG Series devices, NetScreen Series devices, TCA Series devices, BXOS Series devices, and Media Flow devices. Configlet Variables Variables in CLI Configlets consists leading $. CLI Configlets use three kinds of variables Default Variables The value of these variables need not be input by the user, these values are derived from the current execution context. The following are the default variables. Variable Value $DEVICE Name of the host on which the CLI Configlet is applied $INTERFACE Name of the interface for which the CLI Configlet is applied $UNIT Unit number of the logical interface for which the CLI Configlet is being applied $CONTEXT Context of the element for which the CLI Configlet is applied User defined Variables The values for these variables are entered by the user at execution time. Text fields or Selection fields are used to retrieve data from the user. Predefined Variables These are the variables for which the values are predefined while creating the CLI Configlet. These are also called invisible parameters because they cannot be modified by the user. Velocity Templates Junos Space Network Management Platform enables the user to definite the device configuration in the form of Velocity Templates. These templates are called CLI Configlets. CLI Configlets are transformed into CLI configuration before being applied to the device, this transformation is directed by references and directives of VTL. References are used to embed dynamic content in the configuration text and directives allow dynamic manipulation of the content. Please refer for detailed documentation on VTL. VTL variable is a type of reference and consists of a leading "$" character followed by a VTL Identifier. Directives Directives include an included CLI Configlet s content and parameters in the base CLI Configlet, and import the metadata information related to the parameters of the included 4

19 Chapter 1: CLI Configlets CLI Configlet. You can include CLI Configlets in Junos Space Platform by using two directives : #include_configlet and #mixin directives. #include_configlet --This directive includes an included CLI Configlet s content and parameters in the base CLI Configlet, and imports the metadata information related to the parameters of the included CLI Configlet. If you define a new parameter in the base CLI Configlet by using the #include_configlet directive, the metadata information is fetched and used from the included CLI Configlets. The parameter values updated in the included CLI Configlet after their inclusion into the base CLI Configlet are not updated and available for the base CLI Configlet. If both the base CLI Configlet and included CLI Configlet contain parameters with a common name, the metadata information related to the parameters is ignored. #mixin -- This directive differentiates the parameters of the base CLI Configlet from the parameters of the included CLI Configlet on the Junos Space user interface. The parameter values for the included CLI Configlets can be modified even when you apply the CLI Configlet to the device. You cannot include CLI Configlets that have a period (.) or space in its name. You include these directives in the base CLI Configlet in the following format: #include_configlet( <name of the included configlet> ) #mixin( <name of the included configlet> ) format. Related Documentation Viewing CLI Configlet Statistics on page 40 CLI Configlets Workflow Table 3: Parameters for a Configlet A configlet can be defined from the configlet workspace. Table 3 on page 5 lists the parameters to be defined for a configlet. Parameter Description Name Name of the configlet. The Name cannot exceed 255 characters. Allowable characters include the dash (-), underscore (_), letters, and numbers and the period (.). You cannot have two configlets with the same name. Category The Category of the configlet. The Category cannot exceed 255 characters. Allowable characters include the dash (-), underscore (_), letters, and numbers and the period (.). Device Family Series The device family series which the configlet will be applicable for. Context The context for which the configlet would be applicable for. This is an optional field. Description Description of the configlet. The description cannot exceed 2500 characters. This is an optional field. 5

20 CLI Configlets Table 3: Parameters for a Configlet (continued) Parameter Description Preview options Selecting the Show Parameters option displays the parameters that are present in the configlet. The Show Configuration option displays the consolidated configuration before applying the configlet. Post-view options Selecting the Show Parameters option displays the parameters that are present in the configlet. The Show Configuration option displays the consolidated configuration after applying the configlet. Configlet Content The actual configlet is defined here. The configlet can contain multiple pages and follows a tab like structure. The configuration being applied onto the device can be split among multiple pages, while applying the configuration in all the pages would be combined together in order of the page numbers and applied onto the device as a single commit operation. A configlet is always validated before moving to the next screen. Reference Number The range of values are from 1 to NOTE: You cannot move to the next screen if the configlet content is invalid. Validation involves bracket matching. Parameters are the variables defined in the configlet whose values are either retrieved from the environment or entered by the user during execution. Parameters appear in the second step in the create/edit CLI configlet wizard. While applying configlets, the user is asked to input values for all the variables defined in the configlet. To configure a parameter, click the modify icon on the toolbar. The Edit Configlet Parameter screen is displayed. The attributes of a parameter are set from this screen. To add an additional parameter, click the add icon on the toolbar. The Add Configlet Parameter screen is displayed. The attributes of a parameter are set from this screen. To delete a parameter, click the delete icon on the toolbar. By default, all the variables present in the configlet are listed in the parameters page. Local variables have to be deleted manually or set to type Invisible. Table 2 lists the attributes of the configlet parameters. Table 4: Attributes of Configlet Parameters Configlet Parameter Attributes Description Parameter Name of the parameter If displayed with a name space in the <configlet name>.<parameter.name> format, this parameter belongs to the included configlet. Display Name Display name of the parameter 6

21 Chapter 1: CLI Configlets Table 4: Attributes of Configlet Parameters (continued) Configlet Parameter Attributes Description Description Description of the parameter Types The types of parameters supported are: Text field You can provide a custom value. A text field is shown to get the value of this field from the user while executing the configlet. The default value for this field can either be configured with an XPath in the field Configured Value XPath or with a plain string in the field Default Value. This returns a single value. Selection field You can select a value from a set of options. A selection field is shown to get the value of this field from the user while executing this configlet. The default value for this field can either be configured with an XPath in the field Configured Value XPath or with a plain string in the field Default Value. The options can be configured by an XPath in the field Selection Values XPath, or by a csv string in the field Selection Values. This returns a single value. NOTE: Though this returns a single value, the return value is of array type and the selected value can be taken from index 0. Invisible field You cannot edit this field. This parameter refers to values either defined explicitly as a csv string in the field Default Value field or by an XPath in the field Configured Value XPath. This field returns an array of values. Password Field You need to enter a value when you apply a CLI Configlet containing the parameter. This hides sensitive information in the Apply CLI Configlet job results. Password Confirm Field You need to enter a value twice when you apply a CLI configlet containing the parameter. This hides sensitive information in the Apply CLI Configlet job results. Configured Value XPATH This field is used to give the XPath of the configured values. The behavior of this field depends on the type of parameter. When the parameter type is text field or selection field, the corresponding value present in the XPath is taken as the default value. This value can be modified. In case the XPath returns multiple values, the first value returned is considered. When the parameter type is invisible field, the list of values returned by the XPath is taken as the value of the parameter.. Invisible field will have configured & selection value xpath only when the parameter scope is either device/entity specific, it will be disabled for global. NOTE: When using $INTERFACE, $UNIT, Configured Value Xpath, Invisible Params, Selection fields; the variable definition in the configlet editor should contain.get(0) in order to fetch the value from the array. For example, $INTERFACE.get(0) Default Value The behavior is same as that of Configured value XPath except that the value is given explicitly. This field is considered only when Configured Value XPATH is not specified or if the XPath doesn't return any value. Selection Values XPATH This field is enabled only for parameter type Selection Field. This field contains the XPath (with reference to device XML) to fetch the set of values for the selection field. 7

22 CLI Configlets Table 4: Attributes of Configlet Parameters (continued) Configlet Parameter Attributes Description Selection Values This field is same as Selection values XPath except that the value is given explicitly. This field is considered only when Selection Values XPATH is not specified or if the XPath doesn't return any value. NOTE: : Comma separated values can be used in order to provide an array of values in the Default Value and Selection values field. NOTE: While defining the XPath, the text node has to be directly accessed with text() function. Otherwise it will return the complete XML path of the node. An example would be /device/interface-information/physical-interface/name/text() to fetch the names of all interfaces. Order The order of the parameter. The relative order in which the field has to be displayed while getting input at the time of execution. Regex Value This field contains the regular expression for the parameter which is used to validate the parameter value while applying the CLI configlet to the device. Read-only Whether the parameter belongs to the base configlet or the included configlet false This parameter belongs to the base configlet. true This parameter belongs to the included configlet. It cannot be modified or deleted from this configlet. Related Documentation Viewing CLI Configlet Statistics on page 40 Configlets User Roles The Junos Space User Administrator is a role assigned to a Junos Space administrator that enables the administrator to grant or deny access to different Junos Space tasks. The Junos Space administrator creates users and assigns roles (permissions) so that you can access and perform different tasks. You cannot view the pages that you do not have access to. You can create users and manage them on the Manage Users page if you have User Administrator permissions. To create and manage these users, navigate to Network Management Platform > Role Based Access Control > Users. The Manage Users page lists the existing users. Use this page to create and assign roles to the Configlets users. Table 5 on page 9 describes the Configlets tasks that different users have access to, based on the roles assigned to them. 8

23 Chapter 1: CLI Configlets Table 5: Configlets User Roles Permissions User Role Permitted Tasks CLI Configlets Manager Viewing, creating, modifying, cloning, deleting, compare versions, Import, Export, applying configlets CLI Configlets Operator Applying CLI configlets. Related Documentation Viewing CLI Configlet Statistics on page 40 Configlet Context Execution of scripts and CLI configlets may be required in some case. For example, one might need to restrict the scope of execution of 'disable interface' script to just the interfaces that are enabled. Having a context associated to the script/configlet solves this problem of restricting the scope of them. Context of an element is basically a unique path which leads to its XML counterpart in the DeviceXML. For all context related computations, we consolidate the XMLs fetched form the device under one node called device. This includes configuration xml, interface-information xml, chassis-inventory xml and system-information xml. An example of a device XML is as follows: <device> <interface-information>...</interface-information> <system-information>...</system-information> <chassis-inventory>...</chassis-inventory> <configuration>...</configuration>... </device> Table 6 on page 9 shows the commands to view the XML from the CLI of the device. Table 6: Commands to View XML from the CLI XML type Command Chassis Inventory > show chassis hardware display xml Interface Information > show interfaces display xml Configuration > show configuration display xml System Information 9

24 CLI Configlets NOTE: The command for system information XML is not available. An instance of the system information XML is as follows: <system-information> <hardware-model>ex t</hardware-model> <os-name>junos-ex</os-name> <os-version>11.3r2.4</os-version> <serial-number>abcde12345</serial-number> <host-name>ex-device1</host-name> <virtual-chassis/> </system-information> Context of an Element There is a need to have thean ability to restrict script/configlet execution to certain elements of interest. For example, one might need to restrict the scope of execution of 'disable interface' script only to the interfaces that are enabled. Having a context associated with the script or configlet solves this scoping problem. The context of an element is the XPath that maps to the XML node that represents the element in the device XML. The Context takes the following form for each type of element Element Type XML Referred Context Path Device N/A /device Physical Inventory element Chassis Inventory /device/chassis-inventory/* Physical Interface Interface Information /device/interface-information/* Logical Interface Configuration /device/configuration/* Examples: Element Context Description Device /device The context of a device Chassis /device/chassis-inventory/chassis[name='chassis'] Context of a chassis Routing Engine /device/chassis-inventory/chassis[name='chassis']/chassis-module[name='routing Engine 0'] The context of a routing engine FPC /device/chassis-inventory/chassis[name='chassis']/chassis-module[name='fpc 1'] The context of an FPC in slot 1 PIC /device/chassis-inventory/chassis[name='chassis']/chassis-module[name='fpc 1']/chassis-sub-module[name='PIC 4'] The context of a PIC in slot 4 under FPC in slot 1 10

25 Chapter 1: CLI Configlets Element Context Description Logical Interfaces device/configuration/interfaces/interface[name='ge-0/0/1]/unit[name='0'] The context of logical interface ge-0/0/1.0 Physical Interfaces /device/interface-information/physical-interface[name='ge-0/1/1] The context of a physical interface ge-0/1/1 Context filtering The context attribute of the script/configlet dictates which elements(inventory component/logical interface/physical interface) it is applicable to. The rule to check whether the script/configlet is applicable to an element is as follows Evaluate the context XPath associated to a script/configlet on the device XML. This results in a set of xml nodes. If the resultant xml node list contains the xml node representing the subject element, then the script/template entity is considered a match. Given below are few examples of script or configlet contexts with their descriptions: /device/chassis-inventory/chassis[name='chassis']/chassis-module[starts-with(name,'routing Engine')] - Applicable to all routing engines /device/chassis-inventory/chassis[name='chassis']/chassis-module[starts-with(name,'fpc')] - Applicable to all FPCs /device[starts-with(system-information/os-version,"11")]/interface-information/ physical-interface[starts-with(name,"ge")] - Applicable to all interfaces of type 'ge' which has system os-version as 11 /device/interface-information/physical-interface[admin-status= up ] - Applicable to all physical interfaces with admin status in up state. /device/chassis-inventory/chassis[name='chassis']/chassis-module [starts-with(name,'fpc')]/chassis-sub-module[starts-with(name,'pic')] / device/chassis-inventory/chassis[name='chassis']/chassis-module [starts-with(name,'fpc')]/chassis-sub-module[starts-with(name,'mic')] /chassis-sub-sub-module[starts-with(name,'pic')] - Applicable to all PICs NOTE: If we intend to specify the scope of a script as PIC's, then we would have to consider two different XPaths the PIC can take (One with MIC in-between and one without). We have to give an OR combination of both the XPaths. 11

26 CLI Configlets NOTE: If no context is associated to a script/configlet, then the context of the script is taken as /device. These scripts/configlets would be listed for execution in devices. Physical Interface Example Consider the following device XML <device> <interface-information> <physical-interface> <name>ge-0/0/0</name> <admin-status>up</admin-status>... </physical-interface> <physical-interface> <name>ge-0/0/1</name> <admin-status>down</admin-status>... </physical-interface>... </interface-information>... <!-- ALL THE OTHER NODES -->... </device> Context of an element Context of physical-interface ge-0/0/0 is /device/interface-information/physical-interface[name='ge-0/0/0'] This XPath maps to the node below. This is the XML counterpart of the interface ge-0/0/0 <physical-interface> <name>ge-0/0/0</name> <admin-status>up</admin-status>... </physical-interface> Physical Interface in up state: If the user wants to write a configlet to set the admin status of an interface down if its up, the context of the script can be set as /device/interface-information/physical-interface[admin-status='up'] This configlet will be enabled only for interfaces with admin status up. Since in our example, ge-0/0/0 satisfies the above condition, this configlet can be executed on it. Related Documentation CLI Configlets Overview on page 3 CLI Configlets Workflow on page 5 12

27 Chapter 1: CLI Configlets Nesting Parameters You can use XPath context to define the default option/selectable options of a parameter. This XPath could have dependencies on other parameters. Consider the example below A configlet requires two inputs, a Physical Interface (Input-1) and a Logical Interface (Input-2) that is a part of the selected Physical Interface(Input-1). We define a parameter PHYINT to get the name of the physical interface and a parameter LOGINT to get the name of the logical interface. We define the SELECTIONVALUESXPATH for PHYINT as "/device/interface-information/physical-interface/name/text()". User selects a value from the options listed by the Xpath. Since the selection values listed for LOGINT parameter is dependent on the value selected for PHYINT, we can define the SELECTIONVALUESXPATH of LOGINT as "/device/configuration/interfaces/interface[name='$phyint']/unit/name/text()". This ensures that, only the logical interfaces of the selected physical interface are listed. A configlet could refer another configlet present in Junos Space Network Management Platform using the following statement. #include_configlet("<configlet-name>") Junos Space Network Management Platform would merge the referred configlets inline. Create a configlet named 'SayHello' #set( $person = "Bob" ) Hello $person Create another configlet named 'Greeting' This is a greeting example #include_configlet("sayhello") When the confilget 'Greeting' gets evaluated, it generates the following string. This is a greeting example Hello Bob Related Documentation CLI Configlets Overview on page 3 13

28 CLI Configlets 14

29 CHAPTER 2 Configuration Views Configuration Views Overview Configuration Views Overview on page 15 Configuration View Variables on page 16 Configuration View Workflow on page 16 Configuration Views User Roles on page 18 XML Extensions on page 18 Configuration Views are configuration tools provided by Junos OS that enables the user who wants to see configuration details in his/her own way. The four types of configuration views are Form View, Grid View, XML View, and CLI View. Form View is simple view of configuration as key value pair. The dynamic fields in form view are defined using parameters. Grid view is a customizable grid that can show key(column) list of values(rows) pair. The dynamic column values in grid view are defined using parameter definitions. Velocity templates (VTL) are used to define the parameters. XML and CLI views show the configuration XML and CLI format of the selected component. Configuration Views Workspace can be accessed by selecting Configlets > Configuration Views from the Junos Space user interface. You can perform the following tasks from Configlets > Configuration Views. View the statistics of the Configuration Views present in Junos Space Network Management Platform. Create, Modify, Delete a Configuration Views. Configuration Views can be created from the CLI Configlets workspace. It can be triggered from the actual elements for which the configuration has to be applied. The actual elements are represented in a tree structure of device configuration xml. The context of the element for which the Configuration View is being created is called execution context. Related Documentation Deleting Configuration Views on page 55 Default Configuration Views Examples on page 56 15

30 CLI Configlets Configuration View Variables A parameter name in Configuration View consists of a leading $. Configuration View uses three kinds of variables. Configuration views can use the following default variables to define a parameter. Default Variables The values of the variables are taken from the current execution context. The following are the default variables. Variable Value $DEVICE The name of the host which the configuration view is being created $INTERFACE Name of the interface for which the configuration view is being created $UNIT The unit number of the logical interface for which the configuration view is being created $CONTEXT The context of the element for which the configuration view is being created Velocity Templates Junos Space Network Management Platform enables the user to define the device configuration view parameter's XPath using Velocity Templates. Nested parameters are referred using VTL. Please refer for detailed documentation of VTL. VTL variable is a type of reference and consists of a leading "$" character followed by a VTL Identifier. Related Documentation Modifying a Configuration View on page 55 Configuration View Workflow A configuration view can be defined form the Configuration View workspace, Configuration View will have the following parameters to be defined. Name Name of the configuration view. The Name cannot exceed 255 characters. Allowable characters include the dash (-), underscore (_), letters, and numbers and the period (.). You cannot have two configuration views with the same name. Domain Domain to which the configuration view is associated Title Title of the configuration view. The title cannot exceed 255 characters. Allowable characters include the dash (-), underscore (_), letters, and numbers and the period (.). Device Family Series The device family series which the configuration view will be applicable for. Context The context for which the configuration view would be applicable for. 16

31 Chapter 2: Configuration Views Description Description of the configuration view. The description cannot exceed 2500 characters. This is an optional field. Order Order of the configuration view tab in Device Configuration View. The order can accept values from 1 to View Type View types are Form View, Grid View, XML View, and CLI View.. Parameters are the variables defined in the configuration view whose values are got from the environment. Parameters appear in the create/edit configuration view, as they are added to configuration view. To configure a parameter, click modify icon on the toolbar, the Edit Form View Parameter appears. The attributes of a parameter are set from this screen. To add additional parameter, clicks add icon on the tool bar, the Add Form View Parameter screen appears. The attributes of a parameter are set from this screen. To delete a parameter, click the delete icon on the toolbar. A parameter has the following specific attribute. Parameter Name of the parameter. Index Parameter To consider a parameter as an index parameter or not. This is applicable for a grid view only. An index parameter should meet at least one of the following two conditions except when only one parameter is defined in a grid view. An index parameter should refer at least one of the other index parameters. An index parameter should be referred in one of the other parameters. A non index parameter should always refer at least one index parameter. Display Name Display name of the parameter. Configured Value XPATH This field is used to give the XPath of the configured values. The behavior of this field depends on the type of view. When the view type is form, the corresponding value present in the XPath is taken as the field value. In case XPath returns multiple values, first value returned is considered. In case the XPath returns multiple values, the first value returned is considered. When the view type is grid, the following behavior is followed. If more than one parameters defined then following rules should be met. For independent index parameters, a join would be performed between the values returned by the XPath and the existing set of rows. For dependent index parameters, join would be performed between the values returned by the XPath and the correspondent row. For non index parameters, if list of values returned then they are aggregated into comma separated values. Order The order of the parameter. The relative order in which the parameter has to be displayed. Related Documentation Configuration Views Overview on page 15 17

32 CLI Configlets Configuration Views User Roles The Junos Space User Administrator is a role assigned to a Junos Space administrator that enables the administrator to grant or deny access to different Junos Space tasks. The Junos Space administrator creates users and assigns roles (permissions) so that you can access and perform different tasks. You cannot view the pages that you do not have access to. You can create users and manage them on the Manage Users page if you have User Administrator permissions. To create and manage users, navigate to Network Management Platform > Role Based Access Control > Users. The Users page lists the existing users. Use this page to create and assign roles to the Configuration View users. The following table describes the Configuration View tasks that different users have access to, based on the role assigned to them. User Role Permitted Tasks Configuration View Manager Viewing, creating, modifying, deleting configuration views and Viewing device configuration Configuration View Operator Viewing Configuration view details and device configuration details Related Documentation Modifying a Configuration View on page 55 XML Extensions In configuration-view, the querying is not restricted to the Device XML data. Space lets users define parameters that can fetch additional details that are not a part of the device XML itself. Operational Status In the config viewer, realtime status of the component could be queried using the XPATH <xpath-of-the-component>/oper-status. NOTE: For physical interface component <xpath-of-physical-inteface>/oper-status/text() wouldn't work. Its only possible to query with <xpath-of-physical-inteface>>/oper-status. This limitation doesn't apply for chassis components. Customized Attributes In config viewer, Custom attributes of a component could be queried using the XPATH <xpath-of-the-component>/customized-attribute[name='<attribute-name>']. While defining a view with customized attribute, the user has an option to make it editable. Making a customized attribute editable would allow the user to edit the values inline. Changes would be persisted immediately. To make a customized attribute editable, 18

33 Chapter 2: Configuration Views enable the checkboxs Customized Attribute and Editable. Custom attributes are editable only in Grid View. NOTE: For custom attributes XPATH <xpath-of-the-component>/customized-attribute[name='<attribute-name>'] would work properly, but /text() or any other extensions at the end of the xpath wouldn t work. Related Documentation Modifying a Configuration View on page 55 19

34 CLI Configlets 20

35 CHAPTER 3 XPATH and Regex XPATH and Regex Overview XPATH and Regex Overview on page 21 While developing configlets, XPaths and Regular Expressions would be used intensively. It would be desirable to let the user define frequently used XPaths and Regular expressions in such a way that they can be referred when required. User can define these templates from 'XPath and Regex' workspace (CLIConfiglets > XPath and Regex). Xpaths and Regular expressions defined here are referred from all the fields that require the defined type as input. The user defined values can be selected from the dropdown provided for the field. This can be edited at the field level. Related Documentation Creating Xpath or Regex on page 33 21

36 CLI Configlets 22

37 PART 2 Configuration CLI Configlets on page 25 Configuration Views on page 29 XPath and Regex on page 33 Configuration Filters on page 35 23

38 CLI Configlets 24

39 CHAPTER 4 CLI Configlets Creating a CLI Configlet Creating a CLI Configlet on page 25 You create a CLI Configlet to push configuration to devices. Parameters are the variables defined in the configlet whose values are either got from the environment or given by the user during execution. To create a CLI Configlet: 1. On the Junos Space Network Management Platform user interface, select CLI Configlets > Configlets. The Configlets page is displayed. 2. Click the Create CLI Configet icon from the toolbar. The Create CLI Configlet page is displayed. 3. In the Name field, enter a name for the CLI Configlet. The Name cannot exceed 255 characters. Allowable characters include the dash (-), underscore (_), letters, and numbers and the period (.). You cannot have two Configlets with the same name. 4. In the Category field, enter a name for the category you want to associate this CLI Configlet to. The Category of the Configlet. The Category Field cannot exceed 255 characters. Allowable characters include the dash (-), underscore (_), letters, and numbers and the period (.). 5. From the Device Family Series drop-down list, select the device family for the CLI Configlet. 6. (Optional) From the Context drop-down list, select the appropriate context for this CLI Configlet. 7. In the Reference Number field, enter a reference number for this CLI Configlet. The range is 1 to (Optional) In the Description field, enter a description. 25

40 CLI Configlets The description cannot exceed 2500 characters. 9. From the Execution Type section, select the type of execution. The option buttons available are Single Execution and Grouped Execution. By default, the Single Execution option button is selected. a. If you select Single Execution, you can apply to the CLI Configlet to one device at a time. b. If you select Multiple Execution, you can apply to the CLI Configlet to multiple devices at a time. 10. For Preview options, select the check boxes if you want to view the parameters and the configuration in the CLI Configlet before applying the configuration to devices. The check boxes available are Show Parameters and Show Configuration. By default, both check boxes are selected. 11. For Postview options, select the check boxes if you want to view the parameters and the configuration in the CLI Configlet in the Apply CLI Configlet job results. The check boxes available are Show Parameters and Show Configuration. By default, both check boxes are selected. 12. In the Configlet Editor section, enter the content for the CLI Configlet. You can type or manually paste the configuration in the Configlet Editor. NOTE: You cannot create a CLI Configlet if you do not enter content in the Configlet Editor. NOTE: You can also create a CLI Configlet to erase specific configuration from devices. To do so, include the delete: statement above the hierarchy level that should be deleted from devices. When you apply this CLI Configlet to a device, the physical interface of a device, the logical interface of a device, or the physical inventory element of a device, the configuration in the hierarchy level is erased on the device. For more information about the protocol and the syntax used for creating, modifying, and deleting configuration using CLI Configlets, see Junos XML Management Protocol Guide 13. Click Next. You can add the parameters for this CLI Configlet on this page. 14. To add a parameter to the CLI Configlet: a. Click the Add Parameter icon. The Add Configlet Parameter pop-up window is displayed. b. In the Parameter field, enter the name of the parameter. 26