rbeapi 0.5.0 → 0.5.1

data/lib/rbeapi/api/ospf.rb

@@ -32,17 +32,17 @@
 require 'rbeapi/api'
 
 ##
-# Rbeapi toplevel namespace
+# Rbeapi toplevel namespace.
 module Rbeapi
   ##
-  # Api is module namespace for working with the EOS command API
+  # Api is module namespace for working with the EOS command API.
   module Api
     ##
     # The Ospf class is a global class that provides an instance for working
-    # with the node's OSPF configuration
+    # with the node's OSPF configuration.
     class Ospf < Entity
       ##
-      # Returns the global OSPF configuration from the node
+      # Returns the global OSPF configuration from the node.
       #
       # rubocop:disable Metrics/MethodLength
       #
@@ -55,9 +55,9 @@ module Rbeapi
       #     redistribute: {}
       #   }
       #
-      # @param [String] :inst The ospf instance name
+      # @param inst [String] The ospf instance name.
       #
-      # @return [Hash]  A Ruby hash object that provides the OSPF settings as
+      # @return [Hash] A Ruby hash object that provides the OSPF settings as
       #   key / value pairs.
       def get(inst)
         config = get_block("router ospf #{inst}")
@@ -88,19 +88,19 @@ module Rbeapi
       end
 
       ##
-      # Returns the OSPF configuration from the node as a Ruby hash
+      # Returns the OSPF configuration from the node as a Ruby hash.
       #
       # @example
-      # {
-      #   <pid>: {
-      #     router_id: <string>,
-      #     areas: {},
-      #     redistribute: {}
-      #   },
-      #   interfaces: {}
-      # }
+      #   {
+      #     <pid>: {
+      #       router_id: <string>,
+      #       areas: {},
+      #       redistribute: {}
+      #     },
+      #     interfaces: {}
+      #   }
       #
-      # @return [Hash]  A Ruby hash object that provides the OSPF settings as
+      # @return [Hash] A Ruby hash object that provides the OSPF settings as
       #   key / value pairs.
       def getall
         instances = config.scan(/(?<=^router\sospf\s)\d+$/)
@@ -118,38 +118,38 @@ module Rbeapi
       end
 
       ##
-      # create will create a router ospf with the specified pid
+      # create will create a router ospf with the specified pid.
       #
-      # @param [String] :pid The router ospf to create
+      # @param pid [String] The router ospf to create.
       #
-      # @return [Boolean] returns true if the command completed successfully
+      # @return [Boolean] Returns true if the command completed successfully.
       def create(pid)
         configure "router ospf #{pid}"
       end
 
       ##
-      # delete will remove the specified router ospf
+      # delete will remove the specified router ospf.
       #
-      # @param [String] :pid The router ospf to remove
+      # @param pid [String] The router ospf to remove.
       #
-      # @return [Boolean] returns true if the command completed successfully
+      # @return [Boolean] Returns true if the command completed successfully.
       def delete(pid)
         configure "no router ospf #{pid}"
       end
 
       ##
-      # set_router_id sets router ospf router-id with pid and options
+      # set_router_id sets router ospf router-id with pid and options.
       #
-      # @param [String] :pid The router ospf name
+      # @param pid [String] The router ospf name.
       #
-      # @param [hash] :opts Optional keyword arguments
+      # @param opts [hash] Optional keyword arguments.
       #
-      # @option :opts [Boolean] :enable If false then the command is
+      # @option opts enable [Boolean] If false then the command is
       #   negated. Default is true.
       #
-      # @option :opts [Boolean] :default Configure the router-id to default.
+      # @option opts default [Boolean] Configure the router-id to default.
       #
-      # @return [Boolean] returns true if the command completed successfully
+      # @return [Boolean] Returns true if the command completed successfully.
       def set_router_id(pid, opts = {})
         cmd = command_builder('router-id', opts)
         cmds = ["router ospf #{pid}", cmd]
@@ -159,13 +159,13 @@ module Rbeapi
       ##
       # add_network adds network settings for router ospf and network area.
       #
-      # @param [String] :pid The pid for router ospf
+      # @param pid [String] The pid for router ospf.
       #
-      # @param [String] :net The network name
+      # @param net [String] The network name.
       #
-      # @param [String] :area The network area name
+      # @param area [String] The network area name.
       #
-      # @return [Boolean] returns true if the command completed successfully
+      # @return [Boolean] Returns true if the command completed successfully.
       def add_network(pid, net, area)
         configure ["router ospf #{pid}", "network #{net} area #{area}"]
       end
@@ -174,34 +174,34 @@ module Rbeapi
       # remove_network removes network settings for router ospf and network
       #   area.
       #
