rubybvc 0.3.1 → 1.0.0

data/lib/netconfdev/vrouter/vrouter5600.rb

@@ -28,23 +28,44 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 # THE POSSIBILITY OF SUCH DAMAGE.
 
+##
+# Class that represents a VRouter 5600 device.
+#
 class VRouter5600 < NetconfNode
   require 'netconfdev/vrouter/firewall'
   require 'netconfdev/vrouter/rules'
   require 'netconfdev/vrouter/rule'
   require 'netconfdev/vrouter/dataplane_firewall'
   
+  ##
+  # Return a list of YANG schemas for this VRouter5600.
+  #
+  # _Return_ _Value_
+  # * NetconfResponse :  Status ( NetconfResponseStatus ) and list of YANG schemas for the node.
   def get_schemas
     @controller.get_schemas(@name)
   end
-  
+ 
+  ##
+  # Return a YANG schema for the indicated schema on the VRouter5600.
+  #
+  # _Parameters_ 
+  # * +id+:: String : Identifier for schema
+  # * +version+:: String : Version/date for schema
+  # _Return_ _Value_
+  # * NetconfResponse :  Status ( NetconfResponseStatus ) and YANG schema.  
   def get_schema(id: nil, version: nil)
     raise ArgumentError, "Identifier (id) required" unless id
     raise ArgumentError, "Version (version) required" unless version
     
     @controller.get_schema(@name, id: id, version: version)
   end
-  
+
+  ##
+  # Return configuration of the VRouter5600.
+  #
+  # _Return_ _Value_
+  # * NetconfResponse :  Status ( NetconfResponseStatus ) and configuration of VRouter5600. 
   def get_cfg
     get_uri = @controller.get_ext_mount_config_uri(self)
     response = @controller.rest_agent.get_request(get_uri)
@@ -52,7 +73,12 @@ class VRouter5600 < NetconfNode
       NetconfResponse.new(NetconfResponseStatus::OK, body)
     end
   end
-  
+
+  ##
+  # Return firewall configuration of the VRouter5600.
+  #
+  # _Return_ _Value_
+  # * NetconfResponse :  Status ( NetconfResponseStatus ) and Firewall configuration JSON.  
   def get_firewalls_cfg
     get_uri = "#{@controller.get_ext_mount_config_uri(self)}/"\
       "vyatta-security:security/vyatta-security-firewall:firewall"
@@ -61,7 +87,14 @@ class VRouter5600 < NetconfNode
       NetconfResponse.new(NetconfResponseStatus::OK, body)
     end
   end
-  
+
+  ##
+  # Return configuration for a specific firewall on the VRouter5600.
+  #
+  # _Parameters_ 
+  # * +firewall_or_name+:: Firewall or String : A Firewall object or name of firewall for which you want the configuration.  
+  # _Return_ _Value_
+  # * NetconfResponse :  Status ( NetconfResponseStatus ) and configuration of requested firewall.  
   def get_firewall_instance_cfg(firewall_or_name)
     firewall_name = firewall_or_name.is_a?(Firewall) ? firewall_or_name.rules.name :
       firewall_or_name 
@@ -73,7 +106,14 @@ class VRouter5600 < NetconfNode
       NetconfResponse.new(NetconfResponseStatus::OK, body)
     end
   end
-  
+
+  ##
+  # Create a firewall on the VRouter5600.
+  #
+  # _Parameters_ 
+  # * +firewall+:: Firewall : firewall object describing the firewall to be created. 
+  # _Return_ _Value_
+  # * NetconfResponse :  Status ( NetconfResponseStatus ).  
   def create_firewall_instance(firewall)
     raise ArgumentError, "Firewall must be instance of 'Firewall'" unless firewall.is_a?(Firewall)
     post_uri = @controller.get_ext_mount_config_uri(self)
@@ -83,7 +123,14 @@ class VRouter5600 < NetconfNode
       NetconfResponse.new(NetconfResponseStatus::OK)
     end
   end
