'\" t '\" See man(1) (e.g., on Solaris) about man page preprocessing .\" snfs.cfgx.5: auto-generated, DO NOT EDIT .\" .\" Copyright 2009-2025. Quantum Corporation. All Rights Reserved. .\" StorNext is either a trademark or registered trademark of .\" Quantum Corporation in the US and/or other countries. .\" .\" Code start macro .de Cs .sp .ft C .in +0.3i .nf .. .\" Code end macro .de Ce .fi .in -0.3i .ft R .. .\" Example file macro .de Fs .RS .Cs .in 0i .. .de Fe .in 0.3i .Ce .RE .. .\" Not recommended message macro .de Nr \fINOTE\fR: Not intended for general use. Only use when recommended by Apple Support. .. .\" Attribute definition (first argument underlined, the rest space separated) .de Ah .sp .in -0.2i \(bu .ft I \\$1 .ft R .in +0.2i .. .TH snfs.cfgx 5 "August 2025" "Xsan File System" .SH NAME snfs.cfgx \- Xsan Volume Configuration File .SH SYNOPSIS This page describes the XML-format file system configuration file first introduced in StorNext 4.0 (the configDoc element will have a version attribute of "1.0"). It is an XML 1.0 compliant format, and is hierarchical in nature. All elements and attributes are case-sensitive. .PP See .BR snfs_config (5) for details and descriptions of specific fields in this file and for a more general overview of file system configuration. .PP See .BR sncfgedit (8) for the best way to edit a configuration file from the commandline. .PP A volume name is associated to its configuration file by the file's prefix. For example, if the volume were named \fBprojecta\fR, then its configuration file would be .IR /Library/Preferences/Xsan/projecta.cfgx . There may be multiple volumes simultaneously mounted, with an FSM program running for each active volume. Configuration files must reside on the same system as the FSM processes that use them. .SH ELEMENTS The following describes the elements in hierarchical depth-first order. See EXAMPLE CONFIGURATION FILE to see all the elements together. .SS configDoc The main element of the config is a \fBconfigDoc\fR. This sets up the XML namespace via the \fIxmlns\fR attribute and specifies the version of the configuration format via the \fIversion\fR attribute. The configDoc contains all configuration information for the Xsan Volume described by the file. .Ah xmlns Setup the xml namespace. If this is set to "snfs", no additional work is required. If it is setup like this: .Cs xmlns:snfs="http://www.quantum.com/snfs" .Ce .PP each element in the document must be prefixed with "snfs:" to explicitly add them to the snfs namespace. .Ah version The format version. Currently must be "1.0". .PP Currently, the only element the \fBconfigDoc\fR contains is a single \fBconfig\fR element. .PP .SS config Each \fBconfig\fR element contains one \fBglobals\fR element, one \fBdiskTypes\fR element, and one \fBstripeGroups\fR element. It also contains the following attributes: .Ah configVersion A generation number for the configuration file. This typically increases by one every time a changed version of the configuration is written to disk. .Ah fsMade Not used in this release .Ah requestType Not used in this release .Ah name A string denoting the name of the file system .Ah fsBlockSize The block size of the file system. As of StorNext 5, the block size is fixed at 4096. A value other than 4096 may be specified for a file system that has been upgraded, in which case the size when the file system was created is used. .Ah journalSize The size of the file system's journal. Must be at least 1024 times larger than the fsBlockSize. .PP .SS globals The \fBglobals\fR element contains all global variable elements. .PP The following table lists the globals, their default values, and the valid range of values for each: .RS -0.5i .TS tab(:); l r r r. Variable Name:Default:Min:Max _ affinityPreference:false:false:true .T& l r r s l r r r. allocationStrategy:round:round, fill, balance allocSessionReservationSize:1073741824:134217728:1099511627776 bufferCacheSize:256M:32M:500G caseInsensitive:false:false:true .T& l r l s l r r r. cvRootDir\(dg:"/":valid dir with < 1024 chars debug:00000000:00000000:FFFFFFFF dirWarp\(de:true:false:true enableSpotlight:false:false:true eventFiles\(dg:true:false:true .T& l r r s l r r r. eventFileDir\(dg:special:valid dir with < 1024 chars extentCountThreshold:49152:0:0x1FFFC00 fileLockResyncTimeOut\(dg:20:0:60 filelocks:false:false:true forcePerfectFit\(dg:false:false:true fsCapacityThreshold:0:0:100 globalShareMode:false:false:true globalSuperUser:false:false:true .T& l l s s l r r r. haFsType:HaUnmonitored (values in snfs_config(5)) inodeCacheSize:131072:4096:524288 inodeDeleteMax:special:10:0xFFFFFFFF inodeExpandInc\(de:0:1:17179869184 inodeExpandMax\(de:0:1:17179869184 inodeExpandMin\(de:0:1:17179869184 InodeStripeWidth:4294967296:0:1099511627776 ioTokens:true:false:true maintenanceMode:false:false:true maxLogs:4:1:1000 maxLogSize:16777216:1048576:1073741824 namedStreams:false:false:true opHangLimitSecs:180:0:0xFFFFFFFF perfectFitSize:32768:4096:17179869184 quotas:false:false:true quotaHistoryDays:7:0:3650 remoteNotification\(dg:false:false:true renameTracking:false:false:true reservedSpace\(dg:true:false:true metadataArchive\(dg:false:false:true .T& l r r s l r r r. metadataArchiveDir\(dg:special:valid dir with < 1024 chars metadataArchiveSearch\(dg:YES:NO:YES metadataArchiveDays\(dg:0:0:366 metadataArchiveCache\(dg:2GB:1GB:500GB securityModel:legacy:legacy, acl, unixpermbits spotlightUseProxy:false:false:true storageManager:false:false:true stripeAlignSize:-1:-1:0xFFFFFFFF trimOnClose\(dg:0:0:(2^64)-1 .T& l r r s l r r r. unixIdMapping:algorithmic:algorithmic, ldap unixDirectoryCreationModeOnWindows:0755:0:0777 unixFileCreationModeOnWindows:0644:0:0777 unixIdFabricationOnWindows:true:false:true unixIdMapping:algorithmic::none, algorithmic, winbind unixNobodyGidOnWindows:60001:0:0x7FFFFFFF unixNobodyUidOnWindows:60001:0:0x7FFFFFFF useL2bufferCache:true:false:true _ Security Model Variables _ useActiveDirectorySFU:true:false:true windowsSecurity:true:false:true .T& l r r s l s s s l r r r. windowsIdMapping:ldap:ldap, mdc, none _ XSan-specific Variables _ enforceACLs:false:false:true spotlightSearchLevel:ReadWrite:FsSearch:ReadWrite _ .TE .RE .PP \(dg .Nr .PP \(de \fINOTE:\fR Deprecated and will no longer be valid in a future release .PP \fBDeprecated global options\fR .PP The following global option has been deprecated: .PP \fBAllocSessionReservation\fR .PP The \fBAllocSessionReservation\fR parameter has been replaced by the \fBallocSessionReservationSize\fR parameter. The old parameter is ignored but warnings are issued to indicate what to do in some cases. .PP .PP .SS autoAffinities The \fBautoAffinities\fR element contains one or more \fBautoAffinity\fR and/or \fBnoAffinity\fR elements. .PP .SS autoAffinity The \fBautoAffinity\fR element defines a mapping of extensions to the given affinity. It contains one or more \fBextension\fP elements and has one attribute: .Ah affinity The \fBAffinity\fP for this mapping. .SS extension Each extension element within the \fBautoAffinity\fP element contains a file name extension to map to this \fBAffinity\fP. The extension string is case insensitive. The extension string can be empty which means all files not matching any extension in any mapping. .PP Put together it looks like this: .Cs dpx mov mp3 wav .Ce .SS noAffinity The \fBnoAffinity\fR element defines a mapping of extensions to no affinity, i.e. an affinity value of 0. It contains one or more \fBextension\fP elements in the same format as \fBautoAffinity\fP. .PP Put together it looks like this: .Cs txt html .Ce .SS diskTypes The \fBdiskTypes\fR element contains one or more \fBdiskType\fR elements. .PP .SS diskType The \fBdiskType\fR element defines a single disk type. It has three attributes: .Ah typeName The name by which this disk type will be referenced in subsequent \fBdisk\fR elements .Ah sectors The number of sectors this disk type contains .Ah sectorSize The size of each sector for this disk type .PP Put together it looks like this: .Cs .Ce .SS stripeGroups The \fBstripeGroups\fR element contains one or more \fBstripeGroup\fR elements. .SS stripeGroup The \fBstripeGroup\fR element contains a storage pool definition. A stripegroup element contains an optional \fBaffinities\fR element and one or more \fBdisk\fR elements. It also has several attributes associated with it: .Ah index A non-negative integer denoting the order of the storage pool within the file system. .Ah name A string containing the name of the storage pool .Ah status \fBup\fR or \fBdown\fR .Ah metadata \fBtrue\fR if the storage pool contains metadata, \fBfalse\fR otherwise. .Ah journal \fBtrue\fR if the storage pool contains the journal, \fBfalse\fR otherwise. Only one storage pool per file system may contain a journal. .Ah userdata \fBtrue\fR if the storage pool contains userdata, \fBfalse\fR otherwise. .Ah stripeBreadth The number of bytes to write to each disk in the storage pool before moving to the next disk. .Ah multipathMethod One of the following multipath methods: rotate|static|sticky|balance|cycle .Ah read \fBtrue\fR or \fBfalse\fR. .Ah write \fBtrue\fR to enable writes and new allocations to the stripe group, or \fBfalse\fR to disable writes and allocations. .Ah alloc \fBtrue\fR to enable new allocations to the stripe group, or \fBfalse\fR to disable allocations. .Ah realTimeIOs Maximum number of I/O operations per second available to real-time applications for the stripe group using the \fBQuality of Service (QoS)\fR API. .Ah realTimeIOsReserve I/Os that should be reserved for applications not using the QoS API. .Ah realTimeMB Maximum number of MBs per second available to real-time applications for the stripe group using the \fBQoS\fR API. .Ah realTimeMBReserve MBs per second that should be reserved for applications not using the QoS API. .Ah realTimeTokenTimeout A non-negative integer indicating the number of seconds for the \fBFSM\fR server to wait for clients to respond to a \fBQoS\fR token callback before timeout. .PP A stripegroup element looks like the following: .Cs .Ce .SS affinities The \fBaffinities\fR element is only valid in storage pools that have \fIuserdata\fR="true". It contains one or more \fBaffinity\fR elements. It has one attribute. .Ah exclusive If \fIexclusive\fR is \fBtrue\fR, only files that have the affinities defined for the storage pool associated with them will be allocated in the storage pool. If \fIexclusive\fR is \fBfalse\fR, file with the associated affinities will be steered to this storage pool but other files may be allocated in this storage pool as well. .SS affinity The \fBaffinity\fR element defines an affinity to be associated with the storage pool. An affinity is a sequence of up to 8 characters. Up to 512 affinities may be associated with a given storage pool. .PP For example: .Cs MyAff1 .Ce .SS disk A \fBdisk\fR element defines a disk to use in the storage pool. It contains the following attributes: .Ah index Defines the order within the storage pool. Cannot be changed after the file system is made. .Ah diskLabel The label of the disk. See .BR cvlabel (8) for details on how to create labels. .Ah diskType The name of a defined disk type .Ah ordinal The global order of the disks in the file system configuration. Cannot be changed after the file system is made. .PP For example: .Cs .Ce .SH EXAMPLE CONFIGURATION FILE .Fs false false round HaUnmonitored 33554432 / false 00000000 49152 false false false 20 false 0 true 32768 0 0 0 0 4294967296 true 4 false false false 300 131072 false 7 false false 0 false -1 0 true 644 false 755 60001 60001 true legacy ldap false true true 1073741824 false dpx mov mp3 wav txt html Video Audio .Fe .SH FILES .I /Library/Preferences/Xsan/*.cfgx .br .I /System/Library/Filesystems/acfs.fs/Contents/examples/example.cfgx .br .IR /Library/Logs/Xsan/data/ /config_history/*.cfgx. .SH "SEE ALSO" .BR snfs_config (5), .BR snfs.cfg (5)