rbeapi 0.5.0 → 0.5.1

data/lib/rbeapi/api/ipinterfaces.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 Ipinterface class provides an instance for managing logical
@@ -49,17 +49,17 @@ module Rbeapi
       #
       # @example
       #   {
-      #     address: <string>
-      #     mtu: <string>
+      #     address: <string>,
+      #     mtu: <string>,
       #     helper_addresses: array<strings>
       #   }
       #
-      # @param [String] :name The full interface identifier of the interface to
-      #   return the resource configuration hash for.  The name must be the
-      #   full name (Ethernet, not Et)
+      # @param name [String] The full interface identifier of the interface to
+      #   return the resource configuration hash for. The name must be the
+      #   full name (Ethernet, not Et).
       #
-      # @return [nil, Hash<Symbol, Object>] returns the ip interface
-      #   configuration as a hash.  If the provided interface name is not a
+      # @return [nil, Hash<Symbol, Object>] Returns the ip interface
+      #   configuration as a hash. If the provided interface name is not a
       #   configured ip address, nil is returned.
       def get(name)
         config = get_block("interface #{name}")
@@ -80,13 +80,13 @@ module Rbeapi
       # @example
       #   {
       #     <name>: {
-      #       address: <string>
-      #       mtu: <string>
+      #       address: <string>,
+      #       mtu: <string>,
       #       helper_addresses: array<strings>
       #     },
       #     <name>: {
-      #       address: <string>
-      #       mtu: <string>
+      #       address: <string>,
+      #       mtu: <string>,
       #       helper_addresses: array<strings>
       #     },
       #     ...
@@ -94,9 +94,9 @@ module Rbeapi
       #
       # @see get Ipaddress resource example
       #
-      # @return [Hash<Symbol, Object>] returns a hash object that
-      #   represents all of the configured IP addresses found.  If no IP
-      #   addresses are configured, then an empty hash is returned
+      # @return [Hash<Symbol, Object>] Returns a hash object that
+      #   represents all of the configured IP addresses found. If no IP
+      #   addresses are configured, then an empty hash is returned.
       def getall
         interfaces = config.scan(/(?<=^interface\s).+/)
         interfaces.each_with_object({}) do |name, hsh|
@@ -107,17 +107,17 @@ module Rbeapi
 
       ##
       # parse_address scans the provided configuration block and extracts
-      # the interface address, if configured, and returns it.  If there is
+      # the interface address, if configured, and returns it. If there is
       # no IP address configured, then this method will return the
-      # DEFAULT_ADDRESS.  The return value is intended to be merged into the
+      # DEFAULT_ADDRESS. The return value is intended to be merged into the
       # ipaddress resource hash.
       #
       # @api private
       #
-      # @param [String] :config The IP interface configuration block returned
-      #   from the node's running configuration
+      # @param config [String] The IP interface configuration block returned
+      #   from the node's running configuration.
       #
-      # @return [Hash<Symbol, Object>] resource hash attribute
+      # @return [Hash<Symbol, Object>] Returns the resource hash attribute.
       def parse_address(config)
         mdata = /(?<=^\s{3}ip\saddress\s)(.+)$/.match(config)
         { address: mdata.nil? ? DEFAULT_ADDRESS : mdata[1] }
@@ -126,16 +126,16 @@ module Rbeapi
 
       ##
       # parse_mtu scans the provided configuration block and extracts the IP
-      # interface MTU value.  The MTU value is expected to always be present in
-      # the configuration blcok.  The return value is intended to be merged
-      # into the ipaddress resource hash
+      # interface MTU value. The MTU value is expected to always be present in
+      # the configuration blcok. The return value is intended to be merged
+      # into the ipaddress resource hash.
       #
       # @api private
       #
-      # @param [String] :config The IP interface configuration block returned
-      #   from the node's running configuration
+      # @param config [String] The IP interface configuration block returned
+      #   from the node's running configuration.
       #
-      # @return [Hash<Symbol, Object>] resource hash attribute
+      # @return [Hash<Symbol, Object>] Returns the resource hash attribute.
       def parse_mtu(config)
         mdata = /(?<=mtu\s)(\d+)$/.match(config)
         { mtu: mdata.nil? ? '' : mdata[1] }
@@ -144,18 +144,18 @@ module Rbeapi
 
       ##
       # parse_helper_addresses scans the provided configuration block and
