Apple Xsan Documentation
Apple Guides
- Xsan 2 Administrator’s Guide
- Xsan 2 Setup Guide
- Xsan 2 Migration Guide (Third Edition)
- Xsan 2 Technology Overview
Man pages (Xsan 2.2.1)
User commands
- man1/cvadmin.1.html – Xsan administration (start/stop/show volumes, view storage pools and edit quotas)
- man1/cvaffinity.1.html – List and set affinities
- man1/cvcp.1.html – Xsan optimized copy
- man1/cvdb.1.html – Xsan debugger
- man1/cvdbset.1.html – Xsan debugger control
- man1/cvfs.1.html – init.d script
- man1/cvfs_failover.1.html – Xsan failover
- man1/cvfsck.1.html – Check consistency and repair Xsan volumes
- man1/cvfsid.1.html – displays SNFS identifiers (Storenext)
- man1/cvgather.1.html – collects debug information
- man1/cvlabel.1.html – configures Xsan file system disks
- man1/cvmkdir.1.html – creates a directory or change its affinity
- man1/cvmkfile.1.html – preallocates a file
- man1/cvmkfs.1.html – filesystem initialization
- man1/cvsginfo.1.html – displays informations about storage pools
- man1/cvupdatefs.1.html – commits a configuration change to the system (run cvfsck before)
- man1/cvversions.1.html – displays FSM revision, build level and creation date
- man1/mount_acfs.1.html – mount helper
- man1/sndiskmove.1.html – migrates the contents of a disk to a new disk
- man1/snfsdefrag.1.html – defragments and reallocate data to affinities
- man1/snmetadump.1.html – dumps the volume’s metadata
Configuration files
- man4/cvfail.4.html – config run after failover
- man4/cvfs_config.4.html – physical and logical layout of an individual volume
- man4/cvpaths.4.html – specifies specific paths for LUN scanning
- man4/fsmlist.4.html – contains the name of the volume to start
- man4/fsnameservers.4.html – manages FS name coordinator(s)
- man4/fsports.4.html – provides a way to constrain the TCPand UDP ports used by the Xsan server processes
- man4/fsroutes.4.html – deprecated
System administrator’s commands
- man8/cvfsd.8.html – internal kernel thread used for communication with FSM
- man8/cvfsdb.8.html – unknown
- man8/fsm.8.html – manages the volume’s name space, allocations, and metadata coherency
- man8/fsmpm.8.html – FSM portmapper (Apple internal use only !)
- man8/xsanctl.8.html – provides a basic control facility for the Xsan file system
Developper documentation
Config files
[volume].cfg | M | Volume settings |
volume-auxdata.plist | M | Additional volume settings |
fsmlist | M | Volume autostart list |
fsnameservers | M+C | Controller list |
automount.plist | M+C | Volumes to mount and their mount options |
config.plist | M+C | Private Xsan Admin configuration information |
notification.plist | M+C | Notification settings (emails) |
notes/ | M+C | Xsan Admin entered notes |
uuid | M+C | Unique computer identification information |
licence.dat | M+C | licensing information for StorNext clients |
.auth_secret | M+C | shared secret file for use with StorNext clients |
M = Metadata Controller ; C = Client