5. NFS-CONFIG Command Reference

 

This chapter describes the commands you can run from the NFS-CONFIG command line. NFS-CONFIG lets you examine, modify, and save configuration files for the MultiNet NFS system.

To invoke NFS-CONFIG, enter:

$ MULTINET CONFIGURE /NFS

At any NFS-CONFIG prompt, you can list the available commands by typing "?". Online help for each NFS-CONFIG command is available through the NFS-CONFIG HELP command.

Changes do not take effect until you reload the configuration with the NFS-CONFIG RELOAD command. You can also reload the MultiNet NFS Server configuration with the MULTINET NETCONTROL NFS RELOAD and MULTINET NETCONTROL RPCMOUNT RELOAD commands, or by restarting the server with the RESTART command.

For details on configuring MultiNet NFS Client and MultiNet NFS Server, refer to the MultiNet for OpenVMS Installation and Administrator’s Guide.

 

Command Summary

NFS-CONFIG Command Summary  lists the commands you can run from the NFS-CONFIG prompt.

Table 5-1     NFS-CONFIG Command Summary 

NFS-CONFIG Command

Description

ADD DECSTATION-MOUNT-POINT

Adds a particular directory or file to the list of DECstation mount points.

ADD EXPORT

Adds a device or directory to the list of exported mount points.

ADD MOUNT-RESTRICTION

Adds to the list of clients authorized to mount a file system.

ADD NFS-GROUP

Adds systems to a particular NFS group.

ADD NFS-PASSWD-FILE

Specifies the name of a UNIX-style /etc/password file that provides username-to-UID translation information.

ADD UID-TRANSLATION

Creates an individual mapping between an OpenVMS user name and a UID/GID pair.

APPEND

Appends configuration changes to a configuration file.

ATTACH

Detaches the terminal from the calling process and reattaches it to another process.

CURRENT

Selects the mount point to be acted on by the ADD and DELETE commands.

DELETE DECSTATION-MOUNT-POINT

Removes a file or directory from the list of DECstation mount points.

DELETE EXPORTED-FILE-SYSTEM

Removes a device or directory from the list of exported mount points.

DELETE MOUNT-RESTRICTION

Removes a client from the mount restrictions list.

DELETE NFS-GROUP

Removes systems from a particular NFS group.

DELETE NFS-PASSWD-FILE

Deletes an NFS password file entry.

DELETE UID-TRANSLATION

Deletes an OpenVMS username-to-UID/GID translation.

EXIT

Exits the configuration program after saving the current configuration, if it has been modified.

GET

Reads in a configuration file.

HELP

Invokes command help.

NETCONTROL

Transfers control to an NFS configuration manager subsystem that contacts the NETCONTROL server at local or remote sites.

PUSH

Creates a subprocess or attaches to a parent process.

QUIT

Prompts you to save the file before quitting.

RELOAD

Reloads the NFS Client, NFS Server, and RPCMOUNT server databases.

RESTART

Restarts the NFS and RPCMOUNT servers. (Same as WRITE.)

SAV

Saves the configuration parameters.

SELECT

Selects a mount point.

SET APPROXIMATE-TEXT-SIZE-THRESHOLD

Permits UNIX ls commands to execute faster.

SET DIRECTORY-INFO-FLUSH-AGE

Controls how long cached headers and data buffers for a directory can remain in the cache.

SET DIRECTORY-INFO-IDLE-FLUSH-AGE

Controls how long cached headers and data buffers for a directory which is not being accessed by any client can remain in the cache.

SET FILE-CACHE-TIMER-INTERVAL

Determines how often the MultiNet NFS Server scans the cache, checking other parameters to see if their timers have expired, and processes those that have.

SET FILE-INFO-FLUSH-AGE

Controls how long cached headers and data buffers for a file can remain in the cache.

SET FILE-INFO-IDLE-FLUSH-AGE

Controls how long cached headers and data buffers for a file which is not being accessed by any client can remain in the cache.

SET MAXIMUM-CACHE-BUFFERS

Determines the maximum number of cached file headers and data buffers allowed simultaneously for the cache as a whole.

SET MAXIMUM-CACHE-FILES

Determines the maximum number of cached file headers and data buffers allowed simultaneously for the cache as a whole.

SET MAXIMUM-DIRTY-BUFFERS

Specifies the maximum number of modified buffers in the writeback cache.

SET MAXIMUM-FILESYSTEM-BUFFERS

Determines the maximum number of cached file headers and data buffers allowed simultaneously for single file systems on a per-mount-point basis.

SET MAXIMUM-FILESYSTEM-CHANNELS

Determines the maximum number of open channels allowed simultaneously for single file systems on a per-mount-point basis.

SET MAXIMUM-FILESYSTEM-FILES

Determines the maximum number of cached file headers and data buffers allowed simultaneously for single file systems on a per-mount-point basis.

SET MAXIMUM-OPEN-CHANNELS

Determines the maximum number of open channels allowed simultaneously for the cache as a whole.

SET MAXIMUM-QUEUED-REMOVES

Limits the number of remove operations that may be queued in the delete-behind cache.

SET MAXIMUM-WRITE-JOBS

Limits the number of simultaneous write operations that can occur when the writeback cache is enabled.

SET NUMBER-OF-DUPLICATE-REQUESTS-CACHED

Limits the number of requests that can be retained in the NFS Server's duplicate-request detection cache.

SET NUMBER-OF-RPC-TRANSPORTS

Limits the number of simultaneous requests that the NFS Server can process.

SET READ-ONLY-FLUSH-AGE

Limits how long idle channels can remain assigned to a file.

SET READ-WRITE-FLUSH-AGE

Limits how long idle channels can remain assigned to a file.

SET SECONDS-BEFORE-WRITEBACK

Sets the length of time that write operations are deferred before the data is written to disk.

SET USE-DIRECTORY-BLOCKING-ASTS

Determines whether the server flushes the cache whenever an OpenVMS user attempts to access a directory from which cached information came.

SET USE-FILE-BLOCKING-ASTS

Determines whether the server flushes the cache whenever an OpenVMS user attempts to access a file from which cached information came.

SHOW

Displays information about the configuration of the NFS Server and NFS Client.

SPAWN

Executes a single DCL command, or if entered without options, starts a subprocess with the same effect as PUSH.

