[BACK]Return to xfsdump.html CVS log [TXT][DIR] Up to [Development] / xfs-website.orig / manpages
File: [Development] / xfs-website.orig / manpages / xfsdump.html (download) (as text)

Revision 1.4, Thu Jan 25 19:55:31 2001 UTC (16 years, 9 months ago) by xfs
Branch: MAIN
CVS Tags: HEAD
Changes since 1.3: +344 -244 lines 

Man pages update.

<html>
<head>
<meta name="Content-Style" content="text/css">
</head>
<body>
<a href="#NAME">NAME</a><br>
<a href="#SYNOPSIS">SYNOPSIS</a><br>
<a href="#DESCRIPTION">DESCRIPTION</a><br>
<a href="#NOTES">NOTES</a><br>
<a href="#Dump Interruption">Dump Interruption</a><br>
<a href="#Dump Resumption">Dump Resumption</a><br>
<a href="#Media Management">Media Management</a><br>
<a href="#Inventory">Inventory</a><br>
<a href="#Labels">Labels</a><br>
<a href="#UUIDs">UUIDs</a><br>
<a href="#Dump Level Usage">Dump Level Usage</a><br>
<a href="#FILES">FILES</a><br>
<a href="#SEE ALSO">SEE ALSO</a><br>
<a href="#DIAGNOSTICS">DIAGNOSTICS</a><br>
<a href="#BUGS">BUGS</a><br>
<!-- Creator     : groff version 1.16.1  -->
<!-- CreationDate: Wed Jan 24 01:42:51 2001
 -->
<!-- Total number of pages: 5 -->
<!-- Page: 1 -->
<!-- left  margin: 220 -->
<!-- right margin: 750 -->
<a name="NAME"></a><h2>NAME</h2><p style="margin-left: 18%"><font size=3>xfsdump - XFS filesystem incremental dump utility</font></p>
<a name="SYNOPSIS"></a><h2>SYNOPSIS</h2><p style="margin-left: 18%"><font size=3><B>xfsdump</B></font> <font size=3>[</font> <font size=3><B>&shy;a</B></font> <font size=3>] [</font> <font size=3><B>-b</B></font> <font size=3>blocksize ]</font>
<table width="99%" rules="none" frame="none" cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td valign="top" align="left" width="22%">
</p>
</td>
<td valign="top" align="left" width="77%">
<p><font size=3>[</font> <font size=3><B>-c</B></font> <font size=3>media_change_alert_program ] [</font> <font size=3><B>-f</B></font> <font size=3>destination ... ]</font></p>
</td>
</tr>
</table>

<table width="99%" rules="none" frame="none" cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td valign="top" align="left" width="22%">
</p>
</td>
<td valign="top" align="left" width="77%">
<p><font size=3>[</font> <font size=3><B>-l</B></font> <font size=3>level ] [</font> <font size=3><B>-m</B></font> <font size=3>force usage of minimal tape strategy ]</font></p>
</td>
</tr>
</table>

<table width="99%" rules="none" frame="none" cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td valign="top" align="left" width="22%">
</p>
</td>
<td valign="top" align="left" width="77%">
<p><font size=3>[</font> <font size=3><B>-o</B></font> <font size=3>overwrite tape ] [</font> <font size=3><B>-p</B></font> <font size=3>report_interval ]</font></p>
</td>
</tr>
</table>

<table width="99%" rules="none" frame="none" cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td valign="top" align="left" width="22%">
</p>
</td>
<td valign="top" align="left" width="77%">
<p><font size=3>[</font> <font size=3><B>-s</B></font> <font size=3>pathname ... ] [</font> <font size=3><B>-v</B></font> <font size=3>verbosity ] [</font> <font size=3><B>-A</B></font> <font size=3>]</font></p>
</td>
</tr>
</table>

<table width="99%" rules="none" frame="none" cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td valign="top" align="left" width="22%">
</p>
</td>
<td valign="top" align="left" width="77%">
<p><font size=3>[</font> <font size=3><B>-B</B></font> <font size=3>base_id ] [</font> <font size=3><B>-E</B></font> <font size=3>] [</font> <font size=3><B>-F</B></font> <font size=3>] [</font> <font size=3><B>-I</B></font> <font size=3>[ subopt=value ... ] ]</font></p>
</td>
</tr>
</table>

