logo

Manual Pages


Table of Contents

NAME

options - display or set filer options

SYNOPSIS

options [ option value ] ...

DESCRIPTION

options is used to change configurable filer software options. If no options are specified, then options prints the current value of all available options. The default value for most options is off, which means that the option is not set. Changing the value to on enables the option; for most options, the only valid values are on (which can also be expressed as yes, true, or 1) in any mixture of upper and lower case, and off (which can also be expressed as no, false, or 0) in any mixture of upper and lower case. The description of the option will indicate the default if it is not off, and will indicate what values are allowed if it isn't an on/off option. If it is desired to make an option setting permanent, the necessary options command must be placed in the /etc/rc file, as options settings are not preserved across system reboots. The legal options are as follows:

autosupport.enable
Enables/disables the autosupport email notification feature (see na_autosupport(8)). The default is on to cause autosupport mail to be sent.

autosupport.mailhost
Defines the list of up to 5 mailhost names. The host names should be entered as a comma-separated list with no spaces in between. The default is an empty list.

autosupport.to Defines the list of recipients for the autosupport email notification. Up to 5 mail addresses are allowed. Enter the addresses as a comma-separated list with no spaces in between. The default is autosupport@netapp.com.

autosupport.noteto
Defines the list of recipients for the autosupport short note email. Up to 5 mail addresses are allowed. Enter the addresses as a comma-separated list with no spaces in between. The default is a null list to disable short note emails.

autosupport.from
Defines the user to be designated as the sender of the notification. The default is autosupport.

autosupport.doit
Triggers the autosupport daemon to send email notification immediately. A text word entered as the option is sent in the notification subject line and should be used to explain the reason for the notification.

cifs.access_logging_enable
When on, enables the filer to process access logging, or auditing, information. The default is off.

cifs.access_logging.filename
Specifies the active event log file. The file must be in an existing directory in a network share.

