NFS static mount commands

NFS static mount mode provides the commands to create or modify an NFS static mount configuration.

To enter the mode, use the global nfs-static-mount command. To delete a static mount, use the no nfs-static-mount command. For more information, see nfs-static-mount.

While in this mode, use the commands in the following table to define an NFS static mount.

To view the current configuration, use the show command.
To restore default values, use the reset command.
To exit this configuration mode without saving changes to the running configuration, use the cancel command.
To exit this configuration mode and save changes to the running configuration, use the exit command.

Table 1. NFS static mount commands
Command	Purpose
admin-state	This command sets the administrative state for the configuration.
local-filesystem-access	This command controls local access to the mounted file system.
mount-type	This command indicates the type of NFS mount to use.
read-only	This command identifies file access privileges for the NFS mount.
remote	This command identifies the remote NFS file system to make available as a static mount.
retrans	This command specifies the maximum number of RPC minor timeouts to allow before the NFS transaction fails.
rsize	This command specifies the number of bytes for each read operation on the NFS mount.
summary	This command specifies the brief, descriptive summary for the object instance.
timeo	This command specifies the initial interval between retransmission attempts to the NFS mount.
transport	This command identifies the preferred transport-layer protocol for the NFS mount.
version	This command identifies the preferred protocol version for the NFS mount.
wsize	This command specifies the number of bytes for each write operation to the NFS mount.

local-filesystem-access

This command controls local access to the mounted file system.

Syntax

local-filesystem-access on

local-filesystem-access off

Parameters

on: Enable local access.
off: Disable local access. This setting is the default value.

Guidelines

The local-filesystem-access command controls command-line access to the mounted file system. By default, access to the mounted file system is disabled. When enabled, the mounted file system is available as a folder with the name of the NFS static mount. If the name is greater than 12 characters in length, you are unable to locally access the files.

Attempts to access an unavailable or downed file system can cause the DataPower® Gateway to become unstable.

mount-type

This command indicates the type of NFS mount to use.

Syntax

mount-type hard

mount-type soft

Parameters

hard

Make this NFS mount a hard mount. Hard mounts ensure the reliable transfer of data. If the NFS server is unavailable for more than 2 minutes, the DataPower Gateway might restart because of a watchdog error. This setting is the default value.

soft

Make this NFS mount a soft mount. Soft mounts are at risk of undetected data corruption and the loss of files that are read or written through NFS. Soft mounts can prevent a watchdog in the following case. Select this behavior only to prevent watchdog errors is more important than data integrity.

The NFS server is unavailable.
The retransmit timeout and count does not complete in less than 2 minutes.

Guidelines

The mount-type command indicates the type of NFS mount to use. The default behavior, which is generally the appropriate behavior, is to use NFS hard mounts.

With hard mounts, no risk of data corruption exists. With soft mounts, undetected data corruption is possible, but the DataPower Gateway might be less prone to restarts caused by watchdog timeouts when the NFS server is unavailable.

read-only

This command identifies file access privileges for the NFS mount.

Syntax

read-only on

read-only off

Parameters

on: The mount allows read transactions only.
off: The mount allows read and write transactions. This setting is the default value.

Guidelines

The read-only command specifies the file access privileges for the NFS mount.

To mount the same mount points in NFS version 4 in different domains, the first mount sets file access privileges. For example, if domain-A mounts host:/foo as read-only access and then domain-B mounts host:/foo as read/write access, both mounts are read-only access.

remote

This command identifies the remote NFS file system to make available as a static mount.

Syntax

remote mount

Parameters

mount: Specifies the NFS mount point as an ASCII string. Enter the mount in the form host:/path where host is the domain name or IP address of the target NFS server, and path is a hierarchical directory path.
The path must match or be more specific than the NFS export that is provided by the target server. For example, the server provides an export of XML/stylesheets and the path portion can specify XML/stylesheets or, if the financialServices subdirectory exists, XML/stylesheets/financialServices.

retrans

This command specifies the maximum number of RPC minor timeouts to allow before the NFS transaction fails.

Syntax

retrans count

Parameters