<table width="99%" rules="none" frame="none" cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td valign="top" align="left" width="22%">
</p>
</td>
<td valign="top" align="left" width="77%">
<p><font size=3>[</font> <font size=3><B>-J</B></font> <font size=3>] [</font> <font size=3><B>-L</B></font> <font size=3>session_label ] [</font> <font size=3><B>-M</B></font> <font size=3>media_label ... ]</font></p>
</td>
</tr>
</table>

<table width="99%" rules="none" frame="none" cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td valign="top" align="left" width="22%">
</p>
</td>
<td valign="top" align="left" width="77%">
<p><font size=3>[</font> <font size=3><B>-O</B></font> <font size=3>options_file ] [</font> <font size=3><B>-R</B></font> <font size=3>] [</font> <font size=3><B>-T</B></font> <font size=3>] [</font> <font size=3><B>-Y</B></font> <font size=3>io_ring_length ]</font></p>
</td>
</tr>
</table>

<table width="99%" rules="none" frame="none" cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td valign="top" align="left" width="22%">
</p>
</td>
<td valign="top" align="left" width="77%">
<p><font size=3>[</font> <font size=3><B>-</B></font> <font size=3>] filesystem</font></p>
</td>
</tr>
</table>
</p>
<a name="DESCRIPTION"></a><h2>DESCRIPTION</h2><p style="margin-left: 18%"><font size=3><I>xfsdump</I></font> <font size=3>backs up files and their attributes in a filesystem. The files are dumped to storage media, a regular file, or standard output. Options allow the operator to have all files dumped, just files that have changed since a previous dump, or just files contained in a list of pathnames.</font></p>
<p style="margin-left: 18%"><font size=3>The</font> <font size=3><I>xfsrestore</I></font><font size=3>(8) utility re&shy;populates a filesystem with the contents of the dump.</font></p>
<p style="margin-left: 18%"><font size=3>Each invocation of</font> <font size=3><I>xfsdump</I></font> <font size=3>dumps just one filesystem. That invocation is termed a dump session. The dump session splits the filesystem into one or more dump streams, one per destination. The split is done in filesystem inode number (ino) order, at boundaries selected to equalize the size of each stream. Furthermore, the breakpoints between streams may be in the middle of very large files (at extent boundaries) if necessary to achieve reasonable stream size equalization. Each dump stream can span several media objects, and a single media object can contain several dump streams. The typical media object is a tape cartridge. The media object records the dump stream as one or more media files. A media file is a self&shy;contained partial dump. The portion of a dump stream contained on a media object can be split into several media files. This minimizes the impact of media dropouts on the entire dump stream, and speeds subtree restores.</font></p>
<p style="margin-left: 18%"><font size=3>However, the current implementation in Linux only supports one destination and running single threaded. Therefore, the above comments regarding multiple streams describe the possible future capabilities.</font></p>
<p style="margin-left: 18%"><font size=3><I>xfsdump</I></font> <font size=3>maintains an online dump inventory in</font> <font size=3><I>/var/xfsdump/inventory</I></font><font size=3>. The</font> <font size=3><B>-I</B></font> <font size=3>option displays the inventory contents hierarchically. The levels of the hierarchy are: filesystem, dump session, stream, and media file.</font>
<table width="98%" rules="none" frame="none" cols="3" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td valign="top" align="left" width="18%">
</p>
</td>
<td valign="top" align="left" width="4%">
<p><font size=3><B>-a</B></font></p>
</td>
<td valign="top" align="left" width="76%">
<p><font size=3>Specifies that files for which the Data Migration Facility (DMF) has complete offline copies be dumped as DMF state offline (OFL). This means that the file data will not be dumped by xfsdump, resulting in a smaller dump file. If the file is later restored the file data is still accessible through DMF. However, the current implementation in Linux does not yet support the</font> <font size=3><B>-a</B></font> <font size=3>option.</font></p>
</td>
</tr>
</table>
</p>
<p style="margin-left: 18%"><font size=3><B>-b</B></font> <font size=3><I>blocksize</I></font>
<table width="99%" rules="none" frame="none" cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td valign="top" align="left" width="23%">
</p>
</td>
<td valign="top" align="left" width="76%">
<p><font size=3>Specifies the blocksize to be used for the dump. The same blocksize must be specified to restore the tape. If the</font> <font size=3><B>-m</B></font> <font size=3>option is not used, then</font> <font size=3><B>-b</B></font> <font size=3>does not need to be specified. Instead, a default blocksize of 1Mb will be used.</font></p>
</td>
</tr>
</table>
</p>
<p style="margin-left: 18%"><font size=3><B>-c</B></font> <font size=3><I>media_change_alert_program</I></font>
<table width="99%" rules="none" frame="none" cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td valign="top" align="left" width="23%">
</p>
</td>
<td valign="top" align="left" width="76%">
<p><font size=3>Use the specified program to alert the operator when a media change is required. The alert program is typically a script to send a mail or flash a window to draw the operator's attention.</font></p>
</td>
</tr>
</table>
</p>
<p style="margin-left: 18%"><font size=3><B>-f</B></font> <font size=3><I>destination</I></font>
<table width="99%" rules="none" frame="none" cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td valign="top" align="left" width="23%">
</p>
</td>
<td valign="top" align="left" width="76%">
<p><font size=3>Specifies a dump destination. A dump destination can be the pathname of a device (such as a tape drive), a regular file or a remote tape drive (see</font> <font size=3><I>rmt</I></font><font size=3>(8)). This option must be omitted if the standard output option (a lone</font> <font size=3><B>-</B></font> <font size=3>preceding the source filesystem specification) is specified.</font></p>
</td>
</tr>
</table>
</p>
<p style="margin-left: 18%"><font size=3><B>-l</B></font> <font size=3><I>level</I></font>
<table width="99%" rules="none" frame="none" cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td valign="top" align="left" width="23%">
</p>
</td>
<td valign="top" align="left" width="76%">
<p><font size=3>Specifies a dump level of 0 to 9. The dump level determines the base dump to which this dump is relative. The base dump is the most recent dump at a lesser level. A level 0 dump is absolute - all files are dumped. A dump level where 1 &lt;=</font> <font size=3><I>level</I></font> <font size=3>&lt;= 9 is</font></p>
</td>
</tr>
</table>
<br>
</p>

