Family nfsd netlink specification

Summary

NFSD configuration over generic netlink.

Operations

rpc-status-get

dump pending nfsd rpc

attribute-set:

rpc-status

dump:

reply

attributes:

[xid, flags, prog, version, proc, service-time, saddr4, daddr4, saddr6, daddr6, sport, dport, compound-ops]

threads-set

set the maximum number of running threads

attribute-set:

server

flags:

[admin-perm]

do:

request

attributes:

[threads, gracetime, leasetime, scope, min-threads, fh-key]

threads-get

get the maximum number of running threads

attribute-set:

server

do:

reply

attributes:

[threads, gracetime, leasetime, scope, min-threads]

version-set

set nfs enabled versions

attribute-set:

server-proto

flags:

[admin-perm]

do:

request

attributes:

[version]

version-get

get nfs enabled versions

attribute-set:

server-proto

do:

reply

attributes:

[version]

listener-set

set nfs running sockets

attribute-set:

server-sock

flags:

[admin-perm]

do:

request

attributes:

[addr]

listener-get

get nfs running listeners

attribute-set:

server-sock

do:

reply

attributes:

[addr]

pool-mode-set

set the current server pool-mode

attribute-set:

pool-mode

flags:

[admin-perm]

do:

request

attributes:

[mode]

pool-mode-get

get info about server pool-mode

attribute-set:

pool-mode

do:

reply

attributes:

[mode, npools]

cache-notify

Notification that there are cache requests that need servicing

attribute-set:

cache-notify

mcgrp:

exportd

event:

attributes:

[cache-type]

svc-export-get-reqs

Dump all pending svc_export requests

attribute-set:

svc-export-reqs

flags:

[admin-perm]

dump:

reply

attributes:

[requests]

svc-export-set-reqs

Respond to one or more svc_export requests

attribute-set:

svc-export-reqs

flags:

[admin-perm]

do:

request

attributes:

[requests]

expkey-get-reqs

Dump all pending expkey requests

attribute-set:

expkey-reqs

flags:

[admin-perm]

dump:

reply

attributes:

[requests]

expkey-set-reqs

Respond to one or more expkey requests

attribute-set:

expkey-reqs

flags:

[admin-perm]

do:

request

attributes:

[requests]

cache-flush

Flush nfsd caches (svc_export and/or expkey)

attribute-set:

cache-flush

flags:

[admin-perm]

do:

request

attributes:

[mask]

unlock-ip

release NLM locks held by an IP address

attribute-set:

unlock-ip

flags:

[admin-perm]

do:

request

attributes:

[address]

unlock-filesystem

revoke NFS state under a filesystem path

attribute-set:

unlock-filesystem

flags:

[admin-perm]

do:

request

attributes:

[path]

unlock-export

Revoke NFSv4 state acquired through exports of a given path. Unlike unlock-filesystem, which operates at superblock granularity, this command targets only state associated with a specific export path. Userspace (exportfs -u) sends this after removing the last client for a path so the underlying filesystem can be unmounted.

attribute-set:

unlock-export

flags:

[admin-perm]

do:

request

attributes:

[path]

Multicast groups

• none

• exportd

Definitions

cache-type

type:

flags

entries:

• svc_export

• expkey

export-flags

type:

flags

doc:

These flags are ordered to match the NFSEXP_* flags in include/linux/nfsd/export.h

entries:

• readonly

• insecure-port

• rootsquash

• allsquash

• async

• gathered-writes

• noreaddirplus

• security-label

• sign-fh

• nohide

• nosubtreecheck

• noauthnlm

• msnfs

• fsid

• crossmount

• noacl

• v4root

• pnfs

xprtsec-mode

type:

flags

doc:

These flags are ordered to match the NFSEXP_XPRTSEC_* flags in include/linux/nfsd/export.h

entries:

• none

• tls

• mtls

Attribute sets

cache-notify

cache-type (u32)

enum:

cache-type

rpc-status

xid (u32)

byte-order:

big-endian

flags (u32)

prog (u32)

version (u8)

proc (u32)

service-time (s64)

pad (pad)

saddr4 (u32)

byte-order:

big-endian

display-hint:

ipv4

daddr4 (u32)

byte-order:

big-endian

display-hint:

ipv4

saddr6 (binary)

display-hint:

ipv6

daddr6 (binary)

display-hint:

ipv6

sport (u16)

byte-order:

big-endian

dport (u16)

byte-order:

big-endian

compound-ops (u32)

multi-attr:

True

server

threads (u32)

multi-attr:

True

gracetime (u32)

leasetime (u32)

scope (string)

min-threads (u32)

fh-key (binary)

version

major (u32)

minor (u32)

enabled (flag)

server-proto

version (nest)

nested-attributes:

version

multi-attr:

True

sock

addr (binary)

transport-name (string)

server-sock

addr (nest)

nested-attributes:

sock

multi-attr:

True

pool-mode

mode (string)

npools (u32)

fslocation

host (string)

path (string)

fslocations

location (nest)

nested-attributes:

fslocation

multi-attr:

True

auth-flavor

pseudoflavor (u32)

flags (u32)

enum:

export-flags

enum-as-flags:

True

svc-export

seqno (u64)

client (string)

path (string)

negative (flag)

expiry (u64)

anon-uid (u32)

anon-gid (u32)

fslocations (nest)

nested-attributes:

fslocations

uuid (binary)

secinfo (nest)

nested-attributes:

auth-flavor

multi-attr:

True

xprtsec (u32)

enum:

xprtsec-mode

multi-attr:

True

flags (u32)

enum:

export-flags

enum-as-flags:

True

fsid (s32)

svc-export-reqs

requests (nest)

nested-attributes:

svc-export

multi-attr:

True

expkey

seqno (u64)

client (string)

fsidtype (u8)

fsid (binary)

negative (flag)

expiry (u64)

path (string)

expkey-reqs

requests (nest)

nested-attributes:

expkey

multi-attr:

True

cache-flush

mask (u32)

enum:

cache-type

enum-as-flags:

True

unlock-ip

address (binary)

doc:

struct sockaddr_in or struct sockaddr_in6.

unlock-filesystem

path (string)

doc:

Filesystem path whose state should be released.

unlock-export

path (string)

doc:

Export path whose NFSv4 state should be revoked. All state (opens, locks, delegations, layouts) acquired through any export of this path is revoked, regardless of which client holds the state. Intended for use after all clients have been unexported from a given path, enabling the underlying filesystem to be unmounted.