-      # @param [String] :pid The pid for router ospf
+      # @param pid [String] The pid for router ospf.
       #
-      # @param [String] :net The network name
+      # @param net [String] The network name.
       #
-      # @param [String] :area The network area name
+      # @param area [String] The network area name.
       #
-      # @return [Boolean] returns true if the command completed successfully
+      # @return [Boolean] Returns true if the command completed successfully.
       def remove_network(pid, net, area)
         configure ["router ospf #{pid}", "no network #{net} area #{area}"]
       end
 
       ##
-      # set_redistribute sets router ospf router-id with pid and options
+      # set_redistribute sets router ospf router-id with pid and options.
       #
-      # @param [String] :pid The router ospf name
+      # @param pid [String] The router ospf name.
       #
-      # @param [String] :proto The redistribute value
+      # @param proto [String] The redistribute value.
       #
-      # @param [hash] :opts Optional keyword arguments
+      # @param opts [hash] Optional keyword arguments.
       #
-      # @option :opts [String] :routemap The route-map value
+      # @option opts routemap [String] The route-map value.
       #
-      # @option :opts [Boolean] :enable If false then the command is
+      # @option opts enable [Boolean] If false then the command is
       #   negated. Default is true.
       #
-      # @option :opts [Boolean] :default Configure the router-id to default.
+      # @option opts default [Boolean] Configure the router-id to default.
       #
-      # @return [Boolean] returns true if the command completed successfully
+      # @return [Boolean] Returns true if the command completed successfully.
       def set_redistribute(pid, proto, opts = {})
         routemap = opts[:routemap]
         cmds = ["router ospf #{pid}", "redistribute #{proto}"]
@@ -212,21 +212,21 @@ module Rbeapi
 
     ##
     # The OspfInterfaces class is a global class that provides an instance
-    # for working with the node's OSPF interface configuration
+    # for working with the node's OSPF interface configuration.
     class OspfInterfaces < Entity
       ##
-      # Returns a single MLAG interface configuration
+      # Returns a single MLAG interface configuration.
       #
       # Example
       #   {
       #      network_type: <string>
       #   }
       #
-      # @param [String] :name The interface name to return the configuration
-      #   values for.  This must be the full interface identifier.
+      # @param name [String] The interface name to return the configuration
+      #   values for. This must be the full interface identifier.
       #
       # @return [nil, Hash<String, String>] A Ruby hash that represents the
-      #   MLAG interface configuration.  A nil object is returned if the
+      #   MLAG interface configuration. A nil object is returned if the
       #   specified interface is not configured
       def get(name)
         config = get_block("interface #{name}")
@@ -241,7 +241,7 @@ module Rbeapi
 
       ##
       # Returns the collection of MLAG interfaces as a hash index by the
-      # interface name
+      # interface name.
       #
       # Example
       #   {
@@ -255,7 +255,7 @@ module Rbeapi
       #   }
       #
       # @return [nil, Hash<String, String>] A Ruby hash that represents the
-      #   MLAG interface configuration.  A nil object is returned if no
+      #   MLAG interface configuration. A nil object is returned if no
       #   interfaces are configured.
       def getall
         interfaces = config.scan(/(?<=interface\s)[Et|Po|Lo|Vl].+/)
@@ -266,21 +266,21 @@ module Rbeapi
       end
 
       ##
-      # set_network_type sets network type with options
+      # set_network_type sets network type with options.
       #
-      # @param [String] :name The name of the interface
+      # @param name [String] The name of the interface.
       #
-      # @param [hash] :opts Optional keyword arguments
+      # @param opts [hash] Optional keyword arguments.
       #
-      # @option :opts [String] :value The point-to-point value
+      # @option opts value [String] The point-to-point value.
       #
-      # @option :opts [Boolean] :enable If false then the command is
+      # @option opts enable [Boolean] If false then the command is
       #   negated. Default is true.
       #
-      # @option :opts [Boolean] :default Configure the ip ospf network
+      # @option opts default [Boolean] Configure the ip ospf network
       #   to default.
       #
-      # @return [Boolean] returns true if the command completed successfully
+      # @return [Boolean] Returns true if the command completed successfully.
       def set_network_type(name, opts = {})
         value = opts[:value]
         return false unless [nil, 'point-to-point'].include?(value)

data/lib/rbeapi/api/prefixlists.rb

@@ -32,10 +32,10 @@
 require 'rbeapi/api'
 
 ##
-# Rbeapi toplevel namespace
+# Rbeapi toplevel namespace.
 module Rbeapi
   ##
