| 1 |
.TH xfs_freeze 8 |
| 2 |
.SH NAME |
| 3 |
xfs_freeze \- suspend access to an XFS filesystem |
| 4 |
.SH SYNOPSIS |
| 5 |
.B xfs_freeze |
| 6 |
[ |
| 7 |
.B \-f |
| 8 |
| |
| 9 |
.B \-u |
| 10 |
] |
| 11 |
.I mount-point |
| 12 |
.br |
| 13 |
.B xfs_freeze \-V |
| 14 |
.fi |
| 15 |
.SH DESCRIPTION |
| 16 |
.B xfs_freeze |
| 17 |
suspends and resumes access to an XFS filesystem (see |
| 18 |
.BR xfs (5)). |
| 19 |
.PP |
| 20 |
.B xfs_freeze |
| 21 |
halts new access to the filesystem and creates a stable image on disk. |
| 22 |
.B xfs_freeze |
| 23 |
is intended to be used with volume managers and hardware RAID devices |
| 24 |
that support the creation of snapshots. |
| 25 |
.PP |
| 26 |
The |
| 27 |
.I mount-point |
| 28 |
argument is the pathname of the directory where the filesystem |
| 29 |
is mounted. |
| 30 |
The filesystem must be mounted to be frozen (see |
| 31 |
.BR mount (8)). |
| 32 |
.PP |
| 33 |
.PP |
| 34 |
The |
| 35 |
.B \-f |
| 36 |
flag requests the specified XFS filesystem to be |
| 37 |
frozen from new modifications. |
| 38 |
When this is selected, all ongoing transactions in the filesystem |
| 39 |
are allowed to complete, new write system calls are halted, other |
| 40 |
calls which modify the filesystem are halted, and all dirty data, |
| 41 |
metadata, and log information are written to disk. |
| 42 |
Any process attempting to write to the frozen filesystem will block |
| 43 |
waiting for the filesystem to be unfrozen. |
| 44 |
.PP |
| 45 |
Note that even after freezing, the on-disk filesystem can contain |
| 46 |
information on files that are still in the process of unlinking. |
| 47 |
These files will not be unlinked until the filesystem is unfrozen |
| 48 |
or a clean mount of the snapshot is complete. |
| 49 |
.PP |
| 50 |
The |
| 51 |
.B \-u |
| 52 |
flag is used to un-freeze the filesystem and allow |
| 53 |
operations to continue. |
| 54 |
Any filesystem modifications that were blocked by the freeze are |
| 55 |
unblocked and allowed to complete. |
| 56 |
.PP |
| 57 |
The |
| 58 |
.B \-V |
| 59 |
flag prints the version number and exits. |
| 60 |
.PP |
| 61 |
Unless |
| 62 |
.B \-V |
| 63 |
is specified, one of |
| 64 |
.B \-f |
| 65 |
or |
| 66 |
.B \-u |
| 67 |
must be supplied to |
| 68 |
.BR xfs_freeze . |
| 69 |
.SH NOTES |
| 70 |
A copy of a frozen XFS filesystem will usually have the same universally |
| 71 |
unique identifier (UUID) as the original, and thus may be prevented from |
| 72 |
being mounted. |
| 73 |
The XFS |
| 74 |
.B nouuid |
| 75 |
mount option can be used to circumvent this issue. |
| 76 |
.PP |
| 77 |
In Linux kernel version 2.6.29, the interface which XFS uses to freeze |
| 78 |
and unfreeze was elevated to the VFS, so that this tool can now be |
| 79 |
used on many other Linux filesystems. |
| 80 |
.SH SEE ALSO |
| 81 |
.BR xfs (5), |
| 82 |
.BR lvm (8), |
| 83 |
.BR mount (8). |