cifs.bypass_traverse_checking
When on (the default), directories in the path to a file are not required to have the `X' (traverse) permission. This option does not apply in UNIX qtrees.

cifs.guest_account
Enables a user to get access to the filer provided that either the filer uses a Domain Controller for authentication and the user is not in a trusted domain, or the filer uses the /etc/passwd file or the NIS password database for authentication and the user has no entry in the /etc/passwd or the NIS password database. If this option is set to the name of an account in the password database, a user logging into the filer will be assigned to the guest account if their name is not listed in the password database (when using /etc/passwd or NIS) or if the user is not from a trusted domain (when using a domain controller). The configured user name will be used for the UNIX user ID, group ID, and group set of the specified account. If the option is blank, guest access is disabled.

cifs.home_dir When set to the pathname of a directory, this defines the path to the ``homes directory''. The directories under this path should have the names of users as their names. When a user connects to the filer using CIFS and there is a directory name that exactly matches the user's lower-cased Windows login name, they will see a share of that name (truncated to 12 characters) that is their ``home directory". Only the user can access the home directory using this share. All other users cannot see the share name since they are logged in under a different user.

cifs.idle_timeout
Specifies the amount of idle time in seconds before the filer disconnects a session. An idle session is a session in which a user does not have any files opened on the filer. The value of this option ranges from 600 to 4,000,000 (effectively infinite). The default is 1800.

cifs.netbios_aliases
Provides a comma-separated list of alternative names for the filer. A user can connect to the filer using any of the listed names.

cifs.oplocks.enable
When cifs.oplocks.enable is on (the default), the filer allows clients to use oplocks (opportunistic locks) on files. Oplocks are a significant performance enhancement, but have the potential to cause lost cached data on some networks with impaired reliability or latency, particularly wide-area networks. In general, this option should be disabled only to isolate problems.

cifs.perm_check_use_gid
This option affects security checking for Windows clients of files with UNIX security where the requestor is not the file owner. In all cases Windows client requests are checked against the share-level ACL, then if the requestor is owner, the "user" perms are used to determine the access.

If the requestor is not owner and if perm_check_use_gid is "on" it means files with UNIX security are checked using normal UNIX rules, i.e. if the requestor is a member of the file's owning group the "group" perms are used, otherwise the "other" perms are used.

If the requestor is not owner and if perm_check_use_gid is "off", files with UNIX security style are checked in a way which works better when controlling access via share-level ACLs. In that case the requestor's desired access is checked against the file's "group" permissions, and the "other" permissions are ignored. In effect, the "group" perms are used as if the Windows client were always a member of the file's owning group, and the "other" perms are never used.

The default setting is "on" for new installations. For existing installations, this has the opposite effect of the old "PC-mode" installation setting.

If you do not plan to use share-level ACLs to control access to UNIX security style files (e.g. in a UNIX qtree), you might wish to change this setting to "on."

cifs.save_case By default, the filer preserves the case of CIFS names, even though a case insensitive hash and search is done. Setting this option to OFF forces names to be saved in lower case, avoiding some of the case conversion problems with non-ASCII characters and preventing PC applications from changing the names of files that were created with lower case names from UNIX.

cifs.scopeid NetBIOS scope IDs allow the system administrator to create small workgroups out of a network by partitioning the NetBIOS name space; only clients with the same NetBIOS scope ID as the filer will be able to use the filer as a CIFS server. Normally, the scope ID is a null string, but if the filer is to run in a NetBIOS scope other than the default one, its scope ID must be set to the scope ID of that scope. The scope ID can be changed only when CIFS is not running.

cifs.search_domains
Specifies a list of domains that trust each other to search for a mapped account. The argument for the option is a comma-separated list that is searched in order. If no list is supplied, all domains are searched. You use this option to control searches if you used an asterisk for a domain name in the usermap.cfg file.

cifs.show_snapshot
By default this option is FALSE. The snapshot directory ~snapshot is no longer shown at the root of a share. This is a change in behavior from previous versions. Setting this to TRUE will restore the old behavior. On Windows NT 4 or Windows 95 clients, the user can access snapshots by entering \\filer\share\.snapshot (or ~snapshot or ~snapsht) in the Start->Run menu. Snapshots can also be accessed lower in the share by providing a path to a lower directory. Snapshots can be accessed through DOS on any system by changing to the ~snapsht directory.

NOTE: When this option is TRUE it can confuse programs like FastFind that don't know about snapshots.

cifs.symlinks.cycleguard
The cifs.symlinks.cycleguard option (on by default), eliminates the possibility of traversing directories cyclically during the process of following symbolic links. With this option set to on, if the target of the symlink resolves to a directory that is directly above the symlink's parent directory, it is disallowed.

With this option set to off, many standard Windows apps (such as Find in Win95 / NT4.0) will not operate correctly when a symlink points to a parent directory. This is because they do not understand symbolic links and will repeatedly loop on them. Users should use caution when changing this option.

cifs.symlinks.enable
When cifs.symlinks.enable is on (the default), if the object being accessed by a CIFS client is a symbolic link (whether absolute or relative), the filer follows the link with the proviso that the ultimate target turns out to reside within the originating share (thus ensuring that the client has access permission to the target).

cifs.trace_login
When cifs.trace_login is on (the default is off), the filer logs all login-related activities. This can be used to diagnose access problems on the filer.

console.encoding
Specifies how non-ASCII character information is presented. The value can be:

nfs - NFS character set. You can use both NFS extended (> 0x7F) and SGML characters for input.

sgml - SGML character format. You can use both NFS extended (greater than 0x7F) and SGML characters for input.

utf8 - UTF-8 character sets. For input, any character greater than 0x7F is the beginning of a UTF-8 encoding.

The default is nfs.

dns.domainname Sets the DNS domainname to the specified domainname.

dns.enable Enables DNS client on the filer. The DNS domain must be set and the /etc/resolv.conf file must exist prior to enabling DNS.

ip.path_mtu_discovery.enable
Enables/disables path MTU discovery; it is currently used only by TCP. Path MTU discovery, described in RFC 1191, allows a host to discover the ``maximum transmission unit'', i.e. the largest link-level packet that can be transmitted, over a path from that host to another host. This means that the filer needn't choose a conservative packet size for a TCP connection to a host not on the same net as the filer, but can attempt to discover the largest packet size that can make it to the other host without fragmentation.

httpd.enable Enables HTTP access to the filer.

httpd.admin.enable
Enables HTTP access to the administration area of the filer through a special URL. This URL begins with /na_admin and is mapped to the directory /etc/http. Thus, a man page on the filer toaster with the file name /etc/http/man/name can be accessed with the URL http://toaster/na_admin/man/name.

httpd.log.max_file_size
Specifies the maximum size that the HTTP log file /etc/log/httpd.log can grow to. The default is 2147483647, which is the largest file size that many clients support.

httpd.rootdir Specifies the complete pathname of the root directory that contains files and subdirectories for HTTP access.

httpd.timeout Specifies the minimum amount of time (in seconds) before an idle HTTP 15 connection will time out. The default is 900 seconds, which is fifteen minutes.

httpd.timewait.enable
When enabled, the filer will put HTTP connections that have been closed by the client into the TIME_WAIT state for one minute, which is twice the maximum segment lifetime (2*MSL). By default, TIME_WAIT state is bypassed for HTTP connections.

ip.match_any_ifaddr
If the option is on, the filer will accept any packet that is addressed to it even if that packet came in on the wrong interface. If you are concerned about security, you should turn this off.

nfs.mount_rootonly
When enabled, the mount server will deny the request if the client is not root user using privileged ports. By default, the feature is enabled for more secure access.

nfs.per_client_stats.enable
Enables/disables the collection and display of per-client NFS statistics, as described in na_nfsstat(1).

nfs.tcp.enable When enabled, the NFS server supports NFS over TCP. By default, the feature is enabled; it can be disabled if there is a problem with some client when using NFS over TCP, and that client cannot be configured to use NFS over UDP.

nfs.v2.df_2gb_lim
Causes the filer to return replies to the "file system statistics" NFS version 2 request that show no more than (2**31)-1 (or 2,147,483,647) total, free, or available bytes (i.e., 2GB) on the file system.

Some NFS clients require this option because, if they get return values from the "file system statistics" request with more than the specified number of bytes, they'll incorrectly compute the amount of free space on the file system, and may think that there's no free space on a file system that has more than 2GB free.

nfs.v3.enable When enabled, the NFS server supports NFS version 3. By default, the feature is enabled; it can be disabled if there is a problem with some client when using NFS version 3, and that client cannot be configured to use NFS version 2.

nfs.webnfs.enable
When enabled, the NFS server supports WebNFS lookups. By default, WebNFS lookups are disabled.

nfs.webnfs.rootdir
Specifies the WebNFS rootdir. Once the rootdir is set, WebNFS clients can issue lookups relative to the rootdir using the public filehandle.

nfs.webnfs.rootdir.set
After specifying the rootdir, this option needs to be enabled for the rootdir setting to take effect. Disabling this option disables the existing rootdir setting.

nis.domainname Sets the NIS domain to the specified domainname.

nis.enable Enables NIS client on the filer. The NIS domain must be set prior to enabling NIS.

nis.group_update_schedule
Specifies the hours of the day when the local NIS group cache has to be updated. `now' will update the cache imediately.