-  # Api is module namespace for working with the EOS command API
+  # Api is module namespace for working with the EOS command API.
   module Api
     ##
     # The Prefixlists class provides a configuration instance for working
@@ -43,7 +43,7 @@ module Rbeapi
     #
     class Prefixlists < Entity
       ##
-      # Returns the static routes configured on the node
+      # Returns the static routes configured on the node.
       #
       # @example
       #   {
@@ -53,12 +53,12 @@ module Rbeapi
       #     }
       #   }
       #
-      # @param [String] :name The name of the prefix-list to return
+      # @param name [String] The name of the prefix-list to return.
       #
-      # @returns [Hash<String, String> The method will return all of the
-      #   configured static routes on the node as a Ruby hash object.  If
+      # @return [Hash<String, String> The method will return all of the
+      #   configured static routes on the node as a Ruby hash object. If
       #   there are no static routes configured, this method will return
-      #   an empty hash
+      #   an empty hash.
       def get(name)
         config = get_block("ip prefix-list #{name}")
         return nil unless config
@@ -71,7 +71,7 @@ module Rbeapi
       end
 
       ##
-      # Returns the static routes configured on the node
+      # Returns the static routes configured on the node.
       #
       # @example
       #   {
@@ -81,10 +81,10 @@ module Rbeapi
       #     }
       #   }
       #
-      # @returns [Hash<String, String> The method will return all of the
-      #   configured static routes on the node as a Ruby hash object.  If
+      # @return [Hash<String, String> The method will return all of the
+      #   configured static routes on the node as a Ruby hash object. If
       #   there are no static routes configured, this method will return
-      #   an empty hash
+      #   an empty hash.
       def getall
         lists = config.scan(/(?<=^ip\sprefix-list\s).+/)
         lists.each_with_object({}) do |name, hsh|
@@ -96,9 +96,9 @@ module Rbeapi
       ##
       # create will create a new ip prefix-list with designated name.
       #
-      # @param [String] :name The name of the ip prefix-list
+      # @param name [String] The name of the ip prefix-list.
       #
-      # @return [Boolean] returns true if the command completed successfully
+      # @return [Boolean] Returns true if the command completed successfully.
       def create(name)
         configure "ip prefix-list #{name}"
       end
@@ -107,15 +107,15 @@ module Rbeapi
       # add_rule will create an ip prefix-list with the designated name,
       #   seqno, action and prefix.
       #
-      # @param [String] :name The name of the ip prefix-list
+      # @param name [String] The name of the ip prefix-list.
       #
-      # @param [String] :seq The seq value
+      # @param seq [String] The seq value.
       #
-      # @param [String] :action The action value
+      # @param  action [String] The action value.
       #
-      # @param [String] :prefix The prefix value
+      # @param prefix [String] The prefix value.
       #
-      # @return [Boolean] returns true if the command completed successfully
+      # @return [Boolean] Returns true if the command completed successfully.
       def add_rule(name, action, prefix, seq = nil)
         cmd = "ip prefix-list #{name}"
         cmd << " seq #{seq}" if seq
@@ -124,13 +124,13 @@ module Rbeapi
       end
 
       ##
-      # delete will remove the designated prefix-list
+      # delete will remove the designated prefix-list.
       #
-      # @param [String] :name The name of the ip prefix-list
+      # @param name [String] The name of the ip prefix-list.
       #
-      # @param [String] :seq The seq value
+      # @param seq [String] The seq value.
       #
-      # @return [Boolean] returns true if the command completed successfully
+      # @return [Boolean] Returns true if the command completed successfully.
       def delete(name, seq = nil)
         cmd = "no ip prefix-list #{name}"
         cmd << " seq #{seq}" if seq

data/lib/rbeapi/api/radius.rb

@@ -32,10 +32,10 @@
 require 'rbeapi/api'
 
 ##
-# Rbeapi toplevel namespace
+# Rbeapi toplevel namespace.
 module Rbeapi
   ##
-  # Api is module namespace for working with the EOS command API
+  # Api is module namespace for working with the EOS command API.
   module Api
     ##
     # Radius provides instance methods to retrieve and set radius configuration
@@ -70,7 +70,7 @@ module Rbeapi
       #     servers: <array>
       #   }
       #
-      # @return [Array<Hash>] Single element Array of resource hashes
+      # @return [Array<Hash>] Single element Array of resource hashes.
       def get
         global = {}
         global.merge!(parse_global_timeout)
@@ -82,12 +82,12 @@ module Rbeapi
 
       ##
       # parse_time scans the nodes current configuration and parse the