<!-- Page: 2  -->
<!-- left  margin: 220 -->
<!-- right margin: 750 -->

<table width="99%" rules="none" frame="none" cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td valign="top" align="left" width="23%">
</td>
<td valign="top" align="left" width="76%">
<p><font size=3>referred to as an incremental dump. Only files that have been changed since the base dump are dumped. Subtree dumps (see the</font> <font size=3><B>-s</B></font> <font size=3>option below) cannot be used as the base for incremental dumps.</font></p>
</td>
</tr>
</table>

<table width="98%" rules="none" frame="none" cols="3" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td valign="top" align="left" width="18%">
</td>
<td valign="top" align="left" width="4%">
<p><font size=3><B>-m</B></font></p>
</td>
<td valign="top" align="left" width="76%">
<p><font size=3>Use the minimal tape protocol for non&shy;scsi tape destinations or remote tape destinations which are not scsi Linux tape drives nor IRIX tape drives. This option cannot be used without specifying a blocksize to be used (see</font> <font size=3><B>-b</B></font> <font size=3>option above).</font></p>
</td>
</tr>
<tr valign="top" align="left">
<td valign="top" align="left" width="18%">
</td>
<td valign="top" align="left" width="4%">
<p><font size=3><B>-o</B></font></p>
</td>
<td valign="top" align="left" width="76%">
<p><font size=3>Overwrite the tape. With this option,</font> <font size=3><I>xfsdump</I></font> <font size=3>does not read the tape first to check the contents. This option may be used if</font> <font size=3><I>xfsdump</I></font> <font size=3>is unable to determine the block size of a tape .</font></p>
</td>
</tr>
</table>
<p style="margin-left: 18%"><font size=3><B>-p</B></font> <font size=3><I>interval</I></font>
<table width="99%" rules="none" frame="none" cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td valign="top" align="left" width="23%">
</p>
</td>
<td valign="top" align="left" width="76%">
<p><font size=3>Causes progress reports to be printed at the specified interval.</font> <font size=3><I>interval is given in seconds.</I></font> <font size=3>The progress report indicates how many files have been dumped, the total number of files to dump, the percentage of data dumped, and the elapsed time.</font></p>
</td>
</tr>
</table>
</p>
<p style="margin-left: 18%"><font size=3><B>-s</B></font> <font size=3><I>pathname</I></font> <font size=3>...</font>
<table width="99%" rules="none" frame="none" cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td valign="top" align="left" width="23%">
</p>
</td>
<td valign="top" align="left" width="76%">
<p><font size=3>Restricts the dump to files contained in the specified pathnames (subtrees). Up to 100 pathnames can be specified. A</font> <font size=3><I>pathname</I></font> <font size=3>must be relative to the mount point of the filesystem. For example, if a filesystem is mounted at</font> <font size=3><I>/d2</I></font><font size=3>, the</font> <font size=3><I>pathname</I></font> <font size=3>argument for the directory</font> <font size=3><I>/d2/users</I></font> <font size=3>is ``users''. A</font> <font size=3><I>pathname</I></font> <font size=3>can be a file or a directory; if it is a directory, the entire hierarchy of files and subdirectories rooted at that directory is dumped. Subtree dumps cannot be used as the base for incremental dumps (see the</font> <font size=3><B>-l</B></font> <font size=3>option above).</font></p>
</td>
</tr>
</table>
</p>
<p style="margin-left: 18%"><font size=3><B>-v</B></font> <font size=3><I>verbosity_level</I></font>
<table width="99%" rules="none" frame="none" cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td valign="top" align="left" width="23%">
</p>
</td>
<td valign="top" align="left" width="76%">
<p><font size=3>Specifies the level of detail of the messages displayed during the course of the dump. The argument can be</font> <font size=3><B>silent</B></font><font size=3>,</font> <font size=3><B>verbose</B></font><font size=3>, or</font> <font size=3><B>trace</B></font><font size=3>. The default is</font> <font size=3><B>verbose</B></font><font size=3>.</font></p>
</td>
</tr>
</table>

