- play_arrow Overview
- play_arrow Junos Automation Scripts Overview
- play_arrow Junos XML Management Protocol and Junos XML API Overview
-
- play_arrow Automation Scripting Using XSLT
- play_arrow XSLT Overview
- play_arrow Standard XPath and XSLT Functions Used in Automation Scripts
- play_arrow Standard XSLT Elements and Attributes Used in Automation Scripts
-
- play_arrow Automation Scripting Using SLAX
- play_arrow SLAX Overview
- SLAX Overview
- SLAX Syntax Rules Overview
- SLAX Elements and Element Attributes Overview
- SLAX Elements as Function Arguments
- Understanding SLAX Default Namespaces
- XPath Expressions Overview for SLAX
- SLAX Templates Overview
- SLAX Functions Overview
- SLAX Parameters Overview
- SLAX Variables Overview
- SLAX Statements Overview
- XSLT Elements Without SLAX Equivalents
- SLAX Operators
- play_arrow SLAX Statements
- append
- apply-imports
- apply-templates
- attribute
- attribute-set
- call
- copy-node
- copy-of
- decimal-format
- element
- else
- else if
- expr
- fallback
- for
- for-each
- function
- if
- import
- key
- match
- message
- mode
- mvar
- number
- output-method
- param
- preserve-space
- priority
- processing-instruction
- result
- set
- sort
- strip-space
- template
- terminate
- trace
- uexpr
- use-attribute-sets
- var
- version
- while
- with
- play_arrow The libslax Distribution for Automation Scripting
- libslax Distribution Overview
- libslax Library and Extension Libraries Overview
- Download and Install the libslax Distribution
- libslax Default Extension Libraries: bit, curl, db, os, and xutil
- Understanding the SLAX Processor (slaxproc)
- How to Use the SLAX Processor (slaxproc)
- SLAX Debugger, Profiler, and callflow
-
- play_arrow Automation Scripting Using Python
- play_arrow Python Overview
- Understanding Python Automation Scripts for Junos Devices
- Requirements for Executing Python Automation Scripts on Junos Devices
- Overview of Python Modules on Junos Devices
- How to Use Python Interactive Mode on Devices Running Junos OS
- How to Use the psutil Module to Retrieve Process and System Information on Devices Running Junos OS
- How to Use the Requests Library for Python on Devices Running Junos OS
- IPv6 Support in Python Automation Scripts
- How to Specify the Routing Instance in Python 3 Applications on Devices Running Junos OS Evolved
-
- play_arrow Automation Script Input
- play_arrow Global Parameters in Automation Scripts
-
- play_arrow Extension Functions and Named Templates for Automation Scripts
- play_arrow Extension Functions for Automation Scripting
- play_arrow Extension Functions in the jcs and slax Namespaces
- base64-decode() Function (SLAX)
- base64-encode() Function (SLAX)
- break-lines() Function (SLAX and XSLT)
- close() Function (SLAX and XSLT)
- dampen() Function (Python, SLAX, and XSLT)
- document() Function (SLAX)
- emit_error() Function (Python)
- emit_snmp_attributes Function (Python)
- emit_warning() Function (Python)
- empty() Function (SLAX and XSLT)
- evaluate() Function (SLAX)
- execute() Function (SLAX and XSLT)
- first-of() Function (SLAX and XSLT)
- get-command() Function (SLAX)
- get-hello() Function (SLAX and XSLT)
- get-input() Function (SLAX and XSLT) and get_input() (Python)
- get-protocol() Function (SLAX and XSLT)
- get-secret() Function (SLAX and XSLT) and get_secret() (Python)
- get_snmp_action() Function (Python)
- get_snmp_oid() Function (Python)
- hostname() Function (Python, SLAX, and XSLT)
- invoke() Function (SLAX and XSLT)
- open() Function (SLAX and XSLT)
- output() Function (Python, SLAX, and XSLT)
- parse-ip() Function (SLAX and XSLT) and parse_ip() (Python)
- printf() Function (Python, SLAX, and XSLT)
- progress() Function (Python, SLAX, and XSLT)
- regex() Function (SLAX and XSLT)
- set_routing_instance() Function (Python)
- sleep() Function (SLAX and XSLT)
- split() Function (SLAX and XSLT)
- sysctl() Function (Python, SLAX, and XSLT)
- syslog() Function (Python, SLAX, and XSLT)
- trace() Function (Python, SLAX, and XSLT)
- play_arrow Named Templates for Automation Scripting
- play_arrow Named Templates in the jcs Namespace
-
- play_arrow Manage Automation Scripts
- play_arrow Store and Enable Scripts
- play_arrow Configure a Remote Source for Scripts
- play_arrow Configure the Session Protocol for Scripts
- play_arrow Control Execution of Scripts
- play_arrow Synchronize Scripts Between Routing Engines
- play_arrow Convert Scripts Between SLAX and XSLT
-
- play_arrow Commit Scripts
- play_arrow Commit Scripts Overview
- play_arrow Create and Execute Commit Scripts
- Required Boilerplate for Commit Scripts
- XML Syntax for Common Commit Script Tasks
- Design Considerations for Commit Scripts
- How to Avoid Potential Conflicts When Using Multiple Commit Scripts
- Line-by-Line Explanation of Sample Commit Scripts
- Control the Execution of Commit Scripts During Commit Operations
- Control the Execution of Commit Scripts in the QFabric System
- Configure Checksum Hashes for a Commit Script
- How to Process Large Configurations Against Commit Scripts
- Example: Retrieve the Pre-Inheritance Candidate Configuration in a Commit Script
- play_arrow Generate a Custom Warning, Error, or System Log Message Using Commit Scripts
- Overview of Generating Custom Warning, Error, and System Log Messages
- Generate a Custom Warning, Error, or System Log Message in Commit Scripts
- SLAX and XSLT Commit Script Tag Elements to Use When Generating Messages
- Example: Generate a Custom Warning Message
- Example: Generate a Custom Error Message
- Example: Generate a Custom System Log Message
- play_arrow Generate Persistent or Transient Configuration Changes Using Commit Scripts
- Overview of Generating Persistent or Transient Configuration Changes Using Commit Scripts
- Generate a Persistent or Transient Configuration Change in SLAX and XSLT Commit Scripts
- Generate a Persistent or Transient Configuration Change in Python Commit Scripts
- SLAX and XSLT Commit Script Tag Elements to Use When Generating Persistent and Transient Configuration Changes
- Remove a Persistent or Transient Configuration Change Using Commit Scripts
- Example: Generate Persistent and Transient Configuration Changes Using Commit Scripts
- play_arrow Create Custom Configuration Syntax with Commit Script Macros
- Overview of Creating Custom Configuration Syntax with Commit Script Macros
- Create Custom Configuration Syntax with Commit Script Macros
- Create a Commit Script Macro to Read the Custom Syntax and Generate Related Configuration Statements
- Example: Creating Custom Configuration Syntax with Commit Script Macros
- play_arrow Commit Script Examples
- Example: Adding a Final then accept Term to a Firewall
- Example: Adding T1 Interfaces to a RIP Group
- Example: Assign a Classifier Using a Commit Script
- Example: Automatically Configure Logical Interfaces and IP Addresses
- Example: Configure Administrative Groups for LSPs
- Example: Configure a Default Encapsulation Type
- Example: Configure Dual Routing Engines
- Example: Configure an Interior Gateway Protocol on an Interface
- Example: Control IS-IS and MPLS Interfaces
- Example: Control LDP Configuration
- Example: Create a Complex Configuration Based on a Simple Interface Configuration
- Example: Impose a Minimum MTU Setting
- Example: Limit the Number of ATM Virtual Circuits
- Example: Limit the Number of E1 Interfaces
- Example: Load a Base Configuration
- Example: Prepend a Global Policy
- Example: Prevent Import of the Full Routing Table
- Example: Require Internal Clocking on T1 Interfaces
- Example: Require and Restrict Configuration Statements
- play_arrow Junos XML and XSLT Tag Elements Used in Commit Scripts
- play_arrow Troubleshoot Commit Scripts
-
- play_arrow Op Scripts
- play_arrow Op Scripts Overview
- play_arrow Create and Execute Op Scripts
- Required Boilerplate for Op Scripts
- Map Operational Mode Commands and Output Fields to Junos XML Notation
- How to Use RPCs and Operational Mode Commands in Op Scripts
- Declare and Use Command-Line Arguments in Op Scripts
- Configure Help Text for Op Scripts
- Define Operational Mode Commands to Allow in an Op Script
- Enable an Op Script and Define a Script Alias
- Configure Checksum Hashes for an Op Script
- Execute an Op Script on the Local Device
- Execute an Op Script from a Remote Site
- Disable an Op Script
- play_arrow Op Script Examples
- Change the Configuration Using SLAX and XSLT Scripts
- Example: Change the Configuration Using SLAX and XSLT Op Scripts
- Example: Change the Configuration Using Python Op Scripts
- Example: Customize Output of the show interfaces terse Command Using an Op Script
- Example: Display DNS Hostname Information Using an Op Script
- Example: Find LSPs to Multiple Destinations Using an Op Script
- Example: Restart an FPC Using an Op Script
- Example: Export Files Using an Op Script
- Example: Import Files Using an Op Script
- Example: Search Files Using an Op Script
- play_arrow Provision Services Using Service Template Automation
- play_arrow Troubleshoot Op Scripts
-
- play_arrow Event Policies and Event Scripts
- play_arrow Event Policy Overview
- play_arrow Event Policy Triggers
- Use Correlated Events to Trigger an Event Policy
- Trigger an Event Policy Based on Event Count
- Example: Trigger an Event Policy Based on Event Count
- Use Regular Expressions to Refine the Set of Events That Trigger a Policy
- Example: Controlling Event Policy Using a Regular Expression
- Generate Internal Events to Trigger Event Policies
- Use Nonstandard System Log Messages to Trigger Event Policies
- Junos Logger Utility
- play_arrow Event Policy Actions
- Configure an Event Policy to Execute Operational Mode Commands
- Configure an Event Policy to Change the Configuration
- Example: Changing the Configuration Using an Event Policy
- Example: Changing the Interface Configuration in Response to an Event
- Execute Event Scripts in an Event Policy
- Change the Configuration Using an Event Script
- Configuring an Event Policy to Pass Arguments to an Event Script
- Configure Event Policies to Ignore an Event
- Example: Ignore Events Based on Receipt of Other Events
- Overview of Using Event Policies to Raise SNMP Traps
- Example: Raise an SNMP Trap in Response to an Event
- Understanding the Event System Log Priority in an Event Policy
- Example: Configuring the Event System Log Priority in an Event Policy
- Example: Limit Event Script Output Based on a Specific Event Type
- play_arrow Configure Event Policy File Archiving
- play_arrow Configure Event Policy Privileges
- play_arrow Event Scripts Overview
- play_arrow Create and Execute Event Scripts
- play_arrow Troubleshoot Event Policies and Event Scripts
-
- play_arrow Configuration Statements and Operational Commands
Trace SNMP Script Processing on Devices Running Junos OS
SNMP script tracing operations track SNMP script operations and record them in a log file. The logged error descriptions provide detailed information to help you solve problems faster.
The default operation of SNMP script tracing is to log important events, which include errors, warnings, progress messages, and script processing events, in the /var/log/snmp.log file on the device. When the file snmp.log reaches 128 kilobytes (KB), it is renamed with a number 0 through 9 (in ascending order) appended to the end of the file and then compressed. The resulting files are snmp.log.0.gz, then snmp.log.1.gz, until there are 10 trace files. Then the oldest trace file (snmp.log.9.gz) is overwritten.
Minimum Configuration for Enabling Traceoptions for SNMP Scripts
If no SNMP script trace options are configured, the simplest
way to view the trace output of an SNMP script is to configure the output
trace flag and issue the show log snmp.log | last
command. To do this, perform the following steps:
If you have not done so already, enable an SNMP script by including the
file
statement at the[edit system scripts snmp]
hierarchy level.Enable trace options by including the
traceoptions flag output
statement at the[edit system scripts snmp]
hierarchy level.Commit the configuration.
content_copy zoom_out_map[edit] user@host# commit
To display the resulting trace messages recorded at the end of the /var/log/snmp.log file, issue the
show log snmp.log | last
operational mode command.content_copy zoom_out_map[edit] user@host# run show log snmp.log | last
Table 1 summarizes useful
filtering commands that display selected portions of the snmp.log
file.
Task | Command |
---|---|
Display logging data associated with all SNMP script processing. |
|
Display processing for only the most recent operation. |
|
Display processing for script errors. |
|
Display processing for a particular script. |
|
Example: Minimum Configuration for Enabling Traceoptions for SNMP Scripts
Display the trace output of the SNMP script file sample_snmp.slax in the default SNMP script log file:
[edit] system { scripts { snmp { file sample_snmp.slax { oid .1.3.6.1.4.1.2636.13.61.1.9.1.1; } traceoptions { flag output; } } }
[edit] user@host# commit and-quit
user@host> show snmp mib get .1.3.6.1.4.1.2636.13.61.1.9.1.1.1 juniperMIB.13.61.1.9.1.1.1 = 211 user@host> show log snmp.log | last Mar 1 11:00:09 snmp script processing begins Mar 1 11:00:09 running snmp script 'sample_snmp.slax' Mar 1 11:00:09 opening snmp script '/var/run/scripts/snmp//sample_snmp.slax' Mar 1 11:00:09 snmp script input Mar 1 11:00:09 begin dump <?xml version="1.0" standalone="yes"?> <snmp-script-input> <snmp-action>get</snmp-action> <snmp-oid>.1.3.6.1.4.1.2636.13.61.1.9.1.1.1</snmp-oid> </snmp-script-input> Mar 1 11:00:09 end dump Mar 1 11:00:09 reading snmp script 'sample_snmp.slax' Mar 1 11:00:09 snmp script output Mar 1 11:00:09 begin dump <?xml version="1.0"?> <snmp-script-results> <snmp-oid>.1.3.6.1.4.1.2636.13.61.1.9.1.1.1</snmp-oid> <snmp-type>Integer32</snmp-type> <snmp-value>211</snmp-value> </snmp-script-results> Mar 1 11:00:09 end dump Mar 1 11:00:09 inspecting snmp output 'sample_snmp.slax' Mar 1 11:00:09 sample_snmp.slax triggered for oid = .1.3.6.1.4.1.2636.13.61.1.9.1.1.1, with type = Integer32, and with value = 211 Mar 1 11:00:09 finished snmp script 'sample_snmp.slax' Mar 1 11:00:09 snmp script processing ends
Configuring Tracing of SNMP Scripts
You cannot change the directory (/var/log) to which trace files are written. However, you can customize other
trace file settings by including the following statements at the [edit system scripts snmp traceoptions]
hierarchy level:
[edit system scripts snmp traceoptions] file <filename> <files number> <size size> <world-readable | no-world-readable>; flag all; flag events; flag input; flag offline; flag output; flag rpc; flag xslt; no-remote-trace;
These statements are described in the following sections:
- Configuring the SNMP Script Log Filename
- Configuring the Number and Size of SNMP Script Log Files
- Configuring Access to SNMP Script Log Files
- Configuring the SNMP Script Trace Operations
Configuring the SNMP Script Log Filename
By default, the name of the file that records trace output is snmp.log. You can specify a different name by including
the file
statement at the [edit system scripts snmp
traceoptions]
hierarchy level.
[edit system scripts snmp traceoptions] file filename;
Configuring the Number and Size of SNMP Script Log Files
By default, when the trace file reaches 128 KB in size, it is renamed and compressed to filename.0.gz, then filename.1.gz, and so on, until there are 10 trace files. Then the oldest trace file (filename.9.gz) is overwritten.
You can configure the limits on the number and size of trace
files by including the following statements at the [edit system scripts snmp
traceoptions file filename]
hierarchy
level:
[edit system scripts snmp traceoptions file filename] files number size size;
For example, set the maximum file size to 640 KB and the maximum number of files to 20. When the file that receives the output of the tracing operation (filename) reaches 640 KB, it is renamed and compressed to filename.0.gz, and a new file called filename is created. When filename reaches 640 KB, filename.0.gz is renamed filename.1.gz, and filename is renamed and compressed to filename.0.gz. This process repeats until there are 20 trace files. Then the oldest file (filename.19.gz) is overwritten.
The number of files can range from 2 through 1000 files. The file size can range from 10 KB through 1 gigabyte (GB).
If you set either a maximum file size or a maximum number of trace files, you also must specify the other parameter and a filename.
Configuring Access to SNMP Script Log Files
By default, access to the SNMP script log file is restricted
to the owner. You can manually configure access by including the world-readable
or no-world-readable
statement at
the [edit system scripts snmp traceoptions file filename]
hierarchy level.
[edit system scripts snmp traceoptions file filename] (world-readable | no-world-readable);
The no-world-readable
statement restricts SNMP script
log access to the owner. The world-readable
statement enables
unrestricted access to the SNMP script log file.
Configuring the SNMP Script Trace Operations
By default, the traceoptions events
flag is turned
on, regardless of the configuration settings, and only important events
are logged. This includes errors, warnings, progress messages, and
script processing events. You can configure the trace operations to
be logged by including the following statements at the [edit
system scripts snmp traceoptions]
hierarchy level:
[edit system scripts snmp traceoptions] flag all; flag events; flag input; flag offline; flag output; flag rpc; flag xslt;
Table 2 describes the meaning of the SNMP script tracing flags.
Flag | Description | Default Setting |
---|---|---|
| Trace all operations. | Off |
| Trace important events, including errors, warnings, progress messages, and script processing events. | On |
| Trace SNMP script input data. | Off |
| Generate data for offline development. | Off |
| Trace SNMP script output data. | Off |
| Trace SNMP script RPCs. | Off |
| Trace the Extensible Stylesheet Language Transformations (XSLT) library. | Off |