AuriStor File System (AFS) Reference Manual

 
User Commands
afsIntroduction to Auristor File System (AFS) commands
aklogObtain tokens for authentication to Auristor
cmdebugThe Cache Manager Debugging Tool
fsIntroduction to the fs command suite
fs aproposDisplays each help entry containing a keyword string
fs blacklistManages blacklists of filenames and directory names
fs bypassthresholdget/set Cache Bypass file size threshold [LINUX only]
fs checkserversDisplays the status of server machines
fs checkvolumesForces the Cache Manager to refresh volume location information
fs chgrpChanges the group for an object stored within /afs [Windows only]
fs chmodChanges the UNIX mode for an object stored within /afs [Windows only]
fs chownChanges the owner for an object stored within /afs [Windows only]
fs cleanaclRemove obsolete entries from an ACL
fs copyaclCopies an ACL from a file or directory to one or more other
fs disconManage client "disconnected mode"
fs diskfreeShows data about the partition housing a directory or file
fs examineShows data about the volume containing a directory or file
fs flushForces the Cache Manager to discard a cached file or directory
fs flushallForces the Cache Manager to discard all cached files or directories
fs flushmountForces the Cache Manager to forget a mount point target
fs flushvolumeForces the Cache Manager to discard cached data from a volume
fs getcacheparmsDisplays the current size and usage of the cache
fs getcalleraccessShow the current user's access to a file or directory
fs getcellstatusReports whether setuid programs are honored in a cell
fs getcryptDisplays the state of encryption for Cache Manager operations
fs getfidDisplay the fid for a path in /afs
fs getserverprefsDisplays preference ranks for File servers or Location servers
fs getverifyDisplays the state of data verification for Cache Manager store operations [Windows only]
fs helpDisplays help for fs commands
fs listaclDisplays ACLs
fs listaliasesDisplays the current list of cell aliases [UNIX only]
fs listcellsDisplays the location servers known to the Cache Manager
fs listquotaDisplays quota information for a volume
fs lsmountReports the target volume of a mount point
fs memdumpDump Cache Manager state and memory allocations [Windows only]
fs messagesSets whether the Cache Manager writes log messages [UNIX only]
fs minidumpGenerate a minidump from the current afsd service [Windows only]
fs mkmountCreates a mount point for a volume
fs newaliasCreates a new alias for a cell [UNIX only]
fs newcellChanges the Cache Manager list of a cell's location servers
fs quotaDisplays the quota used in the volume containing a directory or file
fs removeaclRemove a file ACL
fs rmmountRemoves a mount point
fs setaclSets the ACL for a file or directory
fs setcachesizeSets the size of the disk cache
fs setcellConfigures permissions for setuid programs from specified cells
fs setcryptModifies the state of encryption for Cache Manager operations
fs setquotaSets the quota for the volume containing a file or directory
fs setserverprefsSets the Cache Manager preference ranks for file servers or location servers
fs setverifyEnables or disables data verification for store data operations [Windows only]
fs setvolSet quota and messages for a volume containing a file or directory
fs storebehindEnables asynchronous writes to the file server [UNIX only]
fs sysnameReports or sets the CPU/operating system type
fs traceEnable or disable Auristor Cache Manager tracing [Windows only]
fs uuidPrints the uuid of the client or generates a new one
fs whereisReports each file server housing a file or directory
fs whichcellReturns the cell to which a file or directory belongs
fs whoamiDisplay the identities seen by the fileserver
fs wscellReturns the name of the cell to which a machine belongs
klog.krb5Authenticates to Kerberos and obtains a token
klog, klog.krbAuthenticates with the Authentication Server
livesysReports the configured CPU/operating system type [UNIX only]
pagshCreates a new PAG [UNIX only but not OSX]
ptsIntroduction to the pts command suite
pts adduserAdds a user, machine or network to a group
pts aproposDisplays each help entry containing a keyword string
pts chownChanges the owner of a Protection Service entry
pts creategroupCreates an (empty) Protection Service group entry
pts createuserCreates a user, machine or network Protection Service entry
pts deleteDeletes a Protection Service entry
pts examineDisplays a Protection Service entry
pts getcpsDisplays the Current Protection Set for one or more entries
pts helpDisplays help for pts commands
pts interactiveEnters interactive mode
pts listentriesDisplays all users or groups managed by the Protection Service
pts listmaxDisplays the max user id and max group id counters
pts listownedShow the Protection Database groups owned by a user or group
pts membershipDisplays the membership list for a user or group
pts quitExit from pts interactive mode
pts removeuserRemoves a user from a Protection group
pts renameChanges the name of a Protection Database entry
pts setaccessSets privacy and authorization flags for Protection Service entries
pts setfieldsSets privacy flags or quota for a Protection Service entry
pts setmaxSets the value of the max group id or max user id counter
pts sleepPauses for a few seconds
pts sourceRead pts commands from a file
pts whoamiDisplays the AFS UID and name for the current user
restorevolRestore a volume from vos dump to the local file system
rxdebugProvides debugging trace of Rx activity
rxperfProvides Rx throughput tests and profiling
symlinkIntroduction to the symlink command suite [Windows only]
symlink listShow the file to which a symlink points [Windows only]
symlink makeCreate a symbolic link [Windows only]
symlink removeRemove a symbolic link [Windows only]
sysReports the compile-time CPU/operating system type
tokensDisplays the issuer's tokens
translate_etTranslates numbered error codes into text messages
udebugReports Ubik process status for a database service instance
unlogDiscards all of the issuer's tokens
vosIntroduction to the vos command suite
vos addsiteAdds a read-only site definition to a volume's VLDB entry
vos aproposDisplays each help entry containing a keyword string
vos backupCreates a backup volume for a single read/write volume
vos backupsysCreates a backup volume for several read/write volumes
vos changelocChange a volume's Location Service registration without File Server contact
vos convertROtoRWConverts a Read-Only volume into a Read/Write volume
vos copyMake a copy of a volume
vos copysiteCopies a readonly volume to another site
vos createCreates a read/write volume listed with the Location Service
vos delentryDelists a volume from the Location Service.
vos dumpConverts a volume into ASCII format and writes it to a file
vos eachfsIterate file servers registered with the Location Service
vos eachvolA volume iteration tool
vos endtransEnds a volserver transaction
vos examineDisplay volume state and location information
vos helpDisplays help for vos commands
vos interactiveEnters interactive mode
vos listfsDisplays all file servers registered with the location service
vos listlocDisplays a volume's location information
vos listmaxaclDisplays the maximum access list for a volume.
vos listpartDisplays all partitions on a file server
vos listseclevelsShows the permitted security classes and levels for a volume.
vos listvolDisplays information from a volume header
vos lockLocks a volume
vos moveMoves a read/write volume to another site
vos movesiteMoves a readonly volume to another site
vos offlineSets a volume's state to offline
vos onlineSets a volume's state to online
vos partinfoReports the available and total space on a partition
vos quitExit from vos interactive mode
vos releaseUpdates read-only volumes to match the read/write source volume
vos removeRemoves a volume from a partition on a file server
vos removefsDeregisters a file server from the location service
vos remsiteRemoves a read-only site definition from the Location Service
vos renameRenames a volume
vos restoreCreates or replaces a volume from a dump file
vos setfieldsSets the quota or clears counters on a volume.
vos setmaxaclSets the maximum access list for a volume.
vos setquotaSets the maximum quota for a volume.
vos setseclevelsSets the permitted security classes and levels for a volume.
vos sizeComputes the size of a volume dump
vos sleepPauses for a few seconds
vos sourceRead vos commands from a file
vos splitvolumeSplit a portion of a volume into a new volume.
vos statusReports a Volume Server's transaction status
vos syncfsVerifies volume location information that mentions a specified site
vos synclocVerifies location information for volumes housed at a specified site
vos unlockUnlocks a single volume
vos unlockallUnlocks all volumes or those located at a specific site
vos zapRemoves a volume from its site without contacting the Location Service
xstat_cm_testDisplays data collections from the Cache Manager
xstat_fs_testDisplays data collections from the File Server process
yfs-upRecursively copy directories, preserving F</afs> metadata
 
