rbeapi 0.4.0 → 0.5.0

data/lib/rbeapi/api/dns.rb

@@ -35,13 +35,13 @@ require 'rbeapi/api'
 # Rbeapi toplevel namespace
 module Rbeapi
   ##
-  # Rbeapi::Api
+  # Api is module namespace for working with the EOS command API
   module Api
     ##
     # The Dns class manages DNS settings on an EOS node.
     class Dns < Entity
       ##
-      # Returns the DNS resource
+      # get returns the DNS resource
       #
       # @example
       #   {
@@ -60,21 +60,43 @@ module Rbeapi
         response
       end
 
+      ##
+      # parse_domain_name parses the domain-name from config
+      #
+      # @api private
+      #
+      # @return [Hash<Symbol, Object>] resource hash attribute
       def parse_domain_name
         mdata = /ip domain-name ([\w.]+)/.match(config)
         { domain_name: mdata.nil? ? '' : mdata[1] }
       end
+      private :parse_domain_name
 
+      ##
+      # parse_name_servers parses the name-server values from
+      #   config
+      #
+      # @api private
+      #
+      # @return [Hash<Symbol, Array>] resource hash attribute
       def parse_name_servers
         servers = config.scan(/(?:ip name-server vrf )(?:\w+)\s(.+)/)
         values = servers.each_with_object([]) { |srv, arry| arry << srv.first }
         { name_servers: values }
       end
+      private :parse_name_servers
 
+      ##
+      # parse_domain_list parses the domain-list from config
+      #
+      # @api private
+      #
+      # @return [Hash<Symbol, Object>] resource hash attribute
       def parse_domain_list
         search = config.scan(/(?<=^ip\sdomain-list\s).+$/)
         { domain_list: search }
       end
+      private :parse_domain_list
 
       ##
       # Configure the domain-name value in the running-config
@@ -135,10 +157,22 @@ module Rbeapi
         configure cmds
       end
 
+      ##
+      # add_name_server adds an ip name-server.
+      #
+      # @param [String] :server The name of the ip name-server to create
+      #
+      # @return [Boolean] returns true if the command completed successfully
       def add_name_server(server)
         configure "ip name-server #{server}"
       end
 
+      ##
+      # remove_name_server removes the specified ip name-server.
+      #
+      # @param [String] :server The name of the ip name-server to remove
+      #
+      # @return [Boolean] returns true if the command completed successfully
       def remove_name_server(server)
         configure "no ip name-server #{server}"
       end
@@ -190,10 +224,22 @@ module Rbeapi
         configure cmds
       end
 
+      ##
+      # add_domain_list adds an ip domain-list.
+      #
+      # @param [String] :name The name of the ip domain-list to add
+      #
+      # @return [Boolean] returns true if the command completed successfully
       def add_domain_list(name)
         configure "ip domain-list #{name}"
       end
 
+      ##
+      # remove_domain_list removes a specified ip domain-list.
+      #
+      # @param [String] :name The name of the ip domain-list to remove
+      #
+      # @return [Boolean] returns true if the command completed successfully
       def remove_domain_list(name)
         configure "no ip domain-list #{name}"
       end

data/lib/rbeapi/api/interfaces.rb

@@ -36,7 +36,7 @@ require 'rbeapi/utils'
 # Rbeapi toplevel namespace
 module Rbeapi
   ##
-  # Api module namespace
+  # Api is module namespace for working with the EOS command API
   module Api
     ##
     # The Interfaces class manages all physical and logical interfaces on an
@@ -47,10 +47,52 @@ module Rbeapi
         @instances = {}
       end
 
+      ##
+      # get returns a hash of interface configurations for the given name
+      #
+      # @example
+      #   {
+      #     name: <string>,
+      #     type: <string>,
+      #     description: <string>,
+      #     shutdown: <boolean>
+      #   }
+      #
+      # @param [String] :name The interface name to return a resource for from
+      #   the nodes configuration
+      #
+      # @return [nil, Hash<Symbol, Object>] Returns the interface resource as a
+      #   Hash. If the specified name is not found in the nodes current
+      #   configuration a nil object is returned
       def get(name)
         get_instance(name).get(name)
       end
 
+      ##
+      # getall returns a hash of interface configurations
+      #
+      # @example
+      #   {
+      #     <name>: {
+      #       name: <string>,
+      #       type: <string>,
+      #       description: <string>,
+      #       shutdown: <boolean>,
+      #       ...
+      #     },
+      #     <name>: {
+      #       name: <string>,
+      #       type: <string>,
+      #       description: <string>,
+      #       shutdown: <boolean>,
+      #       ...
+      #     },
+      #     ...
+      #   }
+      #
+      # @return [Hash<Symbol, Object>] Returns the interface resources as a
+      #   Hash. If none exist in the nodes current
+      #   configuration an empty hash is returned
       def getall
         interfaces = config.scan(/(?<=^interface\s).+$/)
 
