OpenAFS Reference Manual

 
User Commands
afsIntroduction to AFS commands
afsmonitorMonitors File Servers and Cache Managers
aklogObtain tokens for authentication to AFS
cmdebugReports the status of a host Cache Manager
dlogAuthenticates to the DCE Security Service
dpassReturns the DCE password for a new DCE account
fsIntroduction to the fs command suite
fs_aproposDisplays each help entry containing a keyword string
fs_checkserversDisplays the status of server machines
fs_checkvolumesForces the Cache Manager to update volume information
fs_cleanaclRemove obsolete entries from an ACL
fs_copyaclCopies an ACL from a directory to one or more other directories
fs_diskfreeShows data about the partition housing a directory or file
fs_examineShows data about the volume containing a directory or file
fs_exportafsConfigures export of AFS to clients of other file systems
fs_flushForces the Cache Manager to discard a cached file or directory
fs_flushallForce the AFS Cache Manager to discard all data
fs_flushmountForces the Cache Manager to discard a mount point
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_getclientaddrsDisplays the client interfaces to register
fs_getcryptDisplays the state of encryption for AFS file transfers
fs_getserverprefsDisplays preference ranks for file servers or VL servers
fs_helpDisplays help for fs commands
fs_listaclDisplays ACLs
fs_listaliasesDisplays the current list of aliases for AFS cells
fs_listcellsDisplays the database server machines known to the Cache Manager
fs_listquotaDisplays quota information for a volume
fs_lsmountReports the volume for which a directory is the mount point.
fs_messagesSets whether the Cache Manager writes log messages
fs_minidumpGenerate a minidump from the current afsd service
fs_mkmountCreates a mount point for a volume
fs_newaliasCreates a new alias for a cell
fs_newcellChanges the kernel-resident list of a cell's database servers
fs_quotaDisplays the quota used in the volume containing a directory or file
fs_rmmountRemoves a mount point
fs_rxstatpeerEnables Rx packet logging in the OpenAFS kernel module
fs_setaclSets the ACL for a directory
fs_setcachesizeSets the size of the disk cache
fs_setcellConfigures permissions for setuid programs from specified cells
fs_setclientaddrsSets the client interfaces to register with the File Server
fs_setcryptEnables of disables the encryption of AFS file transfers
fs_setquotaSets the quota for the volume containing a file or directory
fs_setserverprefsSets the preference ranks for file servers or VL servers
fs_setvolSet quota and messages for a volume containing a file or directory
fs_storebehindEnables asynchronous writes to the file server
fs_sysnameReports or sets the CPU/operating system type
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_wscellReturns the name of the cell to which a machine belongs
klogAuthenticates with the Authentication Server
knfsEstablishes authenticated access via the NFS/AFS Translator
kpasswdChanges the issuer's password in the Authentication Database
livesysReports the configured CPU/operating system type
package_testTests the validity of a package configuration file
pagshCreates a new PAG
ptsIntroduction to the pts command suite
pts_adduserAdds a user or machine to a Protection Database group
pts_aproposDisplays each help entry containing a keyword string
pts_chownChanges the owner of a Protection Database entry
pts_creategroupCreates an (empty) Protection Database group entry
pts_createuserCreates a user or machine entry in the Protection Database
pts_deleteDeletes a Protection Database entry
pts_examineDisplays a Protection Database entry
pts_helpDisplays help for pts commands
pts_interactiveEnters interactive mode
pts_listentriesDisplays all users or groups in the Protection Database
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 Database group
pts_renameChanges the name of a Protection Database entry
pts_setfieldsSets privacy flags or quota for a Protection Database 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
rxdebugProvides debugging trace of Rx activity
rxgenStub generator for the Rx remote procedure call package
scoutMonitors the File Server process
symlinkIntroduction to the symlink command suite
symlink_listShow the file to which a symlink points
symlink_makeCreate a symbolic link
symlink_removeRemove a symbolic link.
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 server process
unlogDiscards all of the issuer's tokens
upRecursively copy directories, preserving AFS metadata
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_changeaddrChanges or removes a file server machine's entry in the VLDB
vos_changelocChange a volume's entry in the VLDB
vos_cloneCreates a shared-space copy of a volume on a partition
vos_convertROtoRWConverts a Read-Only volume into a Read/Write volume
vos_copyMake a copy of a volume
vos_createCreates a read/write volume and associated VLDB entry
vos_delentryRemoves a volume entry from the VLDB.
vos_dumpConverts a volume into ASCII format and writes it to a file
vos_examineShows volume header and VLDB entry information for a volume
vos_helpDisplays help for vos commands
vos_listaddrsDisplays all VLDB server entries
vos_listpartDisplays all AFS partitions on a file server machine
vos_listvldbDisplays a volume's VLDB entry
vos_listvolDisplays information from a volume header
vos_lockLocks a VLDB volume entry
vos_moveMoves a read/write volume to another site
vos_offlineTakes a volume offline
vos_onlineBrings a volume online
vos_partinfoReports the available and total space on a partition
vos_releaseUpdates read-only volumes to match the read/write source volume
vos_removeRemoves a volume from a site
vos_remsiteRemoves a read-only site definition from a VLDB entry
vos_renameRenames a volume
vos_restoreConverts an ASCII dump file into an AFS volume
vos_shadowCreates a shadow copy of a volume on a different server/partition
vos_sizeComputes the size of a volume dump
vos_statusReports a Volume Server's status
vos_syncservVerifies VLDB entries that mention a specified site
vos_syncvldbVerifies VLDB entries for volumes residing at specified site
vos_unlockUnlocks a single VLDB entry
vos_unlockvldbUnlocks several locked VLDB entries
vos_zapRemoves a volume from its site without writing to the VLDB
xstat_cm_testDisplays data collections from the Cache Manager
xstat_fs_testDisplays data collections from the File Server process
 
