rbeapi 0.5.0 → 0.5.1

data/lib/rbeapi/api/varp.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 Varp class provides an instance for working with the global
-    # VARP configuration of the node
+    # VARP configuration of the node.
     class Varp < Entity
       ##
-      # Returns the global VARP configuration from the node
+      # Returns the global VARP configuration from the node.
       #
       # @example
       #   {
@@ -58,7 +58,7 @@ module Rbeapi
       #     }
       #   }
       #
-      # @return [Hash]  A Ruby hash object that provides the Varp settings as
+      # @return [Hash] A Ruby hash object that provides the Varp settings as
       #   key / value pairs.
       def get
         response = {}
@@ -68,17 +68,17 @@ module Rbeapi
       end
 
       ##
-      # parse_mac_address parses mac-address values from the provided config
+      # parse_mac_address parses mac-address values from the provided config.
       #
       # @api private
       #
-      # @param [String] :config The configuration block returned
-      #   from the node's running configuration
+      # @param config [String] The 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_mac_address(config)
         # ip virtual-router mac-address value will always
-        #   be stored in aa:bb:cc:dd:ee:ff format
+        #   be stored in aa:bb:cc:dd:ee:ff format.
         regex = /mac-address ((?:[a-f0-9]{2}:){5}[a-f0-9]{2})$/
         mdata = regex.match(config)
         { mac_address: mdata.nil? ? '' : mdata[1] }
@@ -92,15 +92,18 @@ module Rbeapi
       end
 
       ##
-      # Configure the VARP virtual-router mac-address value
+      # Configure the VARP virtual-router mac-address value.
       #
-      # @param [Hash] opts The configuration parameters
-      # @option opts [string] :value The value to set the mac-address to
-      # @option opts [Boolean] :enable If false then the command is
+      # @param opts [Hash] The configuration parameters.
+      #
+      # @option opts value [string] The value to set the mac-address to.
+      #
+      # @option opts enable [Boolean] If false then the command is
       #   negated. Default is true.
-      # @option opts [Boolean] :default The value should be set to default
       #
-      # @return [Boolean] returns true if the command completed successfully
+      # @option opts default [Boolean] The value should be set to default.
+      #
+      # @return [Boolean] Returns true if the command completed successfully.
       def set_mac_address(opts = {})
         cmd = command_builder('ip virtual-router mac-address', opts)
         configure(cmd)
@@ -109,21 +112,21 @@ module Rbeapi
 
     ##
     # The VarpInterfaces class provides an instance for working with the global
-    # VARP interface configuration of the node
+    # VARP interface configuration of the node.
     class VarpInterfaces < Entity
       ##
-      # Returns a single VARP interface configuration
+      # Returns a single VARP interface configuration.
       #
       # @example
       #   {
       #     "addresses": array<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
-      #   VARP interface configuration.  A nil object is returned if the
+      #   VARP interface configuration. A nil object is returned if the
       #   specified interface is not configured
       def get(name)
         config = get_block("^interface #{name}")
@@ -134,7 +137,7 @@ module Rbeapi
 
       ##
       # Returns the collection of MLAG interfaces as a hash index by the
-      # interface name
+      # interface name.
       #
       # @example
       #   {
@@ -148,7 +151,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)(Vl.+)$/)
@@ -162,14 +165,14 @@ module Rbeapi
 
       ##
       # parse_addresses parses ip virtual-router address from the provided
-      #   config
+      #   config.
       #
       # @api private
       #
-      # @param [String] :config The configuration block returned
-      #   from the node's running configuration
+      # @param config [String] The 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_addresses(config)
         addrs = config.scan(/(?<=\s{3}ip\svirtual-router\saddress\s).+$/)
         { addresses: addrs }
@@ -181,17 +184,21 @@ module Rbeapi
       # to the specified VLAN interface. All existing addresses are
       # removed before the ones in value are added.
       #
-      # @param [String] :name The name of the interface.  The
-      #   name argument must be the full interface name.  Valid interfaces
-      #   are restricted to VLAN interfaces
-      # @param [Hash] opts The configuration parameters
-      # @option opts [Array] :value Array of IPv4 addresses to add to
+      # @param name [String] The name of the interface. The
+      #   name argument must be the full interface name. Valid interfaces
+      #   are restricted to VLAN interfaces.
+      #
+      # @param opts [Hash] The configuration parameters.
+      #
+      # @option opts value [Array] Array of IPv4 addresses to add to
       #   the virtual router.
-      # @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 The value should be set to default
       #
-      # @return [Boolean] True if the commands succeeds otherwise False
+      # @option opts default [Boolean] The value should be set to default.
+      #
+      # @return [Boolean] True if the commands succeeds otherwise False.
       def set_addresses(name, opts = {})
         value = opts[:value]
         enable = opts.fetch(:enable, true)
