nfs.update

Update the NFS service configuration.

At least one protocol must remain enabled in protocols; the showmount command is available only while NFSv3 is enabled. When servers is null, the number of nfsd is determined automatically from the system’s capabilities (between 1 and 32); otherwise it is set to the requested value (1 to 256). The number of mountd processes is always one quarter of the number of nfsd. When bindip is empty, NFS listens on all active server addresses. NFS over RDMA, enabled with rdma, is only available on supported platforms with an RDMA-capable NIC and uses port 20049.

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: nfs_update

nfs_update

Type: object

NFSUpdateArgs parameters.

 No Additional Properties

Servers


Specify the number of nfsd. Set 1..256, or null/unset to have the server determine the count automatically. When automatic, the count equals the number of CPU cores, clamped to no less than 1 and no more than 32. The number of mountd processes is always one quarter of the number of nfsd.

Type: integer

Value must be greater or equal to 1 and lesser or equal to 256

Type: null

Allow Nonroot

Type: boolean

Allow non-root mount requests. This equates to 'insecure' share option.

Protocols

Type: array of enum (of string)

Specify supported NFS protocols: NFSv3, NFSv4 or both can be listed. At least one must be enabled. The showmount command is available only while NFSv3 is enabled.

 No Additional Items
Each item of this array must be:
Type: enum (of string)
Must be one of:
  • "NFSV3"
  • "NFSV4"

V4 Krb

Type: boolean

Force Kerberos authentication on NFS shares. When enabled, NFS shares will be inaccessible if a valid Kerberos ticket is not available.

V4 Domain

Type: string

Specify a DNS domain (NFSv4 only). Overrides the DNS domain for NFSv4 (sets the Domain setting in idmapd.conf).

Bindip

Type: array of string

Limit the server IP addresses available for NFS. When empty, NFS listens on all active server addresses.

 No Additional Items
Each item of this array must be:
Type: string

Must be at least 1 characters long

Mountd Port


Specify the mountd port binding.

Type: integer

Value must be greater or equal to 1 and lesser or equal to 65535

Type: null

Rpcstatd Port


Specify the rpc.statd port binding.

Type: integer

Value must be greater or equal to 1 and lesser or equal to 65535

Type: null

Rpclockd Port


Specify the rpc.lockd port binding.

Type: integer

Value must be greater or equal to 1 and lesser or equal to 65535

Type: null

Mountd Log

Type: boolean

Enable or disable mountd logging.

Statd Lockd Log

Type: boolean

Enable or disable statd and lockd logging.

Userd Manage Gids

Type: boolean

Enable to allow server to manage gids.

Rdma

Type: boolean

Enable or disable NFS over RDMA. Available on supported platforms with an installed RDMA-capable NIC. NFS over RDMA uses port 20049.

NFSEntry

Type: object

The updated NFS service configuration.

 No Additional Properties

Id

Type: integer

Placeholder identifier. Not used as there is only one.

Servers


Specify the number of nfsd. Set 1..256, or null/unset to have the server determine the count automatically. When automatic, the count equals the number of CPU cores, clamped to no less than 1 and no more than 32. The number of mountd processes is always one quarter of the number of nfsd.

Type: integer

Value must be greater or equal to 1 and lesser or equal to 256

Type: null

Allow Nonroot

Type: boolean

Allow non-root mount requests. This equates to 'insecure' share option.

Protocols

Type: array of enum (of string)

Specify supported NFS protocols: NFSv3, NFSv4 or both can be listed. At least one must be enabled. The showmount command is available only while NFSv3 is enabled.

 No Additional Items
Each item of this array must be:
Type: enum (of string)
Must be one of:
  • "NFSV3"
  • "NFSV4"

V4 Krb

Type: boolean

Force Kerberos authentication on NFS shares. When enabled, NFS shares will be inaccessible if a valid Kerberos ticket is not available.

V4 Domain

Type: string

Specify a DNS domain (NFSv4 only). Overrides the DNS domain for NFSv4 (sets the Domain setting in idmapd.conf).

Bindip

Type: array of string Default: []

Limit the server IP addresses available for NFS. When empty, NFS listens on all active server addresses.

 No Additional Items
Each item of this array must be:
Type: string

Must be at least 1 characters long

Mountd Port


Specify the mountd port binding.

Type: integer

Value must be greater or equal to 1 and lesser or equal to 65535

Type: null

Rpcstatd Port


Specify the rpc.statd port binding.

Type: integer

Value must be greater or equal to 1 and lesser or equal to 65535

Type: null

Rpclockd Port


Specify the rpc.lockd port binding.

Type: integer

Value must be greater or equal to 1 and lesser or equal to 65535

Type: null

Mountd Log

Type: boolean

Enable or disable mountd logging.

Statd Lockd Log

Type: boolean

Enable or disable statd and lockd logging.

V4 Krb Enabled

Type: boolean

Status of NFSv4 authentication requirement (status only).

Userd Manage Gids

Type: boolean

Enable to allow server to manage gids.

Keytab Has Nfs Spn

Type: boolean

Report status of NFS Principal Name in keytab (status only).

Managed Nfsd

Type: boolean

Report status of 'servers' field. If true, the number of nfsd is managed by the server (status only).

Rdma

Type: boolean

Enable or disable NFS over RDMA. Available on supported platforms with an installed RDMA-capable NIC. NFS over RDMA uses port 20049.


Required roles: SHARING_NFS_WRITE