PowerScaleOneFS CLI Command Reference

Syntax

isi nfs exports create <paths>
  [--block-size <size>]
  [--can-set-time {yes | no}]
  [--case-insensitive {yes | no}]
  [--case-preserving {yes | no}]
  [--chown-restricted {yes | no}]
  [--directory-transfer-size <size>]
  [--link-max <integer>]
  [--max-file-size <size>]
  [--name-max-size <integer>]
  [--no-truncate {yes | no}]
  [--return-32bit-file-ids {yes | no}]
  [--symlinks {yes | no}]
  [--zone <string>]
  [--clients <client>]
  [--description <string>]
  [--root-clients <client>]
  [--read-write-clients <client>]
  [--read-only-clients <client>]
  [--all-dirs {yes | no}]
  [--encoding <string>]
  [--security-flavors {unix | krb5 | krb5i | krb5p}]
  [--snapshot <snapshot>]
  [--map-lookup-uid {yes | no}]
  [--map-retry {yes | no}]
  [--map-root-enabled {yes | no}]
  [--map-non-root-enabled {yes | no}]
  [--map-failure-enabled {yes | no}]
  [--map-all <identity>]
  [--map-root <identity>]
  [--map-non-root <identity>]
  [--map-failure <identity>]
  [--map-full {yes | no}]
  [--commit-asynchronous {yes | no}]
  [--read-only {yes | no}]
  [--readdirplus {yes | no}]
  [--eaddirplus-prefetch <integer> 
  [--read-transfer-max-size <size>]
  [--read-transfer-multiple <integer>]
  [--read-transfer-size <size>]
  [--setattr-asynchronous {yes | no}]
  [--time-delta <time delta>]
  [--write-datasync-action {datasync | filesync |unstable}]
  [--write-datasync-reply {datasync | filesync}]
  [--write-filesync-action {datasync | filesync |unstable}]
  [--write-filesync-reply filesync]
  [--write-unstable-action {datasync | filesync |unstable}]
  [--write-unstable-reply {datasync | filesync |unstable}]
  [--write-transfer-max-size <size>]
  [--write-transfer-multiple <integer>]
  [--write-transfer-size <size>]
  [--ignore-unresolvable-hosts]
  [--ignore-bad-paths]
  [--ignore-bad-auth]
  [--ignore-conflicts]
  [--force | -f]
  [--verbose]

Required Privileges

IISI_PRIV_NFS.

Options

<paths> ...

Required. Specifies the path to be exported, starting at /ifs. This option can be repeated to specify multiple paths.

--block-size <size>

Specifies the block size, in bytes.

--can-set-time {yes | no}

If set to yes, enables the export to set time. The default setting is no.

--case-insensitive {yes | no}

If set to yes, the server will report that it ignores case for file names. The default setting is no.

--case-preserving {yes | no}

If set to yes, the server will report that it always preserves case for file names. The default setting is no.

--chown-restricted {yes | no}

If set to yes, the server will report that only the superuser can change file ownership. The default setting is no.

--directory-transfer-size <size>

Specifies the preferred directory transfer size. Valid values are a number followed by a case-sensitive unit of measure: b for bytes; K for KB; M for MB; or G for GB. If no unit is specified, bytes are used by default. The maximum value is 4294967295b. The initial default value is 128K.

--link-max <integer>

The reported maximum number of links to a file.

--max-file-size <size>

Specifies the maximum allowed file size on the server (in bytes). If a file is larger than the specified value, an error is returned.

--name-max-size <integer>

The reported maximum length of characters in a filename.

--no-truncate {yes | no}

If set to yes, too-long file names will result in an error rather than be truncated.

--return-32bit-file-ids {yes | no}

Applies to NFSv3 and NFSv4. If set to yes, limits the size of file identifiers returned from readdir to 32-bit values. The default value is no.

NOTE:This setting is provided for backward compatibility with older NFS clients, and should not be enabled unless necessary.

--symlinks {yes | no}

If set to yes, advertises support for symlinks. The default setting is no.

--zone <string>

Access zone in which the export should apply. The default zone is system.

--clients <client>

Specifies a client to be allowed access through this export. Specify clients as an IPv4 or IPv6 address, hostname, netgroup, or CIDR range. You can add multiple clients by repeating this option.

NOTE:This option replaces the entire list of clients. To add or remove a client from the list, specify --add-clients or --remove-clients.

--description <string>

The description for this NFS export.

--root-clients <client>

Allows the root user of the specified client to execute operations as the root user of the cluster. This option overrides the --map-all and --map-root option for the specified client.

Specify clients as an IPv4 or IPv6 address, hostname, netgroup, or CIDR range. You can specify multiple clients in a comma-separated list.

--read-write-clients <client>

Grants read/write privileges to the specified client for this export. This option overrides the --read-only option for the specified client.

Specify clients as an IPv4 or IPv6 address, hostname, netgroup, or CIDR range. You can specify multiple clients in a comma-separated list.

--read-only-clients <client>

Makes the specified client read-only for this export. This option overrides the --read-only option for the specified client.

Specify clients as an IPv4 or IPv6 address, hostname, netgroup, or CIDR range. You can specify multiple clients in a comma-separated list.

--all-dirs {yes | no}

If set to yes, this export will cover all directories. The default setting is no.

--encoding <string>

Specifies the character encoding of clients connecting through this NFS export.

Valid values and their corresponding character encodings are provided in the following table. These values are taken from the node's /etc/encodings.xml file, and are not case sensitive.

Table 1. Encoding valuesCharacter encoding.

Value	Encoding
cp932	Windows-SJIS
cp949	Windows-949
cp1252	Windows-1252
euc-kr	EUC-KR
euc-jp	EUC-JP
euc-jp-ms	EUC-JP-MS
utf-8-mac	UTF-8-MAC
utf-8	UTF-8
iso-8859-1	ISO-8859-1 (Latin-1)
iso-8859-2	ISO-8859-2 (Latin-2)
iso-8859-3	ISO-8859-3 (Latin-3)
iso-8859-4	ISO-8859-4 (Latin-4)
iso-8859-5	ISO-8859-5 (Cyrillic)
iso-8859-6	ISO-8859-6 (Arabic)
iso-8859-7	ISO-8859-7 (Greek)
iso-8859-8	ISO-8859-8 (Hebrew)
iso-8859-9	ISO-8859-9 (Latin-5)
iso-8859-10	ISO-8859-10 (Latin-6)
iso-8859-13	ISO-8859-13 (Latin-7)
iso-8859- 14	ISO-8859-14 (Latin-8)
iso-8859-15	ISO-8859-15 (Latin-9)
iso-8859-16	ISO-8859-16 (Latin-10)

--security-flavors {unix | krb5 | krb5i | krb5p}

Specifies a security flavor to support. To support multiple security flavors, repeat this option for each additional entry. The following values are valid:

unix

UNIX (system) authentication.

krb5

Kerberos V5 authentication.

krb5i

Kerberos V5 authentication with integrity.

krb5p

Kerberos V5 authentication with privacy.

--snapshot {<snapshot> | <snapshot-alias>}

Specifies the ID of a snapshot or snapshot alias to export. If you specify this option, directories will be exported in the state captured in either the specified snapshot or the snapshot referenced by the specified snapshot alias. If the snapshot does not capture the exported path, the export will be inaccessible to users.

If you specify a snapshot alias, and the alias is later modified to reference a new snapshot, the new snapshot will be automatically applied to the export.

Because snapshots are read-only, clients will not be able to modify data through the export unless you specify the ID of a snapshot alias that references the live version of the file system.

Specify <snapshot> or <snapshot-alias> as the ID or name of a snapshot or snapshot alias.

--map-lookup-uid {yes | no}

If set to yes, incoming UNIX user identifiers (UIDs) will be looked up locally. The default setting is no.

--map-retry {yes | no}

If set to yes, the system retries failed user-mapping lookups. The default setting is no.

--map-root-enabled {yes | no}

Enable/disable mapping incoming root users to a specific account.

--map-non-root-enabled {yes | no}

Enable/disable mapping incoming non-root users to a specific account.

--map-failure-enabled {yes | no}

Enable/disable mapping users to a specific account after failing an auth lookup.

--map-all <identity>

Specifies the default identity that operations by any user will execute as. If this option is not set to root, you can allow the root user of a specific client to execute operations as the root user of the cluster by including the client in the --root-clients list.

--map-root <identity>

Map incoming root users to a specific user and/or group ID.

--map-non-root <identity>

Map non-root users to a specific user and/or group ID.

--map-failure <identity>

Map users to a specific user and/or group ID after a failed auth attempt.

--map-full {yes | no}

Determines how user mapping is accomplished if a user is specified in an export option such as --map-root or --map-all. When enabled, a user mapping queries the OneFS user database and retrieves users from the applicable authentication subsystem, such as local authentication or Active Directory. When disabled, only local authentication is queried.

The default setting is yes.

--commit-asynchronous {yes | no}

If set to yes, enables commit data operations to be performed asynchronously. The default setting is no

--read-only {yes | no}

Determines the default privileges for all clients accessing the export.

If set to yes, you can grant read/write privileges to a specific client by including the client in the --read-write-clients list.

If set to no, you can make a specific client read-only by including the client in the --read-only-clients list. The default setting is no.

--readdirplus {yes | no}

Applies to NFSv3 only. If set to yes, enables processing of readdir-plus requests. The default setting is yes.

--readdirplus-prefetch <integer>

Deprecated. This option currently does nothing.

--read-transfer-max-size <size>

Specifies the maximum read transfer size to report to NFSv3 and NFSv4 clients. Valid values are a number followed by a case-sensitive unit of measure: b for bytes; K for KB; M for MB; or G for GB. If no unit is specified, bytes are used by default. The maximum value is 4294967295b. The initial default value is 1M.

--read-transfer-multiple <integer>

Specifies the suggested multiple read size to report to NFSv3 and NFSv4 clients. Valid values are 0–4294967295. The initial default value is 512.

--read-transfer-size <size>

Specifies the preferred read transfer size to report to NFSv3 and NFSv4 clients. Valid values are a number followed by a case-sensitive unit of measure: b for bytes; K for KB; M for MB; or G for GB. If no unit is specified, bytes are used by default. The maximum value is 4294967295b, or lower if the --read-transfer-max-size is set to a lesser value. The initial default value is 128K.

--setattr-asynchronous {yes | no}

If set to yes, performs set-attributes operations asynchronously. The default setting is no.

--time-delta <float>

Specifies server time granularity, in seconds.

--write-datasync-action {datasync | filesync | unstable}

Applies to NFSv3 and NFSv4 only. Specifies an alternate datasync write method. The following values are valid:

• datasync
• filesync
• unstable

The default value is datasync, which performs the request as specified.

--write-datasync-reply {datasync | filesync}

Applies to NFSv3 and NFSv4 only. Specifies an alternate datasync reply method. The following values are valid:

• datasync
• filesync

The default value is datasync (does not respond differently).

--write-filesync-action {datasync | filesync | unstable}

Applies to NFSv3 and NFSv4 only. Specifies an alternate filesync write method. The following values are valid:

• datasync
• filesync
• unstable

The default value is filesync, which performs the request as specified.

--write-filesync-reply {filesync}

Applies to NFSv3 and NFSv4 only. Specifies an alternate filesync reply method. The only valid value is filesync (does not respond differently).

--write-unstable-action {datasync | filesync | unstable}

Specifies an alternate unstable-write method. The following values are valid:

• datasync
• filesync
• unstable

The default value is unstable, which performs the request as specified.

--write-unstable-reply {datasync | filesync | unstable}

Specifies an alternate unstable-reply method. The following values are valid:

• datasync
• filesync
• unstable

The default value is unstable (does not respond differently).

--write-transfer-max-size <size>

Specifies the preferred maximum write transfer size to report to NFSv3 and NFSv4 clients. Valid values are a number followed by a case-sensitive unit of measure: b for bytes; K for KB; M for MB; or G for GB. If no unit is specified, bytes are used by default. The maximum value is 4294967295b. The initial default value is 1M.

--write-transfer-multiple <integer>

Specifies the suggested write transfer multiplier to report to NFSv3 and NFSv4 clients. Valid values are 0–4294967295. The initial default value is 512.

--write-transfer-size <size>

Specifies the preferred write transfer size to report to NFSv3 and NFSv4 clients. Valid values are a number followed by a case-sensitive unit of measure: b for bytes; K for KB; M for MB; or G for GB. If no unit is specified, bytes are used by default. The maximum value is 4294967295b, or lower if the --write-transfer-max-size is set to a lesser value. The initial default value is 512K.

--ignore-unresolvale-hosts

Does not present an error condition on unresolvable hosts when creating or modifying an export.

--ignore-bad-paths

Does not present an error condition on bad paths when creating or modifying an export.

--ignore-bad-auth

Ignores bad authentication for mapping options when creating or modifying an export.

--ignore-conflicts

Ignores conflicts between the new or modified exports and the existing configuration.

{--force | -f}

If set to no (default), a confirmation prompt displays when the command runs. If set to yes, the command executes without prompting for confirmation.

{--verbose | -v}

Displays more detailed information.

--help | -h

Display help for this command.

Examples

The following command creates an NFS export for a particular zone and set of clients:

isi nfs exports create /ifs/data/ugroup1/home 
  --description 'Access to home dirs for user group 1'
  --zone ugroup1 --clients 10.1.28.1 --clients 10.1.28.2

The following command creates an NFS export with multiple directory paths and a custom security type (Kerberos 5):

isi nfs exports create /ifs/data/projects /ifs/data/templates 
  --security-flavors krb5