-      # extracts any configured IP helper address values.  The interface could
-      # be configured with one or more helper addresses.  If no helper
+      # extracts any configured IP helper address values. The interface could
+      # be configured with one or more helper addresses. If no helper
       # addresses are configured, then an empty array is set in the return
-      # hash.  The return value is intended to be merged into the ipaddress
-      # resource hash
+      # hash. The return value is intended to be merged into the ipaddress
+      # resource hash.
       #
       # @api private
       #
-      # @param [String] :config The IP interface configuration block returned
-      #   from the node's running configuration
+      # @param config [String] The IP interface configuration block returned
+      #   from the node's running configuration.
       #
-      # @return [Hash<Symbol, Object>] resource hash attribute
+      # @return [Hash<Symbol, Object>] Returns the resource hash attribute.
       def parse_helper_addresses(config)
         helpers = config.scan(/(?<=\s{3}ip\shelper-address\s).+$/)
         { helper_addresses: helpers }
@@ -163,80 +163,80 @@ module Rbeapi
       private :parse_helper_addresses
 
       ##
-      # create will create a new IP interface on the node.  If the ip interface
+      # create will create a new IP interface on the node. If the ip interface
       # already exists in the configuration, this method will still return
-      # successful.  This method will cause an existing layer 2 interface
+      # successful. This method will cause an existing layer 2 interface
       # (switchport) to be deleted if it exists in the node's configuration.
       #
-      # @eos_version 4.13.7M
+      # @since eos_version 4.13.7M
       #
-      # @commands
+      # ===Commands
       #   interface <name>
       #     no switchport
       #
-      # @param [String] :name The full interface name of the port to create the
-      #   logical interface on.  The name must be the full interface
-      #   identifier
+      # @param name [String] The full interface name of the port to create the
+      #   logical interface on. The name must be the full interface
+      #   identifier.
       #
-      # @return [Boolean] returns true if the commands complete successfully
+      # @return [Boolean] Returns true if the commands complete successfully.
       def create(name)
         configure(["interface #{name}", 'no switchport'])
       end
 
       ##
       # delete will delete an existing IP interface in the node's current
-      # configuration.  If the IP interface does not exist on the specified
-      # interface, this method will still return success.  This command will
+      # configuration. If the IP interface does not exist on the specified
+      # interface, this method will still return success. This command will
       # default the interface back to being a switchport.
       #
-      # @eos_version 4.13.7M
+      # @since eos_version 4.13.7M
       #
-      # @commands
+      # ===Commands
       #   interface <name>
       #     no ip address
       #     switchport
       #
-      # @param [String] :name The full interface name of the port to delete the
-      #   logical interface from.  The name must be the full interface name
+      # @param name [String] The full interface name of the port to delete the
+      #   logical interface from. The name must be the full interface name
       #
-      # @return [Boolean] returns true if the commands complete successfully
+      # @return [Boolean] Returns true if the commands complete successfully.
       def delete(name)
         configure(["interface #{name}", 'no ip address', 'switchport'])
       end
 
       ##
       # set_address configures a logical IP interface with an address.
-      # The address value must be in the form of A.B.C.D/E.  If the enable
+      # The address value must be in the form of A.B.C.D/E. If the enable
       # keyword is false, then the interface address is negated using the
-      # config no keyword.  If the default option is set to true, then the
-      # ip address # value is defaulted using the default keyword.  The
+      # config no keyword. If the default option is set to true, then the
+      # ip address # value is defaulted using the default keyword. The
       # default keyword has precedence over the enable keyword if both
-      # options are specified
+      # options are specified.
       #
-      # @eos_version 4.13.7M
+      # @since eos_version 4.13.7M
       #
-      # @commands
+      # ===Commands
       #   interface <name>
       #     ip address <value>
       #     no ip address
       #     default ip address
       #
-      # @param [String] :name The name of the interface to configure the
-      #   address in the node.  The name must be the full interface name.
+      # @param name [String] The name of the interface to configure the
+      #   address in the node. The name must be the full interface name.
       #
-      # @param [Hash] :opts Optional keyword arguments
+      # @param opts [Hash] Optional keyword arguments.
       #
-      # @option :opts [String] :value The value to configure the address to
-      #   for the specified interface name.  The value must be in the form
-      #   of A.B.C.D/E
+      # @option opts value [String] The value to configure the address to
+      #   for the specified interface name. The value must be in the form
+      #   of A.B.C.D/E.
       #
