# sharing.nfs.query

Sent on sharing.nfs changes.

Type: object

##

#### SharingNFSAddedEvent

Type: object
No Additional Properties

##

#### Id

Type: integer

##

#### SharingNFSEntry

Type: object
No Additional Properties

##

#### Id

Type: integer

Unique identifier for the NFS share.

##

#### Path

Type: string

Local path to be exported.

Must be at least `1` characters long

##

#### Dataset

Dataset name component of the path (e.g., 'tank/share'). Null if path cannot be resolved.

## Any of

Type: string
Type: null

##

#### Relative Path

Relative path component within the dataset (e.g., 'subdir/data'). Null if path cannot be resolved.

## Any of

Type: string
Type: null

##

#### 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.
Excessively long lists should be avoided.

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.
Excessively long lists should be avoided.

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.

## Any of

Type: string
Type: null

##

#### Maproot Group

Default: null

Map root group client to a specified group.

## Any of

Type: string
Type: null

##

#### Mapall User

Default: null

Map all client users to a specified user.

## Any of

Type: string
Type: null

##

#### Mapall Group

Default: null

Map all client groups to a specified group.

## Any of

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

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

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.

##

#### SharingNFSChangedEvent

Type: object
No Additional Properties

##

#### Id

Type: integer

##

#### SharingNFSEntry

Type: object
No Additional Properties

##

#### Id

Type: integer

Unique identifier for the NFS share.

##

#### Path

Type: string

Local path to be exported.

Must be at least `1` characters long

##

#### Dataset

Dataset name component of the path (e.g., 'tank/share'). Null if path cannot be resolved.

## Any of

Type: string
Type: null

##

#### Relative Path

Relative path component within the dataset (e.g., 'subdir/data'). Null if path cannot be resolved.

## Any of

Type: string
Type: null

##

#### 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.
Excessively long lists should be avoided.

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.
Excessively long lists should be avoided.

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.

## Any of

Type: string
Type: null

##

#### Maproot Group

Default: null

Map root group client to a specified group.

## Any of

Type: string
Type: null

##

#### Mapall User

Default: null

Map all client users to a specified user.

## Any of

Type: string
Type: null

##

#### Mapall Group

Default: null

Map all client groups to a specified group.

## Any of

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

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

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.

##

#### SharingNFSRemovedEvent

Type: object
No Additional Properties

##

#### Id

Type: integer

Required roles: SHARING_NFS_READ