Class: Nl::Linux::Nfsd

Inherits:
Genl::Family show all
Defined in:
nl-linux/generated/nl/linux/nfsd.rb

Overview

NFSD configuration over generic netlink.

Defined Under Namespace

Modules: AttributeSets, Flags, Messages, Notifications, Structs Classes: AsyncOperations

Constant Summary collapse

NAME = 
"nfsd"
VERSION = 
1

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Genl::Family

version

Class Method Details

.open(resolver: ::Nl::Linux::DEFAULT_RESOLVER, executor: nil, notification_capacity: DEFAULT_NOTIFICATION_CAPACITY) ⇒ Nfsd .open(resolver: ::Nl::Linux::DEFAULT_RESOLVER, executor: nil, notification_capacity: DEFAULT_NOTIFICATION_CAPACITY) {|family| ... } ⇒ Object

Overloads:

  • .open(resolver: ::Nl::Linux::DEFAULT_RESOLVER, executor: nil, notification_capacity: DEFAULT_NOTIFICATION_CAPACITY) ⇒ Nfsd

    Parameters:

    • resolver (#call) (defaults to: ::Nl::Linux::DEFAULT_RESOLVER)
    • executor (Symbol, nil) (defaults to: nil)
    • notification_capacity (Integer, nil) (defaults to: DEFAULT_NOTIFICATION_CAPACITY)

    Returns:

  • .open(resolver: ::Nl::Linux::DEFAULT_RESOLVER, executor: nil, notification_capacity: DEFAULT_NOTIFICATION_CAPACITY) {|family| ... } ⇒ Object

    Returns the result of the block.

    Parameters:

    • resolver (#call) (defaults to: ::Nl::Linux::DEFAULT_RESOLVER)
    • executor (Symbol, nil) (defaults to: nil)
    • notification_capacity (Integer, nil) (defaults to: DEFAULT_NOTIFICATION_CAPACITY)

    Yield Parameters:

    Returns:

    • (Object) —

      the result of the block



26
27
28
 
# File 'nl-linux/generated/nl/linux/nfsd.rb', line 26

def self.open(resolver: ::Nl::Linux::DEFAULT_RESOLVER, executor: nil, notification_capacity: DEFAULT_NOTIFICATION_CAPACITY)
  super
end

Instance Method Details

#async(stream_capacity: nil) ⇒ AsyncOperations

Returns the asynchronous operation facade for this family.

Parameters:

  • stream_capacity (::Integer, nil) (defaults to: nil)

Returns:



2027
2028
2029
2030
 
# File 'nl-linux/generated/nl/linux/nfsd.rb', line 2027

def async(stream_capacity: nil)
  return @async_operations ||= build_async_facade(AsyncOperations) if stream_capacity.nil?
  build_async_facade(AsyncOperations, stream_capacity:)
end

#do_cache_flush(**args) ⇒ void

This method returns an undefined value.

Flush nfsd caches (svc_export and/or expkey)

Requires CAP_NET_ADMIN in the initial user namespace.

Parameters:

  • args (Hash)

Options Hash (**args):

See Also:



1806
1807
1808
 
# File 'nl-linux/generated/nl/linux/nfsd.rb', line 1806

def do_cache_flush(**args)
  exchange_message(:"do", Messages::DoCacheFlushRequest, nil, args)
end

#do_expkey_set_reqs(**args) ⇒ void

This method returns an undefined value.

Respond to one or more expkey requests

Requires CAP_NET_ADMIN in the initial user namespace.

Parameters:

  • args (Hash)

Options Hash (**args):

See Also:



1795
1796
1797
 
# File 'nl-linux/generated/nl/linux/nfsd.rb', line 1795

def do_expkey_set_reqs(**args)
  exchange_message(:"do", Messages::DoExpkeySetReqsRequest, nil, args)
end

#do_listener_get(**args) ⇒ Messages::DoListenerGetReply

get nfs running listeners

Parameters:

  • args (Hash)

Returns:

See Also:



1718
1719
1720
 
# File 'nl-linux/generated/nl/linux/nfsd.rb', line 1718

def do_listener_get(**args)
  exchange_message(:"do", Messages::DoListenerGetRequest, Messages::DoListenerGetReply, args)
end

#do_listener_set(**args) ⇒ void

This method returns an undefined value.

set nfs running sockets

Requires CAP_NET_ADMIN in the initial user namespace.

Parameters:

  • args (Hash)

Options Hash (**args):

See Also:



1710
1711
1712
 
# File 'nl-linux/generated/nl/linux/nfsd.rb', line 1710

def do_listener_set(**args)
  exchange_message(:"do", Messages::DoListenerSetRequest, nil, args)
end

#do_pool_mode_get(**args) ⇒ Messages::DoPoolModeGetReply

get info about server pool-mode

Parameters:

  • args (Hash)

Returns:

See Also:



1737
1738
1739
 
# File 'nl-linux/generated/nl/linux/nfsd.rb', line 1737

def do_pool_mode_get(**args)
  exchange_message(:"do", Messages::DoPoolModeGetRequest, Messages::DoPoolModeGetReply, args)
end

#do_pool_mode_set(**args) ⇒ void

This method returns an undefined value.

set the current server pool-mode

Requires CAP_NET_ADMIN in the initial user namespace.

Parameters:

  • args (Hash)

Options Hash (**args):

  • mode (String)

See Also:



1729
1730
1731
 
# File 'nl-linux/generated/nl/linux/nfsd.rb', line 1729

def do_pool_mode_set(**args)
  exchange_message(:"do", Messages::DoPoolModeSetRequest, nil, args)
end

#do_svc_export_set_reqs(**args) ⇒ void

This method returns an undefined value.

Respond to one or more svc_export requests

Requires CAP_NET_ADMIN in the initial user namespace.

Parameters:

  • args (Hash)

Options Hash (**args):

See Also:



1766
1767
1768
 
# File 'nl-linux/generated/nl/linux/nfsd.rb', line 1766

def do_svc_export_set_reqs(**args)
  exchange_message(:"do", Messages::DoSvcExportSetReqsRequest, nil, args)
end

#do_threads_get(**args) ⇒ Messages::DoThreadsGetReply

get the maximum number of running threads

Parameters:

  • args (Hash)

Returns:

See Also:



1680
1681
1682
 
# File 'nl-linux/generated/nl/linux/nfsd.rb', line 1680

def do_threads_get(**args)
  exchange_message(:"do", Messages::DoThreadsGetRequest, Messages::DoThreadsGetReply, args)
end

#do_threads_set(**args) ⇒ void

This method returns an undefined value.

set the maximum number of running threads

Requires CAP_NET_ADMIN in the initial user namespace.

Parameters:

  • args (Hash)

Options Hash (**args):

  • threads (Array<Integer>)
  • gracetime (Integer)
  • leasetime (Integer)
  • scope (String)
  • min_threads (Integer)
  • fh_key (String)

See Also:



1672
1673
1674
 
# File 'nl-linux/generated/nl/linux/nfsd.rb', line 1672

def do_threads_set(**args)
  exchange_message(:"do", Messages::DoThreadsSetRequest, nil, args)
end

#do_unlock_export(**args) ⇒ void

This method returns an undefined value.

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.

Requires CAP_NET_ADMIN in the initial user namespace.

Parameters:

  • args (Hash)

Options Hash (**args):

  • path (String) —

    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.

See Also:



1839
1840
1841
 
# File 'nl-linux/generated/nl/linux/nfsd.rb', line 1839

def do_unlock_export(**args)
  exchange_message(:"do", Messages::DoUnlockExportRequest, nil, args)
end

#do_unlock_filesystem(**args) ⇒ void

This method returns an undefined value.

revoke NFS state under a filesystem path

Requires CAP_NET_ADMIN in the initial user namespace.

Parameters:

  • args (Hash)

Options Hash (**args):

  • path (String) —

    Filesystem path whose state should be released.

See Also:



1828
1829
1830
 
# File 'nl-linux/generated/nl/linux/nfsd.rb', line 1828

def do_unlock_filesystem(**args)
  exchange_message(:"do", Messages::DoUnlockFilesystemRequest, nil, args)
end

#do_unlock_ip(**args) ⇒ void

This method returns an undefined value.

release NLM locks held by an IP address

Requires CAP_NET_ADMIN in the initial user namespace.

Parameters:

  • args (Hash)

Options Hash (**args):

  • address (String) —

    struct sockaddr_in or struct sockaddr_in6.

See Also:



1817
1818
1819
 
# File 'nl-linux/generated/nl/linux/nfsd.rb', line 1817

def do_unlock_ip(**args)
  exchange_message(:"do", Messages::DoUnlockIpRequest, nil, args)
end

#do_version_get(**args) ⇒ Messages::DoVersionGetReply

get nfs enabled versions

Parameters:

  • args (Hash)

Returns:

See Also:



1699
1700
1701
 
# File 'nl-linux/generated/nl/linux/nfsd.rb', line 1699

def do_version_get(**args)
  exchange_message(:"do", Messages::DoVersionGetRequest, Messages::DoVersionGetReply, args)
end

#do_version_set(**args) ⇒ void

This method returns an undefined value.

set nfs enabled versions

Requires CAP_NET_ADMIN in the initial user namespace.

Parameters:

  • args (Hash)

Options Hash (**args):

See Also:



1691
1692
1693
 
# File 'nl-linux/generated/nl/linux/nfsd.rb', line 1691

def do_version_set(**args)
  exchange_message(:"do", Messages::DoVersionSetRequest, nil, args)
end

#dump_expkey_get_reqs(**args) ⇒ Array<Messages::DumpExpkeyGetReqsReply> #dump_expkey_get_reqs(**args) {|reply| ... } ⇒ void

Dump all pending expkey requests

Requires CAP_NET_ADMIN in the initial user namespace.

Overloads:

See Also:



1784
1785
1786
 
# File 'nl-linux/generated/nl/linux/nfsd.rb', line 1784

def dump_expkey_get_reqs(**args, &block)
  exchange_message(:"dump", Messages::DumpExpkeyGetReqsRequest, Messages::DumpExpkeyGetReqsReply, args, &block)
end

#dump_rpc_status_get(**args) ⇒ Array<Messages::DumpRpcStatusGetReply> #dump_rpc_status_get(**args) {|reply| ... } ⇒ void

dump pending nfsd rpc

Overloads:

See Also:



1656
1657
1658
 
# File 'nl-linux/generated/nl/linux/nfsd.rb', line 1656

def dump_rpc_status_get(**args, &block)
  exchange_message(:"dump", Messages::DumpRpcStatusGetRequest, Messages::DumpRpcStatusGetReply, args, &block)
end

#dump_svc_export_get_reqs(**args) ⇒ Array<Messages::DumpSvcExportGetReqsReply> #dump_svc_export_get_reqs(**args) {|reply| ... } ⇒ void

Dump all pending svc_export requests

Requires CAP_NET_ADMIN in the initial user namespace.

Overloads:

See Also:



1755
1756
1757
 
# File 'nl-linux/generated/nl/linux/nfsd.rb', line 1755

def dump_svc_export_get_reqs(**args, &block)
  exchange_message(:"dump", Messages::DumpSvcExportGetReqsRequest, Messages::DumpSvcExportGetReqsReply, args, &block)
end

#subscribe(*groups) ⇒ self

Parameters:

  • groups (Array<:none, :exportd>)

Returns:

  • (self) 


2034
2035
2036
2037
 
# File 'nl-linux/generated/nl/linux/nfsd.rb', line 2034

def subscribe(*groups) = super
# @rbs (*(:none | :exportd) groups) -> self
# @param [Array<:none, :exportd>] groups
# @return [self]

#unsubscribe(*groups) ⇒ self

Parameters:

  • groups (Array<:none, :exportd>)

Returns:

  • (self) 


2038
 
# File 'nl-linux/generated/nl/linux/nfsd.rb', line 2038

def unsubscribe(*groups) = super