aviz-sonic-rbapi 0.0.0

data/lib/sonic-rbapi/devenvs.rb

@@ -0,0 +1,43 @@
+#!/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 Devenvs class provides a class implementation and methods for getting
+# device environment details. This class presents an abstraction
+
+class Devenvs
+        @devenvs_cfg  = '/api/devenvs'
+
+        # This API gets the device environment details
+        #
+        # Request URL: http://IP-ADDR:REST-PORT/api/devenvs
+        #
+        # @param conn [Class] Connect object to the node
+        #
+        # @return [RestClient::Request] Rest output from SONIC in JSON format as below
+        #         {
+        #          "Fans": {"fan1": "rpm", "fan2": "rpm"}
+        #          “Temperature”:{ },
+        #          “Power”:{ “name”:””, “status”:””},
+        #          “Platform”:{ “Platform Name”:””, “ONIE version”: “”, “CRC-32”:””}
+        #         }
+        def self.get_devenvs_data(conn)
+          url = form_url(conn, @devenvs_cfg)
+          hdr = form_hdr(conn)
+          Rest.get(conn, url, hdr)
+        end
+end

data/lib/sonic-rbapi/interfaces.rb

@@ -0,0 +1,174 @@
+#!/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 Interface class provides a class implementation and methods for managing the Interfaces
+# on the node. This class presents an abstraction
+
+class Interfaces
+@interface_cfg = '/api/interfaces/cfgs'
+@interface_info = '/api/interfaces/info'
+@interface_stats = '/api/interfaces/info/stats'
+@interface_transceiver = '/api/interfaces/transceivers'
+
+        # This API get the interface information.
+        #
+        # Request URL: http://IP-ADDR:REST-PORT/api/interfaces/info/Ethernet0
+        #              http://IP-ADDR:REST-PORT/api/interfaces/info
+        #
+        # @param conn [Class] Connect object to the node
+        # @param interface [String] Interface Name
+        #
+        # @return [RestClient::Request] Rest output from SONIC in JSON format
+        #                   {
+        #                      "InterfaceName": Ethernet0 {
+        #                         "lanes": "",
+        #                         "alias": "",
+        #                         "admin_status": "up or down",
+        #                         "oper_status": "up or down",
+        #                         "speed": "",
+        #                         "transceiver": ""
+        #                      }
+        #                   }
+        def self.get_interface_info(conn, interface=nil)
+          if interface == nil
+            url = form_url(conn, @interface_info)
+          else
+            url = form_url(conn, @interface_info + '/' +  interface.to_s)
+          end
+          hdr = form_hdr(conn)
+          Rest.get(conn, url, hdr)
+        end
+
+        # This API get the interface statistics.
+        #
+        # Request URL: http://IP-ADDR:REST-PORT/api/interfaces/info/stats/Ethernet0
+        #              http://IP-ADDR:REST-PORT/api/interfaces/info/stats
+        #
+        # @param conn [Class] Connect object to the node
+        # @param interface [String] Interface Name
+        #
+        # @return [RestClient::Request] Rest output from SONIC in JSON format
+        #                    {
+        #                       "collected_time": "03/20/2019, 18:53:05",
+        #                       "Ethernet120": {
+        #                           "IF_IN_OCTETS": 0,
+        #                           "IF_IN_UCAST_PKTS": 0,
+        #                           "IF_IN_NON_UCAST_PKTS": 0,
+        #                           "IF_IN_DISCARDS": 0,
+        #                           "IF_IN_ERRORS": 0,
+        #                           ...
+        #                       }
+        #                    }
+        def self.get_interface_stats(conn, interface=nil)
+          if interface == nil
+            url = form_url(conn, @interface_stats)
+          else
+            url = form_url(conn, @interface_stats + '/' +  interface.to_s)
+          end
+          hdr = form_hdr(conn)
+          Rest.get(conn, url, hdr)
+        end
+
+        # This API get the interface transceiver information.
+        #
+        # Request URL: http://IP-ADDR:REST-PORT/api/interfaces/transceivers/Ethernet0
+        #              http://IP-ADDR:REST-PORT/api/interfaces/transceivers
+        #
+        # @param conn [Class] Connect object to the node
+        # @param interface [String] Interface Name
+        #
+        # @return [RestClient::Request] Rest output from SONIC in JSON format
+        #                    {
+        #                       "Interface Name":
+        #                       {
+        #                          Present :”true or false”,
+        #                          Encoding: “’,
+        #                          Length Cable Assembly(m): ,
+        #                          Specification compliance: “”
+        #                          Vendor Date Code(YYYY-MM-DD Lot): “”
+        #                          Vendor Name: “”
+        #                          Vendor OUI: “”
+        #                          Vendor PN: “”
+        #                          Vendor Rev: “”
+        #                          Vendor SN: “”
+        #                       }
+        #                    }        
+        def self.get_interface_transceivers(conn, interface=nil)
+          if interface == nil
+            url = form_url(conn, @interface_transceiver)
+          else
+            url = form_url(conn, @interface_transceiver + '/' +  interface.to_s)
+          end
+          hdr = form_hdr(conn)
+          Rest.get(conn, url, hdr)
+        end
+
+        # This API updates properties of a interface.
+        #
+        # Request URL: http://IP-ADDR:REST-PORT/api/interfaces/cfgs/Ethernet0
+        #       payload format of key-value pairs
+        #       {
+        #        "fec": "none",
+        #        "mtu": "9100",
+        #        "speed": "100000",
+        #        "admin_status": "up",
+        #       }
+        #
+        # @param conn [Class] Connect object to the node
+        # @param interface [String] Interface Name
+        # @param fec {String] Forwarding error correction setting(optional). Valid Values: "none", "rs",  "fc"
+        # @param mtu [Integer] Maximum transmission unit (optional)
+        # @param speed [Integer] Interface's speed in Mbps (optional)
+        # @param admin_status [String] Admin status of the interface (mandatory). Valid Values: "up" or "down"
+        #
+        # @return [RestClient::Request] Rest output from SONIC in JSON format
+        def self.update_interface_cfg(conn, interface, fec="none", mtu=9100, speed=100000, admin_status="up")
+          url = form_url(conn, @interface_cfg + '/' + interface.to_s)
+          hdr = form_hdr(conn)
+          params = {"fec": fec, "mtu": mtu, "speed": speed, "admin_status": admin_status}
+          params = params.to_json
+          Rest.post(conn, url, hdr, params)
+        end
+
+        # This API get the configuration of particular or all interface.
+        #
+        # Request URL: http://IP-ADDR:REST-PORT/api/interfaces/cfgs/Ethernet0
+        #
+        # @param conn [Class] Connect object to the node
+        # @param interface [String] Interface Name or nil
+        #
+        # @return [RestClient::Request] Rest output from SONIC in JSON format as below
+        #                               {
+        #                                "interface": "<interfaceid>",
+        #                                "alias": "hundredGigE1/1"
+        #                                "fec": "none",
+        #                                "speed": "100000",
+        #                                "mtu": "9100",
+        #                                "lanes": "33,34,35,36",
+        #                                "admin_status": "up",
+        #                               }
+        def self.get_interface_cfg(conn, interface=nil)
+          if (interface != nil)
+            url = form_url(conn, @interface_cfg + '/' + interface.to_s)
+          else
+            url = form_url(conn, @interface_cfg)
+          end
+          hdr = form_hdr(conn)
+          Rest.get(conn, url, hdr)
+        end
+end

