sharing.nfs.query

Sent on sharing.nfs changes.

Type: object

ADDED

NfsShareAddedEvent

Type: object
No Additional Properties

id Required

Id

Type: integer

fields Required

NfsShareEntry

Type: object
No Additional Properties

id Required

Id

Type: integer

path Required

Path

Type: string

Local path to be exported.

Must be at least 1 characters long

aliases

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

Comment

Type: string Default: ""

User comment associated with share.

networks

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

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

Ro

Type: boolean Default: false

Export the share as read only.

maproot_user

Maproot User

Default: null

Map root user client to a specified user.

Any of

• Option 1
• Option 2

Type: string

Type: null

maproot_group

Maproot Group

Default: null

Map root group client to a specified group.

Any of

• Option 1
• Option 2

Type: string

Type: null

mapall_user

Mapall User

Default: null

Map all client users to a specified user.

Any of

• Option 1
• Option 2

Type: string

Type: null

mapall_group

Mapall Group

Default: null

Map all client groups to a specified group.

Any of

• Option 1
• Option 2

Type: string

Type: null

security

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

Enabled

Type: boolean Default: true

Enable or disable the share.

locked Required

Locked

Read-only value indicating whether the share is located on a locked dataset.

Returns:
- True: The share is in a locked dataset.
- False: The share is not in a locked dataset.
- None: Lock status is not available because path locking information was not requested.

Any of

• Option 1
• Option 2

Type: boolean

Type: null

expose_snapshots

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.

CHANGED

NfsShareChangedEvent

Type: object
No Additional Properties

id Required

Id

Type: integer

fields Required

NfsShareEntry

Type: object
No Additional Properties

id Required

Id

Type: integer

path Required

Path

Type: string

Local path to be exported.

Must be at least 1 characters long

aliases

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

Comment

Type: string Default: ""

User comment associated with share.

networks

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

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

Ro

Type: boolean Default: false

Export the share as read only.

maproot_user

Maproot User

Default: null

Map root user client to a specified user.

Any of

• Option 1
• Option 2

Type: string

Type: null

maproot_group

Maproot Group

Default: null

Map root group client to a specified group.

Any of

• Option 1
• Option 2

Type: string

Type: null

mapall_user

Mapall User

Default: null

Map all client users to a specified user.

Any of

• Option 1
• Option 2

Type: string

Type: null

mapall_group

Mapall Group

Default: null

Map all client groups to a specified group.

Any of

• Option 1
• Option 2

Type: string

Type: null

security

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

Enabled

Type: boolean Default: true

Enable or disable the share.

locked Required

Locked

Read-only value indicating whether the share is located on a locked dataset.

Returns:
- True: The share is in a locked dataset.
- False: The share is not in a locked dataset.
- None: Lock status is not available because path locking information was not requested.

Any of

• Option 1
• Option 2

Type: boolean

Type: null

expose_snapshots

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.

REMOVED

NfsShareRemovedEvent

Type: object
No Additional Properties

id Required

Id

Type: integer

Required roles: SHARING_NFS_READ