-  
+
+  ##
+  # Delete a firewall from the VRouter5600.
+  #
+  # _Parameters_ 
+  # * +firewall_or_name+:: Firewall or String : A Firewall object or name of firewall for which you want to remove from vRouter5600.  
+  # _Return_ _Value_
+  # * NetconfResponse :  Status ( NetconfResponseStatus ) and error info if an error.  
   def delete_firewall_instance(firewall_or_name)
     firewall_name = firewall_or_name.is_a?(Firewall) ? firewall_or_name.rules.name :
       firewall_or_name
@@ -97,7 +144,12 @@ class VRouter5600 < NetconfNode
       handle_error_response(response)
     end
   end
-  
+
+  ##
+  # Return a list of interfaces on the VRouter5600
+  #
+  # _Return_ _Value_
+  # * NetconfResponse :  Status ( NetconfResponseStatus ) and a list of datapath interfaces.  
   def get_dataplane_interfaces_list
     response = get_interfaces_config
     check_response_for_success(response) do |body|
@@ -113,7 +165,12 @@ class VRouter5600 < NetconfNode
       end
     end
   end
-  
+
+  ##
+  # Return the configuration for the dataplane interfaces on the VRouter5600.
+  #
+  # _Return_ _Value_
+  # * NetconfResponse :  Status ( NetconfResponseStatus ) and the configuration of the dataplane interfaces.  
   def get_dataplane_interfaces_cfg
     response = get_interfaces_config
     check_response_for_success(response) do |body|
@@ -126,7 +183,14 @@ class VRouter5600 < NetconfNode
       end
     end
   end
-  
+
+  ##
+  # Return the configuration for a dataplane interface on the VRouter5600
+  #
+  # _Parameters_ 
+  # * +interface_name+:: String : name of the dataplane interface from #get_dataplane_interfaces_list 
+  # _Return_ _Value_
+  # * NetconfResponse :  Status ( NetconfResponseStatus ) and configuration of the requested dataplane interface.  
   def get_dataplane_interface_cfg(interface_name)
     get_uri = "#{@controller.get_ext_mount_config_uri(self)}/"\
       "vyatta-interfaces:interfaces/vyatta-interfaces-dataplane:dataplane/"\
@@ -136,7 +200,12 @@ class VRouter5600 < NetconfNode
       NetconfResponse.new(NetconfResponseStatus::OK, body)
     end
   end
-  
+
+  ##
+  # Return a list of loopback interfaces on the VRouter5600
+  #
+  # _Return_ _Value_
+  # * NetconfResponse :  Status ( NetconfResponseStatus ) and list of loopback interfaces.  
   def get_loopback_interfaces_list
     response = get_interfaces_config
     check_response_for_success(response) do |body|
@@ -152,7 +221,12 @@ class VRouter5600 < NetconfNode
       end
     end
   end
-  
+
+  ##
+  # Return the configuration for the loopback interfaces on the VRouter 5600.
+  #
+  # _Return_ _Value_
+  # * NetconfResponse :  Status ( NetconfResponseStatus ) and list of configurations of loopback interfaces.  
   def get_loopback_interfaces_cfg
     response = get_interfaces_config
     check_response_for_success(response) do |body|
@@ -163,7 +237,14 @@ class VRouter5600 < NetconfNode
       end
     end
   end
-  
+
+  ##
+  # Return the configuration for a single loopback interface on the VRouter 5600.
+  #
+  # _Parameters_ 
+  # * +interface_name+:: String : name of the loopback interface from the #get_loopback_interfaces_list 
+  # _Return_ _Value_
+  # * NetconfResponse :  Status ( NetconfResponseStatus ) and configuration for the requested loopback interface.  
   def get_loopback_interface_cfg(interface_name)
     get_uri = "#{@controller.get_ext_mount_config_uri(self)}/"\
       "vyatta-interfaces:interfaces/vyatta-interfaces-loopback:loopback/"\
@@ -173,7 +254,16 @@ class VRouter5600 < NetconfNode
       NetconfResponse.new(NetconfResponseStatus::OK, body)
     end
   end
