rbeapi 0.4.0 → 0.5.0

data/lib/rbeapi/api/ospf.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 Ospf class is a global class that provides an instance for working
@@ -48,13 +48,15 @@ module Rbeapi
       #
       # @example
       #   {
-      #     "router_id": <string>
-      #     "areas": {
+      #     router_id: <string>
+      #     areas: {
       #       <string>: array<string>
       #     },
-      #     "redistribute"
+      #     redistribute: {}
       #   }
       #
+      # @param [String] :inst The ospf instance name
+      #
       # @return [Hash]  A Ruby hash object that provides the OSPF settings as
       #   key / value pairs.
       def get(inst)
@@ -90,9 +92,16 @@ module Rbeapi
       #
       # @example
       # {
-      #   <pid>: {...}
-      #   "interfaces": {...}
+      #   <pid>: {
+      #     router_id: <string>,
+      #     areas: {},
+      #     redistribute: {}
+      #   },
+      #   interfaces: {}
       # }
+      #
+      # @return [Hash]  A Ruby hash object that provides the OSPF settings as
+      #   key / value pairs.
       def getall
         instances = config.scan(/(?<=^router\sospf\s)\d+$/)
         response = instances.each_with_object({}) do |inst, hsh|
@@ -108,28 +117,91 @@ module Rbeapi
         @interfaces
       end
 
+      ##
+      # create will create a router ospf with the specified pid
+      #
+      # @param [String] :pid The router ospf to create
+      #
+      # @return [Boolean] returns true if the command completed successfully
       def create(pid)
         configure "router ospf #{pid}"
       end
 
+      ##
+      # delete will remove the specified router ospf
+      #
+      # @param [String] :pid The router ospf to remove
+      #
+      # @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
+      #
+      # @param [String] :pid The router ospf name
+      #
+      # @param [hash] :opts Optional keyword arguments
+      #
+      # @option :opts [Boolean] :enable If false then the command is
+      #   negated. Default is true.
+      #
+      # @option :opts [Boolean] :default Configure the router-id to default.
+      #
+      # @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]
         configure cmds
       end
 
+      ##
+      # add_network adds network settings for router ospf and network area.
+      #
+      # @param [String] :pid The pid for router ospf
+      #
+      # @param [String] :net The network name
+      #
+      # @param [String] :area The network area name
+      #
+      # @return [Boolean] returns true if the command completed successfully
       def add_network(pid, net, area)
         configure ["router ospf #{pid}", "network #{net} area #{area}"]
       end
 
+      ##
+      # remove_network removes network settings for router ospf and network
+      #   area.
+      #
+      # @param [String] :pid The pid for router ospf
+      #
+      # @param [String] :net The network name
+      #
+      # @param [String] :area The network area name
+      #
+      # @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
+      #
+      # @param [String] :pid The router ospf name
+      #
+      # @param [String] :proto The redistribute value
+      #
+      # @param [hash] :opts Optional keyword arguments
+      #
+      # @option :opts [String] :routemap The route-map value
+      #
+      # @option :opts [Boolean] :enable If false then the command is
+      #   negated. Default is true.
+      #
+      # @option :opts [Boolean] :default Configure the router-id to default.
+      #
+      # @return [Boolean] returns true if the command completed successfully
       def set_redistribute(pid, proto, opts = {})
         routemap = opts[:routemap]
         cmds = ["router ospf #{pid}", "redistribute #{proto}"]
@@ -147,8 +219,7 @@ module Rbeapi
       #
       # Example
       #   {
-      #     "name": <string>,
-      #     "network_type": <string>
+      #      network_type: <string>
       #   }
       #
       # @param [String] :name The interface name to return the configuration
@@ -174,8 +245,13 @@ module Rbeapi
       #
       # Example
       #   {
-      #     <name>: {...},
-      #     <name>: {...}
+      #     <name>: {
+      #       network_type: <string>
+      #     },
+      #     <name>: {
+      #       network_type: <string>
+      #     },
+      #     ...
       #   }
       #
       # @return [nil, Hash<String, String>] A Ruby hash that represents the
@@ -189,6 +265,22 @@ module Rbeapi
         end
       end
 