<table width="98%" rules="none" frame="none" cols="3" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td valign="top" align="left" width="18%">
</p>
</td>
<td valign="top" align="left" width="4%">
<p><font size=3><B>-A</B></font></p>
</td>
<td valign="top" align="left" width="76%">
<p><font size=3>Do not dump extended file attributes. Unless this option is specified, extended file attributes are dumped. Note that dumps containing extended file attributes cannot be restored with older versions of</font> <font size=3><I>xfsrestore</I></font><font size=3>(8). However, the current implementation in Linux does not yet support the dumping of extended attributes.</font></p>
</td>
</tr>
</table>
</p>
<p style="margin-left: 18%"><font size=3><B>-B</B></font> <font size=3><I>base_id</I></font>
<table width="99%" rules="none" frame="none" cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td valign="top" align="left" width="23%">
</p>
</td>
<td valign="top" align="left" width="76%">
<p><font size=3>Specifies the ID of the dump session upon which this dump session is to be based. If this option is specified, the</font> <font size=3><B>-l</B></font> <font size=3>(level) and</font> <font size=3><B>-R</B></font> <font size=3>(resume) options are not allowed. Instead,</font> <font size=3><B>xfsdump</B></font> <font size=3>determines if the current dump session should be incremental and/or resumed, by looking at the base session's level and interrupted attributes. If the base session was interrupted, the current dump session is a resumption of that base at the same level. Otherwise, the current dump session is an incremental dump with a level one greater than that of the base session. This option allows incremental and resumed dumps to be based on any previous dump, rather than just the most recent.</font></p>
</td>
</tr>
</table>

<table width="98%" rules="none" frame="none" cols="3" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td valign="top" align="left" width="18%">
</p>
</td>
<td valign="top" align="left" width="4%">
<p><font size=3><B>-E</B></font></p>
</td>
<td valign="top" align="left" width="76%">
<p><font size=3>Pre&shy;erase media. If this option is specified, media is erased prior to use. The operator is prompted for confirmation, unless the</font> <font size=3><B>-F</B></font> <font size=3>option is also specified.</font></p>
</td>
</tr>
<tr valign="top" align="left">
<td valign="top" align="left" width="18%">
</td>
<td valign="top" align="left" width="4%">
<p><font size=3><B>-F</B></font></p>
</td>
<td valign="top" align="left" width="76%">
<p><font size=3>Don't prompt the operator. When</font> <font size=3><I>xfsdump</I></font> <font size=3>encounters a media object containing non&shy;xfsdump data,</font> <font size=3><I>xfsdump</I></font> <font size=3>normally asks the operator for permission to overwrite. With this option the overwrite is performed, no questions asked. When</font> <font size=3><I>xfsdump</I></font> <font size=3>encounters end&shy;of&shy;media during a dump,</font> <font size=3><I>xfsdump</I></font> <font size=3>normally asks the operator if another media object will be provided. With this option the dump is instead interrupted.</font></p>
</td>
</tr>
<tr valign="top" align="left">
<td valign="top" align="left" width="18%">
</td>
<td valign="top" align="left" width="4%">
<p><font size=3><B>-I</B></font></p>
</td>
<td valign="top" align="left" width="76%">
<p><font size=3>Displays the</font> <font size=3><I>xfsdump</I></font> <font size=3>inventory (no dump is performed).</font> <font size=3><I>xfsdump</I></font> <font size=3>records each dump session in an online inventory in</font> <font size=3><I>/var/xfsdump/inventory</I></font><font size=3>.</font> <font size=3><I>xfsdump</I></font> <font size=3>uses this inventory to determine the base for incremental dumps. It is also useful for manually identifying a dump session to be restored. Suboptions to filter the inventory display are described later.</font></p>
</td>
</tr>
<tr valign="top" align="left">
<td valign="top" align="left" width="18%">
</td>
<td valign="top" align="left" width="4%">
<p><font size=3><B>-J</B></font></p>
</td>
<td valign="top" align="left" width="76%">
<p><font size=3>Inhibits the normal update of the inventory. This is useful when the media being dumped to will be discarded or overwritten.</font></p>
</td>
</tr>
</table>