-  
+
+  ##
+  # Set a firewall for inbound, outbound or both for a dataplane interface on the VRouter 5600.
+  #
+  # _Parameters_ 
+  # * +interface_name+:: String : The dataplane interface to attach firewalls. 
+  # * +inbound_firewall_name+:: String : [optional] name of firewall on VRouter5600 to use for traffic inbound towards router.
+  # * +outbound_firewall_name+:: String : [optional] name of firewall on VRouter5600 to use for traffic outbound from router.
+  # _Return_ _Value_
+  # * NetconfResponse :  Status ( NetconfResponseStatus ) and YANG schema.  
   def set_dataplane_interface_firewall(interface_name,
       inbound_firewall_name: nil, outbound_firewall_name: nil)
     raise ArgumentError, "At least one firewall (inbound_firewall_name, "\
@@ -191,7 +281,14 @@ class VRouter5600 < NetconfNode
       handle_error_response(response)
     end
   end
-  
+
+  ##
+  # Delete both inbound and outbound firewalls for a dataplane interface on the VRouter 5600.
+  #
+  # _Parameters_ 
+  # * +interface_name+:: String : name of the dataplane interface to detach firewalls from. 
+  # _Return_ _Value_
+  # * NetconfResponse :  Status ( NetconfResponseStatus ) and error details (if status is error).  
   def delete_dataplane_interface_firewall(interface_name)
     delete_uri = "#{@controller.get_ext_mount_config_uri(self)}/"\
       "vyatta-interfaces:interfaces/vyatta-interfaces-dataplane:dataplane/"\
@@ -203,7 +300,12 @@ class VRouter5600 < NetconfNode
       handle_error_response(response)
     end
   end
-  
+
+  ##
+  # Get the list of interfaces on the VRouter 5600.
+  #
+  # _Return_ _Value_
+  # * NetconfResponse :  Status ( NetconfResponseStatus ) and list of all interfaces.  
   def get_interfaces_list
     response = get_interfaces_config
     check_response_for_success(response) do |body|
@@ -220,7 +322,12 @@ class VRouter5600 < NetconfNode
       end
     end
   end
-  
+
+  ##
+  # Return the configuration for the interfaces on the VRouter 5600.
+  #
+  # _Return_ _Value_
+  # * NetconfResponse :  Status ( NetconfResponseStatus ) and configuration for interfaces.  
   def get_interfaces_cfg
     response = get_interfaces_config
     check_response_for_success(response) do |body|

data/lib/openflowdev/action_output.rb

@@ -28,22 +28,56 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 # THE POSSIBILITY OF SUCH DAMAGE.
 
+# OpenFlow 'Output' action type
 class ActionOutput
-  attr_reader :type, :order, :port, :length
-  
+  # string : type of action.
+  attr_reader :type
+  # integer : order 
+  attr_reader :order
+  # integer : port to output
+  attr_reader :port
+  # integer :  When the ’port’ is the controller, this indicates the max number of 
+  # bytes to send. A value of zero means no bytes of the packet should be sent. 
+  # A value of OFPCML_NO_BUFFER (0xffff) means that the packet is not buffered and the 
+  # complete packet is to be sent to the controller.
+  attr_reader :length
+
+# _Parameters_ 
+# * +port+:: integer : the port to target for output 
+# * +length+:: integer : When the ’port’ is the controller, this indicates the max number of 
+  # bytes to send. A value of zero means no bytes of the packet should be sent. 
+  # A value of OFPCML_NO_BUFFER (0xffff) means that the packet is not buffered and the 
+  # complete packet is to be sent to the controller.
+# * +order+:: integer : order
   def initialize(port: nil, length: nil, order: nil)
     @type = 'output'
     @order = order
     @port = port
     @length = length
   end
-  
+
+
+  ##
+  # Return a list of YANG schemas for the node.
+  #
+  # _Parameters_ 
+  # * +port+:: integer : the port to target for output 
+  # * +length+:: integer : When the ’port’ is the controller, this indicates the max number of 
+  # bytes to send. A value of zero means no bytes of the packet should be sent. 
+  # A value of OFPCML_NO_BUFFER (0xffff) means that the packet is not buffered and the 
+  # complete packet is to be sent to the controller.
+  # * +order+:: integer : order
   def update(port: nil, length: nil, order: nil)
     @order = order unless order.nil?
     @port = port unless port.nil?
     @length = length unless length.nil?
   end
   
+  ##
+  # Update from an existing Action .
+  #
+  # _Parameters_ 
+  # * +action_object+:: Action : Update this action from an existing Action. 
   def update_from_object(action_object)
     @order = action_object['order']
     if action_object.has_key?('output-action')

