Debian Codegraph @

upstream/debian-unstable/man8/xfs_admin.8

raw
1 .TH xfs_admin 8
2 .SH NAME
3 xfs_admin \- change parameters of an XFS filesystem
4 .SH SYNOPSIS
5 .B xfs_admin
6 [
7 .B \-eflpu
8 ] [
9 .BI \-O " featurelist"
10 ] [
11 .BR "\-c 0" | 1
12 ] [
13 .B \-L
14 .I label
15 ] [
16 .B \-U
17 .I uuid
18 ] [
19 .B \-r
20 .I rtdev
21 ]
22 .I device
23 [
24 .I logdev
25 ]
26 .br
27 .B xfs_admin \-V
28 .SH DESCRIPTION
29 .B xfs_admin
30 uses the
31 .BR xfs_db (8)
32 command to modify various parameters of a filesystem.
33 .PP
34 Devices that are mounted cannot be modified.
35 Administrators must unmount filesystems before
36 .BR xfs_admin " or " xfs_db (8)
37 can convert parameters.
38 A number of parameters of a mounted filesystem can be examined
39 and modified using the
40 .BR xfs_growfs (8)
41 command.
42 .PP
43 The optional
44 .B logdev
45 parameter specifies the device special file where the filesystem's external
46 log resides.
47 This is required only for filesystems that use an external log.
48 See the
49 .B mkfs.xfs \-l
50 option, and refer to
51 .BR xfs (5)
52 for a detailed description of the XFS log.
53 .SH OPTIONS
54 .TP
55 .B \-e
56 Enables unwritten extent support on a filesystem that does not
57 already have this enabled (for legacy filesystems, it can't be
58 disabled anymore at mkfs time).
59 .IP
60 This option only applies to the deprecated V4 format.
61 .TP
62 .B \-f
63 Specifies that the filesystem image to be processed is stored in a
64 regular file at
65 .I device
66 (see the
67 .B mkfs.xfs \-d
68 .I file
69 option).
70 .TP
71 .B \-j
72 Enables version 2 log format (journal format supporting larger
73 log buffers).
74 .IP
75 This option only applies to the deprecated V4 format.
76 .TP
77 .B \-l
78 Print the current filesystem label.
79 .TP
80 .B \-p
81 Enable 32bit project identifier support (PROJID32BIT feature).
82 .IP
83 This option only applies to the deprecated V4 format.
84 .TP
85 .B \-u
86 Print the current filesystem UUID (Universally Unique IDentifier).
87 .TP
88 .BR "\-c 0" | 1
89 Enable (1) or disable (0) lazy-counters in the filesystem.
90 .IP
91 Lazy-counters may not be disabled on Version 5 superblock filesystems
92 (i.e. those with metadata CRCs enabled).
93 .IP
94 In other words, this option only applies to the deprecated V4 format.
95 .IP
96 This operation may take quite a bit of time on large filesystems as the
97 entire filesystem needs to be scanned when this option is changed.
98 .IP
99 With lazy-counters enabled, the superblock is not modified or logged on
100 every change of the free-space and inode counters. Instead, enough
101 information is kept in other parts of the filesystem to be able to
102 maintain the counter values without needing to keep them in the
103 superblock. This gives significant improvements in performance on some
104 configurations and metadata intensive workloads.
105 .TP
106 .BI \-L " label"
107 Set the filesystem label to
108 .IR label .
109 XFS filesystem labels can be at most 12 characters long; if
110 .I label
111 is longer than 12 characters,
112 .B xfs_admin
113 will truncate it and print a warning message.
114 The filesystem label can be cleared using the special "\c
115 .B \-\-\c
116 " value for
117 .IR label .
118 .TP
119 .BI \-O " feature1" = "status" , "feature2" = "status..."
120 Add or remove features on an existing V5 filesystem.
121 The features should be specified as a comma-separated list.
122 .I status
123 should be either 0 to disable the feature or 1 to enable the feature.
124 Note, however, that most features cannot be disabled.
125 .IP
126 .B NOTE:
127 Administrators must ensure the filesystem is clean by running
128 .B xfs_repair -n
129 to inspect the filesystem before performing the upgrade.
130 If corruption is found, recovery procedures (e.g. reformat followed by
131 restoration from backup; or running
132 .B xfs_repair
133 without the
134 .BR -n )
135 must be followed to clean the filesystem.
136 .IP
137 Supported features are as follows:
138 .RS 0.7i
139 .TP 0.4i
140 .B inobtcount
141 Keep a count the number of blocks in each inode btree in the AGI.
142 This reduces mount time by speeding up metadata space reservation calculations.
143 The filesystem cannot be downgraded after this feature is enabled.
144 Once enabled, the filesystem will not be writable by older kernels.
145 This feature was added to Linux 5.10.
146 .TP 0.4i
147 .B bigtime
148 Upgrade a filesystem to support larger timestamps up to the year 2486.
149 The filesystem cannot be downgraded after this feature is enabled.
150 Once enabled, the filesystem will not be mountable by older kernels.
151 This feature was added to Linux 5.10.
152 .TP 0.4i
153 .B nrext64
154 Upgrade a filesystem to support large per-inode extent counters. The maximum
155 data fork extent count will be 2^48 - 1, while the maximum attribute fork
156 extent count will be 2^32 - 1. The filesystem cannot be downgraded after this
157 feature is enabled. Once enabled, the filesystem will not be mountable by
158 older kernels. This feature was added to Linux 5.19.
159 .TP 0.4i
160 .B exchange
161 Upgrade a filesystem to support atomic file content exchanges through the
162 XFS_IOC_EXCHANGE_RANGE ioctl, and to support online repairs of directories,
163 extended attributes, symbolic links, and realtime free space metadata.
164 The filesystem cannot be downgraded after this feature is enabled.
165 Once enabled, the filesystem will not be mountable by older kernels.
166 .RE
167 .TP
168 .BI \-U " uuid"
169 Set the UUID of the filesystem to
170 .IR uuid .
171 A sample UUID looks like this: "c1b9d5a2-f162-11cf-9ece-0020afc76f16".
172 The
173 .I uuid
174 may also be
175 .BR nil ,
176 which will set the filesystem UUID to the null UUID.
177 The
178 .I uuid
179 may also be
180 .BR generate ,
181 which will generate a new UUID for the filesystem. Note that on CRC-enabled
182 filesystems, this will set an incompatible flag such that older kernels will
183 not be able to mount the filesystem. To remove this incompatible flag, use
184 .BR restore ,
185 which will restore the original UUID and remove the incompatible
186 feature flag as needed.
187 .TP
188 .BI \-r " rtdev"
189 Specifies the device special file where the filesystem's realtime section
190 resides.
191 Only for those filesystems which use a realtime section.
192 .TP
193 .B \-V
194 Prints the version number and exits.
195 .PP
196 The
197 .BR mount (8)
198 manual entry describes how to mount a filesystem using its label or UUID,
199 rather than its block special device name.
200 .SH SEE ALSO
201 .BR mkfs.xfs (8),
202 .BR mount (8),
203 .BR xfs_db (8),
204 .BR xfs_growfs (8),
205 .BR xfs_repair (8),
206 .BR xfs (5).