aviz-sonic-rbapi 0.0.0

data/lib/sonic-rbapi/portchnl.rb

@@ -0,0 +1,175 @@
+#!/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 Portchnl class provides a class implementation and methods for managing Portchannel
+# on the node. This class presents an abstraction
+
+class Portchnl
+        @portchnl_cfg  = '/api/portchnls/cfgs'
+        @portchnl_info  = '/api/portchnls/info'
+
+        # This API gets the portchannel information.
+        #
+        # Request URL: http://IP-ADDR:REST-PORT/api/portchnls/info/summary - Get PortChannel summary information
+        #              http://IP-ADDR:REST-PORT/api/portchnls/info/state - Get Portchannel state information
+        #
+        # @param conn [Class] Connect object to the node
+        # @param filter [String] String to get PortChannel summary or state
+        # @param pch_id [Integer] Portchannel Id
+        #
+        # @return [RestClient::Request] Rest output from SONIC in JSON format
+        #                    {
+        #                      "PortChannelName": {
+        #                        "admin_status": "up",
+        #                        "oper_status": "down",
+        #                        "mtu": "9100",
+        #                        "members": {
+        #                        ":Interface": {
+        #                        "status": "Active or Inactive or Up or Down"
+        #                        }
+        #                      }
+        #                    }
+        #                    {
+        #                      “Member Name1”:{
+        #                        "info": {
+        #                          "dev_addr": "mac",
+        #                          "ifindex": ,
+        #                        },
+        #                        "actor_lacpdu_info": {
+        #                          "key": ,
+        #                          "port":,
+        #                          "port_priority":,
+        #                          "state": 0,
+        #                          "system": "a4:8c:db:b9:c4:00",
+        #                          "system_priority": 65535
+        #                        },
+        #                        "partner_lacpdu_info": {
+        #                          "key": 0,
+        #                          "port": 0,
+        #                          "port_priority": 0,
+        #                          "state": 0,
+        #                          "system": "00:00:00:00:00:00",
+        #                          "system_priority": 0
+        #                        },
+        #                        "aggregator": {
+        #                          "id": 0,
+        #                          "selected": false
+        #                        },
+        #                      },
+        #                      “Member Name2”:{
+        #                      },
+        #                      ………..
+        #                    }
+        def self.get_portchnl_info(conn, filter, pch_id=nil)
+          if pch_id != nil
+            url = form_url(conn, @portchnl_info + '/' + filter + '/PortChannel' + pch_id.to_s)
+          else
+            url = form_url(conn, @portchnl_info + '/' + filter)
+          end
+          hdr = form_hdr(conn)
+          Rest.get(conn, url, hdr)
+        end
+
+        # This API creates a portchannel.
+        #
+        # Request URL: http://IP-ADDR:REST-PORT/api/portchnls/cfgs/10
+        #         payload format of key-value pairs
+        #         {
+        #          "admin_status": "up",
+        #          "mtu": 9100,
+        #          "fallback": true
+        #         }
+        #
+        # @param conn [Class] Connect object to the node
+        # @param pch_id [Integer] Portchannel id
+        # @param admin_status [String] Admin status of the port-channel. Valid values "up" or "down"
+        # @param mtu [Integer] Max transmission unit. Valid Values: 1500-9100
+        # @param fallback [Boolean] Fallback value "true" or "false"
+        #
+        # @return [RestClient::Request] Rest output from SONIC in JSON format
+        def self.create_portchnl(conn, pch_id, admin_status='up', mtu=9100, fallback='false')
+          url = form_url(conn, @portchnl_cfg + '/' + pch_id.to_s)
+          hdr = form_hdr(conn)
+          params = {"admin_status": admin_status, "mtu": mtu, "fallback": fallback}
+          params = params.to_json
+          Rest.post(conn, url, hdr, params)
+        end
+
+        # This API updates the properties of a particular portchannel.
+        #
+        # Request URL: http://IP-ADDR:REST-PORT/api/portchnls/cfgs/10
+        #         payload format of key-value pairs
+        #            {
+        #             "add_member": ["Ethernet0", "Ethernet4"],
+        #             "rem_member": ["Ethernet12"]
+        #            }
+        #
+        # @param conn [Class] Connect object to the node
+        # @param pch_id [Integer] Portchannel id
+        # @param add_members [Array] List of ports to be added to the portchnl
+        # @param rem_members [Array] List of ports to be removed from the portchnl
+        #
+        # @return [RestClient::Request] Rest output from SONIC in JSON format
+        def self.update_portchnl_members(conn, pch_id, add_members=nil, rem_members=nil)
+          url = form_url(conn, @portchnl_cfg + '/' + pch_id.to_s)
+          hdr = form_hdr(conn)
+          if add_members == nil || rem_members == nil
+            puts("update_portchnl_members: wrong paramers\n")
+          end
+          params = {"add_member": add_members}
+          p1 = {"rem_member": rem_members}
+          params = params.merge(p1)
+          params = params.to_json
+          Rest.put(conn, url, hdr, params)
+        end
+
+        # This API gets all the portchannel startup configuration.
+        #
+        # Request URL: http://IP-ADDR:REST-PORT/api/portchnls/cfgs
+        #
+        # @param conn [Class] Connect object to the node
+        #
+        # @return [RestClient::Request] Rest output from SONIC in JSON format as below
+        #                    {
+        #                      "PortChannel200": {
+        #                         "members": ["Ethernet8", "Ethernet32", "Ethernet16"],
+        #                         "mtu": "9100",
+        #                         "admin_status": "up",
+        #                         "fallback": "true",
+        #                      },
+        #                    }
+        def self.get_portchnl_cfg(conn)
+          url = form_url(conn, @portchnl_cfg)
+          hdr = form_hdr(conn)
+          Rest.get(conn, url, hdr)
+        end
+
+        # This API deletes specified portchannel.
+        #
+        # Request URL: http://IP-ADDR:REST-PORT/api/portchnls/cfgs/10
+        #
+        # @param conn [Class] Connect object to the node
+        # @param pch_id [Integer] Portchannel Id
+        #
+        # @return [RestClient::Request] Rest output from SONIC in JSON format
+        def self.delete_portchnl(conn, pch_id)
+          url = form_url(conn, @portchnl_cfg + '/' + pch_id.to_s)
+          hdr = form_hdr(conn)
+          Rest.delete(conn, url, hdr)
+        end
+end

