Class: Nl::Linux::Ovpn::AsyncOperations

Inherits:
Object
  • Object
show all
Defined in:
nl-linux/generated/nl/linux/ovpn.rb

Instance Method Summary collapse

Instance Method Details

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

Delete cipher key for a specific peer

Requires CAP_NET_ADMIN in the initial user namespace.

Parameters:

  • args (Hash)

Options Hash (**args):

  • ifindex (Integer) —

    Index of the ovpn interface to operate on

  • keyconf (AttributeSets::KeyconfDelInput, Hash<Symbol, Object>) —

    Peer specific cipher configuration

Returns:

See Also:



2056
2057
2058
 
# File 'nl-linux/generated/nl/linux/ovpn.rb', line 2056

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

#do_key_get(**args) ⇒ Nl::Async::Future<Messages::DoKeyGetReply>

Retrieve non-sensitive data about peer key and cipher

Requires CAP_NET_ADMIN in the initial user namespace.

Parameters:

  • args (Hash)

Options Hash (**args):

  • ifindex (Integer) —

    Index of the ovpn interface to operate on

  • keyconf (AttributeSets::KeyconfGet, Hash<Symbol, Object>) —

    Peer specific cipher configuration

Returns:

See Also:



2032
2033
2034
 
# File 'nl-linux/generated/nl/linux/ovpn.rb', line 2032

def do_key_get(**args)
  @exchange.call(:"do", Messages::DoKeyGetRequest, Messages::DoKeyGetReply, args)
end

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

Add a cipher key for a specific peer

Requires CAP_NET_ADMIN in the initial user namespace.

Parameters:

  • args (Hash)

Options Hash (**args):

  • ifindex (Integer) —

    Index of the ovpn interface to operate on

  • keyconf (AttributeSets::Keyconf, Hash<Symbol, Object>) —

    Peer specific cipher configuration

Returns:

See Also:



2020
2021
2022
 
# File 'nl-linux/generated/nl/linux/ovpn.rb', line 2020

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

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

Swap primary and secondary session keys for a specific peer

Requires CAP_NET_ADMIN in the initial user namespace.

Parameters:

  • args (Hash)

Options Hash (**args):

  • ifindex (Integer) —

    Index of the ovpn interface to operate on

  • keyconf (AttributeSets::KeyconfSwapInput, Hash<Symbol, Object>) —

    Peer specific cipher configuration

Returns:

See Also:



2044
2045
2046
 
# File 'nl-linux/generated/nl/linux/ovpn.rb', line 2044

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

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

Delete existing remote peer

Requires CAP_NET_ADMIN in the initial user namespace.

Parameters:

  • args (Hash)

Options Hash (**args):

  • ifindex (Integer) —

    Index of the ovpn interface to operate on

  • peer (AttributeSets::PeerDelInput, Hash<Symbol, Object>) —

    The peer object containing the attributed of interest for the specific operation

Returns:

See Also:



2008
2009
2010
 
# File 'nl-linux/generated/nl/linux/ovpn.rb', line 2008

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

#do_peer_get(**args) ⇒ Nl::Async::Future<Messages::DoPeerGetReply>

Retrieve data about existing remote peers (or a specific one)

Requires CAP_NET_ADMIN in the initial user namespace.

Parameters:

  • args (Hash)

Options Hash (**args):

  • ifindex (Integer) —

    Index of the ovpn interface to operate on

  • peer (AttributeSets::Peer, Hash<Symbol, Object>) —

    The peer object containing the attributed of interest for the specific operation

Returns:

See Also:



1985
1986
1987
 
# File 'nl-linux/generated/nl/linux/ovpn.rb', line 1985

def do_peer_get(**args)
  @exchange.call(:"do", Messages::DoPeerGetRequest, Messages::DoPeerGetReply, args)
end

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

Add a remote peer

Requires CAP_NET_ADMIN in the initial user namespace.

Parameters:

  • args (Hash)

Options Hash (**args):

  • ifindex (Integer) —

    Index of the ovpn interface to operate on

  • peer (AttributeSets::PeerNewInput, Hash<Symbol, Object>) —

    The peer object containing the attributed of interest for the specific operation

Returns:

See Also:



1961
1962
1963
 
# File 'nl-linux/generated/nl/linux/ovpn.rb', line 1961

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

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

modify a remote peer

Requires CAP_NET_ADMIN in the initial user namespace.

Parameters:

  • args (Hash)

Options Hash (**args):

  • ifindex (Integer) —

    Index of the ovpn interface to operate on

  • peer (AttributeSets::PeerSetInput, Hash<Symbol, Object>) —

    The peer object containing the attributed of interest for the specific operation

Returns:

See Also:



1973
1974
1975
 
# File 'nl-linux/generated/nl/linux/ovpn.rb', line 1973

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

#dump_peer_get(**args) ⇒ Nl::Async::Stream<Messages::DumpPeerGetReply>

Retrieve data about existing remote peers (or a specific one)

Requires CAP_NET_ADMIN in the initial user namespace.

Parameters:

  • args (Hash)

Options Hash (**args):

  • ifindex (Integer) —

    Index of the ovpn interface to operate on

Returns:

See Also:



1996
1997
1998
 
# File 'nl-linux/generated/nl/linux/ovpn.rb', line 1996

def dump_peer_get(**args)
  @exchange.call(:"dump", Messages::DumpPeerGetRequest, Messages::DumpPeerGetReply, args)
end