sharing.nfs.update

Update NFS Share of id.

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: id

id

Type: integer

Parameter 2: data

data

Type: object
No Additional Properties

path

Path

Type: string

Local path to be exported.

Must be at least 1 characters long

aliases

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

Comment

Type: string

User comment associated with share.

networks

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

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

Ro

Type: boolean

Export the share as read only.

maproot_user

Maproot User

Map root user client to a specified user.

Any of

• Option 1
• Option 2

Type: string

Type: null

maproot_group

Maproot Group

Map root group client to a specified group.

Any of

• Option 1
• Option 2

Type: string

Type: null

mapall_user

Mapall User

Map all client users to a specified user.

Any of

• Option 1
• Option 2

Type: string

Type: null

mapall_group

Mapall Group

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)

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

Enable or disable the share.

expose_snapshots

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.

Return value

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

Lock state of the dataset (if encrypted).

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.

Required roles: SHARING_NFS_WRITE