<table width="99%" rules="none" frame="none" cols="3" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td valign="top" align="left" width="18%">
</p>
</td>
<td valign="top" align="left" width="43%">
<p><font size=3><B>-L</B></font> <font size=3><I>session_label</I></font></p>
</td>
<td valign="top" align="left" width="38%">
</td>
</tr>
<tr valign="top" align="left">
<td valign="top" align="left" width="18%">
</td>
<td valign="top" align="left" width="43%">
<p><font size=3><span style=" text-indent: 4%;"></span>Specifies a label for the dump session.<br>
<span style=" text-indent: 4%;"></span>characters long.</font></p>
<p><font size=3><B>-M</B></font> <font size=3><I>media_label</I></font></p>
</td>
<td valign="top" align="left" width="38%">
<p><font size=3>It can be any arbitrary string up to 255</font></p>
</td>
</tr>
</table>
<br>
<span style=" text-indent: 4%;"></span><font size=3>Specifies a label for the first media object (for example, tape cartridge) written on the<br>
<span style=" text-indent: 4%;"></span>corresponding destination during the session. It can be any arbitrary string up to 255</font><br>
</p>

<!-- Page: 3  -->
<!-- left  margin: 220 -->
<!-- right margin: 750 -->
<p style="margin-left: 18%"><span style=" text-indent: 4%;"></span><font size=3>characters long. Multiple media object labels can be specified, one for each<br>
<span style=" text-indent: 4%;"></span>destination.</font></p>
<p style="margin-left: 18%"><font size=3><B>-O</B></font> <font size=3><I>options_file</I></font>
<table width="99%" rules="none" frame="none" cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td valign="top" align="left" width="23%">
</p>
</td>
<td valign="top" align="left" width="76%">
<p><font size=3>Insert the options contained in</font> <font size=3><I>options_file</I></font> <font size=3>into the beginning of the command line. The options are specified just as they would appear if typed into the command line. In addition, newline characters (n) can be used as whitespace. The options are placed before all options actually given on the command line, just after the command name. Only one</font> <font size=3><B>-O</B></font> <font size=3>option can be used. Recursive use is ignored. The source filesystem cannot be specified in</font> <font size=3><I>options_file</I></font><font size=3>.</font></p>
</td>
</tr>
</table>

