.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "FS 1" .TH FS 1 2024-03-20 OpenAFS "AFS Command Reference" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH NAME fs \- Introduction to the fs command suite .SH DESCRIPTION .IX Header "DESCRIPTION" The commands in the \fBfs\fR command suite constitute the main administrative interface to the Cache Manager on an AFS client machine, which is responsible for fetching AFS data from file server machines on behalf of applications running on the client machine. .PP There are several categories of commands in the \fBfs\fR command suite: .IP \(bu 4 Commands to set and report how the Cache Manager interacts with server machines: \&\fBfs checkservers\fR, \&\fBfs getcellstatus\fR, \&\fBfs getcrypt\fR, \&\fBfs getserverprefs\fR, \&\fBfs getverify\fR, \&\fBfs listcells\fR, \&\fBfs newcell\fR, \&\fBfs setcbaddr\fR, \&\fBfs setcell\fR, \&\fBfs setcrypt\fR, \&\fBfs setserverprefs\fR, \&\fBfs setverify\fR, \&\fBfs sysname\fR, \&\fBfs uuid\fR, and \fBfs wscell\fR. .IP \(bu 4 Commands to administer access control lists (ACLs): \&\fBfs cleanacl\fR, \&\fBfs copyacl\fR, \&\fBfs getcalleraccess\fR, \&\fBfs listacl\fR, and \fBfs setacl\fR. .IP \(bu 4 Commands to administer server machines, volumes or partitions that house a given file or directory: \&\fBfs diskfree\fR, \&\fBfs examine\fR, \&\fBfs getfid\fR, \&\fBfs listquota\fR, \&\fBfs quota\fR, \&\fBfs setquota\fR, \&\fBfs setvol\fR, \&\fBfs whereis\fR, and \fBfs whichcell\fR. .IP \(bu 4 Commands to administer the local client cache and related information: \&\fBfs bypassthreshold\fR, \&\fBfs checkvolumes\fR, \&\fBfs cscpolicy\fR, \&\fBfs flush\fR, \&\fBfs flushall\fR, \&\fBfs flushvolume\fR, \&\fBfs getcacheparms\fR, \&\fBfs listaliases\fR, \&\fBfs newalias\fR, and \fBfs setcachesize\fR. .IP \(bu 4 Commands to administer volume mount points: \&\fBfs lsmount\fR, \&\fBfs mkmount\fR, and \fBfs rmmount\fR. .IP \(bu 4 Commands to control monitoring and tracing: \&\fBfs debug\fR, \&\fBfs memdump\fR, \&\fBfs messages\fR, \&\fBfs minidump\fR, \&\fBfs monitor\fR, \&\fBfs rxstatpeer\fR, \&\fBfs rxstatproc\fR, and \fBfs trace\fR. .IP \(bu 4 A command to administer the Cache Manager's interaction with other file systems: \&\fBfs exportafs\fR. .IP \(bu 4 Commands to obtain help: \&\fBfs apropos\fR and \fBfs help\fR. .IP \(bu 4 A command to display the OpenAFS command suite version: \fBfs version\fR. .PP The Cache Manager and the fs commands use and maintain the following configuration files: .IP \fI/etc/openafs/CellServDB\fR 4 .IX Item "/etc/openafs/CellServDB" Lists the database server machines in the local cell and any foreign cell to which the administrator wishes to enable AFS access for users working on the machine. The database server machines run the Authentication, Backup, Protection and Volume Location (VL) Server processes, which maintain databases of administrative information. For users to access a cell, its \f(CW\*(C`root.cell\*(C'\fR volume must also be mounted in the local cell's AFS file tree. .IP \fI/etc/openafs/ThisCell\fR 4 .IX Item "/etc/openafs/ThisCell" Defines the machine's cell membership with respect to the AFS command suites and Cache Manager access to AFS data. .IP \fI/etc/openafs/cacheinfo\fR 4 .IX Item "/etc/openafs/cacheinfo" Defines configuration parameters for the cache, including its size and whether it is in memory or on disk. .PP In addition, the Cache Manager automatically creates files on the cache partition (by default, \fI/usr/vice/cache\fR for caching and tracking files fetched from file server machines. .PP For more details, see the reference page for each file. .SH OPTIONS .IX Header "OPTIONS" The following flag is available on every command in the fs suite. The reference page for each command also lists it, but it is described here in greater detail. .IP \fB\-help\fR 4 .IX Item "-help" Prints a command's online help message on the standard output stream. Do not combine this flag with any of the command's other options; when it is provided, the command interpreter ignores all other options, and only prints the help message. .SH "PRIVILEGE REQUIRED" .IX Header "PRIVILEGE REQUIRED" The privileges required for fs commands vary more than for other command suites. Pay special attention to the PRIVILEGE REQUIRED section of each command description. .PP The various types of necessary privilege include: .IP \(bu 4 Having permissions on a directory's ACL. For example, creating and removing mount points requires \f(CW\*(C`a\*(C'\fR (administer), \f(CW\*(C`i\*(C'\fR (insert), and \f(CW\*(C`d\*(C'\fR (delete) permissions on the ACL of the directory in which the mount point resides. .IP \(bu 4 Being logged onto the machine as the local superuser \f(CW\*(C`root\*(C'\fR. This is necessary when issuing commands that affect Cache Manager configuration. .IP \(bu 4 Belonging to the system:administrators group in the Protection Database. .IP \(bu 4 No privilege. Many \fBfs\fR commands simply list information. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBafs_cache\fR\|(5), \&\fBCellServDB\fR\|(5), \&\fBThisCell\fR\|(5) \&\fBcacheinfo\fR\|(5), \&\fBfs_apropos\fR\|(1), \&\fBfs_checkservers\fR\|(1), \&\fBfs_checkvolumes\fR\|(1), \&\fBfs_cleanacl\fR\|(1), \&\fBfs_copyacl\fR\|(1), \&\fBfs_cscpolicy\fR\|(1), \&\fBfs_diskfree\fR\|(1), \&\fBfs_examine\fR\|(1), \&\fBfs_exportafs\fR\|(1), \&\fBfs_flush\fR\|(1), \&\fBfs_flushall\fR\|(1), \&\fBfs_flushmount\fR\|(1), \&\fBfs_flushvolume\fR\|(1), \&\fBfs_getcacheparms\fR\|(1), \&\fBfs_getcalleraccess\fR\|(1), \&\fBfs_getcellstatus\fR\|(1), \&\fBfs_getclientaddrs\fR\|(1), \&\fBfs_getcrypt\fR\|(1), \&\fBfs_getfid\fR\|(1), \&\fBfs_getserverprefs\fR\|(1), \&\fBfs_getverify\fR\|(1), \&\fBfs_help\fR\|(1), \&\fBfs_listacl\fR\|(1), \&\fBfs_listaliases\fR\|(1), \&\fBfs_listcells\fR\|(1), \&\fBfs_listquota\fR\|(1), \&\fBfs_lsmount\fR\|(1), \&\fBfs_memdump\fR\|(1), \&\fBfs_messages\fR\|(1), \&\fBfs_minidump\fR\|(1), \&\fBfs_mkmount\fR\|(1), \&\fBfs_monitor\fR\|(1), \&\fBfs_newalias\fR\|(1), \&\fBfs_newcell\fR\|(1), \&\fBfs_quota\fR\|(1), \&\fBfs_rmmount\fR\|(1), \&\fBfs_rxstatpeer\fR\|(1), \&\fBfs_rxstatproc\fR\|(1), \&\fBfs_setacl\fR\|(1), \&\fBfs_setcachesize\fR\|(1), \&\fBfs_setcbaddr\fR\|(1), \&\fBfs_setcell\fR\|(1), \&\fBfs_setclientaddrs\fR\|(1), \&\fBfs_setcrypt\fR\|(1), \&\fBfs_setquota\fR\|(1), \&\fBfs_setserverprefs\fR\|(1), \&\fBfs_setverify\fR\|(1), \&\fBfs_setvol\fR\|(1), \&\fBfs_storebehind\fR\|(1), \&\fBfs_sysname\fR\|(1), \&\fBfs_trace\fR\|(1), \&\fBfs_whereis\fR\|(1), \&\fBfs_whichcell\fR\|(1), \&\fBfs_wscell\fR\|(1) .SH COPYRIGHT .IX Header "COPYRIGHT" IBM Corporation 2000. All Rights Reserved. .PP This documentation is covered by the IBM Public License Version 1.0. It was converted from HTML to POD by software written by Chas Williams and Russ Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.