nis.servers Specifies the list of preferred NIS servers. `*' specifies binding by broadcast.

pcnfsd.enable Enables/disables the PCNFSD (PC)NFS authentication request server (see na_pcnfsd(8)).

pcnfsd.umask Specifies the default umask for files created by (PC)NFS clients. The value of this option is a three-digit octal number, and the digits correspond to the read, write, and execute permissions for owner, group, and other, respectively. The default value is 022, which means that files normally created with mode 666 effectively will have mode 644. (``644'' means that the file owner has read and write permissions, but the members of the group and others have only read permission.)

raid.timeout Sets the time in hours, as a number greater than or equal to 1, that the system will run after a single disk failure has caused the system to go into degraded mode. The default is 24. If the raid.timeout option is specified after the system is already in degraded mode, the timeout is set to the value specified and the timeout restarted.

raid.reconstruct_speed
Specifies the speed at which the RAID reconstruction should occur ranging from the slowest speed 1 to the fastest speed possible 10. The RAID reconstruction process is given more cpu time as the speed is increased, so increasing the speed of the reconstruction will take away cpu time for network operations. The default speed is 4, which is roughly 40% of the cpu time, though more time may be used if there is idle time available.

raid.scrub.enable
Enables/disables the RAID scrub feature (see na_disk(1)). By default, it is enabled. This option only affects the scrubbing process that gets started from cron. For user requested scrubs, this option is ignored.

rsh.enable Enables the RSH server on the filer.

snmp.enable Enables the SNMP server on the filer.

telnet.enable Enables the Telnet server on the filer.

telnet.hosts Specifies up to 5 clients that will be allowed telnet access to the server. The host names should be entered as a comma-separated list with no spaces in between. Enter a "*" to allow access to all clients; this is the default. Enter a "-" to disable telnet access to the server.

timed.enable Determines whether a time daemon (timed) runs on the filer. If timed.enable is on, the filer synchronizes its time with a time server.

timed.log
Specifies whether time changes initiated by timed should be logged to the console.

timed.max_skew Specifies the maximum amount of skew between the time reported by the time server and the filer's time that we will allow when synchronizing the time. If the difference in the time reported by the server and the filer's time is greater than this value, the filer will not synchronize to the time reported by the time server. The maximum skew is specified in seconds (suffix s), minutes (suffix m), or hours (suffix h). Defaults to "30m".

timed.proto Specifies the protocol used to synchronize time. "rdate" specifies the "rdate" (RFC 868) protocol; "sntp" specifies the Simple Network Time Protocol (RFC 2030).

timed.sched Specifies the timed synchronization schedule. There are several pre-defined schedules:

hourly
synchronize every hour (the default)

multihourly
synchronize every 6 hours

daily
synchronize every day at midnight.

Custom schedules may also be specified by giving the number of minutes or hours between time sychronization. Minutes are specified by digits followed by an "m"; hours are specified by digits followed by an "h". For example, options timed.sched 2h will cause time to be synchronized every two hours.

To avoid overburdening the time server, the filer randomly selects the exact time of the synchronization within a 20minute window.

timed.servers Specifies up to five time servers used by the time daemon. Time servers are contacted in the order specified; if a server can't be contacted, the time daemon tries the next one in the list.

wafl.convert_ucode
Setting this option to ON forces conversion of all directories to Unicode format when accessed from both NFS and CIFS. By default (OFF), access from CIFS causes conversion of pre-4.0 and 4.0 format directories; access from NFS causes conversion of 4.0 format directories.

vol.copy.throttle
Specifies the default speed of all volume copy operations. The speed can be a number in the range from 1 to 10, 10 being the highest speed and the default.

wafl.create_ucode
Setting this option to ON forces Unicode format directories to be created by default, both from NFS and CIFS. By default(OFF), all directories are created in pre-4.0 format and the first CIFS access will convert it to Unicode format.

wafl.default_nt_user
Specifies the NT user account to use when a UNIX user accesses a file with NT security (has an ACL), and that UNIX user would not otherwise be mapped. If this option is set blank, such accesses will be denied.

wafl.default_unix_user
Specifies the UNIX user account to use when an NT user attempts to log in and that NT user would not otherwise be mapped. If this option is set blank, such accesses will be denied.

wafl.maxdirsize
Sets the maximum size (in K-Bytes) that a directory can grow to. This is set to 10240 by default; it limits directory size to 10M-Bytes and can hold over 300,000 files. Most users should not need to change this setting. This option is useful for environments where system users may grow a directory to a size that starts impacting system performance. When a user tries to create a file in a directory that is at the limit, the system returns a ENOSPC error and fails the create.

wafl.nt_admin_priv_map_to_root
When on (the default), an NT administrator is mapped to UNIX root.

wafl.root_only_chown
When enabled, only the root user can change the owner of a file. When disabled, non-root users can change the owner of files that they own. When a non-root user changes the owner of a file they own, both the set-UID and set-GID bits of that file are cleared for security reasons. A non-root user is not allowed to give away a file if it would make the recipient overrun its user quota. wafl.root_only_chown is enabled by default.

wafl.wcc_minutes_valid
Specifies the number of minutes a WAFL credential cache entry is valid. The value can can range from 1 through 20160. The default is 20.

Multiple options can be set at once in an options command. For example:

   options nfs.tcp.enable on nfs.v2.df_2gb_lim on raid.timeout 48

sets nfs.tcp.enable to on, sets nfs.v2.df_2gb_lim to on, and sets raid.timeout to 48.

CLUSTER CONSIDERATIONS

In general, each filer in a cluster has its own options that are independent of the options of its partner. After a takeover, the live filer uses its own option settings or its partner's option settings, depending on whether the live filer operates in partner mode.

However, a few options must have the same setting for both filers in a cluster for takeover to work properly. If you change the setting for one of these options on one filer, the filer displays a message reminding you to make the same change on the other filer. In takeover mode, the same option values are used for both filers.

The following list of options must have the same value on both filers in a cluster:

  dns.domainname
  dns.enable
  httpd.admin.enable
  httpd.enable
  httpd.timeout
  httpd.timewait.enable
  image.throttle
  ip.path_mtu_discovery.enable
  nfs.per_client_stats.enable
  nfs.tcp.enable
  nfs.v2.df_2gb_lim
  nfs.v3.enable
  nis.domainname
  nis.enable
  nis.group_update_schedule
  nis.servers
  pcnfsd.enable
  raid.timeout
  raid.reconstruct_speed
  raid.scrub.enable
  wafl.maxdirsize
  wafl.root_only_chown

After takeover, you can use the options command in partner mode to modify an option setting for the failed filer. However, the change is lost after the giveback operation.

SEE ALSO

na_disk(1), na_nfsstat(1), na_partner(1), na_snap(1), na_autosupport(8), na_pcnfsd(8).

BUGS

A perfect appliance would need no options (other than, perhaps, a darkness adjustment knob). However, user Nigel Tuffnell reports he likes the raid.reconstruct_speed knob that goes from 1 to 10, but he requests a future enhancement to "go to 11 because it's one better, isn't it?"


Table of Contents