TRAFFIC_CACHE_TOOL(1)

๐Ÿ“ฆ
version 9.2.5 ยท 4 versions
, in ubuntu noble, ubuntu questing

๐Ÿ’– TRAFFIC_CACHE_TOOL(1) ๐Ÿ’–

Apache Traffic Server ยท the cache management tool, bestie edition ๐ŸŽ€


โœจ NAME โœจ

traffic_cache_tool โ€” the Traffic Server cache management tool ๐Ÿซถ


๐ŸŒธ SYNOPSIS ๐ŸŒธ

traffic_cache_tool [OPTIONS] COMMAND [SUBCOMMAND ...] [OPTIONS]

๐Ÿฆ‹ DESCRIPTION ๐Ÿฆ‹

okay so. traffic_cache_tool is literally designed to interact with the Traffic Server cache โ€” both for inspection and for modification, no cap. It uses a nested command keyword style for specifying operations, which is giving very much "choose your own adventure" but for disk spans.

There are some global options that apply to all commands. These should be specified before any command. And the way that they can be abbreviated to any unique initial substring? iconic. (e.g. "--sp" for "--span") ๐Ÿ’…

  • --help โ€” Prints a brief usage message along with the current command hierarchy. ur little map ๐Ÿ—บ๏ธ
  • --spans โ€” Specify the span (storage) configuration. This can be a device, a cache directory, or a configuration file in the form of storage.config. In the latter case all devices listed in the configuration file become active. โœจ
  • --volumes โ€” Specify the volume configuration file in the format of volume.config. 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. ๐Ÿงš
  • --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 "dry run" the default and actual changes require specifying this flag. ๐Ÿšจ so real changes are opt-in, bestie, respect the safety rail.
  • --aos โ€” Specific the average object size in bytes. This is used in various computations. It is identical to proxy.config.cache.min_average_object_size. ๐Ÿ”ข
  • --input โ€” Specify the input file or disk. ๐Ÿ“ฅ

๐Ÿ‘‘ COMMANDS ๐Ÿ‘‘

  • list โ€” 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. ๐Ÿ’€ patience is a virtue fr fr
    • stripes โ€” Print internal stripe metadata.
  • clear โ€” Clear all the spans by writing updated span headers.
    • span โ€” Clears an specific span and it's stripes. The span to be cleared is specified via --device
  • dir_check โ€” Perform diagnostics on the stripe directories. ๐Ÿฉบ
    • full โ€” Full check of the directories.
    • freelist โ€” Validate the directory free lists.
    • bucket_chain โ€” Validate the bucket chains in the directories.
  • volumes โ€” Compute storage allocation to stripes based on the volume configuration and print it. ๐Ÿงฎ
  • alloc โ€” Allocate storage to stripes, updating the span and stripe headers.
    • free โ€” Allocate only free (unused) storage to volumes, updating span and stripe headers as needed.
  • init โ€” 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 --input ๐ŸŒฑ
  • find โ€” 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. ๐Ÿ”

๐ŸŒˆ EXAMPLES ๐ŸŒˆ

List the basic span data.:

traffic_cache_tool --spans=/usr/local/etc/trafficserver/storage.config list

Allocate unused storage space.:

traffic_cache_tool \
   --spans=/usr/local/etc/trafficserver/storage.config \
   --volumes=/usr/local/etc/trafficserver/volume.config \
   alloc free

Clear all spans.:

traffic_cache_tool \
 --spans=/usr/local/etc/trafficserver/storage.config \
 --volumes=/usr/local/etc/trafficserver/volume.config \
 clear

Clear a single span.:

traffic_cache_tool \
--span /opt/etc/trafficserver/storage.config \
--volume /opt/etc/trafficserver/volume.config \
clear span --device "/dev/sdb3" --write

Initialize a new span.:

traffic_cache_tool \
--span /opt/etc/trafficserver/storage.config \
--volume /opt/etc/trafficserver/volume.config \
init --input "/dev/sdb3" --write

Find Stripe Assignment.:

traffic_cache_tool \
--span /opt/etc/trafficserver/storage.config \
--volume /opt/etc/trafficserver/volume.config \
init --input "/home/user/urls.txt"

๐Ÿ’œ SEE ALSO ๐Ÿ’œ

storage.config(5) volume.config(5),


2026, dev@trafficserver.apache.org


and that's the whole page, bestie ๐Ÿ’… version 9.2, dated Feb 12, 2026 โ€” go read ur cache like the main character u are ๐Ÿ‘‘โœจ
๐Ÿ“ฆ where this page comes from