data/lib/openflowdev/actions/action.rb

@@ -28,6 +28,7 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 # THE POSSIBILITY OF SUCH DAMAGE.
 
+# Base class for all OpenFlow actions
 class Action
   attr_accessor :order
   

data/lib/openflowdev/actions/copy_ttl_inwards_action.rb

@@ -28,7 +28,11 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 # THE POSSIBILITY OF SUCH DAMAGE.
 
+# Class defining the action that copies Time To Live from outermost header to next-to-outermost header.
 class CopyTTLInwardsAction < Action
+
+# _Parameters_ 
+# * +order+:: integer : The order of the action relative to other actions in Instruction. 
   def initialize(order: 0)
     super(order: order)
   end

data/lib/openflowdev/actions/copy_ttl_outwards_action.rb

@@ -28,7 +28,11 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 # THE POSSIBILITY OF SUCH DAMAGE.
 
+# Class defining openflow action to copy Time To Live from next-to-outermost header to outermost header.
 class CopyTTLOutwardsAction < Action
+
+# _Parameters_ 
+# * +order+:: integer : The order of the action relative to other actions in Instruction. 
   def initialize(order: 0)
     super(order: order)
   end

data/lib/openflowdev/actions/dec_mpls_ttl_action.rb

@@ -28,7 +28,11 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 # THE POSSIBILITY OF SUCH DAMAGE.
 
+# Class representing OpenFlow action to decrement the MPLS Time To Live value.
 class DecMplsTTLAction < Action
+
+# _Parameters_ 
+# * +order+:: integer : The order of the action relative to other actions in Instruction. 
   def initialize(order: 0)
     super(order: order)
   end

data/lib/openflowdev/actions/dec_nw_ttl_action.rb

@@ -28,7 +28,11 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 # THE POSSIBILITY OF SUCH DAMAGE.
 
+# Class to define OpenFlow action that decrements Time To Live
 class DecNwTTLAction < Action
+
+# _Parameters_ 
+# * +order+:: integer : The order of the action relative to other actions in Instruction. 
   def initialize(order: 0)
     super(order: order)
   end

data/lib/openflowdev/actions/drop_action.rb

@@ -30,6 +30,7 @@
 
 require 'openflowdev/actions/action'
 
+#Class defining an OpenFlow action to drop the packet.
 class DropAction < Action
   def to_hash
     {:order => @order, 'drop-action' => {}}

data/lib/openflowdev/actions/flood_action.rb

@@ -28,7 +28,11 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 # THE POSSIBILITY OF SUCH DAMAGE.
 
+#Class defining an OpenFlow action to flood packet
 class FloodAction < Action
+
+# _Parameters_ 
+# * +order+:: integer : The order of the action relative to other actions in Instruction.
   def initialize(order: 0)
     super(order: order)
   end

data/lib/openflowdev/actions/flood_all_action.rb

@@ -28,7 +28,11 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 # THE POSSIBILITY OF SUCH DAMAGE.
 
+#Class to define a Flood-all action.  Floods to all bu the ingress port.
 class FloodAllAction < Action
+
+# _Parameters_ 
+# * +order+:: integer : The order of the action relative to other actions in Instruction.
   def initialize(order: 0)
     super(order: order)
   end

data/lib/openflowdev/actions/group_action.rb

@@ -28,7 +28,13 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 # THE POSSIBILITY OF SUCH DAMAGE.
 
+#Class to define an action to forward to a group
 class GroupAction < Action
+
+# _Parameters_ 
+# * +order+:: integer : The order of the action relative to other actions in Instruction.
+# * +group+:: 
+# * +group_id+:: integer : Identifier for the target group.
   def initialize(order: nil, group: nil, group_id: nil)
     super(order: order)
     raise ArgumentError, "Group (group) required" unless group
@@ -37,7 +43,7 @@ class GroupAction < Action
     @group_id = group_id
   end
   
-  def to_hash
+  def to_hash #:nodoc:
     {:order => @order, 'group-action' => {:group => @group,
         'group-id' => @group_id}}
   end

data/lib/openflowdev/actions/hw_path_action.rb

@@ -29,6 +29,9 @@
 # THE POSSIBILITY OF SUCH DAMAGE.
 
 class HwPathAction < Action
