Class: IControl::Networking::ARP

Inherits:
Base
  • Object
show all
Defined in:
lib/icontrol/networking/arp.rb,
lib/icontrol/networking.rb

Overview

The ARP interface enables you to work with the ARP table and entries.

Defined Under Namespace

Classes: ARPEntry, ARPEntrySequence, ARPStatistics, NDPEntry, NDPEntrySequence, NDPState, NDPStateSequence, NDPStatistics, StaticEntry, StaticEntrySequence

Instance Method Summary collapse

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class IControl::Base

Instance Method Details

#add_static_entry ⇒ Object

Creates/adds this static ARP/NDP entrie to the ARP/NDP table.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



24
25
26
 
# File 'lib/icontrol/networking/arp.rb', line 24

def add_static_entry
  super
end

#delete_all_dynamic_arps ⇒ Object

Deletes all dynamic ARP entrie from the ARP table.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



34
35
36
 
# File 'lib/icontrol/networking/arp.rb', line 34

def delete_all_dynamic_arps
  super
end

#delete_all_dynamic_ndps ⇒ Object

Deletes all dynamic NDP entrie from the NDP table.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



44
45
46
 
# File 'lib/icontrol/networking/arp.rb', line 44

def delete_all_dynamic_ndps
  super
end

#delete_all_static_entries ⇒ Object

Deletes all static ARP/NDP entrie from the ARP/NDP table.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



54
55
56
 
# File 'lib/icontrol/networking/arp.rb', line 54

def delete_all_static_entries
  super
end

#delete_static_entry ⇒ Object

Deletes this static ARP/NDP entrie from the ARP/NDP table.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



64
65
66
 
# File 'lib/icontrol/networking/arp.rb', line 64

def delete_static_entry
  super
end

#dynamic_arp(opts) ⇒ ARPStatistics

Gets the dynamic ARP statistics for this ARP addresses.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :arp_addresses (String) —

    The ARP IP addresses.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



77
78
79
80
 
# File 'lib/icontrol/networking/arp.rb', line 77

def dynamic_arp(opts)
  opts = check_params(opts,[:arp_addresses])
  super(opts)
end

#dynamic_ndp(opts) ⇒ NDPStatistics

Gets the dynamic NDP statistics for this NDP addresses.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :ndp_addresses (String) —

    The NDP IP addresses.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



91
92
93
94
 
# File 'lib/icontrol/networking/arp.rb', line 91

def dynamic_ndp(opts)
  opts = check_params(opts,[:ndp_addresses])
  super(opts)
end

#static_entry ⇒ StaticEntry

Gets a list of all static ARP/NDP entrie.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



103
104
105
 
# File 'lib/icontrol/networking/arp.rb', line 103

def static_entry
  super
end

#version ⇒ String

Gets the version information for this interface.

Returns:

  • (String) 


111
112
113
 
# File 'lib/icontrol/networking/arp.rb', line 111

def version
  super
end