C Library Functions
AFS::ukernelUsermode cache manager for AFS
 
Configuration and Data Files
BackupLogTraces Backup Server operations
BosConfigDefines server processes for the BOS Server to monitor
BosLogTraces BOS Server operations
FORCESALVAGEForces salvage of entire partition
FileLogTraces File Server operations
KeyFileExtDefines AuriStor File System server encryption keys
NoAuthDisables authorization checking
PtLogTraces Protection Server operations
ReaderListDefines readonly privileged users for the BOS Overseer Service
SALVAGE.fsTriggers salvaging of AFS server partitions
SalvageLogTraces Salvager operations
UserListExtDefines privileged users for the BOS Overseer Service
VLLogTraces Volume Location Server operations
VolserLogTraces Volume Server operations
afsIntroduction to Auristor files
afszcm.catError message catalog for debugging the Cache Manager
bos.keytabAuriStor File System BOS Service Kerberos v5 Key Table
butcDefines Tape Coordinator instructions for automated tape devices
butc logsMessage logs from the Tape Coordinator process
fms.logRecords output from the fms command
salvage.lockPrevents multiple simultaneous salvage operations on a partition
serverrepo.cert.pemAuriStor packaging repository SSL client key data
serverrepo.key.pemAuriStor packaging repository SSL client key data
sysidLists file server machine interface addresses registered in VLDB
tapeconfigDefines parameters for tape devices and backup data files
vl.keytabAuriStor File System RXGK Service Kerberos v5 Key Table
yfs-client.confAuriStor File System client configuration file
yfs-server.confAuriStor File System server configuration file
 
