Class: Nl::Linux::Nftables

Inherits:
Raw::Family show all
Defined in:
nl-linux/generated/nl/linux/nftables.rb

Overview

Netfilter nftables configuration over netlink.

Defined Under Namespace

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

Constant Summary collapse

NAME = 
"nftables"
PROTONUM = 
12

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.open(executor: nil, notification_capacity: DEFAULT_NOTIFICATION_CAPACITY) ⇒ Nftables .open(executor: nil, notification_capacity: DEFAULT_NOTIFICATION_CAPACITY) {|family| ... } ⇒ Object

Overloads:

  • .open(executor: nil, notification_capacity: DEFAULT_NOTIFICATION_CAPACITY) ⇒ Nftables

    Parameters:

    • executor (Symbol, nil) (defaults to: nil)
    • notification_capacity (Integer, nil) (defaults to: DEFAULT_NOTIFICATION_CAPACITY)

    Returns:

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

    Returns the result of the block.

    Parameters:

    • executor (Symbol, nil) (defaults to: nil)
    • notification_capacity (Integer, nil) (defaults to: DEFAULT_NOTIFICATION_CAPACITY)

    Yield Parameters:

    Returns:

    • (Object) —

      the result of the block



24
25
26
 
# File 'nl-linux/generated/nl/linux/nftables.rb', line 24