data/lib/sonic-rbapi/rest_utils.rb

@@ -0,0 +1,134 @@
+#!/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'
+
+# The Rest class provides a class implementation and methods for executing REST methods such as GET, POST, PUT and DELETE
+# on the node. This class presents an abstraction
+
+class Rest
+
+        # This API performs REST GET request for the given url with switch credentials.
+        #
+        # @param conn [Class] Connect object to the node
+        # @param url [String] URL for the GET request
+        # @param hdr [String] Header parameters for the GET request
+        #
+        # @return [RestClient::Request] Rest output from SONIC in JSON format
+        def self.get(conn, url, hdr)
+          begin
+            Log.file.puts("\n--------------------- GET --------------------- ", url, hdr)
+            resp = RestClient::Request.execute method: :get, url: url, headers: hdr, user: conn.getUser, password: conn.getPassword, timeout: 20 ,:verify_ssl => false
+            if resp != ''
+              Log.file.puts("RESPONSE - ", resp)
+              response = JSON.parse(resp)
+              response
+            else
+              Log.file.puts("RESPONSE - empty")
+              response = {}
+              response
+            end
+          rescue RestClient::ExceptionWithResponse => err
+            Log.file.puts("ERROR: ")
+            Log.file.puts err
+            Log.file.puts err.response
+          end
+        end
+
+        # This API performs REST PUT request for the given url with switch credentials.
+        #
+        # @param conn [Class] Connect object to the node
+        # @param url [String] URL for the PUT request
+        # @param hdr [String] Header parameters for the PUT request
+        # @param params [String] JSON body for PUT request
+        #
+        # @return [RestClient::Request] Rest output from SONIC in JSON format
+        def self.put(conn, url, hdr, params)
+          begin
+            Log.file.puts("\n--------------------- PUT --------------------- ", url, hdr, params)
+            resp = RestClient::Request.execute method: :put, url: url, headers: hdr, payload: params, user: conn.getUser, password: conn.getPassword, timeout: 20 ,:verify_ssl => false
+            # REST API PUT always gets empty response for success
+            if resp != ''
+              Log.file.puts("RESPONSE - ", resp)
+              response = JSON.parse(resp)
+              response
+            else
+              Log.file.puts("RESPONSE - empty")
+              response = {}
+              response
+            end
+          rescue RestClient::ExceptionWithResponse => err
+            Log.file.puts("ERROR: ")
+            Log.file.puts err
+            Log.file.puts err.response
+          end
+        end
+
+        # This API performs POST request for the given url with switch credentials.
+        #
+        # @param conn [Class] Connect object to the node
+        # @param url [String] URL for the POST request
+        # @param hdr [String] Header parameters for the POST request
+        # @param params [String] JSON body for POST request
+        #
+        # @return [RestClient::Request] Rest output from SONIC in JSON format
+        def self.post(conn, url, hdr, params)
+          begin
+            Log.file.puts("\n--------------------- POST --------------------- ", url, hdr, params)
+            resp = RestClient::Request.execute method: :post, url: url, headers: hdr, payload: params, user: conn.getUser, password: conn.getPassword, timeout: 20 ,:verify_ssl => false
+            # REST API POST always gets '{}' response for success
+            if resp != ''
+              Log.file.puts("RESPONSE - ", resp)
+              response = JSON.parse(resp)
+              response
+            else
+              Log.file.puts("RESPONSE - empty")
+              response = {}
+              response
+            end
+          rescue RestClient::ExceptionWithResponse => err
+            Log.file.puts("ERROR: ")
+            Log.file.puts err
+            Log.file.puts err.response
+          end
+        end
+
+        # This API performs DELETE request for the given url with switch credentials.
+        #
+        # @param conn [Class] Connect object to the node
+        # @param url [String] URL for the DELETE request
+        # @param hdr [String] Header parameters for the DELETE request
+        #
+        # @return [RestClient::Request] Rest output from SONIC in JSON format
+        def self.delete(conn, url, hdr)
+          begin
+            Log.file.puts("\n--------------------- DELETE --------------------- ", url, hdr)
+            resp = RestClient::Request.execute method: :delete, url: url, headers: hdr, user: conn.getUser, password: conn.getPassword, timeout: 20 ,:verify_ssl => false
+            # REST API DELETE always gets empty response for success
+            if resp != ''
+              Log.file.puts("RESPONSE - ", resp)
+              response = JSON.parse(resp)
+              response
+            else
+              Log.file.puts("RESPONSE - empty")
+              response = {}
+              response
+            end
+          rescue RestClient::ExceptionWithResponse => err
+            Log.file.puts("ERROR: ")
+            Log.file.puts err
+            Log.file.puts err.response
+          end
+        end
+end