<table width="98%" rules="none" frame="none" cols="3" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td valign="top" align="left" width="18%">
</p>
</td>
<td valign="top" align="left" width="4%">
<p><font size=3><B>-R</B></font></p>
</td>
<td valign="top" align="left" width="76%">
<p><font size=3>Resumes a previously interrupted dump session. If the most recent dump at this dump's level (</font><font size=3><B>-l</B></font> <font size=3>option) was interrupted, this dump contains only files not in the interrupted dump and consistent with the incremental level. However, files contained in the interrupted dump that have been subsequently modified are re&shy;dumped.</font></p>
</td>
</tr>
<tr valign="top" align="left">
<td valign="top" align="left" width="18%">
</td>
<td valign="top" align="left" width="4%">
<p><font size=3><B>-T</B></font></p>
</td>
<td valign="top" align="left" width="76%">
<p><font size=3>Inhibits interactive dialogue timeouts. When the</font> <font size=3><B>-F</B></font> <font size=3>option is not specified,</font> <font size=3><I>xfsdump</I></font> <font size=3>prompts the operator for labels and media changes. Each dialogue normally times out if no response is supplied. This option prevents the timeout.</font></p>
</td>
</tr>
</table>
</p>
<p style="margin-left: 18%"><font size=3><B>-Y</B></font> <font size=3><I>io_ring_length<br>
<span style=" text-indent: 4%;"></span></I>Specify I/O buffer ring length.</font> <font size=3><I>xfsdump</I></font> <font size=3>uses a ring of output buffers to achieve<br>
<span style=" text-indent: 4%;"></span>maximum throughput when dumping to tape drives. The default ring length is 3.<br>
<span style=" text-indent: 4%;"></span>However, this is only supported when running multi&shy;threaded which has not been done<br>
<span style=" text-indent: 4%;"></span>for Linux yet &shy; making this option benign.</font>
<table width="98%" rules="none" frame="none" cols="3" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td valign="top" align="left" width="18%">
</p>
</td>
<td valign="top" align="left" width="4%">
<p><font size=3><B>-</B></font></p>
</td>
<td valign="top" align="left" width="76%">
<p><font size=3>A lone</font> <font size=3><B>-</B></font> <font size=3>causes the dump stream to be sent to the standard output, where it can be piped to another utility such as</font> <font size=3><I>xfsrestore</I></font><font size=3>(8) or redirected to a file. This option cannot be used with the</font> <font size=3><B>-f</B></font> <font size=3>option. The</font> <font size=3><B>-</B></font> <font size=3>must follow all other options and precede the filesystem specification.</font></p>
</td>
</tr>
</table>
</p>
<p style="margin-left: 18%"><font size=3>The filesystem,</font> <font size=3><I>filesystem</I></font><font size=3>, can be specified either as a mount point or as a special device file (for example,</font> <font size=3><I>/dev/dsk/dks0d1s0</I></font><font size=3>). The filesystem must be mounted to be dumped.</font></p>
<a name="NOTES"></a><h2>NOTES</h2><a name="Dump Interruption"></a><h2>Dump Interruption</h2><p style="margin-left: 16%"><font size=3>A dump can be interrupted at any time and later resumed. To interrupt, type control&shy;C (or the current terminal interrupt character). The operator is prompted to select one of several operations, including dump interruption. After the operator selects dump interruption, the dump continues until a convenient break point is encountered (typically the end of the current file). Very large files are broken into smaller subfiles, so the wait for the end of the current file is brief.</font></p>
<a name="Dump Resumption"></a><h2>Dump Resumption</h2><p style="margin-left: 16%"><font size=3>A previously interrupted dump can be resumed by specifying the</font> <font size=3><B>-R</B></font> <font size=3>option. If the most recent dump at the specified level was interrupted, the new dump does not include files already dumped, unless they have changed since the interrupted dump.</font></p>
<a name="Media Management"></a><h2>Media Management</h2><p style="margin-left: 16%"><font size=3>A single media object can contain many dump streams. Conversely, a single dump stream can span multiple media objects. If a dump stream is sent to a media object already containing one or more dumps,</font> <font size=3><I>xfsdump</I></font> <font size=3>appends the new dump stream after the last dump stream. Media files are never overwritten. If end&shy;of&shy;media is encountered during the course of a dump, the operator is prompted to insert a new media object into the drive. The dump stream continuation is appended after the last media file on the new media object.</font></p>
<a name="Inventory"></a><h2>Inventory</h2><p style="margin-left: 16%"><font size=3>Each dump session updates an inventory database in</font> <font size=3><I>/var/xfsdump/inventory</I></font><font size=3>.</font> <font size=3><I>xfsdump</I></font> <font size=3>uses the inventory to determine the base of incremental and resumed dumps.</font></p>
<p style="margin-left: 16%"><font size=3>This database can be displayed by invoking</font> <font size=3><I>xfsdump</I></font> <font size=3>with the</font> <font size=3><B>-I</B></font> <font size=3>option. The display uses tabbed indentation to present the inventory hierarchically. The first level is filesystem. The second level is session. The third level is media stream (currently only one stream is supported). The fourth level lists the media files sequentially composing the stream.</font></p>
<p style="margin-left: 16%"><font size=3>The following suboptions are available to filter the display.</font> <font size=3><B>-I depth=</B></font><font size=3><I>n</I></font> <font size=3>(where</font> <font size=3><I>n</I></font> <font size=3>is 1, 2, or 3) limits the hierarchical depth of the display. When</font> <font size=3><I>n</I></font> <font size=3>is 1, only the filesystem information from the inventory is displayed. When</font> <font size=3><I>n</I></font> <font size=3>is 2, only filesystem and session information are displayed. When</font> <font size=3><I>n</I></font> <font size=3>is 3, only filesystem, session and stream information are displayed.</font> <font size=3><B>-I level=</B></font><font size=3><I>n</I></font><br>
</p>

