.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "TRAFFIC_CACHE_TOOL" "1" "Nov 02, 2023" "9.2" "Apache Traffic Server"
.SH NAME
traffic_cache_tool \- Traffic Server cache management tool
.SH SYNOPSIS
.sp
\fBtraffic_cache_tool\fP [OPTIONS] COMMAND [SUBCOMMAND ...] [OPTIONS]
.SH DESCRIPTION
.sp
\fBtraffic_cache_tool\fP is designed to interact with the Traffic Server cache both for inspection and
modification. It uses a nested command keyword style for specifying operations. There are some
global options that apply to all commands. These should be specified before any command. These can
be abbreviated to any unique initial substring (e.g. \(dq\-\-sp\(dq for \(dq\-\-span\(dq).
.INDENT 0.0
.TP
.B \-\-help
Prints a brief usage message along with the current command hierarchy.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-spans
Specify the span (storage) configuration. This can be a device, a cache directory, or a
configuration file in the form of \fI\%storage.config\fP\&. In the latter case all devices listed
in the configuration file become active.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-volumes
Specify the volume configuration file in the format of \fI\%volume.config\fP\&. This is important
primarily for allocation operations where having the volume configuration is needed in order to
properly allocate storage in spans to specific volumes.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-write
Enable writing to storage devices. If this flag is not present then all storage will be opened
read only and no operation will write to any storage device. This makes \(dqdry run\(dq the default and
actual changes require specifying this flag.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-aos
Specific the average object size in bytes. This is used in various computations. It is identical
to \fI\%proxy.config.cache.min_average_object_size\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-input
Specify the input file or disk.
.UNINDENT
.SH COMMANDS
.INDENT 0.0
.TP
.B \fBlist\fP
Search the spans for stripe data and display it. This is potentially slow as large sections of
the disk may need to be read to find the stripe headers.
.INDENT 7.0
.TP
.B \fBstripes\fP
Print internal stripe metadata.
.UNINDENT
.TP
.B \fBclear\fP
Clear all the spans by writing updated span headers.
.INDENT 7.0
.TP
.B \fBspan\fP
Clears an specific span and it\(aqs stripes. The span to be cleared is specified via \fB\-\-device\fP
.UNINDENT
.TP
.B \fBdir_check\fP
Perform diagnostics on the stripe directories.
.INDENT 7.0
.TP
.B \fBfull\fP
Full check of the directories.
.TP
.B \fBfreelist\fP
Validate the directory free lists.
.TP
.B \fBbucket_chain\fP
Validate the bucket chains in the directories.
.UNINDENT
.TP
.B \fBvolumes\fP
Compute storage allocation to stripes based on the volume configuration and print it.
.TP
.B \fBalloc\fP
Allocate storage to stripes, updating the span and stripe headers.
.INDENT 7.0
.TP
.B \fBfree\fP
Allocate only free (unused) storage to volumes, updating span and stripe headers as needed.
.UNINDENT
.TP
.B \fBinit\fP
Initializes an uninitialized span and creates stripes on that span according to the volume and storage configuration
The span to be initialized can be passed via \fB\-\-input\fP
.TP
.B \fBfind\fP
Determines the stripe in disk cache where the content corresponding to the provided URL may be cached.
This command takes an input file which lists all the urls for which the stripe assignment needs to be determined.
.UNINDENT
.SH EXAMPLES
.sp
List the basic span data.:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
traffic_cache_tool \-\-spans=/usr/local/etc/trafficserver/storage.config list
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Allocate unused storage space.:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
traffic_cache_tool \e
   \-\-spans=/usr/local/etc/trafficserver/storage.config \e
   \-\-volumes=/usr/local/etc/trafficserver/volume.config \e
   alloc free
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Clear all spans.:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
traffic_cache_tool \e
 \-\-spans=/usr/local/etc/trafficserver/storage.config \e
 \-\-volumes=/usr/local/etc/trafficserver/volume.config \e
 clear
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Clear a single span.:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
traffic_cache_tool \e
\-\-span /opt/etc/trafficserver/storage.config \e
\-\-volume /opt/etc/trafficserver/volume.config \e
clear span \-\-device \(dq/dev/sdb3\(dq \-\-write
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Initialize a new span.:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
traffic_cache_tool \e
\-\-span /opt/etc/trafficserver/storage.config \e
\-\-volume /opt/etc/trafficserver/volume.config \e
init \-\-input \(dq/dev/sdb3\(dq \-\-write
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Find Stripe Assignment.:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
traffic_cache_tool \e
\-\-span /opt/etc/trafficserver/storage.config \e
\-\-volume /opt/etc/trafficserver/volume.config \e
init \-\-input \(dq/home/user/urls.txt\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.SH SEE ALSO
.sp
\fBstorage.config(5)\fP
\fBvolume.config(5)\fP,
.SH COPYRIGHT
2023, dev@trafficserver.apache.org
.\" Generated by docutils manpage writer.
.