+
+# _Parameters_ 
+# * +order+:: integer : The order of the action relative to other actions in Instruction.
   def initialize(order: 0)
     super(order: order)
   end

data/lib/openflowdev/actions/loopback_action.rb

@@ -28,12 +28,16 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 # THE POSSIBILITY OF SUCH DAMAGE.
 
+# Class to represent OpenFlow action for forwarding to the loopback interface of device
 class LoopbackAction
+
+# _Parameters_ 
+# * +order+:: integer : The order of the action relative to other actions in Instruction.
   def initialize(order: 0)
     super(order: order)
   end
   
-  def to_hash
+  def to_hash #:nodoc:
     {:order => @order, 'loopback_action' => {}}
   end
 end

data/lib/openflowdev/actions/output_action.rb

@@ -28,7 +28,16 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 # THE POSSIBILITY OF SUCH DAMAGE.
 
+#Class to define an OpenFlow output action
 class OutputAction < Action
+
+# _Parameters_ 
+# * +order+:: integer : The order of the action relative to other actions in Instruction.
+# * +port+:: integer : the port to target for output 
+# * +max_length+:: integer : When the ’port’ is the controller, this indicates the max number of 
+# bytes to send. A value of zero means no bytes of the packet should be sent. 
+# A value of OFPCML_NO_BUFFER (0xffff) means that the packet is not buffered and the 
+# complete packet is to be sent to the controller.
   def initialize(order: 0, port: nil, max_length: nil)
     super(order: order)
     raise ArgumentError, "Port (port) required" unless port
@@ -36,7 +45,7 @@ class OutputAction < Action
     @max_length = max_length
   end
   
-  def to_hash
+  def to_hash #:nodoc:
     {:order => @order, 'output-action' => {'max-length' => @max_length,
       'output-node-connector' => @port}}
   end

data/lib/openflowdev/actions/pop_mpls_header_action.rb

@@ -28,14 +28,19 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 # THE POSSIBILITY OF SUCH DAMAGE.
 
+# Class that defines an OpenFlow Pop MPLS action ( remove the tunnel encapsulation )
 class PopMplsHeaderAction < Action
+
+# _Parameters_ 
+# * +order+:: integer : The order of the action relative to other actions in Instruction.
+# * +eth_type+:: integer : The ethernet type of the packet.
   def initialize(order: 0, eth_type: nil)
     super(order: order)
     raise ArgumentError, 'Ethernet Type (eth_type) required' unless eth_type
     @eth_type = eth_type
   end
   
-  def to_hash
+  def to_hash #:nodoc:
     {:order => @order, 'pop-mpls-action' => {'ethernet-type' => @eth_type}}
   end
 end

data/lib/openflowdev/actions/pop_pbb_header_action.rb

@@ -28,12 +28,16 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 # THE POSSIBILITY OF SUCH DAMAGE.
 
+#Class to represent OpenFlow action to Pop Provider Backbone Bridge (remove encapsulation)
 class PopPBBHeaderAction < Action
+
+# _Parameters_ 
+# * +order+:: integer : The order of the action relative to other actions in Instruction.
   def initialize(order: 0)
     super(order: order)
   end
   
-  def to_hash
+  def to_hash #:nodoc:
     {:order => @order, 'pop-pbb-aciton' => {}}
   end
 end

data/lib/openflowdev/actions/pop_vlan_header_action.rb

@@ -28,12 +28,16 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 # THE POSSIBILITY OF SUCH DAMAGE.
 
+#Class that is used to define an OpenFlow POP VLAN header action.  Remove the VLAN encapsulation (Q-in-Q).
 class PopVlanHeaderAction < Action
+
+# _Parameters_ 
+# * +order+:: integer : The order of the action relative to other actions in Instruction.
   def initialize(order: 0)
     super(order: order)
   end
   
-  def to_hash
+  def to_hash #:nodoc:
     {:order => @order, 'pop-vlan-action' => {}}
   end
 end

data/lib/openflowdev/actions/push_mpls_header_action.rb

@@ -28,14 +28,19 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 # THE POSSIBILITY OF SUCH DAMAGE.
 