-      # radius-server timeout value.  The timeout value is expected to always
-      # be present in the config
+      # radius-server timeout value. The timeout value is expected to always
+      # be present in the config.
       #
       # @api private
       #
-      # @return [Hash<Symbol, Object>] resource hash attribute
+      # @return [Hash<Symbol, Object>] Returns the resource hash attribute.
       def parse_global_timeout
         value = config.scan(/radius-server timeout (\d+)/).first
         { timeout: value.first.to_i }
@@ -96,12 +96,12 @@ module Rbeapi
 
       ##
       # parse_retransmit scans the cnodes current configuration and parses the
-      # radius-server retransmit value.  the retransmit value is expected to
-      # always be present in the config
+      # radius-server retransmit value. The retransmit value is expected to
+      # always be present in the config.
       #
       # @api private
       #
-      # @return [Hash<Symbol, Object>] resource hash attribute
+      # @return [Hash<Symbol, Object>] Returns the resource hash attribute.
       def parse_global_retransmit
         value = config.scan(/radius-server retransmit (\d+)/).first
         { retransmit: value.first.to_i }
@@ -110,13 +110,13 @@ module Rbeapi
 
       ##
       # parse_key scans the current nodes running configuration and parse the
-      # global radius-server key and format value.  If the key is not
+      # global radius-server key and format value. If the key is not
       # configured this method will return DEFAULT_KEY and DEFAULT_KEY_FORMAT
       # for the resource hash values.
       #
       # @api private
       #
-      # @return [Hash<Symbol, Object>] resource hash attribute
+      # @return [Hash<Symbol, Object>] Returns the resource hash attribute.
       def parse_global_key
         rsrc_hsh = {}
         (key_format, key) = config.scan(/radius-server key (\d+) (\w+)/).first
@@ -127,9 +127,9 @@ module Rbeapi
       private :parse_global_key
 
       ##
-      # parse_servers returns an Array of radius server resource hashes.  Each
+      # parse_servers returns an Array of radius server resource hashes. Each
       # hash describes the current state of the radius server and is intended
-      # to be merged into the radius resource hash
+      # to be merged into the radius resource hash.
       #
       # The resource hash returned contains the following information:
       #  * hostname: hostname or ip address
@@ -145,7 +145,7 @@ module Rbeapi
       #
       # @api private
       #
-      # @return [Array<Hash<Symbol,Object>>] Array of resource hashes
+      # @return [Array<Hash<Symbol,Object>>] Array of resource hashes.
       def parse_servers
         tuples = config.scan(SERVER_REGEXP)
         tuples.map do |(host, vrf, authp, acctp, tout, tries, keyfm, key)|
@@ -164,33 +164,33 @@ module Rbeapi
       private :parse_servers
 
       ##
-      # set_global_key configures the global radius-server key.  If the enable
+      # set_global_key configures the global radius-server key. If the enable
       # option is false, radius-server key is configured using the no
       # keyword. If the default option is specified, radius-server key is
       # configured using the default keyword. If both options are specified,
       # the default keyword option takes precedence.
       #
-      # @eos_version 4.13.7M
+      # @since eos_version 4.13.7M
       #
-      # @commands
+      # ===Commands
       #   radius-server key <format> <value>
       #   no radius-server key
       #   default radius-server key
       #
-      # @option [String] :value The value to configure the radius-server key to
-      #   in the nodes running configuration
+      # @option value [String] The value to configure the radius-server key to
+      #   in the nodes running configuration.
       #
-      # @option [Fixnum] :key_format The format of the key to be passed to the
-      #   nodes running configuration.  Valid values are 0 (clear text) or 7
-      #   (encrypted).  The default value is 0 if format is not provided.
+      # @option key_format [Fixnum] The format of the key to be passed to the
+      #   nodes running configuration. Valid values are 0 (clear text) or 7
+      #   (encrypted). The default value is 0 if format is not provided.
       #
-      # @option :opts [Boolean] :enable If false then the command is
+      # @option opts enable [Boolean] If false then the command is
       #   negated. Default is true.
       #
-      # @option [Boolean] :default Configures the radius-server key using the
-      #   default keyword argument
+      # @option default [Boolean] Configures the radius-server key using the
+      #   default keyword argument.
       #
-      # @return [Boolean] returns true if the commands complete successfully
+      # @return [Boolean] Returns true if the commands complete successfully.
       def set_global_key(opts = {})
         value = opts[:value]
         enable = opts.fetch(:enable, true)
@@ -211,30 +211,30 @@ module Rbeapi
       end
 
       ##
-      # set_global_timeout configures the radius-server timeout value.  If the
+      # set_global_timeout configures the radius-server timeout value. If the
       # enable option is false, then radius-server timeout is configured
