rbeapi 0.5.0 → 0.5.1

data/lib/rbeapi/api/aaa.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 Aaa class manages Authorization, Authentication and Accounting (AAA)
     # on an EOS node.
     class Aaa < Entity
       ##
-      # get returns a hash of all Aaa resources
+      # get returns a hash of all Aaa resources.
       #
       # @example
       #   {
@@ -105,12 +105,12 @@ module Rbeapi
       #     servers: <array>
       #   }
       #
-      # @param [String] :name The server group name to return from the nodes
-      #   current running configuration.  If the name is not configured a nil
+      # @param name [String] The server group name to return from the nodes
+      #   current running configuration. If the name is not configured a nil
       #   object is returned.
       #
-      # @return [nil, Hash<Symbol, Object>] returns the resource hash for the
-      #   specified name.  If the name does not exist, a nil object is returned
+      # @return [nil, Hash<Symbol, Object>] Returns the resource hash for the
+      #   specified name. If the name does not exist, a nil object is returned.
       def get(name)
         block = get_block("aaa group server ([^\s]+) #{name}")
         return nil unless block
@@ -121,22 +121,22 @@ module Rbeapi
       end
 
       ##
-      # getall returns a aaa server groups hash
+      # getall returns a aaa server groups hash.
       #
       # @example
-      # {
-      #   <name>: {
-      #     type: <string>,
-      #     servers: <array>
-      #   },
-      #   <name>: {
-      #     type: <string>,
-      #     servers: <array>
+      #   {
+      #     <name>: {
+      #       type: <string>,
+      #       servers: <array>
+      #     },
+      #     <name>: {
+      #       type: <string>,
+      #       servers: <array>
+      #     }
       #   }
-      # }
       #
-      # @return [Hash<Symbol, Object>] returns the resource hashes for
-      #   configured aaa groups.  If none exist, a nil object is returned
+      # @return [Hash<Symbol, Object>] Returns the resource hashes for
+      #   configured aaa groups. If none exist, a nil object is returned.
       def getall
         cfg = config.scan(/aaa group server (?:radius|tacacs\+) (.+)$/)
         cfg.each_with_object({}) do |name, hsh|
@@ -147,15 +147,15 @@ module Rbeapi
 
       ##
       # parse_type scans the specified configuration block and returns the
-      # server group type as either 'tacacs' or 'radius'.  The type value is
+      # server group type as either 'tacacs' or 'radius'. The type value is
       # expected to always be present in the config.
       #
       # @api private
       #
-      # @param [String] :config The aaa server group block configuration for the
-      #   group name to parse
+      # @param config [String] The aaa server group block configuration for the
+      #   group name to parse.
       #
-      # @return [Hash<Symbol, Object>] resource hash attribute
+      # @return [Hash<Symbol, Object>] Resource hash attribute.
       def parse_type(config)
         value = config.scan(/aaa group server ([^\s]+)/).first
         { type: value.first }
@@ -164,7 +164,7 @@ module Rbeapi
 
       ##
       # parse_servers scans the specified configuraiton block and returns the
-      # list of servers configured for the group.  If there are no servers
+      # list of servers configured for the group. If there are no servers
       # configured for the group the servers value will return an empty array.
       #
       # @api private
@@ -172,13 +172,13 @@ module Rbeapi
       # @see parse_radius_server
       # @see parse_tacacs_server
       #
-      # @param [String] :config The aaa server group block configuration for the
-      #   group name to parse
+      # @param config [String] The aaa server group block configuration for the
+      #   group name to parse.
       #
-      # @param [String] :type The aaa server block type.  Valid values are
+      # @param type [String] The aaa server block type. Valid values are
       #   either radius or tacacs+.
       #
-      # @return [Hash<Symbol, Object>] resource hash attribute
+      # @return [Hash<Symbol, Object>] Resource hash attribute
       def parse_servers(config, type)
         case type
         when 'radius' then parse_radius_server(config)
@@ -189,13 +189,13 @@ module Rbeapi
 
       ##
       # parse_radius_server scans the provide configuration block and returns
-      # the list of servers configured.  The configuration block is expected to
-      # be a radius configuration block.  If there are no servers configured
+      # the list of servers configured. The configuration block is expected to
+      # be a radius configuration block. If there are no servers configured
       # for the group the servers value will return an empty array.
       #
       # @api private
       #
-      # @param [String] :config The aaa server group block configuration for the
+      # @param config [String] The aaa server group block configuration for the
       #   group name to parse
       #
       # @return [Hash<Symbol, Object>] resource hash attribute