-      # @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 address value using
-      #   the default keyword
+      # @option opts default [Boolean] Configure the ip address value using
+      #   the default keyword.
       #
-      # @return [Boolean] returns true if the command completed successfully
+      # @return [Boolean] Returns True if the command completed successfully.
       def set_address(name, opts = {})
         cmds = command_builder('ip address', opts)
         configure_interface(name, cmds)
@@ -244,36 +244,36 @@ module Rbeapi
 
       ##
       # set_mtu configures the IP mtu value of the ip interface in the nodes
-      # configuration.  If the enable option is false, then the ip mtu value is
-      # configured using the no keyword.  If the default keyword option is
+      # configuration. If the enable option is false, then the ip mtu value is
+      # configured using the no keyword. If the default keyword option is
       # provided and set to true then the ip mtu value is configured using the
-      # default keyword.  The default keyword has precedence over the enable
+      # default keyword. The default keyword has precedence over the enable
       # keyword if both options are specified.
       #
-      # @eos_version 4.13.7M
+      # @since eos_version 4.13.7M
       #
-      # @commands
+      # ===Commands
       #   interface <name>
       #     mtu <value>
       #     no mtu
       #     default mtu
       #
-      # @param [String] :name The name of the interface to configure the
-      #   address in the node.  The name must be the full interface name.
+      # @param name [String] The name of the interface to configure the
+      #   address in the node. The name must be the full interface name.
       #
-      # @param [Hash] :opts Optional keyword arguments
+      # @param opts [Hash] Optional keyword arguments.
       #
-      # @option :opts [String] :value The value to configure the IP MTU to in
-      #   the nodes configuration.  Valid values are in the range of 68 to 9214
-      #   bytes.  The default is 1500 bytes
+      # @option opts value [String] The value to configure the IP MTU to in
+      #   the nodes configuration. Valid values are in the range of 68 to 9214
+      #   bytes. The default is 1500 bytes.
       #
-      # @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 mtu value using
-      #   the default keyword
+      # @option opts default [Boolean] Configure the ip mtu value using
+      #   the default keyword.
       #
-      # @return [Boolean] returns true if the command completed successfully
+      # @return [Boolean] Returns true if the command completed successfully.
       def set_mtu(name, opts = {})
         cmds = command_builder('mtu', opts)
         configure_interface(name, cmds)
@@ -281,31 +281,31 @@ module Rbeapi
 
       ##
       # set_helper_addresses configures the list of helper addresses on the ip
-      # interface.  An IP interface can have one or more helper addresses
-      # configured.  If no value is provided, the helper address configuration
-      # is set using the no keyword.  If the default option is specified and
+      # interface. An IP interface can have one or more helper addresses
+      # configured. If no value is provided, the helper address configuration
+      # is set using the no keyword. If the default option is specified and
       # set to true, then the helper address values are defaulted using the
       # default keyword.
       #
-      # @eos_version 4.13.7M
+      # @since eos_version 4.13.7M
       #
-      # @commands
+      # ===Commands
       #   interface <name>
       #     ip helper-address <value>
       #     no ip helper-address
       #     default ip helper-address
       #
-      # @param [String] :name The name of the interface to configure the
-      #   address in the node.  The name must be the full interface name.
+      # @param name [String] The name of the interface to configure the
+      #   address in the node. The name must be the full interface name.
       #
-      # @param [Hash] :opts Optional keyword arguments
+      # @param opts [Hash] Optional keyword arguments.
       #
-      # @option :opts [Array] :value The list of IP addresses to configure as
-      #   helper address on the interface.  The helper addresses must be valid
+      # @option opts value [Array] The list of IP addresses to configure as
+      #   helper address on the interface. The helper addresses must be valid
       #   addresses in the main interface's subnet.
       #
-      # @option :opts [Boolean] :default Configure the ip helper address values
-      #    using the default keyword
+      # @option opts default [Boolean] Configure the ip helper address values
+      #    using the default keyword.
       #
       def set_helper_addresses(name, opts = {})
         value = opts[:value]

data/lib/rbeapi/api/logging.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 Logging class manages logging settings on an EOS node.
@@ -50,8 +50,8 @@ module Rbeapi
       #     hosts: array<strings>
       #   }
       #
-      # @return [Hash<Symbol, Object>] returns the logging resource as a hash
-      #   object from the nodes current configuration
+      # @return [Hash<Symbol, Object>] Returns the logging resource as a hash
+      #   object from the nodes current configuration.
       def get
         response = {}
         response.merge!(parse_enable)
