Class: Nl::Linux::OvsFlow::AsyncOperations

Inherits:

Object

• Object
• Nl::Linux::OvsFlow::AsyncOperations

Defined in:

nl-linux/generated/nl/linux/ovs_flow.rb

Instance Method Summary

• #do_get(**args) ⇒ Nl::Async::Future<Messages::DoGetReply>

  Get / dump OVS flow configuration and state.

• #do_new(**args) ⇒ Nl::Async::Future<void>

  Create OVS flow configuration in a data path.

• #dump_get(**args) ⇒ Nl::Async::Stream<Messages::DumpGetReply>

  Get / dump OVS flow configuration and state.

Instance Method Details

#do_get(**args) ⇒ Nl::Async::Future<Messages::DoGetReply>

Get / dump OVS flow configuration and state

Parameters:

• args (Hash)

Options Hash (**args):

• dp_ifindex (Integer) —

  ifindex of local port for datapath (0 to make a request not specific to a datapath).

• key (AttributeSets::KeyAttrs, Hash<Symbol, Object>) —

  Nested attributes specifying the flow key. Always present in notifications. Required for all requests (except dumps).

• ufid (String) —

  A value between 1-16 octets specifying a unique identifier for the flow. Causes the flow to be indexed by this value rather than the value of the OVS_FLOW_ATTR_KEY attribute. Optional for all requests. Present in notifications if the flow was created with this attribute.

• ufid_flags (Integer) —

  A 32-bit value of ORed flags that provide alternative semantics for flow installation and retrieval. Optional for all requests.

  Known flags are defined in Flags::OvsUfidFlags.

Returns:

• (Nl::Async::Future<Messages::DoGetReply>)

See Also:

• Messages::DoGetRequest

# File 'nl-linux/generated/nl/linux/ovs_flow.rb', line 2883

def do_get(**args)
  @exchange.call(:"do", Messages::DoGetRequest, Messages::DoGetReply, args)
end

#do_new(**args) ⇒ Nl::Async::Future<void>

Create OVS flow configuration in a data path

Parameters:

• args (Hash)

Options Hash (**args):

• dp_ifindex (Integer) —

  ifindex of local port for datapath (0 to make a request not specific to a datapath).

• key (AttributeSets::KeyAttrs, Hash<Symbol, Object>) —

  Nested attributes specifying the flow key. Always present in notifications. Required for all requests (except dumps).

• actions (AttributeSets::ActionAttrs, Hash<Symbol, Object>) —

  Nested attributes specifying the actions to take for packets that match the key. Always present in notifications. Required for OVS_FLOW_CMD_NEW requests, optional for OVS_FLOW_CMD_SET requests. An OVS_FLOW_CMD_SET without OVS_FLOW_ATTR_ACTIONS will not modify the actions. To clear the actions, an OVS_FLOW_ATTR_ACTIONS without any nested attributes must be given.

• mask (AttributeSets::KeyAttrs, Hash<Symbol, Object>) —

  Nested attributes specifying the mask bits for wildcarded flow match. Mask bit value '1' specifies exact match with corresponding flow key bit, while mask bit value '0' specifies a wildcarded match. Omitting attribute is treated as wildcarding all corresponding fields. Optional for all requests. If not present, all flow key bits are exact match bits.

• ufid (String) —

  A value between 1-16 octets specifying a unique identifier for the flow. Causes the flow to be indexed by this value rather than the value of the OVS_FLOW_ATTR_KEY attribute. Optional for all requests. Present in notifications if the flow was created with this attribute.

Returns:

• (Nl::Async::Future<void>)

See Also:

• Messages::DoNewRequest

# File 'nl-linux/generated/nl/linux/ovs_flow.rb', line 2934

def do_new(**args)
  @exchange.call(:"do", Messages::DoNewRequest, nil, args)
end

#dump_get(**args) ⇒ Nl::Async::Stream<Messages::DumpGetReply>

Get / dump OVS flow configuration and state

Parameters:

• args (Hash)

Options Hash (**args):

• dp_ifindex (Integer) —

  ifindex of local port for datapath (0 to make a request not specific to a datapath).

• key (AttributeSets::KeyAttrs, Hash<Symbol, Object>) —

  Nested attributes specifying the flow key. Always present in notifications. Required for all requests (except dumps).

• ufid (String) —

  A value between 1-16 octets specifying a unique identifier for the flow. Causes the flow to be indexed by this value rather than the value of the OVS_FLOW_ATTR_KEY attribute. Optional for all requests. Present in notifications if the flow was created with this attribute.

• ufid_flags (Integer) —

  A 32-bit value of ORed flags that provide alternative semantics for flow installation and retrieval. Optional for all requests.

  Known flags are defined in Flags::OvsUfidFlags.

Returns:

• (Nl::Async::Stream<Messages::DumpGetReply>)

See Also:

• Messages::DumpGetRequest

# File 'nl-linux/generated/nl/linux/ovs_flow.rb', line 2905

def dump_get(**args)
  @exchange.call(:"dump", Messages::DumpGetRequest, Messages::DumpGetReply, args)
end