sharing.nfs.create ================== Create a NFS Share. `path` local path to be exported. `aliases` IGNORED, for now. `networks` is a list of authorized networks that are allowed to access the share having format "network/mask" CIDR notation. If empty, all networks are allowed. `hosts` is a list of IP's/hostnames which are allowed to access the share. If empty, all IP's/hostnames are allowed. `expose_snapshots` enable TrueNAS Enterprise feature to allow access to the ZFS snapshot directory over NFS. This feature requires a valid enterprise license. .. raw:: html
Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: data

data

Type: object
No Additional Properties

Path

Type: string

Local path to be exported.

Must be at least 1 characters long

Aliases

Type: array of string Default: []

IGNORED for now.

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

Must be at least 1 characters long

Comment

Type: string Default: ""

User comment associated with share.

Networks

Type: array of string Default: []

List of authorized networks that are allowed to access the share having format
"network/mask" CIDR notation. Each entry must be unique. If empty, all networks are allowed.
Maximum number of entries: 42

Must contain a maximum of 42 items

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

Must be at least 1 characters long

Hosts

Type: array of string Default: []

list of IP's/hostnames which are allowed to access the share. No quotes or spaces are allowed.
Each entry must be unique. If empty, all IP's/hostnames are allowed.
Maximum number of entries: 42

Must contain a maximum of 42 items

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

Must be at least 1 characters long

Ro

Type: boolean Default: false

Export the share as read only.

Maproot User

Default: null

Map root user client to a specified user.

Type: string
Type: null

Maproot Group

Default: null

Map root group client to a specified group.

Type: string
Type: null

Mapall User

Default: null

Map all client users to a specified user.

Type: string
Type: null

Mapall Group

Default: null

Map all client groups to a specified group.

Type: string
Type: null

Security

Type: array of enum (of string) Default: []

Specify the security schema.

No Additional Items
Each item of this array must be:
Type: enum (of string)
Must be one of:
  • "SYS"
  • "KRB5"
  • "KRB5I"
  • "KRB5P"

Enabled

Type: boolean Default: true

Enable or disable the share.

Expose Snapshots

Type: boolean Default: false

Enterprise feature to enable access to the ZFS snapshot directory for the export.
Export path must be the root directory of a ZFS dataset.

NfsShareEntry

Type: object
No Additional Properties

Id

Type: integer

Path

Type: string

Local path to be exported.

Must be at least 1 characters long

Aliases

Type: array of string Default: []

IGNORED for now.

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

Must be at least 1 characters long

Comment

Type: string Default: ""

User comment associated with share.

Networks

Type: array of string Default: []

List of authorized networks that are allowed to access the share having format
"network/mask" CIDR notation. Each entry must be unique. If empty, all networks are allowed.
Maximum number of entries: 42

Must contain a maximum of 42 items

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

Must be at least 1 characters long

Hosts

Type: array of string Default: []

list of IP's/hostnames which are allowed to access the share. No quotes or spaces are allowed.
Each entry must be unique. If empty, all IP's/hostnames are allowed.
Maximum number of entries: 42

Must contain a maximum of 42 items

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

Must be at least 1 characters long

Ro

Type: boolean Default: false

Export the share as read only.

Maproot User

Default: null

Map root user client to a specified user.

Type: string
Type: null

Maproot Group

Default: null

Map root group client to a specified group.

Type: string
Type: null

Mapall User

Default: null

Map all client users to a specified user.

Type: string
Type: null

Mapall Group

Default: null

Map all client groups to a specified group.

Type: string
Type: null

Security

Type: array of enum (of string) Default: []

Specify the security schema.

No Additional Items
Each item of this array must be:
Type: enum (of string)
Must be one of:
  • "SYS"
  • "KRB5"
  • "KRB5I"
  • "KRB5P"

Enabled

Type: boolean Default: true

Enable or disable the share.

Locked


Lock state of the dataset (if encrypted).

Type: boolean
Type: null

Expose Snapshots

Type: boolean Default: false

Enterprise feature to enable access to the ZFS snapshot directory for the export.
Export path must be the root directory of a ZFS dataset.


*Required roles:* SHARING_NFS_WRITE