AFSMONITOR(5)

📦
version 1.8.16.1 · 10 versions
, in ubuntu stonking

💖 AFSMONITOR 💖

okay bestie, so this is the manual for afsmonitor — well, specifically the config file for it, from the AFS File Reference. yes it's section 5, no we are not scared of it, let's go 🦋

✨ NAME ✨

afsmonitor — gives you the instructions for the afsmonitor command. that's it, that's the name section, slay 💅

🌸 DESCRIPTION 🌸

so like. the afsmonitor configuration file is the girlboss that decides everything: which machines the afsmonitor command probes for File Server or Cache Manager statistics, and which statistics it actually gathers. you tell afsmonitor which config file to use by passing the -config argument to the afsmonitor command. periodt 💅

here are all the instructions that can appear in the configuration file, no cap:

  • cm <host name> — names a client machine where you want Cache Manager statistics displayed. and the order of the cm lines in the file? that's literally the order the client machines show up, top to bottom, on the "System Overview" and "Cache Managers" output screens. it's giving organized. it's giving main character energy 👑
  • fs <host name> — names a file server machine where you want File Server statistics displayed. same deal: the order of the fs lines in the file determines the order the file server machines appear, top to bottom, on the "System Overview" and "File Servers" output screens. ✨
  • thresh (fs | cm) <field> <thresh> [<cmd>] [<arg> ...] — assigns the threshold value thresh to the statistic field, for either a File Server statistic (fs) or a Cache Manager statistic (cm). okay so the optional cmd field names a binary or script to execute each time the value of the statistic changes from being below thresh to being at or above thresh. IMPORTANT: a change between two values that BOTH exceed thresh does not retrigger the binary or script. no double-firing bestie, she's not that kind of girl 🙈. the optional arg fields are extra values that the afsmonitor program passes as arguments to the cmd command. and if any of them include one or more spaces? wrap that whole field in double quotes. fr fr.

the afsmonitor program passes the following parameters to the cmd:

<hostname> (fs|cm) <field> <thresh> <actual> [<arg> ...]

the parameters "fs", "cm", field, thresh, and arg correspond to the values with the same name on the thresh line. the hostname parameter identifies the file server or client machine where the statistic has crossed the threshold, and the actual parameter is the actual value of field that exceeds the threshold value. 💖

use the "thresh" line to set either a global threshold — which applies to all file server machines listed on "fs" lines or client machines listed on "cm" lines in the configuration file — or a machine-specific threshold, which applies to only one file server or client machine. okay here's the tea:

  • to set a global threshold, place the thresh line before any of the "fs" or "cm" lines in the file. 🌈
  • to set a machine-specific threshold, place the thresh line below the corresponding "fs" or "cm" line, and above any other "fs" or "cm" lines. a machine-specific threshold value always overrides the corresponding global threshold, if set. and bestie, listen: do not place a "thresh fs" line directly after a cm line, or a "thresh cm" line directly after a fs line. that's the rule, i don't make them, i just vibe with them 💀
  • show (fs | cm) field/group/section — specifies which individual statistic, group of statistics, or section of statistics to display on the "File Servers" screen (fs) or "Cache Managers" screen (cm), plus the order to display them in. the appendix of afsmonitor statistics in the OpenAFS Administration Guide specifies the group and section each statistic belongs to (iykyk 📖). include as many "show" lines as you need to customize the screen display however you want, and place them anywhere in the file. the top-to-bottom order of the "show" lines in the configuration file determines the left-to-right order in which the statistics appear on the corresponding screen. cute, right? 💅

and if there are no "show" lines in the configuration file, then the screens display all statistics for both Cache Managers and File Servers. similarly: if there are no "show fs" lines, the "File Servers" screen displays all file server statistics, and if there are no "show cm" lines, the "Cache Managers" screen displays all client statistics. she's generous like that 🫶

  • # comments — precedes a line of text that the afsmonitor program ignores because of the initial number ("#") sign, which must appear in the very first column of the line. first column only bestie, don't be putting it in the middle ✋
  • version — prints the OpenAFS command suite version and then exits. bye! 👋

for a list of the values that can appear in the field/group/section field of a "show" instruction, see the afsmonitor statistics appendix to the OpenAFS Administration Guide. 📚

🌟 SEE ALSO 🌟

afsmonitor(1)

IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.

This documentation is covered by the IBM Public License Version 1.0. It was converted from HTML to POD by software written by Chas Williams and Russ Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.

k that's the whole thing bestie, you ate 💅✨ this OpenAFS drop is dated 2026-07-27, mwah, go configure something iconic 🎀🦋

📦 where this page comes from