@@ -213,16 +213,16 @@ module Rbeapi
 
       ##
       # parse_tacacs_server scans the provided configuration block and returns
-      # the list of configured servers.  The configuration block is expected to
-      # be a tacacs configuration block.  If there are no servers configured
+      # the list of configured servers. The configuration block is expected to
+      # be a tacacs configuration block. If there are no servers configured
       # for the group the servers value will return an empty array.
       #
       # @api private
       #
-      # @param [String] :config The aaa server group block configuration for the
-      #   group name to parse
+      # @param config [String] The aaa server group block configuration for the
+      #   group name to parse.
       #
-      # @return [Hash<Symbol, Object>] resource hash attribute
+      # @return [Hash<Symbol, Object>] Resource hash attribute.
       def parse_tacacs_server(config)
         values = config.scan(TACACS_GROUP_SERVER).map do |(name, vrf, port)|
           {
@@ -237,17 +237,17 @@ module Rbeapi
 
       ##
       # find_type is a utility method to find the type of aaa server group for
-      # the specified name.  This method will scan the current running
+      # the specified name. This method will scan the current running
       # configuration on the node and return the server group type as either
-      # 'radius' or 'tacacs+'.  If the server group is not configured, then nil
+      # 'radius' or 'tacacs+'. If the server group is not configured, then nil
       # will be returned.
       #
       # @api private
       #
-      # @param [String] :name The aaa server group name to find in the config
-      #   and return the type value for
+      # @param name [String] The aaa server group name to find in the config
+      #   and return the type value for.
       #
-      # @return [nil, String] returns either the type name as 'radius' or
+      # @return [nil, String] Returns either the type name as 'radius' or
       #   'tacacs+' or nil if the server group is not configured.
       def find_type(name)
         mdata = /aaa group server ([^\s]+) #{name}/.match(config)
@@ -258,19 +258,19 @@ module Rbeapi
       ##
       # create adds a new aaa group server to the nodes current configuration.
       # If the specified name and type are already created then this method
-      # will return successfully.  If the name is configured but the type is
+      # will return successfully. If the name is configured but the type is
       # different, this method will not return successfully (returns false).
       #
-      # @eos_version 4.13.7M
+      # @since eos_version 4.13.7M
       #
-      # @commands
+      # ===Commands
       #   aaa group server <type> <name>
       #
-      # @param [String] :name The name of the aaa group server to create in the
+      # @param name [String] The name of the aaa group server to create in the
       #   nodes running configuration
       #
-      # @param [String] :type The type of aaa group server to create in the
-      #   nodes running configuration.  Valid values include 'radius' or
+      # @param type [String] The type of aaa group server to create in the
+      #   nodes running configuration. Valid values include 'radius' or
       #   'tacacs+'
       #
       # @return [Boolean] returns true if the commands complete successfully
@@ -280,19 +280,19 @@ module Rbeapi
 
       ##
       # delete removes a current aaa server group from the nodes current
-      # configuration.  This method will automatically determine the server
-      # group type based on the name.  If the name is not configured in the
+      # configuration. This method will automatically determine the server
+      # group type based on the name. If the name is not configured in the
       # nodes current configuration, this method will return successfully.
       #
-      # @eos_version 4.13.7M
+      # @since eos_version 4.13.7M
       #
-      # @commands
+      # ===Commands
       #   no aaa group server [radius | tacacs+] <name>
       #
-      # @param [String] :name The name of the aaa group server to create in the
-      #   nodes running configuration
+      # @param name [String] The name of the aaa group server to create in the
+      #   nodes running configuration.
       #
-      # @return [Boolean] returns true if the commands complete successfully
+      # @return [Boolean] Returns true if the commands complete successfully.
       def delete(name)
         type = find_type(name)
         return true unless type
@@ -301,22 +301,20 @@ module Rbeapi
 
       ##
       # set_servers configures the set of servers for a specified aaa server
-      # group.  This is an atomic operation that first removes all current
-      # servers and then adds the new servers back.  If any of the servers
+      # group. This is an atomic operation that first removes all current
+      # servers and then adds the new servers back. If any of the servers
       # failes to be removed or added, this method will return unsuccessfully.
       #
       # @see remove_server
       # @see add_server
       #
-      # @param [String] :name The name of the aaa group server to add the new
+      # @param name [String] The name of the aaa group server to add the new
       #   server configuration to.
       #
-      # @param [String] :server The IP address or host name of the server to
+      # @param servers [String] The IP address or host name of the server to
       #   add to the configuration
       #
-      # @param [Hash] :opts Optional configuration parameters
-      #
-      # @return [Boolean] returns true if the commands complete successfully
+      # @return [Boolean] Returns true if the commands complete successfully
       def set_servers(name, servers)
         current = get(name)
         current[:servers].each do |srv|
@@ -330,22 +328,22 @@ module Rbeapi
       end
 
       ##
-      # add_server adds a new server to the specified aaa server group.  If
+      # add_server adds a new server to the specified aaa server group. If
       # the server is already configured in the list of servers, this method
       # will still return successfully.
       #
       # @see add_radius_server
       # @see add_tacacs_server
       #
-      # @param [String] :name The name of the aaa group server to add the new
+      # @param name [String] The name of the aaa group server to add the new
       #   server configuration to.
       #
-      # @param [String] :server The IP address or host name of the server to
-      #   add to the configuration
+      # @param server [String] The IP address or host name of the server to
+      #   add to the configuration.
       #
-      # @param [Hash] :opts Optional configuration parameters
+      # @param opts [Hash] Optional configuration parameters.
       #
-      # @return [Boolean] returns true if the commands complete successfully
+      # @return [Boolean] Returns true if the commands complete successfully.
       def add_server(name, server, opts = {})
         type = find_type(name)
         return false unless type
@@ -359,24 +357,24 @@ module Rbeapi
       ##
       # add_radius_server adds a new radius server to the nodes current
       # configuration.  If the server already exists in the specified group
-      # name this method will still return successfully
+      # name this method will still return successfully.
       #
-      # @eos_version 4.13.7M
+      # @since eos_version 4.13.7M
       #
-      # @commmands
+      # commmands
       #   aaa group server radius <name>
       #   server <server> [acct-port <acct_port>] [auth-port <auth_port>]
       #                   [vrf <vrf>]
       #
-      # @param [String] :name The name of the aaa group server to add the new
+      # @param name [String] The name of the aaa group server to add the new
       #   server configuration to.
       #
-      # @param [String] :server The IP address or host name of the server to
-      #   add to the configuration
+      # @param server [String] The IP address or host name of the server to
+      #   add to the configuration.
       #
-      # @param [Hash] :opts Optional configuration parameters
+      # @param opts [Hash] Optional configuration parameters.
       #
-      # @return [Boolean] returns true if the commands complete successfully
+      # @return [Boolean] Returns true if the commands complete successfully.
       def add_radius_server(name, server, opts = {})
         # order of command options matter here!
         server = "server #{server} "
@@ -388,25 +386,25 @@ module Rbeapi
 
       ##
       # add_tacacs_server adds a new tacacs server to the nodes current
-      # configuration.  If the server already exists in the specified group
-      # name this method will still return successfully
+      # configuration. If the server already exists in the specified group
+      # name this method will still return successfully.
       #
-      # @eos_version 4.13.7M
+      # @since eos_version 4.13.7M
       #
-      # @commmands
+      # commmands
       #   aaa group server tacacs+ <name>
       #   server <server> [acct-port <acct_port>] [auth-port <auth_port>]
       #                   [vrf <vrf>]
       #
-      # @param [String] :name The name of the aaa group server to add the new
+      # @param name [String] The name of the aaa group server to add the new
       #   server configuration to.
       #
-      # @param [String] :server The IP address or host name of the server to
-      #   add to the configuration
+      # @param server [String] The IP address or host name of the server to
+      #   add to the configuration.
       #
-      # @param [Hash] :opts Optional configuration parameters
+      # @param opts [Hash] Optional configuration parameters.
       #
-      # @return [Boolean] returns true if the commands complete successfully
+      # @return [Boolean] Returns true if the commands complete successfully.
       def add_tacacs_server(name, server, opts = {})
         # order of command options matter here!
         server = "server #{server} "
@@ -417,20 +415,22 @@ module Rbeapi
 
       ##
       # remove_server deletes an existing server from the specified aaa server
-      # group.  If the specified server is not configured in the specified
+      # group. If the specified server is not configured in the specified
       # server group, this method will still return true.
       #
-      # @eos_version 4.13.7M
+      # eos_version 4.13.7M
       #
-      # @commands
+      # ===Commands
       #   aaa group server [radius | tacacs+] <name>
       #   no server <server>
       #
-      # @param [String] :name The name of the aaa group server to remove
+      # @param name [String] The name of the aaa group server to remove.
       #
-      # @param [String] :server The IP address or host name of the server
+      # @param server [String] The IP address or host name of the server.
       #
-      # @return [Boolean] returns true if the commands complete successfully
+      # @param opts [Hash] Optional configuration parameters.
+      #
+      # @return [Boolean] returns true if the commands complete successfully.
       def remove_server(name, server, opts = {})
         type = find_type(name)
         return false unless type

data/lib/rbeapi/api/acl.rb

@@ -33,10 +33,10 @@ require 'netaddr'
 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 Acl class manages the set of standard ACLs.
@@ -75,7 +75,7 @@ module Rbeapi
       #     ...
       #   }
       #
-      # @param [String] :name The ACL name.
+      # @param name [String] The ACL name.
       #
       # @return [nil, Hash<Symbol, Object>] Returns the ACL resource as a
       #   Hash. Returns nil if name does not exist.
@@ -144,11 +144,11 @@ module Rbeapi
 
       ##
       # mask_to_prefixlen converts a subnet mask from dotted decimal to
-      # bit length
+      # bit length.
       #
-      # @param [String] :mask The dotted decimal subnet mask to convert
+      # @param mask [String] The dotted decimal subnet mask to convert.
       #
-      # @return [String] The subnet mask as a valid prefix length
+      # @return [String] The subnet mask as a valid prefix length.
       def mask_to_prefixlen(mask)
         mask = '255.255.255.255' unless mask
         NetAddr::CIDR.create('0.0.0.0/' + mask).netmask_ext
@@ -160,9 +160,9 @@ module Rbeapi
       #
       # @api private
       #
-      # @param [String] :config The switch config.
+      # @param config [String] The switch config.
       #
-      # @return [Hash<Symbol, Object>] resource hash attribute
+      # @return [Hash<Symbol, Object>] Returns the resource hash attribute.
 
       def parse_entries(config)
         entries = {}
@@ -187,38 +187,38 @@ module Rbeapi
 
       ##
       # create will create a new ACL resource in the nodes current
-      # configuration with the specified name.  If the create method
+      # configuration with the specified name. If the create method
       # is called and the ACL already exists, this method will still
       # return true. The ACL will not have any entries. Use add_entry
       # to add entries to the ACL.
       #
-      # @eos_version 4.13.7M
+      # @since eos_version 4.13.7M
       #
-      # @commands
+      # ===Commands
       #   ip access-list standard <name>
       #
-      # @param [String] :name The ACL name to create on the node. Must
+      # @param name [String] The ACL name to create on the node. Must
       #   begin with an alphabetic character. Cannot contain spaces or
       #   quotation marks.
       #
-      # @return [Boolean] returns true if the command completed successfully
+      # @return [Boolean] Returns true if the command completed successfully.
       def create(name)
         configure("ip access-list standard #{name}")
       end
 
       ##
       # delete will delete an existing ACL resource from the nodes current
-      # running configuration.  If the delete method is called and the ACL
+      # running configuration. If the delete method is called and the ACL
       # does not exist, this method will succeed.
       #
-      # @eos_version 4.13.7M
+      # @since eos_version 4.13.7M
       #
-      # @commands
+      # ===Commands
       #   no ip access-list standard <name>
       #
-      # @param [String] :name The ACL name to delete on the node.
+      # @param name [String] The ACL name to delete on the node.
       #
-      # @return [Boolean] returns true if the command completed successfully
+      # @return [Boolean] Returns true if the command completed successfully.
       def delete(name)
         configure("no ip access-list standard #{name}")
       end
@@ -228,15 +228,15 @@ module Rbeapi
       # command has the same effect as deleting the ACL from the nodes
       # running configuration.
       #
-      # @eos_version 4.13.7M
+      # @since eos_version 4.13.7M
       #
-      # @commands
+      # ===Commands
       #   default no ip access-list standard <name>
       #
-      # @param [String] :name The ACL name to set to the default value
+      # @param name [String] The ACL name to set to the default value
       #   on the node.
       #
-      # @return [Boolean] returns true if the command complete successfully
+      # @return [Boolean] Returns true if the command complete successfully
       def default(name)
         configure("default ip access-list standard #{name}")
       end
@@ -246,17 +246,22 @@ module Rbeapi
       #
       # @api private
       #
-      # @param [Hash] :opts the options for the entry
-      # @option :opts  [String] :seqno The sequence number of the entry in
+      # @param entry [Hash] the options for the entry.
+      #
+      # @option entry seqno [String] The sequence number of the entry in
       #   the ACL to add. Default is nil, will be assigned.
-      # @option :opts  [String] :action The action triggered by the ACL. Valid
-      #   values are 'permit', 'deny', or 'remark'
-      # @option :opts  [String] :addr The IP address to permit or deny.
-      # @option :opts  [String] :prefixlen The prefixlen for the IP address.
-      # @option :opts  [Boolean] :log Triggers an informational log message
+      #
+      # @option entry action [String] The action triggered by the ACL. Valid
+      #   values are 'permit', 'deny', or 'remark'.
+      #
+      # @option entry addr [String] The IP address to permit or deny.
+      #
+      # @option entry prefixlen [String] The prefixlen for the IP address.
+      #
+      # @option entry log [Boolean] Triggers an informational log message
       #   to the console about the matching packet.
       #
-      # @return [String] returns commands to create an entry
+      # @return [String] Returns commands to create an entry.
       def build_entry(entry)
         cmds = "#{entry[:seqno]} " if entry[:seqno]
         cmds << "#{entry[:action]} #{entry[:srcaddr]}/#{entry[:srcprefixlen]}"
@@ -269,20 +274,26 @@ module Rbeapi
       # update_entry will update an entry, identified by the seqno
       # in the ACL specified by name, with the passed in parameters.
       #
-      # @eos_version 4.13.7M
+      # @since eos_version 4.13.7M
       #
-      # @param [String] :name The ACL name to update on the node.
-      # @param [Hash] :opts the options for the entry
-      # @option :opts  [String] :seqno The sequence number of the entry in
+      # @param name [String] The ACL name to update on the node.
+      #
+      # @param entry [Hash] the options for the entry.
+      #
+      # @option entry seqno [String] The sequence number of the entry in
       #   the ACL to update.
-      # @option :opts  [String] :action The action triggered by the ACL. Valid
-      #   values are 'permit', 'deny', or 'remark'
-      # @option :opts  [String] :addr The IP address to permit or deny.
-      # @option :opts  [String] :prefixlen The prefixlen for the IP address.
-      # @option :opts  [Boolean] :log Triggers an informational log message
+      #
+      # @option entry action [String] The action triggered by the ACL. Valid
+      #   values are 'permit', 'deny', or 'remark'.
+      #
+      # @option entry addr [String] The IP address to permit or deny.
+      #
+      # @option entry prefixlen [String] The prefixlen for the IP address.
+      #
+      # @option entry log [Boolean] Triggers an informational log message
       #   to the console about the matching packet.
       #
-      # @return [Boolean] returns true if the command complete successfully
+      # @return [Boolean] Returns true if the command complete successfully.
       def update_entry(name, entry)
         cmds = ["ip access-list standard #{name}"]
         cmds << "no #{entry[:seqno]}"
@@ -295,18 +306,23 @@ module Rbeapi
       # add_entry will add an entry to the specified ACL with the
       # passed in parameters.
       #
-      # @eos_version 4.13.7M
+      # @since eos_version 4.13.7M
+      #
+      # @param name [String] The ACL name to add an entry to on the node.
+      #
+      # @param entry [Hash] the options for the entry.
       #
-      # @param [String] :name The ACL name to add an entry to on the node.
-      # @param [Hash] :opts the options for the entry
-      # @option :opts  [String] :action The action triggered by the ACL. Valid
-      #   values are 'permit', 'deny', or 'remark'
-      # @option :opts  [String] :addr The IP address to permit or deny.
-      # @option :opts  [String] :prefixlen The prefixlen for the IP address.
-      # @option :opts  [Boolean] :log Triggers an informational log message
+      # @option entry action [String] The action triggered by the ACL. Valid
+      #   values are 'permit', 'deny', or 'remark'.
+      #
+      # @option entry addr [String] The IP address to permit or deny.
+      #
+      # @option entry prefixlen [String] The prefixlen for the IP address.
+      #
+      # @option entry log [Boolean] Triggers an informational log message
       #   to the console about the matching packet.
       #
-      # @return [Boolean] returns true if the command complete successfully
+      # @return [Boolean] Returns true if the command complete successfully.
       def add_entry(name, entry)
         cmds = ["ip access-list standard #{name}"]
         cmds << build_entry(entry)
@@ -318,13 +334,14 @@ module Rbeapi
       # remove_entry will remove the entry specified by the seqno for
       # the ACL specified by name.
       #
-      # @eos_version 4.13.7M
+      # @since eos_version 4.13.7M
+      #
+      # @param name [String] The ACL name to update on the node.
       #
-      # @param [String] :name The ACL name to update on the node.
-      # @param [String] :seqno The sequence number of the entry in
+      # @param seqno [String] The sequence number of the entry in
       #   the ACL to remove.
       #
-      # @return [Boolean] returns true if the command complete successfully
+      # @return [Boolean] Returns true if the command complete successfully.
       def remove_entry(name, seqno)
         cmds = ["ip access-list standard #{name}", "no #{seqno}", 'exit']
         configure(cmds)