# sharing.nfs.query

Type: object

##

Type: array
No Additional Items

#### Tuple Validation

##### Parameter 1: filters

#### filters

Type: array Default: []
No Additional Items

##### Each item of this array must be:

Type: object

##### Parameter 2: options

#### options

Type: object
Default:
{ "relationships": true, "extend": null, "extend_context": null, "prefix": null, "extra": {}, "order_by": [], "select": [], "count": false, "get": false, "offset": 0, "limit": 0, "force_sql_filters": false }
No Additional Properties

##

#### Relationships

Type: boolean Default: true

##

#### Extend

Default: null

## Any of

Type: string
Type: null

##

#### Extend Context

Default: null

## Any of

Type: string
Type: null

##

#### Prefix

Default: null

## Any of

Type: string
Type: null

##

#### Extra

Type: object Default: {}

##

#### Order By

Type: array of string Default: []
No Additional Items

##### Each item of this array must be:

Type: string

##

#### Select

Type: array Default: []
No Additional Items

##### Each item of this array must be:

## Any of

Type: string
Type: array
No Additional Items

##### Each item of this array must be:

Type: object

##

#### Count

Type: boolean Default: false

##

#### Get

Type: boolean Default: false

##

#### Offset

Type: integer Default: 0

##

#### Limit

Type: integer Default: 0

##

#### Force Sql Filters

Type: boolean Default: false

##

#### Result

## Any of

Type: array of object
No Additional Items

##### Each item of this array must be:

#### SharingNFSQueryResultItem

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

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

User comment associated with share.

##

#### Networks

Type: array of string

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

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

Export the share as read only.

##

#### Maproot User

Map root user client to a specified user.

## Any of

Type: string
Type: null

##

#### Maproot Group

Map root group client to a specified group.

## Any of

Type: string
Type: null

##

#### Mapall User

Map all client users to a specified user.

## Any of

Type: string
Type: null

##

#### Mapall Group

Map all client groups to a specified group.

## Any of

Type: string
Type: null

##

#### Security

Type: array of enum (of string)

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

Enable or disable the share.

##

#### Locked

Lock state of the dataset (if encrypted).

## Any of

Type: boolean
Type: null

##

#### Expose Snapshots

Type: boolean

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

#### SharingNFSQueryResultItem

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

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

User comment associated with share.

##

#### Networks

Type: array of string

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

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

Export the share as read only.

##

#### Maproot User

Map root user client to a specified user.

## Any of

Type: string
Type: null

##

#### Maproot Group

Map root group client to a specified group.

## Any of

Type: string
Type: null

##

#### Mapall User

Map all client users to a specified user.

## Any of

Type: string
Type: null

##

#### Mapall Group

Map all client groups to a specified group.

## Any of

Type: string
Type: null

##

#### Security

Type: array of enum (of string)

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

Enable or disable the share.

##

#### Locked

Lock state of the dataset (if encrypted).

## Any of

Type: boolean
Type: null

##

#### Expose Snapshots

Type: boolean

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

Type: integer

Required roles: SHARING_NFS_READ