SAUNAFS-ADMIN(8)

📦
version 5.8.0 · 4 versions
, in ubuntu stonking

✨ SAUNAFS-ADMIN(8) ✨

okay bestie, so this is the page for saunafs-admin — and also saunafs-probe, which is the older twin 🫶 — the SaunaFS monitoring and administration tool. It's section 8, it's the system-administration section, and yes it's giving main character energy because it literally runs the whole cluster 💅

🎀 SYNOPSIS 🎀

saunafs-admin COMMAND [OPTIONS...] [ARGUMENTS...]

so like, you pick a COMMAND, and then you can sprinkle OPTIONS and ARGUMENTS on top. that's the whole shape of it. periodt ✨

💀 NOTES 💀

real talk: saunafs-probe is deprecated, bestie. use saunafs-admin instead, no cap. it's the icon, the moment, the blueprint 🔥

👑 AVAILABLE COMMANDS 👑 (the menu, and it's a whole vibe)

  • chunks-health <master ip> <master port> — returns chunks health reports for the installation 💖. by default (meaning if you don't specify any report at all) all the reports get shown. and heads up: in replication and deletion states, that column means the number of chunks with the number of copies specified in the label to replicate/delete. iykyk.
    • --porcelain — makes the output parsing-friendly 🧚
    • --availability — prints the report about availability of chunks
    • --replication — prints the report about about the number of chunks that need replication
    • --deletion — prints the report about about the number of chunks that need deletion
  • info <master ip> <master port> — prints stats all about your SaunaFS installation 📊
    • --porcelain — makes the output parsing-friendly
  • iolimits-status <master ip> <master port> — prints the current configuration of the global I/O limiting 🚦
  • list-chunkservers <master ip> <master port> — prints info about all the connected chunkservers 🌈
    • --porcelain — makes the output parsing-friendly
  • list-defective-files <master ip> <master port> — lists the files that currently have defective chunks 😭
    • --porcelain — makes the output parsing-friendly
    • --unavailable — prints unavailable files
    • --undergoal — prints files with undergoal chunks
    • --structure-error — prints files/directories with structure error
    • --limit= — limits the maximum number of printed files
  • list-disks <master ip> <master port> — prints info about all the connected chunkservers 💽
    • --porcelain — makes the output parsing-friendly
    • --verbose — be a little more verbose and show the operations statistics
  • list-goals <master ip> <master port> — lists the goal definitions 🎯
    • --porcelain — makes the output parsing-friendly
    • --pretty — prints a nice table ✨
  • list-mounts <master ip> <master port> — prints info about all the connected mounts 🗂️
    • --porcelain — makes the output parsing-friendly
    • --verbose — be a little more verbose and show the goal and trash time limits
  • list-metadataservers <master ip> <master port> — prints the status of the active metadata servers 👑
    • --porcelain — makes the output parsing-friendly
  • metadataserver-status <master ip> <master port> — prints the status of a master or shadow master server 🦋
    • --porcelain — makes the output parsing-friendly
  • list-tasks <master ip> <master port> — lists the tasks that the master is currently executing 🛠️
  • manage-locks <master ip> <master port> [list/unlock] [flock/posix/all] — manage locks 🔐
    • --porcelain — makes the output parsing-friendly
    • --active — print only active locks
    • --pending — print only pending locks
    • --inode= — specify an inode for the operation
    • --owner= — specify an owner for the operation
    • --sessionid= — specify a sessionid for the operation
    • --start= — specify a range start for the operation
    • --end= — specify a range end for the operation
  • ready-chunkservers-count <master ip> <master port> — prints the number of chunkservers ready to be written to ✍️
  • promote-shadow <shadow ip> <shadow port> — promotes the metadata server 🌟. it works only if the personality ha-cluster-managed is used. also: authentication with the admin password is required 🔑.
  • stop-master-without-saving-metadata <master ip> <master port> — stops the master server without saving metadata in the metadata.sfs file 😳. it's used to quickly migrate a metadata server (works for all personalities). authentication with the admin password is required 🔑.
  • reload-config <master ip> <master port> — requests reloading the configuration from the config file 🔄. this one is synchronous — it waits for the reload to finish. authentication with the admin password is required 🔑.
  • save-metadata <metadataserver ip> <metadataserver port> — requests saving the current state of metadata into the metadata.sfs file 💾. with --async it fails if the process cannot be started, e.g. because the process is already in progress. without --async, it fails if either the process cannot be started or if it finishes with an error (i.e., no metadata file is created). authentication with the admin password is required 🔑.
    • --async — don't wait for the task to finish
  • stop-task <master ip> <master port> <task id> — stops the execution of the task with the given id 🛑
  • list-session <master ip> <master port> — lists all currently open sessions 👀
  • delete-session <master ip> <master port> <session_id> — deletes the specified session 🗑️
  • dump-config <master ip> <master port> — dumps the configuration files of the master server 📜. authentication with the admin password is required 🔑

💅 OPTIONS 💅

  • -v, --version — print version and exit ✌️

🐛 REPORTING BUGS 🐛

found a bug bestie? 😭 don't suffer in silence — report it to the GitHub repository https://github.com/leil-io/saunafs as an issue. the devs will love you for it 🫶

Copyright 2008-2009 Gemius SA

Copyright 2013-2019 Skytechnology sp. z o.o.

Copyright 2023-2024 Leil Storage OÜ

SaunaFS is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 3.

SaunaFS is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with SaunaFS. If not, see http://www.gnu.org/licenses/.

fr fr that's the whole page. now go admin your cluster, you absolute icon 🌸

okay and for the lil sign-off moment: this is from the SAUNAFS-ADMIN(8) page, dated 2026-07-29 📅. bye bestie, slay 💖

📦 where this page comes from