Technical Documentation

traceoptions

Syntax

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

Hierarchy Level

[edit logical-systems logical-system-name protocols pim],[edit logical-systems logical-system-name routing-instances routing-instance-name protocols pim],[edit protocols pim],[edit routing-instances routing-instance-name protocols pim]

Release Information

Statement introduced before JUNOS Release 7.4.

Statement introduced in JUNOS Release 9.0 for EX Series switches.

Description

Configure PIM tracing options.

To specify more than one tracing operation, include multiple flag statements.

Default

The default PIM trace options are those inherited from the routing protocol's traceoptions statement included at the [edit routing-options] hierarchy level.

Options

disable—(Optional) Disable the tracing operation. You can use this option to disable a single operation when you have defined a broad group of tracing operations, such as all.

file filename—Name of the file to receive the output of the tracing operation. Enclose the name within quotation marks. All files are placed in the directory /var/log. We recommend that you place tracing output in the pim-log file.

files number—(Optional) Maximum number of trace files. When a trace file named trace-file reaches its maximum size, it is renamed trace-file.0, then trace-file.1, 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 must also include the size statement to specify the maximum file size.

Range: 2 through 1000 files
Default: 2 files

flag flag—Tracing operation to perform. To specify more than one tracing operation, include multiple flag statements.

PIM Tracing Flags

  • assert—Assert messages
  • bootstrap—Bootstrap messages
  • cache—Packets in the PIM sparse mode routing cache
  • graft—Graft and graft acknowledgment messages
  • hello—Hello packets
  • join—Join messages
  • mt—Multicast tunnel messages
  • nsr-synchronization—Nonstop active routing (NSR) synchronization messages
  • packets—All PIM packets
  • prune—Prune messages
  • register—Register and register stop messages
  • rp—Candidate RP advertisements
  • all—All tracing operations
  • general—A combination of the normal and route trace operations
  • normal—All normal operations
Default: If you do not specify this option, only unusual or abnormal operations are traced.
  • policy—Policy operations and actions
  • route—Routing table changes
  • state—State transitions
  • task—Interface transactions and processing
  • timer—Timer usage

flag-modifier—(Optional) Modifier for the tracing flag. You can specify one or more of these modifiers:

  • detail—Detailed trace information
  • receive—Packets being received
  • send—Packets being transmitted

no-stamp—(Optional) Do not place timestamp information at the beginning of each line in the trace file.

Default: If you omit this option, timestamp information is placed at the beginning of each line of the tracing output.

no-world-readable—(Optional) Do not allow users to read the log file.

replace—(Optional) Replace an existing trace file if there is one.

Default: If you do not include this option, tracing output is appended to an existing trace file.

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 trace-file.0. When trace-file again reaches this size, trace-file.0 is renamed trace-file.1 and trace-file is renamed trace-file.0. 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 must also include the files statement to specify the maximum number of trace files.

Syntax: xk to specify KB, xm to specify MB, or xg to specify GB
Range: 0 KB through the maximum file size supported on your system
Default: 1 MB

world-readable—(Optional) Allow any user to read the log file.

Required Privilege Level

routing and trace—To view this statement in the configuration.

routing-control and trace-control—To add this statement to the configuration.


Published: 2010-04-16