+#Class used to define an OpenFlow action to add MPLS header to packet.
 class PushMplsHeaderAction < Action
+
+# _Parameters_ 
+# * +order+:: integer : The order of the action relative to other actions in Instruction.
+# * +eth_type+:: integer : The ethernet type of the packet.
   def initialize(order: 0, eth_type: nil)
     super(order: order)
     raise ArgumentError, "Ethernet Type (eth_type) required"
     @eth_type = eth_type
   end
   
-  def to_hash
+  def to_hash #:nodoc:
     {:order => @order, 'push-mpls-action' => {'ethernet-type' => @eth_type}}
   end
 end

data/lib/openflowdev/actions/push_pbb_header_action.rb

@@ -28,13 +28,18 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 # THE POSSIBILITY OF SUCH DAMAGE.
 
+#Class to define an OpenFlow action to add a Provider Backbone Bridge encapsulation
 class PushPBBHeaderAction < Action
+
+# _Parameters_ 
+# * +order+:: integer : The order of the action relative to other actions in Instruction.
+# * +eth_type+:: integer : The ethernet type of the packet.
   def initialize(order: 0, eth_type: nil)
     super(order: order)
     @eth_type = eth_type
   end
   
-  def to_hash
+  def to_hash #:nodoc:
     {:order => @order, 'push-pbb-aciton' => {'ethernet-type' => @eth_type}}
   end
 end

data/lib/openflowdev/actions/push_vlan_header_action.rb

@@ -28,7 +28,17 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 # THE POSSIBILITY OF SUCH DAMAGE.
 
+#Class to define an OpenFlow action to add a VLAN encapsulation.
 class PushVlanHeaderAction < Action
+
+# _Parameters_ 
+# * +order+:: integer : The order of the action relative to other actions in Instruction.
+# * +eth_type+:: integer : The ethernet type of the packet.
+# * +tag+:: integer : Tag protocol identifier.
+# * +pcp+:: integer : Priority code point.
+# * +cfi+:: integer : Drop eligible indicator (formerly cannonical format indicator).
+# * +vlan_id+:: integer : VLAN identifier.
+
   def initialize(order: 0, eth_type: nil, tag: nil, pcp: nil, cfi: nil,
       vlan_id: nil)
     super(order: order)
@@ -39,7 +49,7 @@ class PushVlanHeaderAction < Action
     @vlan_id = vlan_id
   end
   
-  def to_hash
+  def to_hash #:nodoc:
     {:order => @order, 'push-vlan-action' => {'ethernet-type' => @eth_type,
       :tag => @tag, :pcp => @pcp, :cfi => @cfi, 'vlan-id' => @vlan_id}}
   end

data/lib/openflowdev/actions/set_dl_dst_action.rb

@@ -28,14 +28,19 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 # THE POSSIBILITY OF SUCH DAMAGE.
 
+#Class to define an OpenFlow action for setting the ethernet (data layer) destination
 class SetDlDstAction < Action
+
+# _Parameters_ 
+# * +order+:: integer : The order of the action relative to other actions in Instruction.
+# * +mac_addr+:: string : The MAC address to set in destination field of ethernet header.
   def initialize(order: nil, mac_addr: nil)
     super(order: order)
     raise ArgumentError, "MAC Address (mac_addr) required"
     @mac = mac_addr
   end
   
-  def to_hash
+  def to_hash #:nodoc:
     {:order => @order, 'set-dl-dst-action' => {:address => @mac}}
   end
 end

data/lib/openflowdev/actions/set_dl_src_action.rb

@@ -28,14 +28,19 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 # THE POSSIBILITY OF SUCH DAMAGE.
 
+#Class to define an OpenFlow action to set the Ethernet (data layer) source MAC address
 class SetDlSrcAction < Action
+
+# _Parameters_ 
+# * +order+:: integer : The order of the action relative to other actions in Instruction.
+# * +mac_addr+:: string : The MAC address to set in source field of ethernet header.
   def initialize(order: nil, mac_addr: nil)
     super(order: order)
     raise ArgumentError, "MAC Address (mac_addr) required"
     @mac = mac_addr
   end
   
-  def to_hash
+  def to_hash #:nodoc:
     {:order => @order, 'set-dl-src-action' => {:address => @mac}}
   end
 end