<!-- Page: 4  -->
<!-- left  margin: 220 -->
<!-- right margin: 750 -->

<table width="99%" rules="none" frame="none" cols="3" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td valign="top" align="left" width="16%">
</td>
<td valign="top" align="left" width="81%">
<p><font size=3>(where</font> <font size=3><I>n</I></font> <font size=3>is the dump level) limits the display to dumps of that particular dump level.</font></p>
</td>
<td valign="top" align="left" width="2%">
</td>
</tr>
<tr valign="top" align="left">
<td valign="top" align="left" width="16%">
</td>
<td valign="top" align="left" width="81%">
<p><font size=3>The display may be restricted to media files contained in a specific media object.<br>
<B>mobjid=</B></font><font size=3><I>value</I></font> <font size=3>(where</font> <font size=3><I>value</I></font> <font size=3>is a media ID) specifies the media object by its media ID.</font></p>
</td>
<td valign="top" align="left" width="2%">
<p><font size=3><B>-I<br>
-I</B></font></p>
</td>
</tr>
</table>
<p style="margin-left: 16%"> <font size=3><B>mobjlabel=</B></font><font size=3><I>value</I></font> <font size=3>(where</font> <font size=3><I>value</I></font> <font size=3>is a media label) specifies the media object by its media label. Similarly, the display can be restricted to a specific filesystem.</font> <font size=3><B>-I mnt=</B></font><font size=3><I>host&shy;qualified_mount_point_pathname</I></font> <font size=3>(that is, hostname:pathname), identifies the filesystem by mountpoint.</font> <font size=3><B>-I fsid=</B></font><font size=3><I>filesystem_id</I></font> <font size=3>identifies the filesystem by filesystem ID.</font> <font size=3><B>-I dev=</B></font><font size=3><I>host&shy;qualified_device_pathname</I></font> <font size=3>(that is, hostname:device_pathname) identifies the filesystem by device.</font></p>
<p style="margin-left: 16%"><font size=3>More than one of these suboptions, separated by commas, may be specified at the same time to limit the display of the inventory to those dumps of interest. However, at most four suboptions can be specified at once: one to constrain the display hierarchy depth, one to constrain the dump level, one to constrain the media object, and one to constrain the filesystem.</font></p>
<p style="margin-left: 16%"><font size=3>For example,</font> <font size=3><B>-I depth=1,mobjlabel=&quot;tape 1&quot;,mnt=host1:/test_mnt</B></font> <font size=3>would display only the filesystem information (depth=1) for those filesystems that were mounted on</font> <font size=3><I>host1:/test_mnt</I></font> <font size=3>at the time of the dump, and only those filesystems dumped to the media object labeled &quot;tape 1&quot;.</font></p>
<p style="margin-left: 16%"><font size=3>Dump records may be removed (pruned) from the inventory using the</font> <font size=3><I>xfsinvutil</I></font> <font size=3>program.</font></p>
<p style="margin-left: 16%"><font size=3>An additional media file is placed at the end of each dump stream. This media file contains the inventory information for the current dump session. This is currently unused.</font></p>
<p style="margin-left: 16%"><font size=3>When operating in the miniroot environment,</font> <font size=3><I>xfsdump</I></font> <font size=3>does not create and does not reference the inventory database. Thus incremental and resumed dumps are not allowed.</font></p>
<a name="Labels"></a><h2>Labels</h2><p style="margin-left: 16%"><font size=3>The operator can specify a label to identify the dump session and a label to identify a media object. The session label is placed in every media file produced in the course of the dump, and is recorded in the inventory.</font></p>
<p style="margin-left: 16%"><font size=3>The media label is used to identify media objects, and is independent of the session label. Each media file on the media object contains a copy of the media label. An error is returned if the operator specifies a media label that does not match the media label on a media object containing valid media files. Media labels are recorded in the inventory.</font></p>
<a name="UUIDs"></a><h2>UUIDs</h2><p style="margin-left: 16%"><font size=3>UUIDs (Universally Unique Identifiers) are used in three places: to identify the filesystem being dumped (using the filesystem UUID, see</font> <font size=3><I>xfs</I></font><font size=3>(5) for more details), to identify the dump session, and to identify each media object. The inventory display (</font><font size=3><B>-I</B></font><font size=3>) includes all of these.</font></p>
<a name="Dump Level Usage"></a><h2>Dump Level Usage</h2><p style="margin-left: 16%"><font size=3>The dump level mechanism provides a structured form of incremental dumps. A dump of level</font> <font size=3><I>level</I></font> <font size=3>includes only files that have changed since the most recent dump at a level less than</font> <font size=3><I>level</I></font><font size=3>. For example, the operator can establish a dump schedule that involves a full dump every Friday and a daily incremental dump containing only files that have changed since the previous dump. In this case Friday's dump would be at level 0, Saturday's at level 1, Sunday's at level 2, and so on, up to the Thursday dump at level 6.</font></p>
<p style="margin-left: 16%"><font size=3>The above schedule results in a very tedious restore procedure to fully reconstruct the Thursday version of the filesystem;</font> <font size=3><I>xfsrestore</I></font> <font size=3>would need to be fed all 7 dumps in sequence. A compromise schedule is to use level 1 on Saturday, Monday, and Wednesday, and level 2 on Sunday, Tuesday, and Thursday. The Monday and Wednesday dumps would take longer, but the worst case restore requires the accumulation of just three dumps, one each at level 0, level 1, and level 2.</font></p>
<a name="FILES"></a><h2>FILES</h2><p style="margin-left: 18%"><font size=3>/var/xfsdump/inventory dump inventory database</font></p>
<a name="SEE ALSO"></a><h2>SEE ALSO</h2><p style="margin-left: 18%"><font size=3>rmt(8), xfsrestore(8), xfsinvutil(8), attr_get(2).</font></p>
<a name="DIAGNOSTICS"></a><h2>DIAGNOSTICS</h2><p style="margin-left: 18%"><font size=3>The exit code is 0 on normal completion, non&shy;zero if an error occurs or the dump is terminated by the operator.</font></p>
<p style="margin-left: 18%"><font size=3>The message ``xfsdump: WARNING: unable to open directory: ino N: Invalid argument''</font><br>
</p>