@@ -60,6 +102,13 @@ module Rbeapi
         end
       end
 
+      ##
+      # get_instance returns an interface instance for the given name
+      #
+      # @param [String] :name The interface name to return an instance for
+      #
+      # @return [Object] Returns the interface instance as an
+      #   Object.
       def get_instance(name)
         name = name[0, 2].upcase
         case name
@@ -287,20 +336,18 @@ module Rbeapi
       # get returns the specified Ethernet interface resource hash that
       # represents the interface's current configuration in the node.
       #
-      # The resource hash returned contains the following information:
-      #
-      #   * name (string): the interface name (eg Ethernet1)
-      #   * type (string): will always be 'ethernet'
-      #   * description (string): the interface description value
-      #   * speed (string): the current speed setting for the interface speed
-      #   * forced (boolean): true if auto negotiation is disabled otherwise
-      #     false
-      #   * sflow (boolean): true if sflow is enabled on the interface
-      #     otherwise false
-      #   * flowcontrol_send (string): the interface flowcontrol send value.
-      #     Valid values are 'on' or 'off'
-      #   * flowconrol_receive (string): the interface flowcontrol receive
-      #     value.  Valid values are 'on' or 'off'
+      # @example
+      #   {
+      #     name: <string>,
+      #     type: <string>,
+      #     description: <string>,
+      #     shutdown: <boolean>,
+      #     speed: <string>,
+      #     forced: <boolean>,
+      #     sflow: <boolean>,
+      #     flowcontrol_send: <string>,
+      #     flowcontrol_receive: <string>
+      #   }
       #
       # @param [String] :name The interface name to return a resource hash
       #   for from the node's running configuration
@@ -319,7 +366,6 @@ module Rbeapi
         response.merge!(parse_sflow(config))
         response.merge!(parse_flowcontrol_send(config))
         response.merge!(parse_flowcontrol_receive(config))
-
         response
       end
 
@@ -773,24 +819,41 @@ module Rbeapi
       # @param [Array] :members The array of physical interface members to add
       #   to the port-channel logical interface.
       #
+      # @param [str] :mode The LACP mode to configure the member interfaces to.
+      #   Valid values are 'on, 'passive', 'active'. When there are
+      #   existing channel-group members and their lacp mode differs
+      #   from this attribute, all of those members will be removed and
+      #   then re-added using the specified lacp mode. If this attribute
+      #   is omitted, the existing lacp mode will be used for new
+      #   member additions.
+      #
       # @return [Boolean] returns true if the command completed successfully
-      def set_members(name, members)
+      def set_members(name, members, mode = nil)
         current_members = Set.new parse_members(name)[:members]
         members = Set.new members
 
+        lacp_mode = parse_lacp_mode(name)[:lacp_mode]
+        if mode && mode != lacp_mode
+          lacp_mode = mode
+          set_lacp_mode(name, lacp_mode)
+        end
+
+        cmds = []
+        grpid = /(\d+)/.match(name)[0]
+
         # remove members from the current port-channel interface
         current_members.difference(members).each do |intf|
-          result = remove_member(name, intf)
-          return false unless result
+          cmds << "interface #{intf}"
+          cmds << "no channel-group #{grpid}"
         end
 
         # add new member interfaces to the port-channel
         members.difference(current_members).each do |intf|
-          result = add_member(name, intf)
-          return false unless result
+          cmds << "interface #{intf}"
+          cmds << "channel-group #{grpid} mode #{lacp_mode}"
         end
 
-        true
+        configure(cmds)
       end
 
       ##
@@ -938,16 +1001,18 @@ module Rbeapi
       # BaseInterface get method and adds the Vxlan specific attributes to
       # the hash
       #
-      # The returned resource hash contains the following
-      #
-      #   * name: (String) The full interface name identifier
-      #   * type: (String) 'vxlan'
-      #   * description: (String) The configured interface description
-      #   * shutdown: (Boolean) The admin state of the interface
-      #   * source_interface: (String) The vxlan source-interface value
-      #   * multicast_group: (String) The vxlan multicast-group value
-      #   * udp_port: (Fixnum) The vxlan udp-port value
-      #   * flood_list: (Array) The list of VTEPs to flood traffic towards
+      # @example
+      #   {
+      #     name: <string>,
+      #     type: <string>,
+      #     description: <string>,
+      #     shutdown: <boolean>,
+      #     source_interface: <string>,
+      #     multicast_group: <string>,
+      #     udp_port: <fixnum>,
+      #     flood_list: <array>,
+      #     vlans: <hash>
+      #   }
       #
       # @param [String] :name The interface name to return from the nodes
       #   configuration.  This optional parameter defaults to Vxlan1

data/lib/rbeapi/api/ipinterfaces.rb

