aviz-sonic-rbapi 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 933b03c781d2e73cddd22210463b9a1b8164c60384656c64d5c770d8dea46e8f
+  data.tar.gz: 51b8700bfa1fd2dfa53290239b34c044f4162ede4148da8795558ccc52955185
+SHA512:
+  metadata.gz: 7309fbbf5c4760038c52117526f4236daa92522b7de6a041670ccd21a33c60ffb3b42184a3eba9410610fb38fe50ab4d7b6497adb0e2f778a88602c9d95af6c8
+  data.tar.gz: 7226798b8350612dbaafb5ddecb80c883635dade13a031c5344779cc7ce570dc21e9111a2510be6c5c5f6b64392c774a207dc86f82ae38108b1533f498f09a58

data/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2019, Aviz Networks
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,68 @@
+# Aviz Networks AIMS SONIC Ruby API Library
+
+## Overview
+The Ruby Client for Azure SONIC REST API provides a native Ruby implementation for programming
+Aviz Networks SONIC network devices using AIMS. The Ruby client provides the ability to
+build native applications in Ruby that can communicate with SONIC remotely over 
+a HTTP transport protocol.
+
+The Ruby API implemenation also provides an API layer for building native Ruby
+objects that allow for configuration and management of Aviz Networks SONIC switches using AIMS.
+
+## Requirements
+* Aviz Networks SONIC switches
+* Ruby 2.2.3 or later
+
+## SONIC Ruby APIs
+The SONIC Ruby Client was designed to be easy to use and develop plugins or tools
+that interface with the Aviz Networks SONIC switches.
+
+### Using the API
+See the below example for using the API. Also refer test/ directory for more details.
+
+#### Switch Configuration file
+This configuration file is used to define the configuration options or model for switches (switch.yml or any xxx.yml)
+
+```yaml
+protocol : 'http' # protocol (HTTP)
+port : '8090' # HTTP(s) port number (8090 - HTTP)
+ip : 'switch ip address' # Switch IP address
+user : 'username'  # Switch Credentials
+password : 'password' #switch credentials 
+```
+
+#### Creating connection and sending configurations
+Below demonstrates a basic connection using the API. For more examples please see the examples folder
+
+```ruby
+#### import the libraries
+require 'sonic-rbapi/connect'
+require 'sonic-rbapi/vlan'
+
+##### create connection to the node using the configuration file
+conn = Connect.new(param) 
+
+where param is a dictionary formed either from the config file or hardcoded 
+with the following key value pairs 
+
+protocol => 'http' # protocol (HTTP) 
+port => '8090' # HTTP(s) port number (8090 - HTTP)
+ip => 'switch ip address' # Switch IP address 
+user => 'username' #Switch Credentials
+password => 'password' #Switch Credentials
+  
+##### Use VLAN APIs to retrieve all VLAN information
+Vlan.get_all_vlan(conn)
+
+##### Use VLAN APIs to create VLANs
+vlan_id = 10
+dhcp_servers =  ["10.10.10.1", "10.10.10.2"]
+resp = Vlan.create_vlan(conn, vlan_id, dhcp_servers)
+
+##### Use VLAN APIs to retrieve specific VLAN information
+resp = Vlan.get_vlan(conn, 20)
+
+##### Use VLAN APIs to delete VLANs
+Vlan.delete_vlan(conn, 20)
+```
+

data/doc_script

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+# Run the script to generate yard doc
+gem install yard
+yard doc 'lib/*/*.rb' - README.md LICENSE

data/lib/sonic-rbapi.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+##
+### Copyright (c) 2019, Aviz Networks. All rights reserved.
+###
+### This program and the accompanying materials are licensed and made available
+### under the terms and conditions of the 3-clause BSD License that accompanies
+### this distribution.
+###
+### The full text of the license may be found at
+###
+### https://opensource.org/licenses/BSD-3-Clause
+###
+### THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+### WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+###
+#
+require_relative 'sonic-rbapi/connect.rb'

data/lib/sonic-rbapi/bgp.rb