+      ##
+      # set_network_type sets network type with options
+      #
+      # @param [String] :name The name of the interface
+      #
+      # @param [hash] :opts Optional keyword arguments
+      #
+      # @option :opts [String] :value The point-to-point value
+      #
+      # @option :opts [Boolean] :enable If false then the command is
+      #   negated. Default is true.
+      #
+      # @option :opts [Boolean] :default Configure the ip ospf network
+      #   to default.
+      #
+      # @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

@@ -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 Prefixlists class provides a configuration instance for working
@@ -48,16 +48,17 @@ module Rbeapi
       # @example
       #   {
       #     <route>: {
-      #       "next_hop": <string>,
-      #       "name": <string, nil>
+      #       next_hop: <string>,
+      #       name: <string, nil>
       #     }
       #   }
       #
+      # @param [String] :name 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
       #   there are no static routes configured, this method will return
       #   an empty hash
-
       def get(name)
         config = get_block("ip prefix-list #{name}")
         return nil unless config
@@ -69,6 +70,21 @@ module Rbeapi
         end
       end
 
+      ##
+      # Returns the static routes configured on the node
+      #
+      # @example
+      #   {
+      #     <route>: {
+      #       next_hop: <string>,
+      #       name: <string, nil>
+      #     }
+      #   }
+      #
+      # @returns [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
       def getall
         lists = config.scan(/(?<=^ip\sprefix-list\s).+/)
         lists.each_with_object({}) do |name, hsh|
@@ -77,10 +93,29 @@ module Rbeapi
         end
       end
 
+      ##
+      # create will create a new ip prefix-list with designated name.
+      #
+      # @param [String] :name The name of the ip prefix-list
+      #
+      # @return [Boolean] returns true if the command completed successfully
       def create(name)
         configure "ip prefix-list #{name}"
       end
 
+      ##
+      # 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 [String] :seq The seq value
+      #
+      # @param [String] :action The action value
+      #
+      # @param [String] :prefix The prefix value
+      #
+      # @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
@@ -88,6 +123,14 @@ module Rbeapi
         configure cmd
       end
 
+      ##
+      # delete will remove the designated prefix-list
+      #
+      # @param [String] :name The name of the ip prefix-list
+      #
+      # @param [String] :seq The seq value
+      #
+      # @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

@@ -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
     ##
     # Radius provides instance methods to retrieve and set radius configuration
@@ -61,14 +61,14 @@ module Rbeapi
       # This method is intended to be used by a provider's instances class
       # method.
       #
-      # The resource hash returned contains the following information:
-      #  * key: (String) the key either in plain text or hashed format
-      #  * key_format: (Fixnum) e.g. 0 or 7
-      #  * timeout: (Fixnum) seconds before the timeout period ends
-      #  * retransmit: (Fixnum), e.g. 3, attempts after first timeout expiry.
-      #  * servers: (Array),
-      #
-      # @api public
+      # @example
+      #   {
+      #     key: <string>,
+      #     key_format: <fixnum>,
+      #     timeout: <fixnum>,
+      #     retransmit: <fixnum>,
+      #     servers: <array>
+      #   }
       #
       # @return [Array<Hash>] Single element Array of resource hashes
       def get

data/lib/rbeapi/api/routemaps.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 Routemaps class manages routemaps. A route map is a list of rules
@@ -81,8 +81,8 @@ module Rbeapi
       #     }
       #   }
       #
-      # @param [String] name The routemap name to return a resource for from the
-      #   nodes configuration
+      # @param [String] :name The routemap name to return a resource for from
+      #   the nodes configuration
       #
       # @return [nil, Hash<Symbol, Object>] Returns the routemap resource as a
       #   Hash. If the specified name is not found in the nodes current
@@ -174,10 +174,11 @@ module Rbeapi
       ##
       # parse entries is a private method to get the routemap rules.
       #
+      # @api private
+      #
       # @return [nil, Hash<Symbol, Object>] returns a hash that represents the
       #   rules for routemaps from the nodes running configuration.  If
       #   there are no routemaps configured, this method will return nil.