@@ -35,7 +35,7 @@ require 'rbeapi/api'
 # Rbeapi toplevel namespace
 module Rbeapi
   ##
-  # Rbeapi::Api
+  # Api is module namespace for working with the EOS command API
   module Api
     #
     # The Ipinterface class provides an instance for managing logical
@@ -79,7 +79,17 @@ module Rbeapi
       #
       # @example
       #   {
-      #     <name>: {...}
+      #     <name>: {
+      #       address: <string>
+      #       mtu: <string>
+      #       helper_addresses: array<strings>
+      #     },
+      #     <name>: {
+      #       address: <string>
+      #       mtu: <string>
+      #       helper_addresses: array<strings>
+      #     },
+      #     ...
       #   }
       #
       # @see get Ipaddress resource example
@@ -103,6 +113,7 @@ module Rbeapi
       # ipaddress resource hash.
       #
       # @api private
+      #
       # @param [String] :config The IP interface configuration block returned
       #   from the node's running configuration
       #

data/lib/rbeapi/api/logging.rb

@@ -35,7 +35,7 @@ require 'rbeapi/api'
 # Rbeapi toplevel namespace
 module Rbeapi
   ##
-  # Rbeapi::Api
+  # Api is module namespace for working with the EOS command API
   module Api
     ##
     # The Logging class manages logging settings on an EOS node.
@@ -46,7 +46,7 @@ module Rbeapi
       #
       # @example
       #   {
-      #     enable: [true, false]
+      #     enable: [true, false],
       #     hosts: array<strings>
       #   }
       #
@@ -65,6 +65,10 @@ module Rbeapi
       # command is expected to always be in the node's configuration.  This
       # methods return value is intended to be merged into the logging resource
       # hash.
+      #
+      # @api private
+      #
+      # @return [Hash<Symbol, Object>] resource hash attribute
       def parse_enable
         value = /no logging on/ !~ config
         { enable: value }
@@ -76,10 +80,15 @@ module Rbeapi
       # logging hosts are configured, then the value for hosts will be an empty
       # array.  The return value is intended to be merged into the logging
       # resource hash
+      #
+      # @api private
+      #
+      # @return [Hash<Symbol, Object>] resource hash attribute
       def parse_hosts
         hosts = config.scan(/(?<=^logging\shost\s)[^\s]+/)
         { hosts: hosts }
       end
+      private :parse_hosts
 
       ##
       # set_enable configures the global logging instance on the node as either

data/lib/rbeapi/api/mlag.rb

@@ -35,7 +35,7 @@ require 'rbeapi/api'
 # Rbeapi toplevel namespace
 module Rbeapi
   ##
-  # Rbeapi::Api
+  # Api is module namespace for working with the EOS command API
   module Api
     ##
     # The Mlag class provides a configuration instance for working with
@@ -50,15 +50,25 @@ module Rbeapi
       # get scans the current nodes configuration and returns the values as
       # a Hash describing the current state.
       #
-      # The resource hash returned contains the following:
-      #   * domain_id: (String) The MLAG domain-id value
-      #   * local_interface: (String) The MLAG local-interface value
-      #   * peer_address: (String) The IP address of the MLAG peer
-      #   * peer_link: (String) The MLAG transit peer-link value
-      #   * shutdown: (Boolean) The administrative staet of the mlag
-      #     configuration
-      #   * interfaces: (Hash) The list of configured MLAG interfaces.  (See
-      #     parse_interfaces for the Hash details)
+      # @example
+      #   {
+      #     global: {
+      #       domain_id: <string>,
+      #       local_interface: <string>,
+      #       peer_address: <string>,
+      #       peer_link: <string>,
+      #       shutdown: <boolean>
+      #     },
+      #     interfaces: {
+      #       <name>: {
+      #         mlag_id: <fixnum>
+      #       },
+      #       <name>: {
+      #         mlag_id: <fixnum>
+      #       },
+      #       ...
+      #     }
+      #   }
       #
       # @see parse_interfaces
       #

data/lib/rbeapi/api/ntp.rb

@@ -32,10 +32,10 @@
 require 'rbeapi/api'
 
 ##
-# Eos is the toplevel namespace for working with Arista EOS nodes
+# Rbeapi toplevel namespace
 module Rbeapi
   ##
-  # Api is module namesapce for working with the EOS command API
+  # Api is module namespace for working with the EOS command API
   module Api
     ##
     # The Ntp class provides an instance for working with the nodes
@@ -48,7 +48,7 @@ module Rbeapi
       #
       # @example
       #   {
-      #     source_interface: <string>
+      #     source_interface: <string>,
       #     servers: {
       #       prefer: [true, false]
       #     }
@@ -95,6 +95,7 @@ module Rbeapi
         end
         { servers: values }
       end
+      private :parse_servers
 
       ##
       # set_source_interface configures the ntp source value in the nodes