-      # using the no keyword.  If the default option is specified, radius-server
-      # timeout is configured using the default keyword.  If both options are
+      # using the no keyword. If the default option is specified, radius-server
+      # timeout is configured using the default keyword. If both options are
       # specified then the default keyword takes precedence.
       #
-      # @eos_version 4.13.7M
+      # @since eos_version 4.13.7M
       #
-      # @commands
+      # ===Commands
       #   radius-server timeout <value>
       #   no radius-server timeout
       #   default radius-server timeout
       #
-      # @option [String, Fixnum] :value The value to set the global
-      #   radius-server timeout value to.  This value should be in the range of
-      #   1 to 1000
+      # @option value [String, Fixnum] The value to set the global
+      #   radius-server timeout value to. This value should be in the range of
+      #   1 to 1000.
       #
-      # @option :opts [Boolean] :enable If false then the command is
+      # @option opts enable [Boolean] If false then the command is
       #   negated. Default is true.
       #
-      # @option [Boolean] :default Configures the radius-server timeout value
+      # @option default [Boolean] Configures the radius-server timeout value
       #   using the default keyword.
       #
-      # @return [Boolean] returns true if the commands complete successfully
+      # @return [Boolean] Returns true if the commands complete successfully.
       def set_global_timeout(opts = {})
         cmd = command_builder('radius-server timeout', opts)
         configure cmd
@@ -246,26 +246,26 @@ module Rbeapi
       # value is configured using the no keyword.  If the default option is
       # specified, the radius-server retransmit value is configured using the
       # default keyword. If both options are specified then the default keyword
-      # takes precedence
+      # takes precedence.
       #
-      # @eos_version 4.13.7M
+      # @since eos_version 4.13.7M
       #
-      # @commands
+      # ===Commands
       #   radius-server retransmit <value>
       #   no radius-server retransmit
       #   default radius-server retransmit
       #
-      # @option [String, Fixnum] :value The value to set the global
-      #   radius-server retransmit value to.  This value should be in the range
+      # @option value [String, Fixnum] The value to set the global
+      #   radius-server retransmit value to. This value should be in the range
       #   of 1 to 100
       #
-      # @option :opts [Boolean] :enable If false then the command is
+      # @option opts enable [Boolean] If false then the command is
       #   negated. Default is true.
       #
-      # @option [Boolean] :default Configures the radius-server retransmit
-      #   value using the default keyword
+      # @option default [Boolean] Configures the radius-server retransmit
+      #   value using the default keyword.
       #
-      # @return [Boolean] returns true if the commands complete successfully
+      # @return [Boolean] Returns true if the commands complete successfully.
       def set_global_retransmit(opts = {})
         cmd = command_builder('radius-server retransmit', opts)
         configure cmd
@@ -275,11 +275,29 @@ module Rbeapi
       # update_server configures a radius server resource on the target device.
       # This API method maps to the `radius server host` command, e.g.
       # `radius-server host 10.11.12.13 auth-port 1024 acct-port 2048 timeout
-      # 30 retransmit 5 key 7 011204070A5955`
+      # 30 retransmit 5 key 7 011204070A5955`.
       #
       # @api public
       #
-      # @return [Boolean] true if there are no errors
+      # @param opts [Hash] The configuration options.
+      #
+      # @option opts key_format [Integer] The key format value.
+      #
+      # @option opts hostname [String] The host value.
+      #
+      # @option opts vrf [String] The vrf value.
+      #
+      # @option opts auth_port [String] The auth-port value.
+      #
+      # @option opts acct_port [String] The acct-port value.
+      #
+      # @option opts timeout [String] The timeout value.
+      #
+      # @option opts retransmit [String] The retransmit value.
+      #
+      # @option opts key [String] The key value.
+      #
+      # @return [Boolean] Returns true if there are no errors.
       def update_server(opts = {})
         # beware: order of cli keyword options counts
         key_format = opts[:key_format] || 7
@@ -299,7 +317,17 @@ module Rbeapi
       #
       # @api public
       #
-      # @return [Boolean] true if no errors
+      # @param opts [Hash] The configuration options.
+      #
+      # @option opts hostname [String] The host value.
+      #
+      # @option opts vrf [String] The vrf value.
+      #
+      # @option opts auth_port [String] The auth-port value.
+      #
+      # @option opts acct_port [String] The acct-port value.
+      #
+      # @return [Boolean] Returns true if there are no errors.
       def remove_server(opts = {})
         cmd = "no radius-server host #{opts[:hostname]}"
         cmd << " vrf #{opts[:vrf]}"             if opts[:vrf]