@@ -215,27 +222,29 @@ module Rbeapi
       end
 
       ##
-      # The add_address method assigns one virtual IPv4 address
+      # The add_address method assigns one virtual IPv4 address.
       #
-      # @param [String] :name The name of the interface.  The
-      #   name argument must be the full interface name.  Valid interfaces
-      #   are restricted to VLAN interfaces
-      # @param [string] :address The virtual router address to add
+      # @param name [String] The name of the interface. The
+      #   name argument must be the full interface name. Valid interfaces
+      #   are restricted to VLAN interfaces.
       #
-      # @return [Boolean] True if the commands succeeds otherwise False
+      # @param value [string] The virtual router address to add.
+      #
+      # @return [Boolean] True if the commands succeeds otherwise False.
       def add_address(name, value)
         configure(["interface #{name}", "ip virtual-router address #{value}"])
       end
 
       ##
-      # The remove_address method removes one virtual IPv4 address
+      # The remove_address method removes one virtual IPv4 address.
+      #
+      # @param name [String] The name of the interface. The
+      #   name argument must be the full interface name. Valid interfaces
+      #   are restricted to VLAN interfaces.
       #
-      # @param [String] :name The name of the interface.  The
-      #   name argument must be the full interface name.  Valid interfaces
-      #   are restricted to VLAN interfaces
-      # @param [string] :address The virtual router address to remove
+      # @param value [string] The virtual router address to remove.
       #
-      # @return [Boolean] True if the commands succeeds otherwise False
+      # @return [Boolean] True if the commands succeeds otherwise False.
       def remove_address(name, value)
         configure(["interface #{name}",
                    "no ip virtual-router address #{value}"])

data/lib/rbeapi/api/vlans.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 Vlan class provides a class implementation for working with the
-    # collection of Vlans on the node.  This class presents an abstraction
+    # collection of Vlans on the node. This class presents an abstraction
     # of the nodes configured vlan id's from the running configuration.
     #
-    # @eos_version 4.13.7M
+    # @since eos_version 4.13.7M
     class Vlans < Entity
       ##
       # get returns the specified vlan resource Hash that represents the
@@ -55,12 +55,12 @@ module Rbeapi
       #     trunk_groups: array[<string]
       #   }
       #
-      # @param [String] :id The vlan id to return a resource for from the
-      #   nodes configuration
+      # @param id [String] The vlan id to return a resource for from the
+      #   nodes configuration.
       #
       # @return [nil, Hash<Symbol, Object>] Returns the vlan resource as a
-      #   Hash.  If the specified vlan id is not found in the nodes current
-      #   configuration a nil object is returned
+      #   Hash. If the specified vlan id is not found in the nodes current
+      #   configuration a nil object is returned.
       def get(id)
         config = get_block("vlan #{id}")
         return nil unless config
@@ -73,8 +73,8 @@ module Rbeapi
 
       ##
       # getall returns the collection of vlan resources from the nodes
-      # running configuration as a hash.  The vlan resource collection
-      # hash is keyed by the unique vlan id
+      # running configuration as a hash. The vlan resource collection
+      # hash is keyed by the unique vlan id.
       #
       # @example
       #   {
@@ -93,10 +93,10 @@ module Rbeapi
       #
       # @see get Vlan resource example
       #
-      # @return [Hash<Symbol, Object>] returns a hash that represents the
-      #   entire vlan collection from the nodes running configuration.  If
+      # @return [Hash<Symbol, Object>] Returns a hash that represents the
+      #   entire vlan collection from the nodes running configuration. If
       #   there are no vlans configured, this method will return an empty
-      #   hash
+      #   hash.
       def getall
         vlans = config.scan(/(?<=^vlan\s)\d+$/)
         vlans.each_with_object({}) do |vid, hsh|
@@ -107,13 +107,13 @@ module Rbeapi
 
       ##
       # parse_name scans the provided configuration block and parses the
-      # vlan name value.  The vlan name should always return a value
-      # from the running configuration.  The return value is intended to
-      # be merged into the resource hash
+      # vlan name value. The vlan name should always return a value
+      # from the running configuration. The return value is intended to
+      # be merged into the resource hash.
       #
       # @api private
       #
-      # @return [Hash<Symbol, Object>] resource hash attribute
+      # @return [Hash<Symbol, Object>] Returns the resource hash attribute.
       def parse_name(config)
         mdata = /name ([^\s]+)$/.match(config)
         { name: mdata[1] }
@@ -123,12 +123,12 @@ module Rbeapi
       ##
       # parse_state scans the provided configuration block and parses the
       # vlan state value. The vlan state should always return a value from