-      #
       def parse_entries(name)
         entries = config.scan(/^route-map\s#{name}\s.+$/)
         return nil if entries.empty?
@@ -196,11 +197,12 @@ module Rbeapi
       ##
       # parse rule is a private method to parse a rule.
       #
+      # @api private
+      #
       # @return [Hash<Symbol, Object>] returns a hash that represents the
       #   rules for routemaps from the nodes running configuration.  If
       #   there are no routemaps configured, this method will return an empty
       #    hash.
-      #
       def parse_rules(rules)
         rules.split("\n").each_with_object({}) do |rule, rule_hsh|
           mdata = /\s{3}(\w+)\s/.match(rule)

data/lib/rbeapi/api/snmp.rb

@@ -35,7 +35,7 @@ require 'rbeapi/api'
 # Rbeapi toplevel namespace
 module Rbeapi
   ##
-  # Api is module namespace for working with eAPI abstractions
+  # Api is module namespace for working with the EOS command API
   module Api
     ##
     # The Snmp class provides a class implementation for working with the
@@ -57,9 +57,9 @@ module Rbeapi
       #
       # @example
       #   {
-      #     location: <string>
-      #     contact: <string>
-      #     chassis_id: <string>
+      #     location: <string>,
+      #     contact: <string>,
+      #     chassis_id: <string>,
       #     source_interface: <string>
       #   }
       #
@@ -403,6 +403,15 @@ module Rbeapi
         configure cmds
       end
 
+      ##
+      # set_community_access configures snmp-server community with designated
+      #   name and access values.
+      #
+      # @param [String] :name The snmp-server community name value
+      #
+      # @param [String] :access The snmp-server community access value
+      #
+      # @return [Boolean] returns true if the command completed successfully
       def set_community_access(name, access)
         configure "snmp-server community #{name} #{access}"
       end

data/lib/rbeapi/api/staticroutes.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 Staticroutes class provides a configuration instance for working

data/lib/rbeapi/api/stp.rb

@@ -34,7 +34,7 @@
 # Rbeapi toplevel namespace
 module Rbeapi
   ##
-  # Rbeapi::Api
+  # Api is module namespace for working with the EOS command API
   module Api
     ##
     # The Stp class provides a base class instance for working with
@@ -48,13 +48,20 @@ module Rbeapi
       # @example
       #   {
       #     mode: <string>
-      #     instances: {...}
-      #     interfaces: {...}
+      #     instances: {
+      #       <string>: {
+      #         priority: <string>
+      #       }
+      #     }
+      #     interfaces: {
+      #       <name>: {
+      #         portfast: <boolean>,
+      #         portfast_type: <string>,
+      #         bpduguard: <boolean>
+      #       }
+      #     }
       #   }
       #
-      # @see StpInstances instances get example
-      # @eee StpInterfaces interfaces get example
-      #
       # @return [Hash] returns a Hash of attributes derived from eAPI
       def get
         response = {}
@@ -150,6 +157,8 @@ module Rbeapi
       #     priority: <string>
       #   }
       #
+      # @param [String] :inst The named stp instance to return
+      #
       # @return [nil, Hash<Symbol, Object] returns the stp instance config as
       #    a resource hash.  If the instances is not configured this method
       #    will return a nil object
@@ -167,11 +176,15 @@ module Rbeapi
       #
       # @example
       #   {
-      #     <inst>: {...}
+      #     <inst>: {
+      #       priority: <string>
+      #     },
+      #     <inst>: {
+      #       priority: <string>
+      #     },
+      #     ...
       #   }
       #
-      # @see get Instance get example
-      #
       # @return [Hash<Symbol, Object>] returns all configured stp instances
       #   found in the nodes running configuration
       def getall
@@ -265,10 +278,14 @@ module Rbeapi
       #
       # @example
       #   {
-      #     portfast: [true, false]
-      #     bpduguard: [true, false]
+      #     portfast: <boolean>,
+      #     portfast_type: <string>,
+      #     bpduguard: <boolean>
       #   }
       #
+      # @param [String] :name The interface name to return a resource for from
+      #   the nodes configuration
+      #
       # @return [nil, Hash<Symbol, Object>] returns the stp interface as a
       #   resource hash
       def get(name)
@@ -289,11 +306,19 @@ module Rbeapi
       #
       # @example
       #   {
-      #     <interface>: {...}
+      #     <name>: {
+      #       portfast: <boolean>,
+      #       portfast_type: <string>,
+      #       bpduguard: <boolean>
+      #     },
+      #     <name>: {
+      #       portfast: <boolean>,
+      #       portfast_type: <string>,
+      #       bpduguard: <boolean>
+      #     },
+      #     ...
       #   }
       #
-      # @see get Interface example
-      #
       # @return [Hash<Symbol, Object>] returns the stp interfaces config as a
       #   resource hash from the nodes running configuration
       def getall