def self.open(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:



8295
8296
8297
8298
 
# File 'nl-linux/generated/nl/linux/nftables.rb', line 8295

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

#do_batch_begin(**args) ⇒ Messages::DoBatchBeginReply

Start a batch of operations

Parameters:

  • args (Hash)

Options Hash (**args):

  • nfgen_family (Integer)
  • version (Integer)
  • res_id (Integer)
  • genid (Integer) —

    generation ID for this changeset

Returns:

See Also:



6928
6929
6930
 
# File 'nl-linux/generated/nl/linux/nftables.rb', line 6928

def do_batch_begin(**args)
  exchange_message(:"do", Messages::DoBatchBeginRequest, Messages::DoBatchBeginReply, args)
end

#do_batch_end(**args) ⇒ void

This method returns an undefined value.

Finish a batch of operations

Parameters:

  • args (Hash)

Options Hash (**args):

  • nfgen_family (Integer)
  • version (Integer)
  • res_id (Integer)
  • genid (Integer) —

    generation ID for this changeset

See Also:



6940
6941
6942
 
# File 'nl-linux/generated/nl/linux/nftables.rb', line 6940

def do_batch_end(**args)
  exchange_message(:"do", Messages::DoBatchEndRequest, nil, args)
end

#do_delchain(**args) ⇒ void

This method returns an undefined value.

Delete an existing chain.

Parameters:

  • args (Hash)

Options Hash (**args):

  • nfgen_family (Integer)
  • version (Integer)
  • res_id (Integer)
  • table (String) —

    name of the table containing the chain

  • handle (Integer) —

    numeric handle of the chain

  • name (String) —

    name of the chain

  • hook (AttributeSets::NftHookAttrs, Hash<Symbol, Object>) —

    hook specification for basechains

See Also:



7089
7090
7091
 
# File 'nl-linux/generated/nl/linux/nftables.rb', line 7089

def do_delchain(**args)
  exchange_message(:"do", Messages::DoDelchainRequest, nil, args)
end

#do_delflowtable(**args) ⇒ void

This method returns an undefined value.

Delete an existing flow table.

Parameters:

  • args (Hash)

Options Hash (**args):

  • nfgen_family (Integer)
  • version (Integer)
  • res_id (Integer)
  • table (String)
  • name (String)
  • hook (AttributeSets::FlowtableHookAttrs, Hash<Symbol, Object>)
  • handle (Integer)

See Also:



7646
7647
7648
 
# File 'nl-linux/generated/nl/linux/nftables.rb', line 7646

def do_delflowtable(**args)
  exchange_message(:"do", Messages::DoDelflowtableRequest, nil, args)
end

#do_delobj(**args) ⇒ void

This method returns an undefined value.

Delete an existing stateful object.

Parameters:

  • args (Hash)

Options Hash (**args):

  • nfgen_family (Integer)
  • version (Integer)
  • res_id (Integer)
  • table (String) —

    name of the table containing the expression

  • name (String) —

    name of this expression type

  • type (Integer) —

    stateful object type

    Known enum values are defined in Nl::Linux::Nftables::Enums::ObjectType.

  • handle (Integer) —

    object handle

See Also:



7564
7565
7566
 
# File 'nl-linux/generated/nl/linux/nftables.rb', line 7564

def do_delobj(**args)
  exchange_message(:"do", Messages::DoDelobjRequest, nil, args)
end

#do_delrule(**args) ⇒ void

This method returns an undefined value.

Delete an existing rule.

Parameters:

  • args (Hash)

Options Hash (**args):

  • nfgen_family (Integer)
  • version (Integer)
  • res_id (Integer)
  • table (String) —

    name of the table containing the rule

  • chain (String) —

    name of the chain containing the rule

  • handle (Integer) —

    numeric handle of the rule

  • id (Integer) —

    uniquely identifies a rule in a transaction

See Also:



7222
7223
7224
 
# File 'nl-linux/generated/nl/linux/nftables.rb', line 7222

def do_delrule(**args)
  exchange_message(:"do", Messages::DoDelruleRequest, nil, args)
end

#do_delset(**args) ⇒ void

This method returns an undefined value.

Delete an existing set.

Parameters:

  • args (Hash)

Options Hash (**args):

  • nfgen_family (Integer)
  • version (Integer)
  • res_id (Integer)
  • table (String) —

    table name

  • name (String) —

    set name

  • handle (Integer) —

    set handle

See Also:



7315
7316
7317
 
# File 'nl-linux/generated/nl/linux/nftables.rb', line 7315

def do_delset(**args)
  exchange_message(:"do", Messages::DoDelsetRequest, nil, args)
end

#do_delsetelem(**args) ⇒ void

This method returns an undefined value.

Delete an existing set element.

Parameters:

  • args (Hash)

Options Hash (**args):

See Also:



7436
7437
7438
 
# File 'nl-linux/generated/nl/linux/nftables.rb', line 7436

def do_delsetelem(**args)
  exchange_message(:"do", Messages::DoDelsetelemRequest, nil, args)
end

#do_deltable(**args) ⇒ void

This method returns an undefined value.

Delete an existing table.

Parameters:

  • args (Hash)

Options Hash (**args):

  • nfgen_family (Integer)
  • version (Integer)
  • res_id (Integer)
  • name (String) —

    name of the table

  • handle (Integer) —

    numeric handle of the table

See Also:



7003
7004
7005
 
# File 'nl-linux/generated/nl/linux/nftables.rb', line 7003

def do_deltable(**args)
  exchange_message(:"do", Messages::DoDeltableRequest, nil, args)
end

#do_destroychain(**args) ⇒ void

This method returns an undefined value.

Delete an existing chain with destroy semantics (ignoring ENOENT errors).

Parameters:

  • args (Hash)

Options Hash (**args):

  • nfgen_family (Integer)
  • version (Integer)
  • res_id (Integer)
  • table (String) —

    name of the table containing the chain

  • handle (Integer) —

    numeric handle of the chain

  • name (String) —

    name of the chain

  • hook (AttributeSets::NftHookAttrs, Hash<Symbol, Object>) —

    hook specification for basechains

See Also:



7105
7106
7107
 
# File 'nl-linux/generated/nl/linux/nftables.rb', line 7105

def do_destroychain(**args)
  exchange_message(:"do", Messages::DoDestroychainRequest, nil, args)
end

#do_destroyflowtable(**args) ⇒ void

This method returns an undefined value.

Delete an existing flow table with destroy semantics.

Parameters:

  • args (Hash)

Options Hash (**args):

  • nfgen_family (Integer)
  • version (Integer)
  • res_id (Integer)
  • table (String)
  • name (String)
  • hook (AttributeSets::FlowtableHookAttrs, Hash<Symbol, Object>)
  • handle (Integer)

See Also:



7661
7662
7663
 
# File 'nl-linux/generated/nl/linux/nftables.rb', line 7661

def do_destroyflowtable(**args)
  exchange_message(:"do", Messages::DoDestroyflowtableRequest, nil, args)
end

#do_destroyobj(**args) ⇒ void

This method returns an undefined value.

Delete an existing stateful object with destroy semantics.

Parameters:

  • args (Hash)

Options Hash (**args):

  • nfgen_family (Integer)
  • version (Integer)
  • res_id (Integer)
  • table (String) —

    name of the table containing the expression

  • name (String) —

    name of this expression type

  • type (Integer) —

    stateful object type

    Known enum values are defined in Nl::Linux::Nftables::Enums::ObjectType.

  • handle (Integer) —

    object handle

See Also:



7581
7582
7583
 
# File 'nl-linux/generated/nl/linux/nftables.rb', line 7581

def do_destroyobj(**args)
  exchange_message(:"do", Messages::DoDestroyobjRequest, nil, args)
end

#do_destroyrule(**args) ⇒ void

This method returns an undefined value.

Delete an existing rule with destroy semantics (ignoring ENOENT errors).

Parameters:

  • args (Hash)

Options Hash (**args):

  • nfgen_family (Integer)
  • version (Integer)
  • res_id (Integer)
  • table (String) —

    name of the table containing the rule

  • chain (String) —

    name of the chain containing the rule

  • handle (Integer) —

    numeric handle of the rule

  • id (Integer) —

    uniquely identifies a rule in a transaction

See Also:



7237
7238
7239
 
# File 'nl-linux/generated/nl/linux/nftables.rb', line 7237

def do_destroyrule(**args)
  exchange_message(:"do", Messages::DoDestroyruleRequest, nil, args)
end

#do_destroyset(**args) ⇒ void

This method returns an undefined value.

Delete an existing set with destroy semantics (ignoring ENOENT errors).

Parameters:

  • args (Hash)

Options Hash (**args):

  • nfgen_family (Integer)
  • version (Integer)
  • res_id (Integer)
  • table (String) —

    table name

  • name (String) —

    set name

  • handle (Integer) —

    set handle

See Also:



7329
7330
7331
 
# File 'nl-linux/generated/nl/linux/nftables.rb', line 7329

def do_destroyset(**args)
  exchange_message(:"do", Messages::DoDestroysetRequest, nil, args)
end

#do_destroysetelem(**args) ⇒ void

This method returns an undefined value.

Delete an existing set element with destroy semantics.

Parameters:

  • args (Hash)

Options Hash (**args):

See Also:



7450
7451
7452
 
# File 'nl-linux/generated/nl/linux/nftables.rb', line 7450

def do_destroysetelem(**args)
  exchange_message(:"do", Messages::DoDestroysetelemRequest, nil, args)
end

#do_destroytable(**args) ⇒ void

This method returns an undefined value.

Delete an existing table with destroy semantics (ignoring ENOENT errors).

Parameters:

  • args (Hash)

Options Hash (**args):

  • nfgen_family (Integer)
  • version (Integer)
  • res_id (Integer)
  • name (String) —

    name of the table

  • handle (Integer) —

    numeric handle of the table

See Also:



7017
7018
7019
 
# File 'nl-linux/generated/nl/linux/nftables.rb', line 7017

def do_destroytable(**args)
  exchange_message(:"do", Messages::DoDestroytableRequest, nil, args)
end

#do_getchain(**args) ⇒ Messages::DoGetchainReply

Get / dump chains.

Parameters:

  • args (Hash)

Options Hash (**args):

  • nfgen_family (Integer)
  • version (Integer)
  • res_id (Integer)
  • table (String) —

    name of the table containing the chain

  • name (String) —

    name of the chain

Returns:

See Also:



7052
7053
7054
 
# File 'nl-linux/generated/nl/linux/nftables.rb', line 7052

def do_getchain(**args)
  exchange_message(:"do", Messages::DoGetchainRequest, Messages::DoGetchainReply, args)
end

#do_getflowtable(**args) ⇒ Messages::DoGetflowtableReply

Get / dump flow tables.

Parameters:

  • args (Hash)

Options Hash (**args):

  • nfgen_family (Integer)
  • version (Integer)
  • res_id (Integer)
  • table (String)
  • name (String)

Returns:

See Also:



7609
7610
7611
 
# File 'nl-linux/generated/nl/linux/nftables.rb', line 7609

def do_getflowtable(**args)
  exchange_message(:"do", Messages::DoGetflowtableRequest, Messages::DoGetflowtableReply, args)
end

#do_getgen(**args) ⇒ Messages::DoGetgenReply

Get / dump rule-set generation.

Parameters:

  • args (Hash)

Options Hash (**args):

  • nfgen_family (Integer)
  • version (Integer)
  • res_id (Integer)

Returns:

See Also:



7461
7462
7463
 
# File 'nl-linux/generated/nl/linux/nftables.rb', line 7461

def do_getgen(**args)
  exchange_message(:"do", Messages::DoGetgenRequest, Messages::DoGetgenReply, args)
end

#do_getobj(**args) ⇒ Messages::DoGetobjReply

Get / dump stateful objects.

Parameters:

  • args (Hash)

Options Hash (**args):

  • nfgen_family (Integer)
  • version (Integer)
  • res_id (Integer)
  • table (String) —

    name of the table containing the expression

  • name (String) —

    name of this expression type

  • type (Integer) —

    stateful object type

    Known enum values are defined in Nl::Linux::Nftables::Enums::ObjectType.

Returns:

See Also:



7517
7518
7519
 
# File 'nl-linux/generated/nl/linux/nftables.rb', line 7517

def do_getobj(**args)
  exchange_message(:"do", Messages::DoGetobjRequest, Messages::DoGetobjReply, args)
end

#do_getrule(**args) ⇒ Messages::DoGetruleReply

Get / dump rules.

Parameters:

  • args (Hash)

Options Hash (**args):

  • nfgen_family (Integer)
  • version (Integer)
  • res_id (Integer)
  • table (String) —

    name of the table containing the rule

  • chain (String) —

    name of the chain containing the rule

  • handle (Integer) —

    numeric handle of the rule

Returns:

See Also:



7139
7140
7141
 
# File 'nl-linux/generated/nl/linux/nftables.rb', line 7139

def do_getrule(**args)
  exchange_message(:"do", Messages::DoGetruleRequest, Messages::DoGetruleReply, args)
end

#do_getrule_reset(**args) ⇒ Messages::DoGetruleResetReply

Get / dump rules and reset stateful expressions.

Parameters:

  • args (Hash)

Options Hash (**args):

  • nfgen_family (Integer)
  • version (Integer)
  • res_id (Integer)
  • table (String) —

    name of the table containing the rule

  • chain (String) —

    name of the chain containing the rule

  • handle (Integer) —

    numeric handle of the rule

Returns:

See Also:



7179
7180
7181
 
# File 'nl-linux/generated/nl/linux/nftables.rb', line 7179

def do_getrule_reset(**args)
  exchange_message(:"do", Messages::DoGetruleResetRequest, Messages::DoGetruleResetReply, args)
end

#do_getset(**args) ⇒ Messages::DoGetsetReply

Get / dump sets.

Parameters:

  • args (Hash)

Options Hash (**args):

  • nfgen_family (Integer)
  • version (Integer)
  • res_id (Integer)
  • table (String) —

    table name

  • name (String) —

    set name

Returns:

See Also:



7277
7278
7279
 
# File 'nl-linux/generated/nl/linux/nftables.rb', line 7277

def do_getset(**args)
  exchange_message(:"do", Messages::DoGetsetRequest, Messages::DoGetsetReply, args)
end

#do_getsetelem(**args) ⇒ Messages::DoGetsetelemReply

Get / dump set elements.

Parameters:

  • args (Hash)

Options Hash (**args):

Returns:

See Also:



7358
7359
7360
 
# File 'nl-linux/generated/nl/linux/nftables.rb', line 7358

def do_getsetelem(**args)
  exchange_message(:"do", Messages::DoGetsetelemRequest, Messages::DoGetsetelemReply, args)
end

#do_getsetelem_reset(**args) ⇒ Messages::DoGetsetelemResetReply

Get / dump set elements and reset stateful expressions.

Parameters:

  • args (Hash)

Options Hash (**args):

Returns:

See Also:



7396
7397
7398
 
# File 'nl-linux/generated/nl/linux/nftables.rb', line 7396

def do_getsetelem_reset(**args)
  exchange_message(:"do", Messages::DoGetsetelemResetRequest, Messages::DoGetsetelemResetReply, args)
end

#do_gettable(**args) ⇒ Messages::DoGettableReply

Get / dump tables.

Parameters:

  • args (Hash)

Options Hash (**args):

  • nfgen_family (Integer)
  • version (Integer)
  • res_id (Integer)
  • name (String) —

    name of the table

Returns:

See Also:



6968
6969
6970
 
# File 'nl-linux/generated/nl/linux/nftables.rb', line 6968

def do_gettable(**args)
  exchange_message(:"do", Messages::DoGettableRequest, Messages::DoGettableReply, args)
end

#do_newchain(**args) ⇒ void

This method returns an undefined value.

Create a new chain.

Parameters:

  • args (Hash)

Options Hash (**args):

  • nfgen_family (Integer)
  • version (Integer)
  • res_id (Integer)
  • table (String) —

    name of the table containing the chain

  • handle (Integer) —

    numeric handle of the chain

  • name (String) —

    name of the chain

  • hook (AttributeSets::NftHookAttrs, Hash<Symbol, Object>) —

    hook specification for basechains

  • policy (Integer) —

    numeric policy of the chain

  • type (String) —

    type name of the chain

  • counters (AttributeSets::NftCounterAttrs, Hash<Symbol, Object>) —

    counter specification of the chain

  • flags (Integer) —

    chain flags

    Known flags are defined in Nl::Linux::Nftables::Flags::ChainFlags.

  • userdata (String) —

    user data

See Also:



7039
7040
7041
 
# File 'nl-linux/generated/nl/linux/nftables.rb', line 7039

def do_newchain(**args)
  exchange_message(:"do", Messages::DoNewchainRequest, nil, args)
end

#do_newflowtable(**args) ⇒ void

This method returns an undefined value.

Create a new flow table.

Parameters:

  • args (Hash)

Options Hash (**args):

  • nfgen_family (Integer)
  • version (Integer)
  • res_id (Integer)
  • table (String)
  • name (String)
  • hook (AttributeSets::FlowtableHookAttrs, Hash<Symbol, Object>)
  • flags (Integer)

See Also:



7596
7597
7598
 
# File 'nl-linux/generated/nl/linux/nftables.rb', line 7596

def do_newflowtable(**args)
  exchange_message(:"do", Messages::DoNewflowtableRequest, nil, args)
end

#do_newobj(**args) ⇒ void

This method returns an undefined value.

Create a new stateful object.

Parameters:

  • args (Hash)

Options Hash (**args):

See Also:



7501
7502
7503
 
# File 'nl-linux/generated/nl/linux/nftables.rb', line 7501

def do_newobj(**args)
  exchange_message(:"do", Messages::DoNewobjRequest, nil, args)
end

#do_newrule(**args) ⇒ void

This method returns an undefined value.

Create a new rule.

Parameters:

  • args (Hash)

Options Hash (**args):

  • nfgen_family (Integer)
  • version (Integer)
  • res_id (Integer)
  • table (String) —

    name of the table containing the rule

  • chain (String) —

    name of the chain containing the rule

  • handle (Integer) —

    numeric handle of the rule

  • expressions (AttributeSets::ExprListAttrs, Hash<Symbol, Object>) —

    list of expressions

  • compat (AttributeSets::RuleCompatAttrs, Hash<Symbol, Object>) —

    compatibility specifications of the rule

  • position (Integer) —

    numeric handle of the previous rule

  • userdata (String) —

    user data

  • position_id (Integer) —

    transaction unique identifier of the previous rule

  • chain_id (Integer) —

    add the rule to chain by ID, alternative to chain name

See Also:



7125
7126
7127
 
# File 'nl-linux/generated/nl/linux/nftables.rb', line 7125

def do_newrule(**args)
  exchange_message(:"do", Messages::DoNewruleRequest, nil, args)
end

#do_newset(**args) ⇒ void

This method returns an undefined value.

Create a new set.

Parameters:

  • args (Hash)

Options Hash (**args):

  • nfgen_family (Integer)
  • version (Integer)
  • res_id (Integer)
  • table (String) —

    table name

  • name (String) —

    set name

  • flags (Integer) —

    bitmask of enum nft_set_flags

    Known flags are defined in Nl::Linux::Nftables::Flags::SetFlags.

  • key_type (Integer) —

    key data type, informational purpose only

  • key_len (Integer) —

    key data length

  • data_type (Integer) —

    mapping data type

  • data_len (Integer) —

    mapping data length

  • policy (Integer) —

    selection policy

  • desc (AttributeSets::SetDescAttrs, Hash<Symbol, Object>) —

    set description

  • id (Integer) —

    uniquely identifies a set in a transaction

  • timeout (Integer) —

    default timeout value

  • gc_interval (Integer) —

    garbage collection interval

  • userdata (String) —

    user data

  • obj_type (Integer) —

    stateful object type

See Also:



7264
7265
7266
 
# File 'nl-linux/generated/nl/linux/nftables.rb', line 7264

def do_newset(**args)
  exchange_message(:"do", Messages::DoNewsetRequest, nil, args)
end

#do_newsetelem(**args) ⇒ void

This method returns an undefined value.

Create a new set element.

Parameters:

  • args (Hash)

Options Hash (**args):

See Also:



7344
7345
7346
 
# File 'nl-linux/generated/nl/linux/nftables.rb', line 7344

def do_newsetelem(**args)
  exchange_message(:"do", Messages::DoNewsetelemRequest, nil, args)
end

#do_newtable(**args) ⇒ void

This method returns an undefined value.

Create a new table.

Parameters:

  • args (Hash)

Options Hash (**args):

  • nfgen_family (Integer)
  • version (Integer)
  • res_id (Integer)
  • name (String) —

    name of the table

  • flags (Integer) —

    bitmask of flags

    Known flags are defined in Nl::Linux::Nftables::Flags::TableFlags.

  • userdata (String) —

    user data

See Also:



6956
6957
6958
 
# File 'nl-linux/generated/nl/linux/nftables.rb', line 6956

def do_newtable(**args)
  exchange_message(:"do", Messages::DoNewtableRequest, nil, args)
end

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

Get / dump chains.

Overloads:

  • #dump_getchain(**args) ⇒ Array<Messages::DumpGetchainReply>

    Returns an array when no block is given.

    Parameters:

    • args (Hash)

    Options Hash (**args):

    • nfgen_family (Integer)
    • version (Integer)
    • res_id (Integer)

    Returns:

  • #dump_getchain(**args) {|reply| ... } ⇒ void

    This method returns an undefined value.

    Yields each reply when a block is given.

    Parameters:

    • args (Hash)

    Options Hash (**args):

    • nfgen_family (Integer)
    • version (Integer)
    • res_id (Integer)

    Yield Parameters:

See Also:



7074
7075
7076
 
# File 'nl-linux/generated/nl/linux/nftables.rb', line 7074

def dump_getchain(**args, &block)
  exchange_message(:"dump", Messages::DumpGetchainRequest, Messages::DumpGetchainReply, args, &block)
end

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

Get / dump flow tables.

Overloads:

  • #dump_getflowtable(**args) ⇒ Array<Messages::DumpGetflowtableReply>

    Returns an array when no block is given.

    Parameters:

    • args (Hash)

    Options Hash (**args):

    • nfgen_family (Integer)
    • version (Integer)
    • res_id (Integer)

    Returns:

  • #dump_getflowtable(**args) {|reply| ... } ⇒ void

    This method returns an undefined value.

    Yields each reply when a block is given.

    Parameters:

    • args (Hash)

    Options Hash (**args):

    • nfgen_family (Integer)
    • version (Integer)
    • res_id (Integer)

    Yield Parameters:

See Also:



7631
7632
7633
 
# File 'nl-linux/generated/nl/linux/nftables.rb', line 7631

def dump_getflowtable(**args, &block)
  exchange_message(:"dump", Messages::DumpGetflowtableRequest, Messages::DumpGetflowtableReply, args, &block)
end

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

Get / dump rule-set generation.

Overloads:

  • #dump_getgen(**args) ⇒ Array<Messages::DumpGetgenReply>

    Returns an array when no block is given.

    Parameters:

    • args (Hash)

    Options Hash (**args):

    • nfgen_family (Integer)
    • version (Integer)
    • res_id (Integer)

    Returns:

  • #dump_getgen(**args) {|reply| ... } ⇒ void

    This method returns an undefined value.

    Yields each reply when a block is given.

    Parameters:

    • args (Hash)

    Options Hash (**args):

    • nfgen_family (Integer)
    • version (Integer)
    • res_id (Integer)

    Yield Parameters:

See Also:



7483
7484
7485
 
# File 'nl-linux/generated/nl/linux/nftables.rb', line 7483

def dump_getgen(**args, &block)
  exchange_message(:"dump", Messages::DumpGetgenRequest, Messages::DumpGetgenReply, args, &block)
end

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

Get / dump stateful objects.

Overloads:

  • #dump_getobj(**args) ⇒ Array<Messages::DumpGetobjReply>

    Returns an array when no block is given.

    Parameters:

    • args (Hash)

    Options Hash (**args):

    • nfgen_family (Integer)
    • version (Integer)
    • res_id (Integer)
    • table (String) —

      name of the table containing the expression

    • type (Integer) —

      stateful object type

      Known enum values are defined in Nl::Linux::Nftables::Enums::ObjectType.

    Returns:

  • #dump_getobj(**args) {|reply| ... } ⇒ void

    This method returns an undefined value.

    Yields each reply when a block is given.

    Parameters:

    • args (Hash)

    Options Hash (**args):

    • nfgen_family (Integer)
    • version (Integer)
    • res_id (Integer)
    • table (String) —

      name of the table containing the expression

    • type (Integer) —

      stateful object type

      Known enum values are defined in Nl::Linux::Nftables::Enums::ObjectType.

    Yield Parameters:

See Also:



7547
7548
7549
 
# File 'nl-linux/generated/nl/linux/nftables.rb', line 7547

def dump_getobj(**args, &block)
  exchange_message(:"dump", Messages::DumpGetobjRequest, Messages::DumpGetobjReply, args, &block)
end

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

Get / dump rules.

Overloads:

  • #dump_getrule(**args) ⇒ Array<Messages::DumpGetruleReply>

    Returns an array when no block is given.

    Parameters:

    • args (Hash)

    Options Hash (**args):

    • nfgen_family (Integer)
    • version (Integer)
    • res_id (Integer)
    • table (String) —

      name of the table containing the rule

    • chain (String) —

      name of the chain containing the rule

    Returns:

  • #dump_getrule(**args) {|reply| ... } ⇒ void

    This method returns an undefined value.

    Yields each reply when a block is given.

    Parameters:

    • args (Hash)

    Options Hash (**args):

    • nfgen_family (Integer)
    • version (Integer)
    • res_id (Integer)
    • table (String) —

      name of the table containing the rule

    • chain (String) —

      name of the chain containing the rule

    Yield Parameters:

See Also:



7165
7166
7167
 
# File 'nl-linux/generated/nl/linux/nftables.rb', line 7165

def dump_getrule(**args, &block)
  exchange_message(:"dump", Messages::DumpGetruleRequest, Messages::DumpGetruleReply, args, &block)
end

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

Get / dump rules and reset stateful expressions.

Overloads:

  • #dump_getrule_reset(**args) ⇒ Array<Messages::DumpGetruleResetReply>

    Returns an array when no block is given.

    Parameters:

    • args (Hash)

    Options Hash (**args):

    • nfgen_family (Integer)
    • version (Integer)
    • res_id (Integer)
    • table (String) —

      name of the table containing the rule

    • chain (String) —

      name of the chain containing the rule

    • handle (Integer) —

      numeric handle of the rule

    Returns:

  • #dump_getrule_reset(**args) {|reply| ... } ⇒ void

    This method returns an undefined value.

    Yields each reply when a block is given.

    Parameters:

    • args (Hash)

    Options Hash (**args):

    • nfgen_family (Integer)
    • version (Integer)
    • res_id (Integer)
    • table (String) —

      name of the table containing the rule

    • chain (String) —

      name of the chain containing the rule

    • handle (Integer) —

      numeric handle of the rule

    Yield Parameters:

See Also:



7207
7208
7209
 
# File 'nl-linux/generated/nl/linux/nftables.rb', line 7207

def dump_getrule_reset(**args, &block)
  exchange_message(:"dump", Messages::DumpGetruleResetRequest, Messages::DumpGetruleResetReply, args, &block)
end

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

Get / dump sets.

Overloads:

  • #dump_getset(**args) ⇒ Array<Messages::DumpGetsetReply>

    Returns an array when no block is given.

    Parameters:

    • args (Hash)

    Options Hash (**args):

    • nfgen_family (Integer)
    • version (Integer)
    • res_id (Integer)
    • table (String) —

      table name

    Returns:

  • #dump_getset(**args) {|reply| ... } ⇒ void

    This method returns an undefined value.

    Yields each reply when a block is given.

    Parameters:

    • args (Hash)

    Options Hash (**args):

    • nfgen_family (Integer)
    • version (Integer)
    • res_id (Integer)
    • table (String) —

      table name

    Yield Parameters:

See Also:



7301
7302
7303
 
# File 'nl-linux/generated/nl/linux/nftables.rb', line 7301

def dump_getset(**args, &block)
  exchange_message(:"dump", Messages::DumpGetsetRequest, Messages::DumpGetsetReply, args, &block)
end

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

Get / dump set elements.

Overloads:

  • #dump_getsetelem(**args) ⇒ Array<Messages::DumpGetsetelemReply>

    Returns an array when no block is given.

    Parameters:

    • args (Hash)

    Options Hash (**args):

    • nfgen_family (Integer)
    • version (Integer)
    • res_id (Integer)
    • table (String)
    • set (String)

    Returns:

  • #dump_getsetelem(**args) {|reply| ... } ⇒ void

    This method returns an undefined value.

    Yields each reply when a block is given.

    Parameters:

    • args (Hash)

    Options Hash (**args):

    • nfgen_family (Integer)
    • version (Integer)
    • res_id (Integer)
    • table (String)
    • set (String)

    Yield Parameters:

See Also:



7384
7385
7386
 
# File 'nl-linux/generated/nl/linux/nftables.rb', line 7384

def dump_getsetelem(**args, &block)
  exchange_message(:"dump", Messages::DumpGetsetelemRequest, Messages::DumpGetsetelemReply, args, &block)
end

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

Get / dump set elements and reset stateful expressions.

Overloads:

  • #dump_getsetelem_reset(**args) ⇒ Array<Messages::DumpGetsetelemResetReply>

    Returns an array when no block is given.

    Parameters:

    • args (Hash)

    Options Hash (**args):

    • nfgen_family (Integer)
    • version (Integer)
    • res_id (Integer)
    • table (String)
    • set (String)

    Returns:

  • #dump_getsetelem_reset(**args) {|reply| ... } ⇒ void

    This method returns an undefined value.

    Yields each reply when a block is given.

    Parameters:

    • args (Hash)

    Options Hash (**args):

    • nfgen_family (Integer)
    • version (Integer)
    • res_id (Integer)
    • table (String)
    • set (String)

    Yield Parameters:

See Also:



7422
7423
7424
 
# File 'nl-linux/generated/nl/linux/nftables.rb', line 7422

def dump_getsetelem_reset(**args, &block)
  exchange_message(:"dump", Messages::DumpGetsetelemResetRequest, Messages::DumpGetsetelemResetReply, args, &block)
end

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

Get / dump tables.

Overloads:

  • #dump_gettable(**args) ⇒ Array<Messages::DumpGettableReply>

    Returns an array when no block is given.

    Parameters:

    • args (Hash)

    Options Hash (**args):

    • nfgen_family (Integer)
    • version (Integer)
    • res_id (Integer)

    Returns:

  • #dump_gettable(**args) {|reply| ... } ⇒ void

    This method returns an undefined value.

    Yields each reply when a block is given.

    Parameters:

    • args (Hash)

    Options Hash (**args):

    • nfgen_family (Integer)
    • version (Integer)
    • res_id (Integer)

    Yield Parameters:

See Also:



6990
6991
6992
 
# File 'nl-linux/generated/nl/linux/nftables.rb', line 6990

def dump_gettable(**args, &block)
  exchange_message(:"dump", Messages::DumpGettableRequest, Messages::DumpGettableReply, args, &block)
end

#subscribe(*groups) ⇒ self

Parameters:

  • groups (Array<:mgmt>)

Returns:

  • (self) 


8302
8303
8304
8305
 
# File 'nl-linux/generated/nl/linux/nftables.rb', line 8302

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

#unsubscribe(*groups) ⇒ self

Parameters:

  • groups (Array<:mgmt>)

Returns:

  • (self) 


8306
 
# File 'nl-linux/generated/nl/linux/nftables.rb', line 8306

def unsubscribe(*groups) = super