rbh-report(1)

💅 rbh-report(1) — the querying command for the robinhood policy engine

okay bestie so this is rbh-report, the querying command for the robinhood policy engine, from the Robinhood 3.0 era. it's literally your little gossip sesh with the filesystem — you ask, it spills. ✨

---

🌈 SYNOPSIS

  rbh-report [options]

that's it. no positional args, just vibes and flags. 🫶

---

✨ AVAILABLE STATS ✨

the whole menu of tea you can ask for, one at a time:

• --activity, -a — spill the stats about daemon activity. what's it been up to? 👀
• --fs-info, -i — statistics about filesystem contents. the classic.
• --class-info[=class_expr] — a Fileclasses summary. you can pass the optional class_expr param to only get stats about the matching fileclasses 🎀
• --status-info status_name[:status_value] — a status summary for the policy or status name you give it. optionally filter on status_value, iykyk.
• --entry-info path|id, -e path|id — literally everything about the given entry. main character treatment for one file.
• --user-info[=username], -u username — user statistics. pass the optional username to get stats about a single user only 🫶
• --group-info[=groupname], -g groupname — group statistics. optional groupname narrows it to one group.
• --top-dirs[=cnt], -d cnt — the largest directories. the optional argument is how many dirs you get back (default: 20).
• --top-size[=cnt], -s cnt — the largest files. optional argument = how many files come back (default: 20).
• --top-users[=cnt], -U cnt — top disk space consumers 🍽️. optional argument = how many users come back (default: 20).
• --oldest-files[=cnt], -o cnt — the oldest files in the filesystem, ordered by access time. optional argument = how many entries to display (default: 20). Tip: use the --reverse option to display the newest files instead. iconic lil flip. 🔄
• --oldest-empty-dirs[=cnt], -O cnt — the oldest empty directories, ordered by modification time. optional argument = how many dirs come back (default: 20).
• --deferred-rm, -R — shows the files that are going to be removed from HSM.
• --dump, -D — dumps all the filesystem entries. absolutely unhinged amount of output, no cap.
• --dump-user username — dumps all entries for the given user.
• --dump-group groupname — dumps all entries for the given group.
• --dump-ost ost_index|ost_set — dumps all entries on the given OST or set of OSTs (e.g. 3,5-8).
• --dump-status status_name:status_value — dumps all entries with the given status (e.g. lhsm_status:released).

---

🕰️ MAINTENANCE SCHEDULING 🕰️

your calendar-girl era:

• --next-maintenance[=date_time] — set/display the time of the next maintenance. the expected date_time format is yyyymmddHHMM[SS] ⏰
• --cancel-maintenance — cancel the next scheduled maintenance. ghosting the maintenance window fr fr 💀

---

🦋 FILTER OPTIONS 🦋

these filters can be specified for reports:

• -P path, --filter-path path — only display the report for objects in the given path.
• -C class_expr, --filter-class class_expr — only report entries in the matching fileclasses.
• --count-min cnt — display only topuser/userinfo with at least cnt entries.

---

🍓 ACCOUNTING REPORT OPTIONS 🍓

• --size-profile, --szprof — display size profile statistics.
• --by-count — sort by count.
• --by-avgsize — sort by average file size.
• --by-size-ratio range, --by-szratio range — sort on the ratio of files in the given size-range range:

<val><sep><val>-   or   <val><sep><val-1>   or   <val><sep>inf

where <val> is one of 0, 1, 32, 1K, 32K, 1M, 32M, 1G, 32G, 1T, and <sep> is ~ or ... e.g: 1G..inf, 1..1K-, 0..31M ✨

• --reverse — reverse the sort order. flip it and reverse it 🔄
• -S, --split-user-groups — display the report by user AND group. both. at once. 💅
• -F, --force-no-acct — generate the report without using the accounting table. heads up: this is slower 😭

---

🎀 CONFIG FILE OPTIONS 🎀

• -f cfg_file, --config-file=cfg_file — path to the configuration file (or a short name).

---

🌸 OUTPUT FORMAT OPTIONS 🌸

• -c, --csv — output stats in a csv-like format, for parsing 🤖
• -q, --no-header — don't display column headers/footers. clean, minimal, aesthetic.

---

🧚 MISCELLANEOUS OPTIONS 🧚

• -l loglevel, --log-level=loglevel — force the log verbosity level (this overrides the configuration value). allowed values: CRIT, MAJOR, EVENT, VERB, DEBUG, FULL.
• -h, --help — display a short help about command line options. your safe space 🫶
• -V, --version — display version info.

---

👑 SEE ALSO 👑

robinhood(1), rbh-find(1), rbh-du(1), rbh-diff(1) — go read the whole friend group, they all slay 💜

---

and that's the whole page, bestie — written up from the Robinhood 3.0 rbh-report(1) manual page, dated 07 July 2016. vintage but still eating. 🎀✨