traceoptions (Protocols BGP)
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 bgp], [edit logical-systems logical-system-name protocols bgp group group-name], [edit logical-systems logical-system-name protocols bgp group group-name neighbor address], [edit logical-systems logical-system-name routing-instances routing-instance-name protocols bgp], [edit logical-systems logical-system-name routing-instances routing-instance-name protocols bgp group group-name], [edit logical-systems logical-system-name routing-instances routing-instance-name protocols bgp group group-name neighbor address], [edit protocols bgp], [edit protocols bgp group group-name], [edit protocols bgp group group-name neighbor address], [edit routing-instances routing-instance-name protocols bgp], [edit routing-instances routing-instance-name protocols bgp group group-name], [edit routing-instances routing-instance-name protocols bgp group group-name neighbor address]
Description
Enabling tracing can adversely impact scale and performance and may increase security risk. We strongly recommend using the trace, tracing, or traceoptions commands only under the guidance of a JTAC support engineer. After collecting the debug information, immediately disable tracing to minimize risk and restore normal system performance.
Configure BGP protocol-level tracing options. To specify more than one tracing operation, include multiple flag statements.
The traceoptions statement is not supported
on QFabric systems.
Default
The default BGP protocol-level tracing options are
inherited from the routing protocols traceoptions statement
included at the [edit routing-options] hierarchy level.
The default group-level trace options are inherited from the BGP protocol-level traceoptions statement. The default peer-level trace options
are inherited from the group-level traceoptions statement.
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 name—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
BGP tracing output in the file bgp-log.
files number—(Optional) Maximum number of trace
files. When a trace file named trace-file.0
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 specify a
maximum file size with the size option.
The maximum file size for traceoptions should be set large enough to accommodate the expected logging volume, based on the configured flags. This helps prevent frequent file rollovers and compression. It is recommended to activate traceoptions only during investigation periods to avoid unnecessary logging.
-
Range: 2 through 1000 files
-
Default: 10 files
flag—Tracing operation to perform. To specify
more than one tracing operation, include multiple flag statements.
BGP Tracing Flags
-
4byte-as—4-byte AS events. -
bfd—BFD protocol events. -
damping—Damping operations. -
graceful-restart—Graceful restart events. -
ipsec—Events related to IPsec support for BGP peers when the IPsec is configured. -
keepalive—BGP keepalive messages. If you enable the the BGPupdateflag only, received keepalive messages do not generate a trace message. -
nsr-synchronization—Nonstop routing synchronization events. -
open—Open packets. These packets are sent between peers when they are establishing a connection. -
packets—All BGP protocol packets. -
refresh—BGP refresh packets. -
update—Update packets. These packets provide routing updates to BGP systems. If you enable only this flag, received keepalive messages do not generate a trace message. Use thekeepaliveflag to generate a trace message for keepalive messages.
Global Tracing Flags
-
all—All tracing operations -
general—A combination of thenormalandroutetrace 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—Routing protocol task processing -
timer—Routing protocol timer processing
flag-modifier—(Optional) Modifier for the tracing
flag. You can specify one or more of these modifiers:
-
detail—Provide detailed trace information. -
filter—Provide filter trace information. Applies only toroute,damping, andupdatetracing flags. -
receive—Trace the packets being received. -
send—Trace the packets being transmitted.
no-world-readable—(Optional) Prevent any user from reading the log
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 the
trace-file again reaches its maximum
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 also must specify a
maximum number of trace files with the files option.
-
Syntax:
xkto specify KB,xmto specify MB, orxgto specify GB
-
Range: 10 KB through the maximum file size supported on your system
-
Default: 128 KB
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.
Release Information
Statement introduced before Junos OS Release 7.4.
4byte-as statement introduced in Junos OS Release 9.2.
4byte-as statement introduced in Junos OS Release 9.2 for EX Series
switches.
ipsec statement introduced in Junos OS Evolved Release 21.3R1.