Technical Documentation

traceoptions (Commit and Op Scripts)

Syntax

traceoptions {file <filename> <files number> <size size> <world-readable | no-world-readable>;flag flag;no-remote-trace;}

Hierarchy Level

[edit system scripts commit],[edit system scripts op]

Release Information

Statement introduced in JUNOS Release 7.4.

Statement introduced in JUNOS Release 9.0 for EX Series switches.

Description

Define tracing operations for commit or op scripts.

Default

If you do not include this statement, no script-specific tracing operations are performed.

Options

filename—Name of the file to receive the output of the tracing operation. All files are placed in the directory /var/log. By default, commit script process tracing output is placed in the file cscript.log and op script process tracing is placed in the file op-script.log. If you include the file statement, you must specify a filename. To retain the default, you can specify cscript.log or op-script.log as the filename.

files number—(Optional) Maximum number of trace files. When a trace file named trace-file reaches its maximum size, it is renamed and compressed to trace-file.0.gz, then trace-file.1.gz, and so on, until the maximum number of trace files is reached. Then the oldest trace file is overwritten.

If you specify a maximum number of files, you also must specify a maximum file size with the size option and a filename.

Range: 2 through 1000
Default: 10 files

flag—Tracing operation to perform. To specify more than one tracing operation, include multiple flag statements. You can include the following flags:

  • all—Log all operations
  • events—Log important events
  • input—Log script input data
  • offline—Generate data for offline development
  • output—Log script output data
  • rpc—Log script RPCs
  • xslt—Log the XSLT library

no-world-readable—Restrict file access to owner. This is the default.

size size—(Optional) Maximum size of each trace file, in kilobytes (KB), megabytes (MB), or gigabytes (GB). When a trace file named trace-file reaches this size, it is renamed and compressed to trace-file.0.gz. When trace-file again reaches its maximum size, trace-file.0.gz is renamed trace-file.1.gz and trace-file is renamed and compressed to trace-file.0.gz. This renaming scheme continues until the maximum number of trace files is reached. Then the oldest trace file is overwritten.

If you specify a maximum file size, you also must specify a maximum number of trace files with the files option and a filename.

Syntax: xk to specify KB, xm to specify MB, or xg to specify GB
Range: 10 KB through 1 GB
Default: 128 KB

world-readable—Enable unrestricted file access.

Required Privilege Level

maintenance—To view this statement in the configuration.
maintenance-control—To add this statement to the configuration.


Published: 2010-01-05