data/lib/sonic-rbapi/system.rb

@@ -0,0 +1,99 @@
+#!/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 System class provides a class implementation and methods for managing and setting up
+# system configuration and images. This class presents an abstraction
+
+class System
+        @system_cfg  = '/api/devices'
+
+        # This API gets the system meta data parameters
+        #
+        # Request URL: http://IP-ADDR:REST-PORT/api/devices
+        #
+        # @param conn [Class] Connect object to the node
+        #
+        # @return [RestClient::Request] Rest output from SONIC in JSON format as below
+        #         {
+        #          "mac": "b4:8c:db:b9:a0:00",
+        #          "hwsku": "YYY",
+        #          "hostname": "<string>",
+        #          "platform": "x86_64",
+        #          "version": <sonic-version>,
+        #          "ASIC": <asic-type>
+        #          "type": "LeafRouter"
+        #          ...
+        #         }
+        def self.get_system_data(conn)
+          url = form_url(conn, @system_cfg)
+          hdr = form_hdr(conn)
+          Rest.get(conn, url, hdr)
+        end
+
+        # This API updates system mac_addr and hostname
+        #
+        # Request URL: http://IP-ADDR:REST-PORT/api/devices
+        #       payload format of key-value pairs
+        #            {
+        #             "mac_addr": "00:01:02:03:04:05",
+        #             "hostname": "hostname"
+        #            }
+        #
+        # @param conn [Class] Connect object to the node
+        # @param mac_addr [String] Base MAC address of the system
+        # @param hostname [String] Hostname of the system
+        #
+        # @return [RestClient::Request] Rest output from SONIC in JSON format
+        def self.update_system_data(conn, mac_addr=nil, hostname=nil)
+          url = form_url(conn, @system_cfg)
+          hdr = form_hdr(conn)
+          if mac_addr != nil
+            params = {"mac_addr": mac_addr}
+          end
+          if hostname != nil
+            p1 =  {"hostname": hostname}
+            if mac_addr != nil
+              params = params.merge(p1)
+            else
+              params = p1
+            end
+          end
+          params = params.to_json
+          Rest.put(conn, url, hdr, params)
+        end
+
+        # This API download and install system image
+        #
+        # Request URL: http://IP-ADDR:REST-PORT/api/devices
+        #       payload format of key-value pairs
+        #            {
+        #             "image_url": "image_url"
+        #            }
+        #
+        # @param conn [Class] Connect object to the node
+        # @param image_url [String] URL to download system image from remote Web server (http ot https)
+        #
+        # @return [RestClient::Request] Rest output from SONIC in JSON format
+        def self.download_system_img(conn, image_url)
+          url = form_url(conn, @system_cfg)
+          hdr = form_hdr(conn)
+          params = {"image_url": image_url}
+          params = params.to_json
+          Rest.post(conn, url, hdr, params)
+        end
+end