data/lib/sonic-rbapi/ip.rb

@@ -0,0 +1,118 @@
+#!/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 Ipintf class provides a class implementation and methods for managing the Ip Interfaces
+# on the node. This class presents an abstraction
+
+class Ipintf
+        @ip_cfg  = '/api/ips/cfgs'
+
+        # This API gets the IP interface.
+        #
+        # Request URL: http://IP-ADDR:REST-PORT/api/ips/cfgs
+        #
+        # @param conn [Class] Connect object to the node
+        # @param intf_name [String] IP interface name as a string like Ethernet0, Vlan100, PortChannel20(optional)
+        #
+        # @return [RestClient::Request] Rest output from SONIC in JSON format
+        #                    {
+        #                      "IntfName": {
+        #                          "ipv4_addr ": "",
+        #                          "ipv4_prefix_len": "",
+        #                          "ipv6_addr ": "",
+        #                          "ipv6_prefix_len": "",
+        #                          “mtu”:
+        #                          “admin_status”:””
+        #                       },
+        #                       …………
+        #                     }
+        def self.get_ip_intf(conn, intf_name=nil)
+          if intf_name == nil
+            url = form_url(conn, @ip_cfg)
+          else
+            url = form_url(conn, @ip_cfg + '/' + intf_name)
+          end
+          hdr = form_hdr(conn)
+          Rest.get(conn, url, hdr)
+        end
+
+        # This API creates the IP interface.
+        #
+        # Request URL: http://IP-ADDR:REST-PORT/api/ips/cfgs
+        #       payload format of key-value pairs
+        #        {
+        #         "inf_name": <inf_name>,
+        #         "inf_name": <inf_name>,
+        #         "ipv4_addr": <ipv4_addr>,
+        #         "ipv4_prefix_len": <ipv4_prefix_len>,
+        #         "ipv6_addr": <ipv6_addr>,
+        #         "ipv6_prefix_len": <ipv6_prefix_len>,
+        #         "gwaddr": <gwaddr>,
+        #         "forced_routes": <forced_routes>
+        #        }
+        #
+        # @param conn [Class] Connect object to the node
+        # @param intf [String] IP interface name like EthernetX, PortChannelXXX, VlanXXX, LoopbackX or eth0 for management interface
+        # @param ipv4_addr [String] IPv4 address
+        # @param ipv4_prefix_len [Integer] Prefix len for the IPv4 address. Valid Values: 0-32 for IPv4
+        # @param ipv6_addr [String] IPv6 address
+        # @param ipv6_prefix_len [Integer] Prefix len for the IPv6 address. Valid Values: 0-128 for IPv4
+        # @param gwaddr [String] Gateway addr for mgmt interface only (optional). Valid Values: Valid IPv4 or IPv6 addresses
+        # @param forced_routes [String] Routes for mgmt interface only (optional). Valid Values: A list of strings. Eg: ["10.10.10.0/24", "192.168.5.0/24"]
+        #
+        # @return [RestClient::Request] Rest output from SONIC in JSON format
+        def self.create_ip_intf(conn, intf, ipv4_addr=nil, ipv4_prefix_len=0, ipv6_addr=nil, ipv6_prefix_len=0, gwaddr=nil, forced_routes=nil)
+          url = form_url(conn, @ip_cfg + '/' + intf)
+          hdr = form_hdr(conn)
+          params = {"inf_name": intf}
+          if ipv4_addr != nil
+            p1 = {"ipv4_addr": ipv4_addr, "ipv4_prefix_len": ipv4_prefix_len}
+            params = params.merge(p1);
+          end
+          if ipv6_addr != nil
+            p2 = {"ipv6_addr": ipv6_addr, "ipv6_prefix_len": ipv6_prefix_len}
+            params = params.merge(p2);
+          end
+          if gwaddr != nil
+            p3 = {"gwaddr": gwaddr}
+            params = params.merge(p3);
+          end
+          if forced_routes != nil
+            p4 = {"forced_routes": forced_routes}
+            params = params.merge(p4);
+          end
+          params = params.to_json
+          Rest.post(conn, url, hdr, params)
+        end
+
+        # This API deletes the ip interface.
+        #
+        # Request URI: /api/ips/cfgs/inf_name?ip_addr=10.1.1.1&mask=24
+        #
+        # @param conn [Class] Connect object to the node
+        # @param intf_name [String] IP interface name as a string like Ethernet0, Vlan100, PortChannel20
+        # @param ip_addr [String] IP address of the interface is about to delete
+        # @param netmask [String] Net mask of the interface is about to delete
+        #
+        # @return [RestClient::Request] Rest output from SONIC in JSON format
+        def self.delete_ip_intf(conn, intf_name, ip_addr, netmask)
+          url = form_url(conn, @ip_cfg + '/' + intf_name + '?ip_addr=' + ip_addr + '&mask=' + netmask.to_s)
+          hdr = form_hdr(conn)
+          Rest.delete(conn, url, hdr)
+        end
+end

