LFS-HSM(1) Lustre User Utilities LFS-HSM(1)

# [NAME](#NAME)

hsm\_state, hsm\_action, hsm\_set, hsm\_clear - lfs commands used to interact with HSM features

# [SYNOPSIS](#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](#DESCRIPTION)

These are a set of lfs commands used to interact with Lustre/HSM binding feature.

[**lfs hsm\_state** \[**,FILE*/*\]...**](#lfs)

Display the current HSM flags and archive ID for provided files.

[**lfs hsm\_action** \[**,FILE*/*\]...**](#lfs~2)

Display the in-progress HSM actions for provided files.

[**lfs hsm\_set** \[**,OPTION*/*\]... \[*,*FILE*/*\]...**](#lfs~3)

Set provided HSM flags on file list.

[**lfs hsm\_clear** \[**,OPTION*/*\]... \[*,*FILE*/*\]...**](#lfs~4)

Clear the HSM related flags on file list.

Non-privileged user can only change the following flags: **norelease**, **noarchive** and **dirty**.

# [OPTIONS](#OPTIONS)

[**--help**](#help)

Print usage message.

[**--norelease**](#norelease)

File should never be released. File data will stay in Lustre even if a copy exists in HSM backend.

[**--noarchive**](#noarchive)

File should never be archived. Useful if this is a temporary file, for example.

[**--dirty**](#dirty)

File content is not in sync with HSM backend. File should be archived again. (root only)

[**--exists**](#exists)

A file copy exists in HSM backend. Useful mostly for debugging. (root only)

[**--archived**](#archived)

An up-to-date file copy exists in HSM backend. Useful mostly for debugging. (root only)

[**--lost**](#lost)

File copy in HSM backend is not usable anymore and file could not be restored. It should be archived again. (root only)

[**--archive-id NUM**](#archive-id)

Set archive number identifier to value *NUM*. If archive-id is 0 or option is not provided, then default identifier 0 is used and means no identifier change.

# [EXAMPLES](#EXAMPLES)

Display 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](#AUTHORS)

Written by Aurelien Degremont.

# [AVAILABILITY](#AVAILABILITY)

**lfs hsm\_action**, **lfs hsm\_clear**, **lfs hsm\_set** and **lfs hsm\_state** are part of the [**lustre**(7)](/man/enterprise-packages/lustre/lustre.7) filesystem package. **lfs hsm\_action** was added in release 1.7.0. **lfs hsm\_clear** was added in release 2.4.0. **lfs hsm\_set** and **lfs hsm\_state** were added in release 2.0.0.

# [SEE ALSO](#SEE_ALSO)

[**lfs**(1)](/man/enterprise-packages/lustre/lfs.1)

2024-08-30 Lustre

---

Document: lfs-hsm(1) from lustre 2.17.59-r2 (Chainguard OS)
Source: https://github.com/lustre/lustre-release