nfsadmin

NAME

nfsadmin - Windows command-line utility to manage Server for NFS, Client for NFS, and Gateway for NFS

SYNOPSIS

nfsadmin server [computer] [-u user [-p pwd]] 
nfsadmin server [computer] [-u user [-p pwd]] -l 
nfsadmin server [computer] [-u user [-p pwd]] -r {client | all}
nfsadmin server [computer] [-u user [-p pwd]] { start | stop} 
nfsadmin server [computer] [-u user [-p pwd]] config option[...]
nfsadmin server [computer] [-u user [-p pwd]] creategroup name 
nfsadmin server [computer] [-u user [-p pwd]] listgroups 
nfsadmin server [computer] [-u user [-p pwd]] deletegroup name 
nfsadmin server [computer] [-u user [-p pwd]] renamegroup oldname newname				 
nfsadmin server [computer] [-u user [-p pwd]] addmembers name host[...]				 
nfsadmin server [computer] [-u user [-p pwd]] listmembers 
nfsadmin server [computer] [-u user [-p pwd]] deletemembers group host[...] 

nfsadmin client [computer] [-u user [-p pwd]] { start | stop} 
nfsadmin client [computer] [-u user [-p pwd]] config option[...] 

nfsadmin gw [computer] [-u user [-p pwd]] { start | stop} 
nfsadmin gw [computer] [-u user [-p pwd]] config option[...] 

DESCRIPTION

The nfsadmin Windows command-line utility administers Server for NFS, Client for NFS, or Gateway for NFS on the local computer or on a remote computer running Windows Services for UNIX version 3.0. If you are logged on with an account that does not have the required privileges, you can specify a user name and password of an account that does. The action performed by nfsadmin depends on the command arguments you supply.

In addition to service-specific command arguments and options, nfsadmin accepts the following:

computer

Specifies the remote computer you want to administer. You can specify the computer using a Windows Internet Name Service (WINS) name or a Domain Name System (DNS) name, or by Internet Protocol (IP) address.

-u usr

Specifies the user name of the user whose credentials are to be used. It might be necessary to add the domain name to the user name in the form domain\username

-p pwd

Specifies the password of the user specified using the -u option. If you specify the -u option but omit the -p option, you are prompted for the user's password.

Administering Server for NFS

Use the nfsadmin server command to administer Server for NFS. The specific action that nfsadmin server takes depends on the command option or argument you specify:

-l

Lists all locks held by clients.

-r {client | all}

Releases the locks held by client or, if all is specified, by all clients.

start

Starts the Server for NFS service.

stop

Stops the Server for NFS service.

config

Specifies general settings for Server for NFS. You must supply at least one of the following options with the config command argument:

mapsvr=server

Sets server as the User Name Mapping server for Server for NFS. Although this option continues to be supported for compatibility with previous versions, you should use the sfuadmin utility instead.

auditlocation={eventlog | file | both | none}

Specifies whether events will be audited and where the events will be recorded. One of the following arguments is required.

eventlog

Specifies that audited events will be recorded only in the Event Viewer application log.

file

Specifies that audited events will be recorded only in the file specified by config fname.

both

Specifies that audited events will be recorded in the Event Viewer application log as well as the file specified by config fname.

none

Specifies that events will not be audited.

fname=file

Sets the file specified by file as the audit file. The default is %sfudir%\log\nfssvr.log

fsize==size

Sets size as the maximum size in megabytes of the audit file. The default maximum size is 7 MB.

audit=[+|-]mount [+|-]read [+|-]write [+|-]create [+|-]delete [+|-]locking [+|-]all

Specifies the events to be logged. To start logging an event, type a plus sign (+) before the event name; to stop logging an event, type a minus sign (-) before the event name. If the sign is omitted, the plus sign is assumed. Do not use all with any other event name.

lockperiod=seconds

Specifies the number of seconds that Server for NFS will wait to reclaim locks after a connection to Server for NFS has been lost and then reestablished or after the Server for NFS service has been restarted.

enabletcp={yes | no}

Specifies whether the Transmission Control Protocol (TCP) protocol will be supported. The default setting is yes.

enableV3={yes | no}

Specifies whether NFS version 3 protocols will be supported. The default setting is yes.

renewauth={yes | no}

Specifies whether client connections will be required to be reauthenticated after the period specified by config renewauthinterval. The default setting is no.

renewauthinterval=seconds

Specifies the number of seconds that elapse before a client is forced to be reauthenticated if config renewauth is set to yes. The default value is 600 seconds.

dircache=size

Specifies the size in kilobytes of the directory cache. The number specified as size must be a multiple of 4 between 4 and 128. The default directory-cache size is 128 KB.

translationfile=[file]

Specifies a file containing mapping information for replacing characters in the names of files when moving them from Windows- to UNIX-based file systems. If file is not specified, then file-name character translation is disabled. For more information on file-name character translation and the format of this file, see File-name character translation. If the value of translationfile is changed, you must restart the server for the change to take effect.

dotfileshidden={yes | no}

Specifies whether files that are created with names beginning with a period (.) will be marked as hidden in the Windows file system and consequently hidden from NFS clients. The default setting is no.

casesensitivelookups={yes | no}