@@ -0,0 +1,152 @@
+#!/usr/bin/env ruby
+# Copyright (c) 2019, Aviz Networks. All rights reserved.
+#
+# This program and the accompanying materials are licensed and made available
+# under the terms and conditions of the 3-clause BSD License that accompanies
+# this distribution.
+#
+# The full text of the license may be found at
+#
+# https://opensource.org/licenses/BSD-3-Clause
+#
+# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+require 'rest-client'
+require 'json'
+require_relative 'connect'
+require_relative 'rest_utils'
+
+# The Bgp class provides a class implementation and methods for managing BGP
+# on the node. This class presents an abstraction
+
+class Bgp
+        @bgp_cfg  = '/api/bgps/neighbors/cfgs'
+        @bgp_info  = '/api/bgps/neighbors/info'
+        @bgp_global = '/api/bgps/globals'
+        
+        # This API gets BGP information from the switch.
+        #
+        # Request URL: http://IP-ADDR:REST-PORT/api/bgps/neighbors/info/summary
+        #              http://IP-ADDR:REST-PORT/api/bgps/neighbors/info
+        #
+        # @param conn [Class] Connect object to the node
+        # @param filter [String] BGP info filter which holds the value "summary" or None
+        #
+        # @return [RestClient::Request] Rest output from SONIC in JSON format as below
+        #                               {
+        #                                   "192.168.10.2": {
+        #                                         "rxMsg": "6036",
+        #                                          "bgp_version": "4",
+        #                                          "txMsg": "6042",
+        #                                          "up_down_time": "01:57:08",
+        #                                          "outQ": "0",
+        #                                          "state_prefix": "Active",
+        #                                          "tblVer": "0",
+        #                                          "inQ": "0",
+        #                                          "peer_asn": "63100"
+        #                                    },
+        #                               }
+        def self.get_bgp_info(conn, filter=nil)
+          summary_filter = "summary"
+
+          if filter == summary_filter
+            url = form_url(conn, @bgp_info + '/' + summary_filter)
+          elsif filter == nil
+            url = form_url(conn, @bgp_info)
+          end
+          hdr = form_hdr(conn)
+          Rest.get(conn, url, hdr)
+        end
+
+        # This API updates the BGP global configuration on the switch.
+        #
+        # Request URL: http://IP-ADDR:REST-PORT/api/bgps/globals
+        #       payload format of key-value pairs
+        #            {
+        #             "default_bgp_status": "up",
+        #             "bgp_asn": 5000
+        #            }
+        #
+        # @param conn [Class] Connect object to the node
+        # @param bgp_status [String] Default BGP neighbor status. Valid Values: "up" or "down"
+        # @param bgp_asn [Integer] Default BGP AS number
+        #
+        # @return [RestClient::Request] Rest output from SONIC in JSON format
+        def self.update_bgp_global_config(conn, bgp_status='up', bgp_asn)
+          url = form_url(conn, @bgp_global)
+          hdr = form_hdr(conn)
+          params = {"default_bgp_status": bgp_status, "bgp_asn": bgp_asn}
+          params = params.to_json
+          Rest.put(conn, url, hdr, params)
+        end
+
+        # This API creates a new BGP neighbor on the switch.
+        #
+        # Request URL: http://IP-ADDR:REST-PORT/api/bgps/neighbors/cfgs/10.10.10.10
+        #       payload format of key-value pairs
+        #            {
+        #             "local_addr": local_ip,
+        #             "neighbor_addr": neighbor_ip,
+        #             "admin_status": status,
+        #             "asn": asn,
+        #             "holdtime": 180,
+        #             "keepalive": 60
+        #            }
+        #
+        # @param conn [Class] Connect object to the node
+        # @param neighbor_ip [String] BGP Neighbor IPv4 or IPv6 address
+        # @param local_addr [String] Local IPv4 or IPv6 address
+        # @param admin_status [String] admin status of the neighbor. Valid Values: "up" or "down"
+        # @param asn [Integer] BGP autonomous system number
+        # @param holdtime [Integer] holdtime timer
+        # @param keepalive [Integer] keep-alive timer
+        #
+        # @return [RestClient::Request] Rest output from SONIC in JSON format
+        def self.create_bgp_neighbor(conn, neighbor_ip, local_addr, admin_status='up', asn=0, holdtime=180, keepalive=60)
+          url = form_url(conn, @bgp_cfg + '/' + neighbor_ip)
+          hdr = form_hdr(conn)
+          params = {"local_addr": local_addr, "neighbor_addr": neighbor_ip, "admin_status": admin_status, "asn": asn, "holdtime": holdtime, "keepalive": keepalive}
+          params = params.to_json
+          Rest.put(conn, url, hdr, params)
+        end
+
+        # This API delete BGP neighbor on the switch.
+        #
+        # Request URL: http://IP-ADDR:REST-PORT/api/bgps/neighbors/cfgs/10.10.10.10
+        #
+        # @param conn [Class] Connect object to the node
+        # @param neighbor_ip [String] Neighbor peer address (IPv4 or IPv6)
+        #
+        # @return [RestClient::Request] Rest output from SONIC in JSON format
+        def self.delete_bgp_neighbor(conn, neighbor_ip)
+          url = form_url(conn, @bgp_cfg + '/' + neighbor_ip)
+          hdr = form_hdr(conn)
+          Rest.delete(conn, url, hdr)
+        end
+
+        # This API gets all BGP neighbors
+        #
+        # Request URL: http://IP-ADDR:REST-PORT/api/bgps/neighbors/cfgs
+        #
+        # @param conn [Class] Connect object to the node
+        #
+        # @return [RestClient::Request] Rest output from SONIC in JSON format as below
+        #                    {
+        #                      "10.0.0.19": {
+        #                         "asn": "65200",
+        #                         "keepalive": "60",
+        #                         "rrclient": "0",
+        #                         "holdtime": "180",
+        #                         "name": "AVI10T2",
+        #                         "local_addr": "10.0.0.18",
+        #                         "nhopself": "0"
+        #                        },
+        #                      ...
+        #                    }
+        def self.get_all_bgp_neighbors(conn)
+          url = form_url(conn, @bgp_cfg)
+          hdr = form_hdr(conn)
+          Rest.get(conn, url, hdr)
+        end
+end
+