@@ -61,14 +61,14 @@ module Rbeapi
 
       ##
       # parse_enable scans the nodes current running configuration and extracts
-      # the current enabled state of the logging facility.  The logging enable
-      # command is expected to always be in the node's configuration.  This
+      # the current enabled state of the logging facility. The logging enable
+      # 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
+      # @return [Hash<Symbol, Object>] Returns the resource hash attribute.
       def parse_enable
         value = /no logging on/ !~ config
         { enable: value }
@@ -76,14 +76,14 @@ module Rbeapi
 
       ##
       # parse_hosts scans the nodes current running configuration and extracts
-      # the configured logging host destinations if any are configured.  If no
+      # the configured logging host destinations if any are configured. If no
       # 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
+      # array. The return value is intended to be merged into the logging
       # resource hash
       #
       # @api private
       #
-      # @return [Hash<Symbol, Object>] resource hash attribute
+      # @return [Hash<Symbol, Object>] Returns the resource hash attribute.
       def parse_hosts
         hosts = config.scan(/(?<=^logging\shost\s)[^\s]+/)
         { hosts: hosts }
@@ -92,28 +92,28 @@ module Rbeapi
 
       ##
       # set_enable configures the global logging instance on the node as either
-      # enabled or disabled.  If the enable keyword is set to true then logging
-      # is globally enabled and if set to false, it is globally disabled.  If
+      # enabled or disabled. If the enable keyword is set to true then logging
+      # is globally enabled and if set to false, it is globally disabled. If
       # the default keyword is specified and set to true, then the configuration
-      # is defaulted using the default keyword.  The default keyword option
+      # is defaulted using the default keyword. The default keyword option
       # takes precedence over the enable keyword if both options are specified.
       #
-      # @eos_version 4.13.7M
+      # @since eos_version 4.13.7M
       #
-      # @commands
+      # ===Commands
       #   logging on
       #   no logging on
       #   default logging on
       #
-      # @param [Hash] :opts Optional keyword arguments
+      # @param opts [Hash] Optional keyword arguments
       #
-      # @option :opts [Boolean] :enable Enables logging globally if value is
-      #   true or disabled logging globally if value is false
+      # @option opts enable [Boolean] Enables logging globally if value is
+      #   true or disabled logging globally if value is false.
       #
-      # @option :opts [Boolean] :default Configure the ip address value using
-      #   the default keyword
+      # @option opts default [Boolean] Configure the ip address value using
+      #   the default keyword.
       #
-      # @return [Boolean] returns true if the command completed successfully
+      # @return [Boolean] Returns true if the command completed successfully.
       def set_enable(opts = {})
         cmd = command_builder('logging on', opts)
         configure cmd
@@ -121,36 +121,36 @@ module Rbeapi
 
       ##
       # add_host configures a new logging destination host address or hostname
-      # to the list of logging destinations.  If the host is already configured
+      # to the list of logging destinations. If the host is already configured
       # in the list of destinations, this method will return successfully.
       #
-      # @eos_version 4.13.7M
+      # @since eos_version 4.13.7M
       #
-      # @commands
+      # ===Commands
       #   logging host <name>
       #
-      # @param [String] :name The host name or ip address of the destination
+      # @param name [String] The host name or ip address of the destination
       #   node to send logging information to.
       #
-      # @return [Boolean] returns true if the command completed successfully
+      # @return [Boolean] Returns true if the command completed successfully.
       def add_host(name)
         configure "logging host #{name}"
       end
 
       ##
       # remove_host deletes a logging destination host name or address form the
-      # list of logging destinations.   If the host is not in the list of
+      # list of logging destinations.  If the host is not in the list of
       # configured hosts, this method will still return successfully.
       #
-      # @eos_version 4.13.7M
+      # @since eos_version 4.13.7M
       #
-      # @commands
+      # ===Commands
       #   no logging host <name>
       #
-      # @param [String] :name The host name or ip address of the destination
-      #   host to remove from the nodes current configuration
+      # @param name [String] The host name or ip address of the destination
+      #   host to remove from the nodes current configuration.
       #
-      # @return [Boolean] returns true if the commands completed successfully
+      # @return [Boolean] Returns true if the commands completed successfully.
       def remove_host(name)
         configure "no logging host #{name}"
       end