Miscellaneous
auristor_migrationMigrating to the AuriStor File System from OpenAFS
auristorfs_aclsAuriStor File System Access Control Lists (ACLs)
auristorfs_linux_exportnfsExporting /afs over NFS on Linux
 
Administrator Commands
afsd, afsd.fuseInitializes the Cache Manager and starts related daemons
aklog_dynamic_authLAM module to obtain AFS tokens from Kerberos tickets
asetkeyAdd a key from a keytab to an AFS KeyFileEx
backupIntroduction to the backup command suite
backup adddumpDefines a dump level in the dump hierarchy
backup addhostAdds a Tape Coordinator entry to the Backup Database
backup addvolentryDefines a volume entry in a volume set
backup addvolsetCreates a new (empty) volume set
backup aproposDisplays each help entry containing a keyword string
backup dbverifyChecks the integrity of the Backup Database
backup deldumpDeletes a dump level from the Backup Database
backup deletedumpDeletes one or more dump records from the Backup Database
backup delhostDeletes a Tape Coordinator entry from the Backup Database
backup delvolentryDeletes a volume entry from a volume set
backup delvolsetDeletes one or more volume sets from the Backup Database
backup diskrestoreRestores the entire contents of a partition
backup dumpCreates a dump (dumps a volume set at a particular dump level)
backup dumpinfoDisplays a dump record from the Backup Database
backup helpDisplays help for backup commands
backup interactiveEnters interactive mode
backup jobsLists pending and running operations in interactive mode
backup killTerminates a pending or running operation
backup labeltapeCreates the magnetic label on a tape
backup listdumpsDisplays the dump hierarchy from the Backup Database
backup listhostsLists Tape Coordinators registered in the Backup Database
backup listvolsetsLists volume set entries from the Backup Database
backup quitLeaves interactive mode
backup readlabelReads and displays a tape's label
backup restoredbRestores a saved copy of the Backup Database
backup savedbCreates a saved copy of the Backup Database
backup scantapeExtracts dump information from a tape
backup setexpSets the expiration date for existing dump levels.
backup statusReports a Tape Coordinator's status
backup volinfoDisplays a volume's dump history from the Backup Database
backup volrestoreRestores one or more volumes
backup volsetrestoreRestores all volumes in a volume set
bosIntroduction to the bos command suite
bos addhostAdds a database server machine to the CellServDB file [DEPRECATED]
bos addkeyAdds a new server encryption key to the KeyFile file
bos adduserAdds a privileged user to the UserListExt file
bos aproposDisplays each help entry containing a keyword string
bos createDefines a new process in the BosConfig file and starts it
bos deleteDeletes a server process from the BosConfig file
bos execExecutes a command on a remote server machine
bos getdateDisplays the time stamps on an AFS binary file
bos getlogPrints a server process's log file
bos getrestartDisplays the automatic restart times for server processes
bos getrestrictedDisplays whether a bos server is restricted or not
bos helpDisplays help for bos commands
bos installInstalls a new version of a binary file
bos listhostsDisplays the contents of the CellServDB file
bos listkeysDisplays the server encryption keys from the KeyFile file
bos listusersLists the privileged users from the UserListExt file
bos pruneRemoves obsolete files from /usr/libexec/yfs and /var/log/yfs
bos removehostRemoves a database server machine from the CellServDB file [DEPRECATED]
bos removekeyRemoves a server encryption key from the KeyFile file
bos removeuserRemoves a privileged user from the UserListExt file
bos restartRestarts a server process
bos salvageRestores internal consistency to a file system or volume
bos setauthSets authorization checking requirements for all server processes
bos setrestartSets when the BOS Server restarts processes [DEPRECATED]
bos setrestrictedplace a server in restricted mode
bos shutdownStops a process without changing its status flag
bos startStarts a process after setting its status flag
bos startupStarts a process without changing its status flag
bos statusDisplays the status of server processes
bos stopStops a process after changing its status flag
bos uninstallReverts to the former version of a process's binary file
bosserverInitializes the BOS Server
buserverInitializes the Backup Server
butcInitializes the Tape Coordinator process
fileserverInitializes the File Server component of the dafs process
fmsDetermine a tape's capacity and a tape device's filemark size
fssync-debugIntroduction to the fssync-debug command suite
fssync-debug_attachForces full volume attachment (FSYNC_VOL_ATTACH opcode)
fssync-debug_callbackBreaks callbacks for a volume (FSYNC_VOL_BREAKCBKS opcode)
fssync-debug_detachDetaches a volume (FSYNC_VOL_DONE opcode)
fssync-debug_errorForces volume into hard error state (FSYNC_VOL_FORCE_ERROR opcode)
fssync-debug_headerRetrieves volume disk data structure (FSYNC_VOL_QUERY_HDR opcode)
fssync-debug_leaveoffLeaves a volume offline (FSYNC_VOL_LEAVE_OFF opcode)
fssync-debug_listHistorical sync command (FSYNC_VOL_LISTVOLUMES opcode)
fssync-debug_modeChanges volume attach mode (FSYNC_VOL_NEEDVOLUME opcode)
fssync-debug_moveSets volume moved flag (FSYNC_VOL_MOVE opcode)
fssync-debug_offlineBrings a volume offline (FSYNC_VOL_OFF opcode)
fssync-debug_onlineBrings a volume online (FSYNC_VOL_ON opcode)
fssync-debug_queryDisplays volume structure (FSYNC_VOL_QUERY opcode)
fssync-debug_statsDisplays various statistics
fssync-debug_vgcaddAdd an entry to the VG cache (FSYNC_VG_UPDATE opcode)
fssync-debug_vgcdelDelete an entry from the VG cache (FSYNC_VG_UPDATE opcode)
fssync-debug_vgcqueryDisplays VG cache contents (FSYNC_VG_QUERY opcode)
fssync-debug_vgcscanForce a VG cache rescan (FSYNC_VG_SCAN opcode)
fssync-debug_vgcscanallForce a VG cache rescan on all partitions (FSYNC_VG_SCAN_ALL opcode)
fssync-debug_vnodeDisplay vnode info (FSYNC_VOL_QUERY_VNODE opcode)
fssync-debug_volopDisplay pending volume operation info (FSYNC_VOL_QUERY_VOP opcode)
fstraceIntroduction to the fstrace command suite
fstrace aproposDisplays each help entry containing a keyword string
fstrace clearClears the trace log
fstrace dumpDumps a trace log
fstrace helpDisplays help for fstrace commands
fstrace lslogDisplays information about a log
fstrace lssetReports the status of an event set
fstrace setlogSets the size of a trace log
fstrace setsetSets the status of an event set
genvolGenerates an Auristor volume dump from a file hierarchy
prdb_checkChecks the integrity of the Protection Database
pt_utilLoad or dump a Protection Server database
ptserverInitializes the Protection Server
read_tapeReads volume dumps from a backup tape to a file
salvagerInitializes the Salvager component of the dafs process
salvageserverInitializes the Salvageserver component of the dafs process
ubikcpCopy data from a running ubik database server
upclientInitializes the client portion of the Update Server
upserverInitializes the server portion of the Update Server
vldb_checkChecks the integrity of the VLDB
vldb_convertConvert the VLDB to/from Transarc AFS versions 3.1-3.4a
vlserverInitializes the Volume Location Server
voldumpDump an AFS volume without using the Volume Server
volinfoProduces detailed statistics about AFS volume headers
volscanProduces detailed information about AFS volumes
volserverInitializes the Volume Server component of the dafs process