data/lib/sonic-rbapi/vlan.rb

@@ -0,0 +1,176 @@
+#!/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 Vlan class provides a class implementation and methods for managing the VLANs
+# on the node. This class presents an abstraction
+
+class Vlan
+        @vlan_cfg = '/api/vlans/cfgs'
+        @vlan_info = '/api/vlans/info'
+
+        # This API get the properties of all VLANs.
+        #
+        # Request URL: http://IP-ADDR:REST-PORT/api/vlans/info
+        #
+        # @param conn [Class] Connect object to the node
+        #
+        # @return [RestClient::Request] Rest output from SONIC in JSON format as below
+        #                               {"Vlan_name": {"vlan_id": 100,
+        #                                    "members": {"Ethernet16": "tagged", ...}
+        #                                    },
+        #                                    {"vlan_id": 200,
+        #                                    "members": {"Ethernet17": "tagged", ...}
+        #                                    },
+        #                                    ...
+        #                               }
+        def self.get_all_vlan(conn)
+          url = form_url(conn, @vlan_info)
+          hdr = form_hdr(conn)
+          Rest.get(conn, url, hdr)
+        end
+
+        # This API get the properties of single vlan.
+        #
+        # Request URL: http://IP-ADDR:REST-PORT/api/vlans/info/100
+        #
+        # @param conn [Class] Connect object to the node
+        # @param vlan_id [Integer] VLAN number
+        #
+        # @return [RestClient::Request] Rest output from SONIC in JSON format as below
+        #                               {"Vlan_name": {"vlan_id": 100,
+        #                                    "members": {"Ethernet16": "tagged", ...}
+        #                                    },
+        #                               }
+        def self.get_vlan(conn, vlan_id)
+          url = form_url(conn, @vlan_info + '/' + vlan_id.to_s)
+          hdr = form_hdr(conn)
+          Rest.get(conn, url, hdr)
+        end
+
+        # This API creates a Vlan.
+        #
+        # Request URL: http://IP-ADDR:REST-PORT/api/vlans/cfgs/100
+        #        payload format of key-value pairs
+        #        {
+        #           "vlanid": 100,
+        #           "member": {"InterfaceName1": "tagged", "InterfaceName": "untagged"} 
+        #        }
+        #
+        # @param conn [Class] Connect object to the node.
+        # @param vlan_id [Integer] VLAN number from 1-4095.
+        # @param add_tagged_members [Array] List of interfaces to be added to the vlan as tagged members
+        # @param add_untagged_members [Array] List of iinterfaces to be added to the vlan as untagged members
+        #
+        # @return [RestClient::Request] Rest output from SONIC in JSON format
+        def self.create_vlan(conn, vlan_id, add_tagged_members=nil, add_untagged_members=nil)
+          url = form_url(conn, @vlan_cfg + '/' + vlan_id.to_s)
+          hdr = form_hdr(conn)
+          params = {"vlanid": vlan_id}
+          add_members = nil
+          for i in 0..add_tagged_members.size-1 do
+            tag = {add_tagged_members[i]=> "tagged"}
+            if (add_members == nil)
+              add_members = tag
+            else
+              add_members = add_members.merge(tag)
+            end
+          end
+          for i in 0..add_untagged_members.size-1 do
+            untag = {add_untagged_members[i]=> "untagged"}
+            if (add_members == nil)
+              add_members = untag
+            else
+              add_members = add_members.merge(untag)
+            end
+          end
+          if add_members != nil
+            p1 = {"add_member": add_members}
+          else
+            p1 = {"add_member": {}}
+          end
+          params = params.merge(p1)
+          params = params.to_json
+          Rest.post(conn, url, hdr, params)
+        end
+
+        # This API updates properties of a VLAN.
+        #
+        # Request URL: http://IP-ADDR:REST-PORT/api/vlans/cfgs/100
+        #        payload format of key-value pairs
+        #        {
+        #               "add_member": {"Ethernet0": "tagged", "Ethernet4": "untagged"},
+        #               "rem_member": ["Ethernet12"],
+        #               "rem_all": "false"
+        #        }
+        #
+        # @param conn [Class] Connect object to the node
+        # @param vlan_id [Integer] VLAN number from 1-4095
+        # @param add_tagged_members [Array] List of interfaces to be added to the vlan as tagged members
+        # @param add_untagged_members [Array] List of iinterfaces to be added to the vlan as untagged members
+        # @param rem_members [Array] List of interfaces to be removed from the vlan
+        # @param rem_all [Boolean]  A flag to remove all members of the Vlan or not ('true or 'false')
+        #
+        # @return [RestClient::Request] Rest output from SONIC in JSON format
+        def self.update_vlan(conn, vlan_id, add_tagged_members=nil, add_untagged_members=nil, rem_members=nil, rem_all='false')
+          url = form_url(conn, @vlan_cfg + '/' + vlan_id.to_s)
+          hdr = form_hdr(conn)
+          add_members = nil
+          params = nil
+          for i in 0..add_tagged_members.size-1 do
+            tag = {add_tagged_members[i]=> "tagged"}
+            if (add_members == nil)
+              add_members = tag
+            else
+              add_members = add_members.merge(tag)
+            end
+          end
+          for i in 0..add_untagged_members.size-1 do
+            untag = {add_untagged_members[i]=> "untagged"}
+            if (add_members == nil)
+              add_members = untag
+            else
+              add_members = add_members.merge(untag)
+            end
+          end
+          if add_members != nil
+            params = {"add_member": add_members}
+          else
+            params = {"add_member": {}}
+          end
+          p1 = {"rem_member": rem_members}
+          params = params.merge(p1)
+          p2 = {"rem_all": rem_all}
+          params = params.merge(p2)
+          params = params.to_json
+          Rest.put(conn, url, hdr, params)
+        end
+
+        # This API deletes a  vlan.
+        #
+        # Request URL: http://IP-ADDR:REST-PORT/api/vlans/cfgs/100
+        #
+        # @param conn [Class] Connect object to the node
+        # @param vlan_id [Integer] VLAN number from 1-4095
+        #
+        # @return [RestClient::Request] Rest output from SONIC in JSON format
+        def self.delete_vlan(conn, vlan_id)
+          url = form_url(conn, @vlan_cfg + '/' + vlan_id.to_s)
+          hdr = form_hdr(conn)
+          Rest.delete(conn, url, hdr)
+        end
+end