<!-- Page: 5  -->
<!-- left  margin: 220 -->
<!-- right margin: 750 -->
<p style="margin-left: 18%"><font size=3>can occur with filesystems which are actively being modified while</font> <font size=3><I>xfsdump</I></font> <font size=3>is running. This can happen to either directory or regular file inodes - affected files will not end up in the dump, files below affected directories will be placed in the</font> <font size=3><I>orphanage</I></font> <font size=3>directory by</font> <font size=3><I>xfsrestore</I></font><font size=3>.</font></p>
<a name="BUGS"></a><h2>BUGS</h2><p style="margin-left: 18%"><font size=3><I>xfsdump</I></font> <font size=3>does not dump unmounted filesystems.</font></p>
<p style="margin-left: 18%"><font size=3>The dump frequency field of</font> <font size=3><I>/etc/fstab</I></font> <font size=3>is not supported.</font></p>
<p style="margin-left: 18%"><font size=3><I>xfsdump</I></font> <font size=3>uses the alert program only when a media change is required.</font></p>
<p style="margin-left: 18%"><font size=3><I>xfsdump</I></font> <font size=3>requires root privilege (except for inventory display).</font></p>
<p style="margin-left: 18%"><font size=3><I>xfsdump</I></font> <font size=3>can only dump XFS filesystems.</font></p>
<p style="margin-left: 18%"><font size=3>The media format used by</font> <font size=3><I>xfsdump</I></font> <font size=3>can only be understood by</font> <font size=3><I>xfsrestore</I></font><font size=3>.</font></p>
<p style="margin-left: 18%"><font size=3><I>xfsdump</I></font> <font size=3>does not know how to manage CD&shy;ROM or other removable disk drives.</font></p>
<p style="margin-left: 18%"><font size=3><I>xfsdump</I></font> <font size=3>can become confused when doing incremental or resumed dumps if on the same machine you dump two XFS filesystems and both filesystems have the same filesystem identifier (UUID). Since</font> <font size=3><I>xfsdump</I></font> <font size=3>uses the filesystem identifier to identify filesystems,</font> <font size=3><I>xfsdump</I></font> <font size=3>maintains one combined set of dump inventories for both filesytems instead of two sets of dump inventories. This scenario can happen only if</font> <font size=3><I>dd</I></font> <font size=3>or some other block&shy;by&shy;block copy program was used to make a copy of an XFS filesystem. See</font> <font size=3><I>xfs_copy</I></font><font size=3>(8) and</font> <font size=3><I>xfs</I></font><font size=3>(5) for more details.</font><br>
</p>
</body>
</html>