robinhood(1)

Okay bestie, you're reading robinhood(1) from the Robinhood 3.0 manual — the policy engine and statistics tool for large file systems. Buckle up, we're gonna make this make sense 💅✨

🌸 NAME 🌸

robinhood — policy engine and statistics tool for large file systems. No cap, that's the whole vibe.

✨ SYNOPSIS ✨

robinhood [options]

💅 ACTIONS 💅

• -S, --scan[=dir] — Scan the filesystem namespace. If dir is specified, only scan the specified subdir. Targeted scan, slay.
• -r, --read-log[=mdt_idx] — Read events from MDT ChangeLog. If mdt_idx is specified, only read ChangeLogs for the given MDT. Else, start 1 changelog reader thread per MDT (with DNE). iykyk
• --run[=all] — Run all policies (based on triggers). main character energy
• --run=policy1(args),policy2(args)... — Run the given policies with the specified arguments. See "Policy run options" for details about args.
• -C policy1,policy2..., --check-thresholds[=policy1,policy2...] — Only check trigger thresholds without applying policy actions. If no policy is specified (or all), check all triggers.

🎀 POLICY RUN OPTIONS 🎀

args is a comma-separated list of <param>=<value>.

e.g. --run=cleanup(target=user:foo,max-count=1000)

The following parameters are allowed:

• target=tgt — Targeted subset of entries for the policy run.

tgt can be one of:

• all (all entries)
• user:username
• group:grpname
• file:path
• class:fileclass
• ost:ost_idx
• pool:poolname

• max-count=nbr — Max number of actions to execute for a policy run.
• max-vol=size — Max volume of entries impacted by a policy run.
• target-usage=pct — Targeted filesystem or OST usage for a policy run, in percent.
• -t tgt, --target=tgt — Specify the default target for policy runs (see target syntax above).
• --target-usage=pct — Specifies the default disk usage (in pct) for all, ost or pool targets.
• -I, --ignore-conditions — Apply policy to all entries in policy scope, without checking policy rule conditions.
• -F, --force — Force applying policies even if a full scan has never been done (partial DB contents).
• --no-limit — Don't limit the maximum number/volume of policy actions per pass.
• --dry-run — Only report policy actions that would be performed without really doing them. Note: Robinhood DB is impacted as if the reported actions were really done. so yes, bestie, the DB still gets touched 👀
• --force-all — Force applying a policy to all eligible entries, without considering policy limits and rule conditions. This is equivalent to: --once --no-limit --ignore-conditions --force

🦋 SCANNING OPTIONS 🦋

• --no-gc — Garbage collection of entries in DB is a long operation when terminating a scan. This skips this operation if you don't care about removed entries (or don't expect entries to be removed). This is also recommended for partial scanning (see -scan=dir option).

🌈 OUTPUT OPTIONS 🌈

• --diff=attrset — When scanning or reading changelogs, display changes for the given set of attributes (to stdout). attrset is a list of values in: path,posix,stripe,all,status,notimes,noatime.

⭐ BEHAVIOR OPTIONS ⭐

• -O, --once — Perform only one pass of the specified action and exit.
• -d, --detach — Daemonize the process (detach from parent process).
• --alter-db — Allow database schema modifications (backup your DB before using this).

⚠️ backup your DB before using --alter-db — this is not a drill, bestie.

🍓 CONFIG FILE OPTIONS 🍓

• -f cfg_file, --config-file=cfg_file — Path to configuration file (or short name).
• -T output_file, --template[=output_file] — Write a configuration file template to the specified file.
• -D, --defaults — Display default configuration values.
• --test-syntax — Check configuration file and exit.

🔥 LOG OPTIONS 🔥

• -L logfile, --log-file=logfile — Force the path to the log file (overrides configuration value). Special values stdout and stderr can be used.
• -l loglevel, --log-level=loglevel — Force the log verbosity level (overrides configuration value). Allowed values: CRIT, MAJOR, EVENT, VERB, DEBUG, FULL.

💜 MISCELLANEOUS OPTIONS 💜

• -h, --help — Display a short help about command line options.
• -V, --version — Display version info
• -p pidfile, --pid-file=pidfile — Pid file (used for service management).

👑 SEE ALSO 👑

rbh-report(1), rbh-find(1), rbh-du(1), rbh-diff(1)

---

mwah 💋 — that's the whole vibe check. This page is from Robinhood 3.0, dated 07 July 2016. Go be iconic with your large file system, bestie 🫶💖