data/lib/sonic-rbapi/config.rb

@@ -0,0 +1,113 @@
+#!/usr/bin/env ruby
+# Copyright (c) 2019, Aviz Networks. All rights reserved.
+#
+# This program and the accompanying materials are licensed and made available
+# under the terms and conditions of the 3-clause BSD License that accompanies
+# this distribution.
+#
+# The full text of the license may be found at
+#
+# https://opensource.org/licenses/BSD-3-Clause
+#
+# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+require 'rest-client'
+require 'json'
+require_relative 'connect'
+require_relative 'rest_utils'
+
+# The Config class provides a class implementation and methods for managing the configs
+# on the node. This class presents an abstraction
+
+class Config
+        @config_cfg  = '/api/configs'
+
+        # This API gets the switch configuration.
+        #
+        # Request URL: http://IP-ADDR:REST-PORT/api/configs?cfgblk=running
+        #
+        # @param conn [Class] Connect object to the node
+        # @param cfgblk [String] Configuration blocks. Valid values are "running" and "bootup"
+        #
+        # @return [RestClient::Request] Rest output from SONIC in JSON format as below
+        #                               {
+        #                                     "PORTCHANNEL": {
+        #                                         "PortChannel200": {
+        #                                             "mtu": "9100",
+        #                                             "admin_status": "up",
+        #                                             "fallback": "true",
+        #                                             "min_links": "2"
+        #                                         }
+        #                                     },
+        #                                     "INTERFACE": {
+        #                                         "Ethernet4|4.4.4.1/24": {},
+        #                                         "Ethernet8|10.0.0.4/31": {}
+        #                                     },
+        #                                     ...
+        #                               }
+        def self.get_switch_config(conn, cfgblk)
+          url = form_url(conn, @config_cfg + '?cfgblk=' + cfgblk)
+          hdr = form_hdr(conn)
+          Rest.get(conn, url, hdr)
+        end
+
+        # This API configure the switch actions related to configurations.
+        #
+        # Request URL: http://IP-ADDR:REST-PORT/api/configs
+        #       payload format of key-value pairs
+        #        {
+        #         "action": "config_save"
+        #         "protocol": "tftp"
+        #         "serverip": "",
+        #         "config_file": "",
+        #         "username": "",
+        #         "passwd": "”,
+        #         "port": <int>,
+        #        }
+        #
+        # @param conn [Class] Connect object to the node
+        # @param action [String] Configuration actions
+        #        Valid Values:
+        #          - "config_save" to save running configuration to bootup configuration file (default).
+        #          - "config_upload" Upload file from a server to startup configuration block.
+        #                            Server details can be obtained from the further parameters.
+        # @param protocol [String] Protocol to communicate which includes "tftp" or "scp" or "http"
+        # @param server_ip [String] Server ip address
+        # @param config_file [String] Configuration file
+        # @param username [String] Username to login the server
+        # @param password [String] Password for the server
+        # @param port [Integer] TCP port used by file transfer protocol
+        #
+        # @return [RestClient::Request] Rest output from SONIC in JSON format
+        def self.switch_config_action(conn, action="config_save", protocol=nil, server_ip=nil, config_file=nil, username=nil, password=nil, port=0)
+          url = form_url(conn, @config_cfg)
+          hdr = form_hdr(conn)
+          params = {"action": action}
+          if protocol != nil
+            p1 = {"protocol": protocol}
+            params = params.merge(p1)
+          end
+          if server_ip != nil
+            p1 = {"serverip": server_ip}
+            params = params.merge(p1)
+          end
+          if config_file != nil
+            p1 = {"config_file": config_file}
+            params = params.merge(p1)
+          end
+          if username != nil
+            p1 = {"username": username}
+            params = params.merge(p1)
+          end
+          if password != nil
+            p1 = {"passwd": password}
+            params = params.merge(p1)
+          end
+          if port != nil
+            p1 = {"port": port}
+            params = params.merge(p1)
+          end
+          params = params.to_json
+          Rest.post(conn, url, hdr, params)
+        end
+end