Specifies whether directory lookups will be case sensitive (that is, require exact matching of character case. When casesensitivelookups is set to yes (the default), cdfcase, fatcase, and ntfscase are always set to preserve.

cdfscase={lower | upper | preserve}

Specifies whether the case of characters in the names of file in the compact disc file system (CDFS) will be returned in lower case, upper case, or in the form stored in the directory. The default setting is preserve. This setting cannot be changed if casesensitivelookups is set to yes.

fatcase={lower | upper | preserve}

Specifies whether the case of characters in the names of file in the file allocation table (FAT) file system will be returned in lower case, upper case, or in the form stored in the directory. The default setting is preserve. This setting cannot be changed if casesensitivelookups is set to yes.

ntfscase={lower | upper | preserve}

Specifies whether the case of characters in the names of files in the NTFS file system will be returned in lowercase, uppercase, or in the form stored in the directory. The default setting is preserve. This setting cannot be changed if casesensitivelookups is set to yes.

creategroup name

Creates a new client group, giving it the specified name.

listgroups

Displays the names of all client groups.

deletegroup name

Removes the client group specified by name.

renamegroup oldname newname

Changes the name of the client group specified by oldname to newname

addmembers name host[...]

Adds host to the client group specified by name.

listmembers name

Lists the host computers in the client group specified by name.

deletemembers group host[...]

Removes the client specified by host from the client group specified by group.

If you do not specify a command option or argument, nfsadmin server displays the current Server for NFS configuration settings.

Administering Client for NFS

Use the nfsadmin client command to administer Client for NFS. The specific action that nfsadmin client takes depends on the command argument you specify:

start

Starts the Client for NFS service.

stop

Stops the Client for NFS service.

config

Specifies general settings for Client for NFS. You must supply at least one of the following options with the config command argument:

fileaccess=mode

Specifies the default permission mode of new files created on the NFS share. Specify mode as a three-digit number in the form ogw, where o, g, and w are each a digit representing the access granted the file's owner and group and the world, respectively. The digits must be in the range 0–7 with the following meaning:

• 0: No access
• 1: x (execute access)
• 2: w (write access)
• 3: wx
• 4: r (read access)
• 5: rx
• 6: rw
• 7: rwx

mapsvr=server

Sets server as the User Name Mapping server for Client for NFS. Although this option continues to be supported for compatibility with previous versions, you should use the sfuadmin utility instead.

mtype={hard | soft}

Specifies the default mount type. For a hard mount, Client for NFS continues to retry a failed RPC until it succeeds. For a soft mount, Client for NFS returns failure to the calling application after retrying the call the number of times specified by the retry option.

preferTCP={yes | no}

If set to yes, specifies that TCP is the preferred transport protocol; if set to no (the default), specifies that User Datagram Protocol (UDP) is the preferred transport protocol.

retry=number

Specifies the number of times to try to make a connection for a soft mount. This value must be from 1 to 10, inclusive. The default is 1.

timeout=seconds

Specifies the number of seconds to wait for a connection (remote procedure call). This value must be 0.8, 0.9, or an integer from 1 to 60, inclusive. The default is 0.8.

rsize=size

Specifies the size, in kilobytes, of the read buffer. This value can be 0.5, 1, 2, 4, 8, 16, or 32. The default is 32.

wsize=size

Specifies the size, in kilobytes, of the write buffer. This value can be 0.5, 1, 2, 4, 8, 16, or 32. The default is 32.

perf=default

Restores the following performance settings to default values:

• mtype
• preferTCP
• retry
• timeout
• rsize
• wsize

fileaccess=mode

Specifies the default permission mode for files created on network file system (NFS) servers. The mode argument consists of a three digits from 0 to 7 (inclusive) representing the default permissions granted the user, group, and others (respectively). The digits translate to UNIX-style permissions as follows: 0=none, 1=x, 2=w, 3=wx, 4=r, 5=rx, 6=rw, and 7=rwx. For example, fileaccess=750 gives rwx permission to the owner, rx permission to the group, and no access permission to others.

If you do not specify a command option or argument, nfsadmin client displays the current Client for NFS configuration settings.

Administering Gateway for NFS

Use the nfsadmin gateway command to administer Gateway for NFS. The specific action that nfsadmin gateway takes depends on the command argument you specify:

start

Starts the Gateway for NFS service.

stop

Stops the Gateway for NFS service.

config

Specifies general settings for Gateway for NFS. You must supply at least one of the following options with the config command argument:

mapsvr=server

Sets server as the User Name Mapping server for Gateway for NFS. Although this option continues to be supported for compatibility with previous versions, you should use the sfuadmin utility instead.

fileaccess=mode

Specifies the default permission mode for files created on NFS servers. The mode argument consists of a three digits from 0 to 7 (inclusive) representing the default permissions granted the user, group, and others (respectively). The digits translate to UNIX-style permissions as follows: 0=none, 1=x, 2=w, 3=wx, 4=r, 5=rx, 6=rw, and 7=rwx. For example, fileaccess=750 gives rwx permission to the owner, rx permission to the group, and no access permission to others.

If you do not specify a command option or argument, nfsadmin gateway displays the current Gateway for NFS configuration settings.

SEE ALSO

Server for NFS

Client for NFS

Gateway for NFS