LFS-HSM(1)

💖 LFS-HSM(1) — the Lustre User Utilities glow-up 💖

okay bestie, welcome to the lfs HSM corner of the Lustre manual. this is the LFS-HSM page from the Lustre User Utilities set, and it's genuinely one of my faves because it's all about the HSM (Hierarchical Storage Management) binding 💅

---

✨ NAME ✨

hsm_state, hsm_action, hsm_set, hsm_clear — the lfs commands you use to interact with HSM features 🦋

---

✨ SYNOPSIS ✨

lfs hsm_state [FILE] ...
lfs hsm_action [FILE] ...
lfs hsm_set [--help] [--norelease] [--noarchive] [--dirty] [--exists]
            [--archived] [--lost] [--archive-id NUM] [FILE] ...
lfs hsm_clear [--help] [--norelease] [--noarchive] [--dirty] [--exists]
              [--archived] [--lost] [FILE] ...

---

✨ DESCRIPTION ✨

so basically these are a lil set of lfs commands you use to vibe with the Lustre/HSM binding feature 🌸

• lfs hsm_state ,FILE/...** — shows you the current HSM flags AND the archive ID for the files you hand it. it's giving receipts 👑
• lfs hsm_action ,FILE/...** — shows you the HSM actions that are currently in progress for those files. the "what's happening rn" report 🔥
• lfs hsm_set ,OPTION/...** ,FILE/...** — sets the HSM flags you picked onto the file list ✨
• lfs hsm_clear ,OPTION/...** ,FILE/...** — clears the HSM-related flags on the file list 🧹

lowkey important: a non-privileged user can only change these three flags: norelease, noarchive and dirty. that's the whole list, no cap. everything else is root-only energy 👑

---

✨ OPTIONS ✨

• --help — prints the usage message 💬
• --norelease — this file should never be released. the file data stays in Lustre even if a copy already exists in the HSM backend 🫶
• --noarchive — this file should never be archived. super useful if it's, like, a temporary file for example 🙈
• --dirty — the file content is not in sync with the HSM backend anymore. the file needs to be archived again. (root only) 💀
• --exists — a copy of the file exists in the HSM backend. mostly useful for debugging. (root only) 🔍
• --archived — an up-to-date copy of the file exists in the HSM backend. also mostly useful for debugging. (root only) ⭐
• --lost — the file copy in the HSM backend is not usable anymore and the file could not be restored. it should be archived again. (root only) 😭
• --archive-id NUM — sets the archive number identifier to the value NUM. if archive-id is 0 or the option isn't provided at all, then the default identifier 0 is used, which means no identifier change 🎀

---

✨ EXAMPLES ✨

display the current HSM flag for foo:

# lfs hsm_state /mnt/lustre/foo
/mnt/lustre/foo: (0x0000000b) exists dirty archived, archive_id: 1

force a file to be considered as modified in lustre (dirty):

# lfs hsm_set --dirty /mnt/lustre/motd

---

✨ AUTHORS ✨

written by Aurelien Degremont 🫶

---

✨ AVAILABILITY ✨

lfs hsm_action, lfs hsm_clear, lfs hsm_set and lfs hsm_state are all part of the lustre(7) filesystem package 🌈

here's the timeline bestie, so you know who showed up when:

1. lfs hsm_action was added in release 1.7.0 ✨
2. lfs hsm_clear was added in release 2.4.0 🦋
3. lfs hsm_set and lfs hsm_state were added in release 2.0.0 🎀

---

✨ SEE ALSO ✨

• lfs(1)

---

and that's the whole page, bestie!! if you need more, go read lfs(1) 🫶

okay mwah, this was the LFS-HSM(1) page from the Lustre User Utilities, dated 2024-08-30, brought to you by Lustre 💜 stay archived, stay iconic, periodt 👑💅