-      # the nodes running configuration.  The return hash is intended to be
-      # merged into the resource hash
+      # the nodes running configuration. The return hash is intended to be
+      # merged into the resource hash.
       #
       # @api private
       #
-      # @return [Hash<Symbol, Object>] resource hash attribute
+      # @return [Hash<Symbol, Object>] Returns the resource hash attribute.
       def parse_state(config)
         mdata = /state (\w+)$/.match(config)
         { state: mdata[1] }
@@ -137,15 +137,15 @@ module Rbeapi
 
       ##
       # parse_trunk_groups scans the provided configuration block and parses
-      # the trunk groups.  If no trunk groups are found in the nodes
+      # the trunk groups. If no trunk groups are found in the nodes
       # running configuration then an empty array is returned as the value.
       # The return hash is intended to be merged into the resource hash.
       #
       # @api private
       #
-      # @return [Hash<Symbol, Object>] resource hash attribute
+      # @return [Hash<Symbol, Object>] Returns the resource hash attribute.
       def parse_trunk_groups(config)
-        values = config.scan(/trunk group (.+)$/).first
+        values = config.scan(/trunk group (.+)$/).flatten
         values = [] unless values
         { trunk_groups: values }
       end
@@ -153,92 +153,92 @@ module Rbeapi
 
       ##
       # create will create a new vlan resource in the nodes current
-      # configuration with the specified vlan id.  If the create method
+      # configuration with the specified vlan id. If the create method
       # is called and the vlan id already exists, this method will still
       # return true.
       #
-      # @eos_version 4.13.7M
+      # @since eos_version 4.13.7M
       #
-      # @commands
+      # ===Commands
       #   vlan <value>
       #
-      # @param [String, Integer] :id The vlan id to create on the node.  The
-      #   vlan id must be in the valid range of 1 to 4094
+      # @param id [String, Integer] The vlan id to create on the node. The
+      #   vlan id must be in the valid range of 1 to 4094.
       #
-      # @return [Boolean] returns true if the command completed successfully
+      # @return [Boolean] Returns true if the command completed successfully.
       def create(id)
         configure("vlan #{id}")
       end
 
       ##
       # delete will delete an existing vlan resource from the nodes current
-      # running configuration.  If the delete method is called and the vlan
+      # running configuration. If the delete method is called and the vlan
       # id does not exist, this method will succeed.
       #
-      # @eos_version 4.13.7M
+      # @since eos_version 4.13.7M
       #
-      # @commands
+      # ===Commands
       #   no vlan <value>
       #
-      # @param [String, Integer] :id The vlan id to delete from the node.  The
-      #   id value should be in the valid range of 1 to 4094
+      # @param id [String, Integer] The vlan id to delete from the node. The
+      #   id value should be in the valid range of 1 to 4094.
       #
-      # @return [Boolean] returns true if the command completed successfully
+      # @return [Boolean] Returns true if the command completed successfully.
       def delete(id)
         configure("no vlan #{id}")
       end
 
       ##
-      # default will configure the vlan using the default keyword.  This
+      # default will configure the vlan using the default keyword. This
       # command has the same effect as deleting the vlan from the nodes
       # running configuration.
       #
-      # @eos_version 4.13.7M
+      # @since eos_version 4.13.7M
       #
-      # @commands
+      # ===Commands
       #   default vlan <value>
       #
-      # @param [String, Integer] :id The vlan id to default in the nodes
-      #   configuration.  Ths vid value should be in the valid range of 1
-      #   to 4094
+      # @param id [String, Integer] The vlan id to default in the nodes
+      #   configuration. Ths vid value should be in the valid range of 1
+      #   to 4094.
       #
-      # @return [Boolean] returns true if the command complete successfully
+      # @return [Boolean] Returns true if the command complete successfully.
       def default(id)
         configure("default vlan #{id}")
       end
 
       ##
       # set_name configures the name value for the specified vlan id in the
-      # nodes running configuration.  If enable is false in the
+      # nodes running configuration. If enable is false in the
       # opts keyword Hash then the name value is negated using the no
-      # keyword.  If the default keyword is set to true, then the name value
-      # is defaulted using the default keyword.  The default keyword takes
-      # precedence over the enable keyword
+      # keyword. If the default keyword is set to true, then the name value
+      # is defaulted using the default keyword. The default keyword takes
+      # precedence over the enable keyword.
       #
-      # @eos_version 4.13.7M
+      # @since eos_version 4.13.7M
       #
-      # @commands
+      # ===Commands
       #   vlan <id>
       #     name <value>
       #     no name
       #     default name
       #
-      # @param [String, Integer] :id The vlan id to apply the configuration
-      #   to.  The id value should be in the valid range of 1 to 4094
+      # @param id [String, Integer] The vlan id to apply the configuration
+      #   to. The id value should be in the valid range of 1 to 4094.
       #