count: Specifies the maximum number of RPC minor timeouts to tolerate before an NFS transaction is abandoned and an NFS failure is declared. Enter a value in the range 1 - 60. The default value is 3.

Guidelines

The retrans command is used with the timeo command to specify behavior in response to RPC minor timeouts and subsequent retransmission attempts.

The retrans command specifies the number of RPC minor timeouts that are tolerated per NFS transaction before an NFS read or write error is declared. The timeo command provides a base value to determine the interval between the RPC timeout and the subsequent retransmission attempt.

With default values (3 for retrans and 0.7 seconds for timeo), RPC timeouts are dealt with in the following manner.

In response to the first RPC timeout, waits 0.7 seconds and then retransmit.
In response to the second RPC timeout, double the initial timeout value to 1.4 seconds and then retransmit.
In response to the third RPC timeout, double the previously used timeout value to 2.8 seconds and then retransmit.
In response to the fourth timeout, which is greater than the value specified by the retrans command, declare an NFS read or write error.

The interval between RPC timeouts and a subsequent retransmission never exceeds 6 seconds.

rsize

This command specifies the number of bytes for each read operation on the NFS mount.

Syntax

rsize bytes

Parameters

bytes: Specifies the number of bytes in each NFS read operation. Enter a value in the range 1024 - 32769. The default value is 4096.

Guidelines

The rsize command specifies the number of bytes for each NFS read operation. To read more than 8192 bytes, use TCP as the transport-layer protocol. TCP is the default protocol as defined by the transport command.

timeo

This command specifies the initial interval between retransmission attempts to the NFS mount.

Syntax

timeo seconds

Parameters

seconds: Specifies the interval in tenths of a second between retransmission attempts. Enter a value in the range 1 - 600. The default value is 7.

Guidelines

The timeo command specifies the interval between the RPC minor timeout and subsequent retransmission attempts. Use this command with the retrans command to define the following behavior.

The interval between an RPC minor timeout and a subsequent retransmission attempt.
The number of RPC minor timeouts to allow per NFS transactions.

After all retransmission attempts fail, an NFS read or write error is declared for the NFS transaction.

For example, assume values of 3 retransmissions and 0.7 seconds between attempts. In this scenario, RPC timeouts are handled as follows.

In response to the first RPC timeout, wait 0.7 seconds and then retransmits.
In response to the second RPC timeout, double the initial timeout value to 1.4 seconds and then retransmits.
In response to the third RPC timeout, double the previously used timeout value to 2.8 seconds and then retransmits.
In response to the fourth timeout, which is greater than the value specified by the retrans command, declare an NFS read or write error.

The interval between RPC timeouts and a subsequent retransmission never exceeds 60 seconds.

transport

This command identifies the preferred transport-layer protocol for the NFS mount.

Syntax

transport tcp

transport udp

Parameters

tcp: Identifies TCP as the protocol. This setting is the default value.
udp: Identifies UDP as the protocol.

Guidelines

The transport command specifies the preferred transport-layer protocol to use, if available. Use the TCP protocol to read or write transactions larger than 8192 bytes. The size of read operations is defined with the rsize command. The size of write operations is defined with the wsize command.

For NFS version 2 or version 3, select the transport protocol to initiate the mount. If TCP is selected and it is not available on the NFS server, the mount uses UDP.
For NFS version 4, this property is ignored. NFS version 4 supports only TCP.

version

This command identifies the preferred protocol version for the NFS mount.

Syntax

version 2

version 3

version 4

Parameters

2: Specifies NFS version 2.
3: Specifies NFS version 3. This setting is the default value.
4: Specifies NFS version 4.

Guidelines

The version command specifies the preferred NFS protocol version.

If set to 3 and the server implements only version 2, the client falls back to version 2.
If set to 4, no fallback.

wsize

This command specifies the number of bytes for each write operation to the NFS mount.

Syntax

wsize bytes

Parameters

bytes: Specifies the number of bytes in each NFS write operation. Enter a value in the range 1024 - 32769. The default value is 4096.

Guidelines

The wsize command specifies the number of bytes for each NFS write operation. To write more than 8192 bytes, use TCP as the transport-layer protocol. TCP is the default protocol as defined by the transport command.