data/lib/sonic-rbapi/lldp.rb

@@ -0,0 +1,118 @@
+#!/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 Lldp class provides a class implementation and methods for managing LLdp
+# on the node. This class presents an abstraction
+
+class Lldp
+        @lldp_cfg  = '/api/lldps/cfgs'
+        @lldp_info  = '/api/lldps'
+
+        # This API gets LLDP information from the switch
+        #
+        # Request URL: http://IP-ADDR:REST-PORT/api/lldps/info/chassis: Get chassis (switch) detailed information
+        #              http://IP-ADDR:REST-PORT/api/lldps/info/stats: Get statistics summary information
+        #              http://IP-ADDR:REST-PORT/api/lldps/info/stats/Ethernet0: Get statistics information for a specific port
+        #              http://IP-ADDR:REST-PORT/api/lldps/info/config: Get LLDP configuration
+        #              http://IP-ADDR:REST-PORT/api/lldps/neighbors: Get LLDP neighbor information for all ports
+        #              http://IP-ADDR:REST-PORT/api/lldps/info/neighbors/Ethernet0: Get LLDP neighbor information for a specific port
+        #
+        # @param conn [Class] Connect object to the node
+        # @param filter [String] LLDP info filter which holds the value chassis/stats/config/neighbors
+        # @param port_name [String] Port name
+        #
+        # @return [RestClient::Request] Rest output from SONIC in JSON format
+        def self.get_lldp_info(conn, filter, port_name=nil)
+          chassis_filter = "chassis"
+          stats_filter = "stats"
+          cfg_filter = "config"
+          neighbor_filter = "neighbors"
+
+          if filter == chassis_filter
+            url = form_url(conn, @lldp_info + '/' + chassis_filter)
+          elsif filter == stats_filter
+            if port_name == nil
+              url = form_url(conn, @lldp_info + '/' + stats_filter)
+            else
+              url = form_url(conn, @lldp_info + '/' + stats_filter + '/' + port_name)
+            end
+          elsif filter == cfg_filter
+            url = form_url(conn, @lldp_info + '/' + cfg_filter)
+          elsif filter == neighbor_filter
+            if port_name == nil
+              url = form_url(conn, @lldp_info + '/' + neighbor_filter)
+            else
+              url = form_url(conn, @lldp_info + '/' + neighbor_filter + '/' + port_name)
+            end
+          end
+          hdr = form_hdr(conn)
+          Rest.get(conn, url, hdr)
+        end
+
+        # This API updates the global LLDP config on the switch.
+        #
+        # Request URL: http://IP-ADDR:REST-PORT/api/lldps/cfgs
+        #       payload format of key-value pairs
+        #            {
+        #              "tx_interval": <tx_interval>,
+        #              "tx_hold": <tx_hold>,
+        #              "admin_status": <admin_status>,
+        #              "capabilities_ad": <cap_status>,
+        #              "mgmt_addr_ad": <mgmt_status>,
+        #            }
+        #
+        # @param conn [Class] Connect object to the node
+        # @param tx_interval [Integer] LLDP transmit delay in seconds (optional)
+        # @param tx_hold [Integer] LLDP transmit hold in seconds (optional)
+        # @param admin_status [String] LLDP admin status(mandatory). Valid values: tx-only, rx-only, rx-and-tx, disabled
+        # @param capabilities_ad [Boolean] Enable/disable capabilities advertisement (optional). Valid values: true, false
+        # @param mgmt_addr_ad [Boolean] Enable/disable management address advertisement (optional). Valid values: true, false
+        #
+        # @return [RestClient::Request] Rest output from SONIC in JSON format
+        def self.update_lldp_global_config(conn, tx_interval=0, tx_hold=0, admin_status='rx-and-tx', capabilities_ad='true', mgmt_addr_ad='false')
+          url = form_url(conn, @lldp_cfg)
+          hdr = form_hdr(conn)
+          params = {"tx_interval": tx_interval, "tx_hold": tx_hold, "admin_status": admin_status, "capabilities_ad": capabilities_ad, "mgmt_addr_ad": mgmt_addr_ad}
+          params = params.to_json
+          Rest.put(conn, url, hdr, params)
+        end
+
+        # This API updates the LLDP port configuration on the switch.
+        #
+        # Request URL: http://IP-ADDR:REST-PORT/api/lldps/cfgs/Ethernet0
+        #       payload format of key-value pairs
+        #            {
+        #              "admin_status": <admin_status>,
+        #              "mgmt_addr_ad": <mgmt_status>,
+        #            }
+        #
+        # @param conn [Class] Connect object to the node
+        # @param port_name [String] Port Name
+        # @param admin_status [String] LLDP admin status (mandatory). Valid values: tx-only, rx-only, rx-and-tx, disabled
+        # @param mgmt_status [Boolean] Enable/disable management address advertisement (optional). Valid values: true, false
+        #
+        # @return [RestClient::Request] Rest output from SONIC in JSON format
+        def self.update_lldp_port_config(conn, port_name, admin_status='rx-and-tx', mgmt_status='false')
+          url = form_url(conn, @lldp_cfg + '/' + port_name)
+          hdr = form_hdr(conn)
+          params = {"admin_status": admin_status, "mgmt_addr_ad": mgmt_status}
+          params = params.to_json
+          Rest.put(conn, url, hdr, params)
+        end
+end
+