STATUS

Displays the status of the current configuration.

USE

Reads in a configuration file.

VERSION

Displays the NFS-CONFIG version and release information.

WRITE

Writes the current configuration to a file. (Same as SAVE.)

 


 

ADD DECSTATION-MOUNT-POINT

Adds a directory or file to the list of DECstations mount points using special DECstation-style file handles. You must do this for the root directory and swap or page files used to boot diskless DECstation systems.

FORMAT

ADD DECSTATION-MOUNT-POINT  filename

PARAMETER

filename

Specifies the file name of the DECstation mount point.

EXAMPLE

This example shows adding a DECSTATION-MOUNT-POINT.

NFS-CONFIG>ADD DECSTATION-MOUNT-POINT DECSTATION:[000000]MAXWELL_ROOT.DIR
[Added new DECstation Mount Point "DECSTATION:[000000]MAXWELL_ROOT.DIR;1"]
NFS-CONFIG>


 

ADD EXPORT

Adds a device or directory to the list of exported mount points.

FORMAT

ADD EXPORT  mount_point_name

PARAMETER

mount_point_name

Specifies the name of the file system's mount point.

EXAMPLE

This example shows how to add SYS$SYSDEVICE: to the list of exported file systems.

NFS-CONFIG>ADD EXPORT SYS$SYSDEVICE:
[Added new Exported file system "SYS$SYSDEVICE:"]
[Current Exported File System set to "SYS$SYSDEVICE:"]
NFS-CONFIG>


 

ADD MOUNT-RESTRICTION

Adds a client to the list of authorized clients permitted to mount the specified mount point. If no clients are specified, anyone can access the mount point.

FORMAT

ADD MOUNT-RESTRICTION  mount_point_name client_name

PARAMETERS

mount_point_name

Specifies the name of the mount point to which to add the restriction.

client_name

Specifies the name of the client, in full domain form (for example, SALES.FLOWERS.COM), in abbreviated form (for example, SALES), in IP address form (for example, 192.168.32.4), or NFS group.

Note!     Some clients use the UNIX automount facility, and may require you to use the non-domain form of the host name. Before requesting access to a file system, these clients check the mount restriction list and refuse to attempt the mount request if it is not listed in the recognized format (as opposed to trying the request and letting it fail or succeed).

QUALIFIER

-ro (read only)

Use this qualifier to prevent writing to the disk specified by the mount point. This restriction affects any NFS group associated with that particular mount point.

EXAMPLE

This example shows how to add the client system "sales" to the list of clients authorized to mount SYS$SYSDEVICE:.

NFS-CONFIG>ADD MOUNT-RESTRICTION SYS$SYSDEVICE: SALES
[Added Mount restriction to "SYS$SYSDEVICE:" allowing host "SALES"]
NFS-CONFIG>


 

ADD NFS-GROUP

Adds NFS client systems to a particular NFS group. NFS groups can be used to group together client systems that share common UID/GID spaces. When you specify a UID/GID-to-OpenVMS username mapping with the ADD UID-TRANSLATION command, you can optionally specify an NFS group to associate the translation. This allows you to have different OpenVMS username-to-UID/GID translations for different client hosts (or groups of hosts).

FORMAT

ADD NFS-GROUP  group_name [host_list]

PARAMETERS

group_name

Specifies the NFS group name.

host_list

Contains a comma-delimited list of names of hosts to add to the specified NFS group.

Note!     Some clients utilize the UNIX automount facility and may require you to use the non-domain form of the host name. Before requesting access to a file system, these clients check the mount restriction list, and refuse to attempt the mount request if it is not listed in the recognized format (as opposed to trying the request and letting it fail or succeed).

EXAMPLE

This example shows how to add two client systems to the NFS group ENGINEERING.

NFS-CONFIG>ADD NFS-GROUP ENGINEERING KAOS.COGS.COM, FANG.COGS.COM
[Current NFS Group set to "ENGINEERING"]
NFS-CONFIG>


 

ADD NFS-PASSWD-FILE

Specifies the name of a UNIX-style /etc/password file that provides username-to-UID translation information.

To create a multi-user mapping, use FTP (or another file transfer utility) to copy each applicable      /etc/password file from the UNIX system to the OpenVMS system running the server. Then, run the NFS-CONFIG utility, and use the ADD NFS-PASSWD-FILE command to create the mapping.

FORMAT

ADD NFS-PASSWD-FILE  file_name [group_name]

PARAMETERS

file_name

Specifies the OpenVMS name of the copied /etc/password file.

group_name

Specifies the NFS group name with which the translations specified by the password file will be associated. If not specified, it defaults to the default NFS group (all translations that are not explicitly in a group).

EXAMPLES

This example shows how to add the file MULTINET:NFS.PASSWD to the configuration for the default NFS group.

NFS-CONFIG>ADD NFS-PASSWD-FILE MULTINET:NFS.PASSWD
[Added new NFS Password File "MULTINET:NFS.PASSWD"]
NFS-CONFIG>

This example shows how to add the file MULTINET:NFS.PASSWD to the configuration for the NFS group ENGINEERING.

NFS-CONFIG>ADD NFS-PASSWD-FILE MULTINET:NFS.PASSWD ENGINEERING
[Added new NFS Password File "ENGINEERING/MULTINET:NFS.PASSWD"]
NFS-CONFIG>


 

ADD UID-TRANSLATION

Creates an individual mapping between an OpenVMS user name and a UID/GID pair.

FORMAT

ADD UID-TRANSLATION  username uid gid [group_name]

PARAMETERS

username

Specifies the name of the user's OpenVMS account.

uid

Specifies the user's UID.

gid

Specifies the user's GID.

group_name

Specifies the NFS group name into which this translation is placed (by default, the default NFS group-all translations not explicitly in a group).

EXAMPLES

This example shows how to add a translation between the OpenVMS user JOHN and the UNIX UID 10 and GID 15.

NFS-CONFIG>ADD UID-TRANSLATION JOHN 10 15
[Added UID Translation "JOHN" = 10, 15]
NFS-CONFIG>

This example shows how to add a translation between the OpenVMS user JETSON and the UNIX UID 101 and GID 20 in the NFS group ENGINEERING.

NFS-CONFIG>ADD UID-TRANSLATION JETSON 101 20 ENGINEERING
[Added UID Translation "ENGINEERING/JETSON" = 101, 20]
NFS-CONFIG>


 