data/lib/sonic-rbapi/connect.rb

@@ -0,0 +1,98 @@
+#!/usr/bin/env ruby
+# Copyright (c) 2019, Aviz Networks. All rights reserved.
+#
+# This program and the accompanying materials are licensed and made available
+# under the terms and conditions of the 3-clause BSD License that accompanies
+# this distribution.
+#
+# The full text of the license may be found at
+#
+# https://opensource.org/licenses/BSD-3-Clause
+#
+# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+require 'rest-client'
+require 'yaml'
+
+def form_hdr(conn)
+  hdr = {}
+  hdr['Accept'] = 'application/json'
+  hdr['Content-type'] = 'application/json'
+  return hdr
+end
+
+def form_url(conn, url)
+  url = conn.getProtocol +  '://' + conn.getIpAddr + ':' + conn.getPort + url
+  return url
+end
+
+# The Connect class provides a class implementation and methods for establishing node connections and
+# initializations. This class presents an abstraction
+
+class Connect
+
+        # This function is used to initialise node paramters.
+        #
+        # @param params [Hash] Hash to hold the switch connection parameters
+        #
+        # @return None
+        def initialize(params)
+          @protocol = params['protocol']
+          @port      = params['port']
+          @ip_addr   = params['ip_addr']
+          @user      = params['user']
+          @password  = params['password']
+          if @protocol == 'http'
+            @url       = @protocol + '://' + @ip_addr + ':' + @port
+          end
+
+          # https is not supported
+          # Need to get certificate from user and form ssl connection for https
+
+          @hdr = {}
+          @hdr['Accept'] = 'application/json'
+          @hdr['Content-type'] = 'application/json'
+        end
+
+        # This API returns Protocol protocol for the current node connection.
+        #
+        # @return [String] Protocol protocol
+        def getProtocol()
+          return @protocol
+        end
+
+        # This API returns REST Port for the current node connection.
+        #
+        # @return [String] REST Port
+        def getPort()
+          return @port
+        end
+
+        # This API returns IP for the current node connection.
+        #
+        # @return [String] Node IP Address
+        def getIpAddr()
+          return @ip_addr
+        end
+
+        # This API returns User for the current node connection.
+        #
+        # @return [String] User name credentials
+        def getUser()
+          return @user
+        end
+
+        # This API returns Password for the current node connection.
+        #
+        # @return [String] Password credentials
+        def getPassword()
+          return @password
+        end
+
+        # This API returns Header Info for the current node connection.
+        #
+        # @return [String] REST Header
+        def getHdr()
+          return @hdr
+        end
+end