-      # @param [Hash] :opts Optional keyword arguments
+      # @param opts [Hash] Optional keyword arguments.
       #
-      # @option :opts [String] :value The value to configure the vlan name
-      #   to in the node configuration.  The name parameter accepts a-z, 0-9
+      # @option opts value [String] The value to configure the vlan name
+      #   to in the node configuration. The name parameter accepts a-z, 0-9
       #   and _.
       #
-      # @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 vlan name value using
-      #   the default keyword
+      # @option opts default [Boolean] Configure the vlan name 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_name(id, opts = {})
         cmd = command_builder('name', opts)
         cmds = ["vlan #{id}", cmd]
@@ -247,39 +247,39 @@ module Rbeapi
 
       ##
       # set_state configures the state value for the specified vlan id in
-      # the nodes running configuration.  If enable is set to false in
+      # the nodes running configuration. If enable is set to false in
       # the opts keyword Hash then the state value is negated using the no
       # keyword.  If the default keyword is set to true, then the state
-      # value is defaulted using the default keyword.  The default keyword
+      # value is defaulted using the default keyword. The default keyword
       # takes precedence over the enable keyword
       #
-      # @eos_version 4.13.7M
+      # @since eos_version 4.13.7M
       #
-      # @commands
+      # ===Commands
       #   vlan <id>
       #     state [active, suspend]
       #     no state
       #     default state
       #
-      # @param [String, Integer] :id The vlan id to apply the configuration
-      #   to.  The id value should be in the valid range of 1 to 4094
+      # @param id [String, Integer] The vlan id to apply the configuration
+      #   to. The id value should be in the valid range of 1 to 4094.
       #
-      # @param [Hash] :opts Optional keyword arguments
+      # @param opts [Hash] Optional keyword arguments.
       #
-      # @option :opts [String] :value The value to configure the vlan state
-      #   to in the node's configuration.  Accepted values are 'active' or
-      #   'suspend'
+      # @option opts value [String] The value to configure the vlan state
+      #   to in the node's configuration. Accepted values are 'active' or
+      #   'suspend'.
       #
-      # @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 vlan state value using
-      #   the default keyword
+      # @option opts default [Boolean] Configure the vlan state value using
+      #   the default keyword.
       #
-      # @return [Boolean] returns true if the command completed successfully
+      # @return [Boolean] Returns true if the command completed successfully.
       #
       # @raise [ArgumentError] if the value is not in the accept list of
-      #   values
+      #   values.
       def set_state(id, opts = {})
         value = opts[:value]
         unless ['active', 'suspend', nil].include?(value)
@@ -294,41 +294,41 @@ module Rbeapi
       ##
       # add_trunk_group adds a new trunk group value to the specified vlan
       # id in the nodes running configuration.  The trunk group name value
-      # accepts a-z 0-9 and _
+      # accepts a-z 0-9 and _.
       #
-      # @version 4.13.7M
+      # @since version 4.13.7M
       #
-      # @commands
+      # ===Commands
       #   vlan <id>
       #     trunk group <value>
       #
-      # @param [String, Integer] :id The vlan id to apply the configuration
-      #   to.  the id value should be in the range of 1 to 4094
+      # @param id [String, Integer] The vlan id to apply the configuration
+      #   to. the id value should be in the range of 1 to 4094
       #
-      # @param [String] :value The value to add to the vlan id configuration
+      # @param value [String] The value to add to the vlan id configuration
       #   on the node.
       #
-      # @return [Boolean] returns true if the command completed successfully
+      # @return [Boolean] Returns true if the command completed successfully.
       def add_trunk_group(id, value)
         configure(["vlan #{id}", "trunk group #{value}"])
       end
 
       ##
       # remove_trunk_group removes the specified trunk group value from the
-      # specified vlan id in the node's configuration.  If the trunk group
+      # specified vlan id in the node's configuration. If the trunk group
       # name does not exist, this method will return success
       #
-      # @eos_version 4.13.7M
+      # @since eos_version 4.13.7M
       #
-      # @commands
+      # ===Commands
       #   vlan <id>
       #     no trunk group <value>
       #
-      # @param [String, Integer] :id The vlan id to apply the configuration
-      #   to.  the id value should be in the range of 1 to 4094
+      # @param id [String, Integer] The vlan id to apply the configuration
+      #   to.  the id value should be in the range of 1 to 4094.
       #
-      # @param [String] :value The value to remove from the list of trunk
-      #   group names configured for the specified vlan
+      # @param value [String] The value to remove from the list of trunk
+      #   group names configured for the specified vlan.
       #
       def remove_trunk_group(id, value)
         configure(["vlan #{id}", "no trunk group #{value}"])