APPEND

Adds to or changes the current configuration parameters. The information you want to append is in a text file whose name you specify as an argument. The appended parameters are in effect as long as the current configuration parameters are in memory. When you RELOAD or RESTART NFS, the parameters are reset to those specified in the NFS.CONFIGURATION file.

For the appended changes to become permanent, use the WRITE or EXIT commands, or enter YES when prompted by the RELOAD or RESTART command to save the current configuration.

APPEND is similar to GET, except that it does not reset any unspecified parameters.

FORMAT

APPEND  filename

PARAMETER

filename

Specifies the name of the file you want to append.

EXAMPLE

This example shows how to append the contents of MULTINET:NFS_ALT.CONFIGURATION to the configuration information in the MULTINET:NFS.CONFIGURATION file, then save the enhanced configuration in the MULTINET:NFS.CONFIGURATION file.

$ MULTINET CONFIGURE  /NFS
MultiNet NFS Configuration Utility 5.5 (nnn)
[Reading in NFS file server configuration from MULTINET:NFS.CONFIGURATION]
NFS-CONFIG>APPEND MULTINET:NFS_ALT.CONFIGURATION
[Reading in NFS file server configuration from MULTINET:NFS_ALT.CONFIGURATION]
NFS-CONFIG>SAVE
[Writing configuration to MULTINET:NFS.CONFIGURATION]
$ QUIT


 

ATTACH

Detaches the terminal from the calling process and reattaches it to another process. Use the SPAWN SHOW PROCESS /SUBPROCESSES command to list the names of subprocesses. Use the DCL LOGOUT command to return to the original process. If the MULTINET_DISABLE_SPAWN logical is enabled, ATTACH does not work.

FORMAT

ATTACH process-name

PARAMETER

process-name

Specifies the name of a process to which you want your terminal attached. (Not all subprocesses can be attached; some testing may be required.)

EXAMPLE

$ MULTINET CONFIGURE  /NFS
MultiNet NFS Configuration Utility 5.5 (nnn)
[Reading in configuration from MULTINET:NFS.CONFIGURATION]
NFS-CONFIG>SPAWN
$ MM
MM>SPAWN SHOW PROCESS/SUB
...
There are 3 processes in this job:
_TWA42:
 PROC_1
  PROC_2 (*)
MM>ATTACH  PROC_1
MM>QUIT
$ LOGOUT
NFS-CONFIG>

This example shows the use and exit of attached subprocesses.

1   The first command uses SPAWN to create a subprocess. MM is invoked from the DCL command line. Next, the SPAWN SHOW PROCESS/SUB command is used to list all the subprocess names. The display shows that three subprocesses are active. (Process _TWA42: is NFS-CONFIG, PROC_1 is MM, and PROC_2 is the SPAWN SHOW PROCESS/SUB command.)

2   In the next command, the MM ATTACH command returns control to the NFS-CONFIG process. From this utility, ATTACH returns control to MM. To exit, the QUIT command is invoked from MM, and LOGOUT is invoked at the original spawned DCL command line; control returns to NFS-CONFIG. (If SPAWN SHOW PROCESS/SUB had been entered, only this command and the configuration processes would be active.)


 

CURRENT

Selects the mount point to be acted on by the ADD and DELETE commands if the mount point is not explicitly specified. (Functionally equivalent to SELECT.)

FORMAT

CURRENT  mount_point_name | none

PARAMETER

mount_point_name

Specifies the name of a mount point. A value of NONE unselects the current mountpoint.

EXAMPLE

This example shows how to select the mount point SYS$SYSDEVICE:

NFS-CONFIG>CURRENT SYS$SYSDEVICE:
[Current Exported File System set to "SYS$SYDEVICE:]
NFS-CONFIG>


 

DELETE DECSTATION-MOUNT-POINT

Removes a file or directory from the list of DECstation mount points.

FORMAT

DELETE DECSTATION-MOUNT-POINT  filename

PARAMETER

filename

Specifies the name of the file or directory to delete from the DECstation mount point list.

EXAMPLE

This example shows how to delete a DECstation mount point.

NFS-CONFIG>DELETE DECSTATION-MOUNT-POINT RETURN
Name: DECSTATION:[000000]MAXWELL_ROOT.DIR
NFS-CONFIG>


 

DELETE EXPORTED-FILE-SYSTEM

Removes a device or directory from the list of exported mount points.

FORMAT

DELETE EXPORT  mount_point_name

PARAMETER

mount_point_name

Specifies the name of the file system's mount point.

EXAMPLE

This example shows how to remove SYS$SYSDEVICE: from the list of exported file systems.

NFS-CONFIG>DELETE EXPORT SYS$SYSDEVICE:
NFS-CONFIG>


 

DELETE MOUNT-RESTRICTION

Removes systems from the mount restrictions list.

FORMAT

DELETE MOUNT-RESTRICTION  mount_point_name name

PARAMETERS

mount_point_name

Specifies the name of the file system's mount point.

name

Specifies the name of the client or NFS group to remove from the restriction list.

EXAMPLE

This example shows how to delete the client "sales" from the mount restriction list for SYS$SYSDEVICE:.

NFS-CONFIG>DELETE MOUNT-RESTRICTION SYS$SYSDEVICE: SALES
[Deleted Mount restriction "SALES"]
NFS-CONFIG>


 

DELETE NFS-GROUP

Removes NFS systems from a particular NFS group. When the last client in a group is deleted, the group itself is also deleted from the configuration.

FORMAT

DELETE NFS-GROUP  group_name [host_names]

PARAMETERS

group_name

Specifies the NFS group name.

host_names

Contains a comma-delimited list of host names to delete from the specified NFS group. If no client is specified, or if an asterisk (*) is specified, the group itself will be deleted.

Note!     Some clients utilize the UNIX automount facility, and may require you to use the non-domain form of the host name. Before requesting access to a file system, these clients check the mount restriction list and refuse to attempt the mount request if it is not listed in the recognized format (as opposed to trying the request and letting it fail or succeed).

EXAMPLES

This example shows how to delete the system FANG.COGS.COM from the NFS group ENGINEERING.

NFS-CONFIG>DELETE NFS-GROUP ENGINEERING FANG.COGS.COM
NFS-CONFIG>

This example shows how to delete the NFS group MARKETING.

NFS-CONFIG>DELETE NFS-GROUP MARKETING *
NFS-CONFIG>


 

DELETE NFS-PASSWD-FILE

Deletes an NFS password file entry.

FORMAT

DELETE NFS-PASSWD-FILE  file_name [group_name]

PARAMETERS

file_name

Specifies the OpenVMS name of the copied /etc/password file.

group_name

Specifies the NFS group name with which the translations specified by the password file are associated (by default, the default NFS group-all translations that are not explicitly in a group).

EXAMPLE

This example shows how to delete the file MULTINET:NFS.PASSWD from the NFS password file list for the default NFS group.

NFS-CONFIG>DELETE NFS-PASSWD-FILE MULTINET:NFS.PASSWD
NFS-CONFIG>


 

DELETE UID-TRANSLATION

Deletes an OpenVMS user name-to-UID/GID translation.

FORMAT

DELETE UID-TRANSLATION  [group_name/]username

PARAMETER

[group_name/]username

Specifies the name for the user's OpenVMS account. To delete a UID translation in a group other than the default, specify the group name, a slash, then the OpenVMS user name.

EXAMPLES

This example shows how to delete the user name JOHN from the configuration.

NFS-CONFIG>DELETE UID-TRANSLATION JOHN
NFS-CONFIG>

This example shows how to delete the user name JETSON in the NFS group ENGINEERING from the configuration.

NFS-CONFIG>DELETE UID-TRANSLATION ENGINEERING/JETSON
NFS-CONFIG>


 

EXIT

Saves the current configuration, if it has been modified, then exits the configuration program. Use the STATUS command to display whether the configuration was modified.

FORMAT

EXIT

EXAMPLES

When the configuration has not changed, a message displays indicating that the configuration file is not updated.

$ MULTINET CONFIGURE  /NFS
NFSS-CONFIG>EXIT
$

When the configuration has changed, a message displays indicating that the configuration file has been updated.

$ MULTINET CONFIGURE  /NFS
MultiNet NFS Configuration Utility 5.5(76)
[Reading in NFS file server configuration from MULTINET:NFS.CONFIGURATION]
NFS-CONFIG>GET MULTINET:NFS.CONFIGURATION
NFS-CONFIG>EXIT
$


 

GET

Reads in a configuration file.

FORMAT

GET  filename

PARAMETER

filename

Specifies the file name of the configuration to be read (by default, NETWORK_DEVICES.CONFIGURATION in the current working directory). GET resets any unspecified parameters. To augment the existing configuration, use the APPEND command.

EXAMPLE

This example retrieves the configuration file MULTINET:TEST.CONFIGURATION into the NFS-CONFIG workspace.

$ MULTINET CONFIGURE /NFS
MultiNet NFS Configuration Utility 5.5 (nnn)
[Reading in configuration from MULTINET:NFS.CONFIGURATION]
NFS-CONFIG>GET MULTINET:TEST.CONFIGURATION


 

HELP

Invokes command help.

FORMAT

HELP [topics]

PARAMETER

topics

Contains a space-delimited list of topics that begins with a topic followed by subtopics. The default topic is HELP.


 

NETCONTROL

Transfers control to an NFS configuration manager subsystem that contacts the NETCONTROL server at local or remote sites.

After invoking NETCONTROL, you can issue commands to the NETCONTROL server to affect MULTINET_SERVER operations at that site.

FORMAT

NETCONTROL  [host]

RESTRICTION

The NETCONTROL server is normally protected from unauthorized access by a restriction list.

PARAMETER

host

Specifies the name of the host to which to connect (by default, the local host).

EXAMPLE

$ MULTINET CONFIGURE /NFS
MultiNet NFS Configuration Utility 5.5 (nnn)
[Reading in configuration from MULTINET:NFS.CONFIGURATION]
NFS-CONFIG>NETCONTROL
Connected to NETCONTROL server on "127.0.0.1"
<FLOWERS.COM Network Control 5.5 (nnn) at Mon 15-Mar-2004 7:42am-EST
NFS>


 

PUSH

Starts and attaches a DCL subprocess. If a parent process exists, attach to it. To return from DCL, use the ATTACH or the LOGOUT command. To switch back from a DCL subprocess, use the ATTACH command.

If the MULTINET_DISABLE_SPAWN logical is set, PUSH does not work.

FORMAT

PUSH


 

QUIT

Prompts you to save the current configuration if it was modified, and then exits.

FORMAT

QUIT

EXAMPLE

$ MULTINET CONFIGURE  /NFS
MultiNet NFS Configuration Utility 5.5 (nnn)
[Reading in configuration from MULTINET:NFS.CONFIGURATION]
NFS-CONFIG>GET MULTINET:NFS.CONFIGURATION
NFS-CONFIG>QUIT
Configuration modified, do you want to save it ? [NO]RETURN
$


 

RELOAD

Reloads the NFS and RPCMOUNT server databases, the NFS Client UID/GID translation table, and the NFS group configuration.

If the configuration has been modified since the last save, RELOAD prompts you to save it before reloading. RELOAD allows you to update the NFS UID-translations and exported mount points without flushing the file cache and causing a temporary performance degradation.

FORMAT

RELOAD


 

RESTART

Restarts the MultiNet NFS Server process and reloads the RPCMOUNT server's databases. If the configuration has been modified since the last save, RESTART prompts you to save it before restarting. In general, you should use RELOAD instead of RESTART.

FORMAT

RESTART

EXAMPLE

$ MULTINET CONFIGURE /NFS
MultiNet NFS Configuration Utility 5.5(nnn)
[Reading in NFS server configuration from MULTINET:NFS.CONFIGURATION]
NFS-CONFIG>RESTART
Connected to NETCONTROL server on "127.0.0.1"
< simple.example.com Network Control 5.5(nnn) at Tue 27-Apr-2004 2:27PM
< NFS/RPCLockMgr Server Started
< RPCMOUNT database reloaded
NFS-CONFIG>


 

SAVE

Saves the configuration parameters.

FORMAT

SAVE  [filename]

PARAMETER

filename

Specifies the file name for the configuration file being saved (by default, the file from which the configuration was read).


 

SELECT

Selects the mount point to be acted on by the ADD and DELETE commands if the mount point is not explicitly specified. (Functionally equivalent to CURRENT.)

FORMAT

SELECT  mount_point_name | none

PARAMETER

mount_point_name

Specifies the name of the mount point. A value of NONE unselects the current mountpoint.

EXAMPLE

This example shows how to select the mount point SYS$SYSDEVICE:.

NFS-CONFIG>SELECT SYS$SYSDEVICE:
[Current Exported File System set to "SYS$SYDEVICE:]
NFS-CONFIG>


 

SET APPROXIMATE-TEXT-SIZE-THRESHOLD

When set to a positive value, the MultiNet NFS Server permits UNIX ls commands to execute faster by approximating file sizes when the OpenVMS file length exceeds the specified threshold.

Note!     The NFS specification requires that NFS servers return exact file sizes.

FORMAT

SET APPROXIMATE-TEXT-SIZE-THRESHOLD  threshold

PARAMETER

threshold

Specifies the minimum OpenVMS file length (in bytes) required before the NFS Server approximates the file size.

The client must use the /APPROXIMATE_TEXT_SIZE qualifier as a mount point option for the threshold to take effect.


 

SET DIRECTORY-INFO-FLUSH-AGE

Controls how long cached headers and data buffers for a directory can remain in the cache.

Unless the cache-interrupt parameters are on, cached headers and buffers are not automatically discarded when an OpenVMS user attempts to access their directories on disk. The DIRECTORY-INFO-FLUSH-AGE parameter specifies a period after which the server discards cached information (requiring rereads from disk if the information is needed again).

This parameter is a trade-off between response time and concurrency between information stored in the cache and on the disk.

You can raise or lower the default setting; however, if you set this parameter below 15 seconds, the server cannot complete any directory operations.

FORMAT

SET DIRECTORY-INFO-FLUSH-AGE  seconds

PARAMETER

seconds

Specifies the length of time, in seconds (by default, 300).

EXAMPLE

This example shows how to set the DIRECTORY-INFO-FLUSH-AGE interval to 600 seconds.

NFS-CONFIG>SET DIRECTORY-INFO-FLUSH-AGE 600
NFS-CONFIG>


 

SET DIRECTORY-INFO-IDLE-FLUSH-AGE

This parameter controls how long cached headers and data buffers can remain in the cache for a directory that is not being accessed by any client.

Unless the cache-interrupt parameters are on, cached headers and buffers are not discarded automatically when an OpenVMS user attempts to access their directories on disk. The DIRECTORY-INFO-IDLE-FLUSH-AGE parameter specifies a period after which the server discards cached information unless a client is actively accessing it (requiring rereads from disk if the information is needed again).

This parameter is a trade-off between response time and concurrency between information stored in the cache and on the disk.

You can raise or lower the default setting; however, if you set this parameter below 15 seconds, the server cannot complete any directory operations.

FORMAT

SET DIRECTORY-INFO-IDLE-FLUSH-AGE  seconds

PARAMETER

seconds

Specifies the length of time, in seconds (by default, 150).

EXAMPLE

This example shows how to set the DIRECTORY-INFO-IDLE-FLUSH-AGE interval to 300 seconds.

NFS-CONFIG>SET DIRECTORY-INFO-IDLE-FLUSH-AGE 300
NFS-CONFIG>


 

SET FILE-CACHE-TIMER-INTERVAL

Determines how often the MultiNet NFS Server scans the cache, checking the other parameters to see if their timers have expired, and processes those that have.

FORMAT

SET FILE-CACHE-TIMER-INTERVAL  seconds

PARAMETER

seconds

Specifies the length of time, in seconds (by default, 30).

Note!     The default setting for the FILE-CACHE-TIMER-INTERVAL parameter, 30 seconds, is not changed during configuration.

EXAMPLE

This example shows how to set the FILE-CACHE-TIMER-INTERVAL interval to 15 seconds.

NFS-CONFIG>SET FILE-CACHE-TIMER-INTERVAL 15
NFS-CONFIG>


 

SET FILE-INFO-FLUSH-AGE

Controls how long cached headers and data buffers for a file can remain in the cache.

Unless the cache-interrupt parameters are on, cached headers and buffers are not automatically discarded when an OpenVMS user attempts to access their files on disk. The FILE-INFO-FLUSH-AGE parameter specifies a period after which the server discards cached information (requiring rereads from disk if the information is needed again).

This parameter is a trade-off between response time and concurrency of information stored in the cache and on the disk.

You can raise or lower the default setting; however, if you set this parameter below 15 seconds, the server cannot complete any file operations.

FORMAT

SET FILE-INFO-FLUSH-AGE  seconds

PARAMETER

seconds

Specifies the length of time, in seconds (by default, 1200).

EXAMPLE

This example shows how to set the FILE-INFO-FLUSH-AGE interval to 2400 seconds.

NFS-CONFIG>SET FILE-INFO-FLUSH-AGE 2400
NFS-CONFIG>


 

SET FILE-INFO-IDLE-FLUSH-AGE

Controls how long cached headers and data buffers for a file that is not being accessed by a client can remain in the cache.

Unless the cache-interrupt parameters are on, cached headers and buffers are not automatically discarded when an OpenVMS user attempts to access their files on disk. The FILE-INFO-IDLE-FLUSH-AGE parameter specifies a period after which the server discards cached information unless a client is actively accessing it (requiring rereads from disk if the information is needed again).

This parameter is a trade-off between response time and the concurrency between information stored in the cache and on the disk.

You can raise or lower the default setting; however, if you set this parameter below 15 seconds, the server cannot complete any file operations.

FORMAT

SET FILE-INFO-IDLE-FLUSH-AGE  seconds

PARAMETER

seconds

Specifies the length of time, in seconds (by default, 600).

EXAMPLE

This example shows how to set the FILE-INFO-IDLE-FLUSH-AGE interval to 1200 seconds.

NFS-CONFIG>SET FILE-INFO-IDLE-FLUSH-AGE 1200
NFS-CONFIG>


 

SET MAXIMUM-CACHE-BUFFERS

Determines the maximum number of cached data buffers allowed simultaneously for the cache as a whole.

FORMAT

SET MAXIMUM-CACHE-BUFFERS  buffers

PARAMETER

buffers

Specifies the number of data buffers. Each data buffer holds 16 disk blocks; the default is 3000.

Note!     Unless the setting for MAXIMUM-CACHE-BUFFERS is large enough to allow the cache to hold the largest files the client will access, performance will be severely degraded for those files. Each cached data buffer holds 16 disk blocks.

EXAMPLE

This example shows how to set the MAXIMUM-CACHE-BUFFERS parameter to 250 buffers.

NFS-CONFIG>SET MAXIMUM-CACHE-BUFFERS 250
NFS-CONFIG>


 

SET MAXIMUM-CACHE-FILES

Determines the maximum number of cached file headers allowed simultaneously for the cache as a whole.

FORMAT

SET MAXIMUM-CACHE-FILES  files

PARAMETER

files

Specifies the maximum number of files.

EXAMPLE

This example shows how to set the MAXIMUM-CACHE-FILES parameter to 1500 files.

NFS-CONFIG>SET MAXIMUM-CACHE-FILES 1500
NFS-CONFIG>


 

SET MAXIMUM-DIRTY-BUFFERS

Controls the functions of the optional writeback feature of the directory and file cache. If the writeback cache is enabled by setting the SECONDS-BEFORE-WRITEBACK parameter to a non-zero value, and the number of modified buffers in the cache exceeds this limit, a write operation is started immediately. A value of zero means that there is no limit to the number of buffers the NFS Server can create.

FORMAT

SET MAXIMUM-DIRTY-BUFFERS  buffers

PARAMETER

buffers

Specifies the number of buffers (by default, 0).

EXAMPLE

This example shows how to set the MAXIMUM-DIRTY-BUFFERS parameter to 10 buffers.

NFS-CONFIG>SET MAXIMUM-DIRTY-BUFFERS 10
NFS-CONFIG>


 

SET MAXIMUM-FILESYSTEM-BUFFERS

Determines the maximum number of cached data buffers allowed simultaneously for a single file system on a per-mount-point basis.

FORMAT

SET MAXIMUM-FILESYSTEM-BUFFERS  buffers

PARAMETER

buffers

Specifies the number of data buffers. Each data buffer holds 16 disk blocks; the default is 500.

Note!     Unless the setting for MAXIMUM-FILESYSTEM-BUFFERS is large enough to allow the cache to hold the largest files the client will access, performance will be severely degraded for those files. Each cached data buffer holds 16 disk blocks.

EXAMPLE

This example shows how to set the MAXIMUM-FILESYSTEM-BUFFERS parameter to 250 buffers.

NFS-CONFIG>SET MAXIMUM-FILESYSTEM-BUFFERS 250
NFS-CONFIG>


 

SET MAXIMUM-FILESYSTEM-CHANNELS

Determines the maximum number of open channels allowed simultaneously for a single file system on a per-mount-point basis.

FORMAT

SET MAXIMUM-FILESYSTEM-CHANNELS  channels

PARAMETER

channels

Specifies the maximum number of open channels (by default, 50).

EXAMPLE

This example shows how to set the MAXIMUM-FILESYSTEM-CHANNELS to 10 channels.

NFS-CONFIG>SET MAXIMUM-FILESYSTEM-CHANNELS 10
NFS-CONFIG>


 

SET MAXIMUM-FILESYSTEM-FILES

Determines the maximum number of cached file headers allowed simultaneously for single file systems on a per-mount-point basis.

FORMAT

SET MAXIMUM-FILESYSTEM-FILES  files

PARAMETER

files

Specifies the maximum number of cached files (by default, 3000).

EXAMPLE

This example shows how to set the MAXIMUM-FILESYSTEM-FILES to 1500 files.

NFS-CONFIG>SET MAXIMUM-FILESYSTEM-FILES 1500
NFS-CONFIG>


 

SET MAXIMUM-OPEN-CHANNELS

Determines the maximum number of open channels allowed simultaneously for the cache as a whole.

FORMAT

SET MAXIMUM-OPEN-CHANNELS  channels

PARAMETER

channels

Specifies the maximum number of open channels (by default, 50).

EXAMPLE

This example shows how to set the MAXIMUM-OPEN-CHANNELS to 100 channels.

NFS-CONFIG>SET MAXIMUM-OPEN-CHANNELS 100
NFS-CONFIG>


 

SET MAXIMUM-QUEUED-REMOVES

Sets a limit on the number of remove operations that can be queued in the delete-behind cache.

This parameter affects how client users perceive the speed at which directories and files are deleted. The OpenVMS file deletion operation is very slow. The MultiNet NFS Server uses its delete-behind queue to hide some of the deletion delay from the client user. When a request to delete a directory or file arrives, the request is answered immediately, but usually the delete request is only enqueued to the OpenVMS file system.

The MAXIMUM-QUEUED-REMOVES parameter limits the number of requests that can be enqueued. When that number is reached, the next delete request must wait until the next enqueued request has completed.

Note!     This delay can be significant if the next request is to delete a large directory; directory deletions always occur synchronously, and each file in a directory must be deleted before the directory itself is deleted.

Therefore, the parameter setting defines when, in a series of deletions, the client user will perceive the OpenVMS deletion delay.

FORMAT

SET MAXIMUM-QUEUED-REMOVES  value

PARAMETER

value

Specifies the maximum number of queued operations. A value of 0 disables the delete-behind cache, making all delete operations synchronous. The default is 25.

EXAMPLE

This example shows how to set the MAXIMUM-QUEUED-REMOVES parameter to 10 files.

NFS-CONFIG>SET MAXIMUM-QUEUED-REMOVES 10
NFS-CONFIG>


 

SET MAXIMUM-WRITE-JOBS

Limits the number of simultaneous write operations that can occur when the writeback cache is enabled.

FORMAT

SET MAXIMUM-WRITE-JOBS  limit

PARAMETER

limit

Specifies the maximum number of simultaneous write operations. A value of zero (the default) means there is no limit.

EXAMPLE

This example shows how to set the MAXIMUM-WRITE-JOBS parameter to 5 simultaneous write operations.

NFS-CONFIG>SET MAXIMUM-WRITE-JOBS 5
NFS-CONFIG>


 

SET NUMBER-OF-DUPLICATE-REQUESTS-CACHED

Limits the number of requests that can be retained in the NFS Server's duplicate-request detection cache. The NFS Server uses this cache to store the most recent responses it has sent to clients that request directory and file access.

The duplicate-request detection cache operates with the cache that the RPC protocol module keeps of the transaction IDs (XIDs) of the last 400 requests it has seen. The RPC layer uses its cache to detect duplicate requests.

For example, if the network layer dropped a UDP packet containing a response to a client, the client would repeat the request after an interval, and the RPC protocol would notify the MultiNet NFS Server that the request was a duplicate. The server would look in its duplicate-request detection cache for the response to resend without repeating the original operation.

Note!     Too low a value causes the following error message to display frequently on the OpenVMS console: "Duplicate Detected but not in cache." Too low a value can also cause an incorrect answer to be sent. A value above 400 has the same effect as 400 (400 is the maximum number of XIDs stored by the RPC protocol).

FORMAT

SET NUMBER-OF-DUPLICATE-REQUESTS-CACHED  value

PARAMETER

value

Specifies the size of the duplicate request cache. By default, the cache stores the last 250 responses sent.

EXAMPLE

This example shows how to set the NUMBER-OF-DUPLICATE-REQUESTS-CACHED parameter to 300.

NFS-CONFIG>SET NUMBER-OF-DUPLICATE-REQUESTS-CACHED 300
NFS-CONFIG>


 

SET NUMBER-OF-RPC-TRANSPORTS

Limits the number of client requests that the MultiNet NFS Server can process simultaneously. When the set limit is reached, no new requests are processed until one of the requests in progress completes. Processing multiple requests simultaneously prevents a single client from locking out other clients while it is performing a slow operation.

FORMAT

SET NUMBER-OF-RPC-TRANSPORTS  value

PARAMETER

value

Specifies the number of simultaneous operations. You can change this value to adjust the trade-off between concurrency and memory requirements. The default setting (10) allows the server to process 10 requests simultaneously.

EXAMPLE

This example shows how to set the NUMBER-OF-RPC-TRANSPORTS to 100 transports.

NFS-CONFIG>SET NUMBER-OF-RPC-TRANSPORTS 100
NFS-CONFIG>


 

SET READ-ONLY-FLUSH-AGE

Limits how long idle channels can remain assigned to a file.

Applies to files that have been opened for read operations only; the READ-WRITE-FLUSH-AGE parameter applies to files that have been opened for both read and write operations. Closing a channel does not discard the data in the file headers and data buffers, and clients can continue to access the cached data without requiring that the file be reopened.

You can shorten or lengthen the timer interval to adjust trade-offs between improved response time and the overhead of keeping channels assigned.

FORMAT

SET READ-ONLY-FLUSH-AGE  seconds

PARAMETER

seconds

Specifies the length of time, in seconds (by default,180).

EXAMPLE

This example shows how to set the READ-ONLY-FLUSH-AGE interval to 60 seconds.

NFS-CONFIG>SET READ-ONLY-FLUSH-AGE 60
NFS-CONFIG>


 

SET READ-WRITE-FLUSH-AGE

Limits how long idle channels can remain assigned to a file.

Applies to files that have been opened for read operations only; the READ-WRITE-FLUSH-AGE parameter applies to files that have been opened for both read and write operations. Closing a channel does not discard the data in the file headers and data buffers, and clients can continue to access the cached data without requiring that the file be reopened. However, the file is locked from access via OpenVMS until the NFS Server releases the channel.

You can shorten or lengthen the timer interval to adjust trade-offs between improved response time and the overhead of keeping channels assigned.

FORMAT

SET READ-WRITE-FLUSH-AGE  seconds

PARAMETER

seconds

Specifies the length of time, in seconds (by default, 60).

EXAMPLE

This example shows how to set the READ-WRITE-FLUSH-AGE interval to 15 seconds.

NFS-CONFIG>SET READ-WRITE-FLUSH-AGE 15
NFS-CONFIG>


 

SET SECONDS-BEFORE-WRITEBACK

Sets the length of time write operations are deferred before the data is written to disk.

FORMAT

SET SECONDS-BEFORE-WRITEBACK  seconds

PARAMETER

seconds

Specifies the length of time in seconds. The default (0) disables the writeback cache.

DESCRIPTION

The directory and file cache normally function as a write-through cache. In this case, whenever a client is notified that a write request has completed, the data has been stored on the disk, and data integrity is guaranteed.

The optional writeback feature greatly increases the speed of write operations, as perceived by the user, by notifying the client that write operations are complete when the data is stored in cache memory on the server, but before it is written to disk. This increase in perceived write performance is achieved at the risk of data loss if the OpenVMS server crashes while a write operation is in progress or if, during a write operation, the server encounters an error such as insufficient disk space, insufficient disk quota, or a hardware write error.

When the server is unable to complete a writeback write operation, it discards the write operation, flags the file's cached header to indicate the error, and sends an error message in response to the next request for the file. However, if there is no new request before the affected header is discarded, or if the next request is from another user, data can be lost.

The SECONDS-BEFORE-WRITEBACK parameter determines whether the writeback feature is enabled and specifies how long the server will delay initiating a write operation after receiving data for a write request. The longer the delay, the greater the chance that the server can merge multiple small write operations into fewer, larger, and more efficient operations.

The default setting (0) disables the writeback feature. Any other value enables the feature. The recommended value for writeback delay is 5 seconds; little performance is gained from longer delays.

EXAMPLE

This example shows how to set the SECONDS-BEFORE-WRITEBACK interval to 5 seconds.

NFS-CONFIG>SET SECONDS-BEFORE-WRITEBACK 5
NFS-CONFIG>


 

SET USE-DIRECTORY-BLOCKING-ASTS

Determines whether the server flushes the cache when an OpenVMS user attempts to access a directory from which cached information came.

Enabling blocking ASTs causes the server to discard the cached file header and all data buffers for a directory when an OpenVMS user attempts to access it on disk.

You must enable this parameter to allow PC clients to use the PC-NFSD remote printing function. Enabling this parameter also ensures that client users almost always receive the directory as it exists on disk. This concurrency is at the expense of the overhead of the additional interrupts and disk reads.

FORMAT

SET USE-DIRECTORY-BLOCKING-ASTS  value

PARAMETER

value

Specify this parameter as 1 to enable blocking ASTs on directories (the default), or 0 to disable blocking ASTs.

EXAMPLE

This example shows how to turn off the USE-DIRECTORY-BLOCKING-ASTS parameter.

NFS-CONFIG>SET USE-DIRECTORY-BLOCKING-ASTS 0
NFS-CONFIG>


 

SET USE-FILE-BLOCKING-ASTS

Determines whether the server flushes the cache when an OpenVMS user attempts to access a file from which cached information came.

Enabling blocking ASTs causes the server to discard the cached file header and all data buffers for a file when an OpenVMS user attempts to access it on disk.

You must enable this parameter to allow PC clients to use the PC-NFSD remote printing function. Enabling this parameter also ensures that client users almost always receive the file as it exists on disk. This concurrency is at the expense of the overhead of the additional interrupts and disk reads.

FORMAT

SET USE-FILE-BLOCKING-ASTS  value

PARAMETER

value

Specify this parameter as 1 to enable blocking ASTs on files (the default), or 0 to disable blocking ASTs.

EXAMPLE

This example shows how to turn off the USE-FILE-BLOCKING-ASTS parameter.

NFS-CONFIG>SET USE-FILE-BLOCKING-ASTS 0
NFS-CONFIG>


 

SHOW

Displays information about the configuration of the NFS Server and NFS Client.

FORMAT

SHOW  [mount_point_name] | [option]

PARAMETERS

mount_point_name

Specifies the name of a specific file system's mount point. If not specified, SHOW displays:

  The file system export list — A list of the file systems available to the network. A mount restrictions list appears next to the entry for each file system, showing the clients that can access the file system (unless all clients can access it).

  The UID/GID-to-OpenVMS user name translation list.

  The global parameter list — The names and settings of the server's global parameters.

option

Specifies the set of configuration parameters to be viewed. Accepted values are "exported-file-systems", "nfs-groups", "nfs-passwd-files", "parameters", and "uid-translations".

QUALIFIER

/FULL

Displays information in greater detail. Without /FULL, SHOW truncates the mount restriction list at 80 columns and displays ellipses ( . . . ) to indicate there are more entries. With /FULL, SHOW displays the full mount restriction list and the settings of each global parameter.


 

SPAWN

Executes a single DCL command, or if entered without options, starts a subprocess with the same effect as PUSH. To return from DCL, use the LOGOUT command. If the MULTINET_DISABLE_SPAWN logical is set, SPAWN does not work.

FORMAT

SPAWN [command]

PARAMETER

command

Specifies a command to execute. If you omit command, a DCL command line subprocess is created.

QUALIFIERS

/INPUT=file-spec

Specifies an input file to the command you enter with SPAWN.

/LOGICAL_NAMES
/NOLOGICAL_NAMES

Specifies that logical names and logical name tables are not copied to the subprocess.

/SYMBOLS
/NOSYMBOLS

Specifies that global and local names are not passed to the subprocesses.

/WAIT
/NOWAIT

Returns control without waiting for the command to complete. Do not use this qualifier with commands that have prompts or screen displays.

/OUTPUT=file-spec

Specifies a file that retains the output of the command invoked with SPAWN. This qualifier only works when a single command is entered without creating a DCL subprocess. In addition, this qualifier is positional; you must enter it immediately after SPAWN or other qualifiers.

EXAMPLES

This example displays terminal information, captures the output in a file, then displays the information with the TYPE command.

$ MULTINET CONFIGURE /NFS
MultiNet NFS Configuration Utility 5.5 (nnn)
NFS-CONFIG>SPAWN/OUTPUT=FOO. SHOW TERM
NFS-CONFIG>SPAWN TYPE FOO.
 . .

This example invokes a command procedure.

$ MULTINET CONFIGURE /NFS
MultiNet NFS Configuration Utility 5.5 (nnn)
NFS-CONFIG>SPAWN @COMPROC
 . .

This example displays help information about NFS-CONFIG. Use the LOGOUT command to return control to NFS-CONFIG.

$ MULTINET CONFIGURE /NFS
MultiNet NFS Configuration Utility 5.5 (nnn)
NFS-CONFIG>SPAWN
$ HELP MULTINET CONFIGURE /NFS
 . .
$ LOGOUT
NFS-CONFIG>


 

STATUS

Displays the status of the current configuration.

FORMAT

STATUS

EXAMPLE

$ MULTINET CONFIGURE /NFS
MultiNet NFS Configuration Utility 5.5 (nnn)
[Reading in NFS file server configuration from MULTINET:NFS.CONFIGURATION]
NFS-CONFIG>STATUS
This is the MultiNet NFS configuration program Version 5.5(76)
There are 19/1024 entries in the exported NFS filesystem list.
There are 1/100 entries in the NFS passwd file list.
There are 10/5000 entries in the UID translation list.
There is NO selected FILESYSTEM entry.
The configuration MULTINET:NFS.CONFIGURATION has not been modified.
NFS-CONFIG>QUIT
$


 

USE

Reads in a configuration file. (Functionally equivalent to GET.)

FORMAT

USE  config_file

PARAMETER

config_file

Specifies the name of the configuration file to read.


 

VERSION

Displays the NFS-CONFIG version and release information.

FORMAT

VERSION

EXAMPLE

$ MULTINET CONFIGURE  /NFS
MultiNet NFS Configuration Utility 5.5(76)
[Reading in NFS file server configuration from MULTINET:NFS.CONFIGURATION]
NFS-CONFIG>VERSION
This is the MultiNet NFS configuration program Version 5.5 (nnn)
NFS-CONFIG>QUIT


 

WRITE

Writes the current configuration to a file. (Functionally equivalent to SAV.)

FORMAT

WRITE  [config_file]

PARAMETER

config_file

Specifies the name of the configuration file to write, by default, the file from which the configuration was read.

EXAMPLE

$ MULTINET CONFIGURE  /NFS
MultiNet NFS Configuration Utility 5.5 (nnn)
[Reading in NFS file server configuration from MULTINET:NFS.CONFIGURATION]
NFS-CONFIG>WRITE
[Writing configuration to MULTINET_ROOT:[MULTINET]NFS.CONFIGURATION.7]
NFS-CONFIG>EXIT
[Writing configuration to MULTINET:NFS.CONFIGURATION]
[Writing Startup file MULTINET:START_MULTINET.COM]
[Changes take effect after the next VMS reboot]
$