Configuration and Data Files
AuthLog.dir, AuthLog.pagLog of Authentication Server privileged operations
AuthLogTraces Authentication Server operations
BackupLogTraces Backup Server operations
BosConfigDefines server processes for the BOS Server to monitor
BosLogTraces BOS Server operations
CellAliasMaps cell names to aliases in /afs
CellServDBLists the database server machines in AFS cells
FORCESALVAGEForces salvage of entire partition
FileLogTraces File Server operations
KeyFileDefines AFS server encryption keys
NetInfoDefines machine interfaces to register with AFS servers
NetRestrictDefines interfaces not to register with AFS servers
NoAuthDisables authorization checking
SALVAGE.fsTriggers salvaging of AFS server partitions
SalvageLogTraces Salvager operations
ThisCellDefines the local cell name
UserListDefines privileged administrators
VLLogTraces Volume Location Server operations
VolserLogTraces Volume Server operations
afsIntroduction to AFS files
afs_cacheFormat of data stored in an AFS client disk cache
afs_volume_headerRepresents an AFS volume
afsmonitorProvides instructions for the afsmonitor command
afszcm.catError message catalog for debugging the Cache Manager
bdb.DB0, bdb.DBSYS1Contain the Backup Database and associated log
butcDefines Tape Coordinator instructions for automated tape devices
butc_logsMessage logs from the Tape Coordinator process
cacheinfoDefines configuration parameters for the Cache Manager
fms.logRecords output from the fms command
kaserver.DB0, kaserver.DBSYS1The Authentication Database and associated log
kaserverauxdbRecords failed authentication attempts
packageProvides instructions for the package command
prdb.DB0, prdb.DBSYS1Contain the Protection Database and associated log
salvage.lockPrevents multiple simultaneous salvage operations on a partition
sysidLists file server machine interface addresses registered in VLDB
tapeconfigDefines parameters for tape devices and backup data files
ussProvides instructions for the uss add command
uss_bulkProvides instructions for the uss bulk command
vldb.DB0, vldb.DBSYS1Contain the Volume Location Database and associated log
 
Administrator Commands
afsdInitializes the Cache Manager and starts related daemons
asetkeyAdd a key from a keytab to an AFS KeyFile
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
bos_addkeyAdds a new server encryption key to the KeyFile file
bos_adduserAdds a privileged user to the UserList 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_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 UserList file
bos_pruneRemoves obsolete files from /usr/afs/bin and /usr/afs/logs
bos_removehostRemoves a database server machine from the CellServDB file
bos_removekeyRemoves a server encryption key from the KeyFile file
bos_removeuserRemoves a privileged user from the UserList 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_setcellnameSets the cell's name in ThisCell and CellServDB
bos_setrestartSets when the BOS Server restarts processes
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
bos_utilManipulate the AFS server Keyfile
bosserverInitializes the BOS Server
buserverInitializes the Backup Server
butcInitializes the Tape Coordinator process
fileserverInitializes the File Server component of the fs process
fmsDetermine a tape's capacity and a tape device's filemark size
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
ka-forwarderForward AFS Authentication Server requests to another server
kadb_checkChecks the integrity of the Authentication Database
kasIntroduction to the kas command suite
kas_aproposDisplays each help entry containing a keyword string
kas_createCreates an entry in the Authentication Database
kas_deleteDeletes an entry from the Authentication Database
kas_examineDisplays information from an Authentication Database entry
kas_forgetticketDiscards all tickets for the issuer
kas_helpDisplays help for kas commands
kas_interactiveEnters interactive mode
kas_listDisplays all entries in the Authentication Database
kas_listticketsDisplays all of the issuer's tickets (tokens)
kas_noauthenticationDiscards an authenticated identity in interactive mode
kas_quitLeaves interactive mode
kas_setfieldsSets fields in an Authentication Database entry
kas_setpasswordChanges the key field in an Authentication Database entry
kas_statisticsDisplays statistics from an Authentication Server process
kas_stringtokeyConverts a character string into an octal key
kas_unlockUnlocks a locked user account
kaserverInitializes the Authentication Server
kdbDisplays log or privileged actions performed by the Authentication Server
kpwvalidChecks quality of new password
packageConfigures files and directories on the local disk
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 fs process
salvageserverInitializes the Salvageserver component of the dafs process
upclientInitializes the client portion of the Update Server
upserverInitializes the server portion of the Update Server
ussIntroduction to the uss command suite
uss_addCreates a user account
uss_aproposDisplays each help entry containing a keyword string.
uss_bulkExecutes multiple uss commands listed in a file
uss_deleteDeletes a user account
uss_helpDisplays help for uss commands
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
volserverInitializes the Volume Server component of the fs process
xfs_size_checkVerifies proper IRIX inode configuration