lenovo-rbapi 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3fc4f268227846d053298925f33b12c71f52068f5fdc784aff2ead47d8c60974
+  data.tar.gz: 6ea37824a3dfe81aa071ea038a2798df130954d60526430fe6000a02c41ee7b4
+SHA512:
+  metadata.gz: ab352ca7fc229add45f71958a3f039ab9c1e3532848a6aa0f8ce30af81f750966fc6402ff079dacf61a08040a714b1d1b1da512a3b852ad1853c8dd5f5f08697
+  data.tar.gz: a6567500337371878f24d35a33a92677afe831bd244dd12b31e714a465cd457e18c9144a8fbd28d44bf03d3cebad4815a816b079fa3d185cc842d63b800d353d

data/LICENSE.md

@@ -0,0 +1,25 @@
+##
+## Copyright (c) 2017, Lenovo. All rights reserved.
+##
+## Redistribution and use in source and binary forms, with or without
+## modification, are permitted provided that the following conditions are met:
+## 1. Redistributions of source code must retain the above copyright notice,
+##    this list of conditions and the following disclaimer.
+## 2. 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.
+## 3. 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,76 @@
+# Lenovo CNOS Ruby API Library
+
+#### Table of Contents
+1. Overview
+2. Requirements
+3. CNOS Ruby APIs
+   3.1 Using Ruby APIs
+4. License
+
+1. Overview
+The Ruby Client for CNOS API provides a native Ruby implementation for programming
+Lenovo CNOS network devices using Ruby.  The Ruby client provides the ability to
+build native applications in Ruby that can communicate with CNOS remotely over 
+a HTTP/S transport (off-box).
+
+The Ruby API implemenation also provides an API layer for building native Ruby
+objects that allow for configuration and management of Lenovo CNOS switches. 
+
+The libray is freely provided to the open source community for building applications 
+using CNOS REST API infrastrcuture. Support is provided as best effort through
+Github iusses.
+
+2. Requirements
+* Lenovo CNOS 10.4 or later
+* Ruby 2.2.3 or later
+
+3. CNOS Ruby APIs
+The CNOS Ruby Client was designed to be easy to use and develop plugins or tools
+that interface with the Lenovo CNOS switches.
+
+3.1 Using the API
+
+3.1.1 Switch Configutation file
+This configuration file is used to define the configuration options or model for 
+switches (switch.yml or any xxx.yml)
+
+transport : 'http' #transport (HTTP/HTTPs)
+port : '8090' #HTTP(s) port number (8090 - HTTP, 443 - HTTPs)
+ip : 'switch ip address' #Switch IP address
+user : '<username>' #Switch Credentials
+password : '<password>' 
+
+3.1.2 Creating connection and sending configurations
+Below demonstrates a basic connection using the API. 
+For more examples, please see the examples folder.
+
+#import the libraries
+require 'cnos-rbapi/connect'
+require 'cnos-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 
+
+transport => 'http' #transport (HTTP/HTTPs)
+port => '8090' #HTTP(s) port number (8090 - HTTP, 443 - HTTPs)
+ip => 'switch ip address' #Switch IP address
+user => '<username>' #Switch Credentials
+password => '<password>'
+ 
+#Use VLAN APIs to retrieve VLAN information
+Vlan.get_all_vlan(conn)
+
+#Use VLAN APIs to create/update and delete VLANs
+params = {"vlan_name" => "test", "vlan_id" => 10, "admin_state" => "up"}
+resp = Vlan.create_vlan(conn, params)
+
+resp = Vlan.get_vlan_prop(conn, 10)
+
+params = {"vlan_name" => "test", "admin_state" => "up"}
+resp = Vlan.update_vlan(conn, 10, params)
+
+Vlan.delete_vlan(conn, 10)
+

data/lib/cnos-rbapi.rb

@@ -0,0 +1,16 @@
+##
+### Copyright (c) 2017, Lenovo. 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 'cnos-rbapi/connect.rb'

data/lib/cnos-rbapi/arp.rb

@@ -0,0 +1,115 @@
+##
+## Copyright (c) 2017, Lenovo. 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 Arp class provides a class implementation and methods for managing the ARP 
+## on the node. This class presents an abstraction
+## 
+
+class Arp
+	@cfg  = '/nos/api/cfg/arp'
+        
+	# This API gets the ARP properties of the system.
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #
+        #  return: JSON response 		
+	def self.get_arp_sys_prop(conn)
+                url = form_url(conn, @cfg)
+                hdr = form_hdr(conn)
+                Rest.get(conn, url, hdr)
+        end
+	
+	# This API gets the ARP properties of all interfaces.
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #
+        #  return: JSON response 		
+        def self.get_arp_prop_all(conn)
+                url = form_url(conn, @cfg + '_interface')
+                hdr = form_hdr(conn)
+                Rest.get(conn, url, hdr)
+        end
+
+	# This API updates the ARP properties of the system.
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #  params - dictionary that requires the following format of key-value pairs
+        #  		{
+        #    		  “ageout_time” : “<ageout_time>”
+        # 		}
+        #  description -
+        #  ageout_time :The global ARP entry age‐out time, in seconds; an integer from 60‐28800.  Default value: 1500 seconds. 
+        #
+	#  return: JSON response 		
+        def self.set_arp_sys_prop(conn, params)
+                url = form_url(conn, @cfg)
+                hdr = form_hdr(conn)
+                params = params.to_json
+                Rest.put(conn, url, hdr, params)
+        end
+
+	# This API gets the ARP properties of one interface.
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #
+        #  return: JSON response 		
+	def self.get_arp_intf_prop(conn, intf)
+                temp = intf.dup
+		temp.sub! '/', '%2F'
+                url = form_url(conn, @cfg + '_interface/' + temp)
+                hdr = form_hdr(conn)
+                Rest.get(conn, url, hdr)
+        end
+
+	# This API updates the ARP properties of one interface.
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #  params - dictionary that requires the following format of key-value pairs
+        #  		{
+        #  		  "if_name": "<if_name>",
+        #    		  “ageout_time” : “<ageout_time>”
+        # 		}
+        #  description -
+        #  if_name     :IP interface name (String).Note: The interface must exist.
+        #  ageout_time :The global ARP entry age‐out time, in seconds; an integer from 60‐28800.  Default value: 1500 seconds. 
+        #
+	#  return: JSON response 		
+        def self.set_arp_intf_prop(conn, intf,  params)
+                temp = intf.dup
+		temp.sub! '/', '%2F'
+                url = form_url(conn, @cfg + '_interface/' + temp)
+                hdr = form_hdr(conn)
+                params = params.to_json
+                Rest.put(conn, url, hdr, params)
+        end
+
+end
+

data/lib/cnos-rbapi/connect.rb

@@ -0,0 +1,146 @@
+##
+## Copyright (c) 2017, Lenovo. 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 = {}
+	tmp_ckie = 'auth_cookie='+ conn.getCookie + ';user=' + conn.getUser + '; Max-Age=3600; Path=/'
+   	hdr['Cookie'] = tmp_ckie
+   	hdr['Content-type'] = 'application/json'
+   	return hdr
+end	
+
+def form_url(conn, url)
+	url = conn.getTransport +  '://' + conn.getIp + ':' + 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 and establish connection with the given paramters.
+        # 
+        # 
+        #  parameters:
+        #  file   :config file
+        #
+        #  return: Connect object 		
+	def initialize(params)
+		@transport = params['transport']
+		@port      = params['port']
+		@ip        = params['ip']
+		@user      = params['user']
+		@password  = params['password']
+		@cookie    = ''
+                if @transport == 'http'
+			@url       = @transport + '://' + @ip + ':' + @port + '/nos/api/login/'
+                end
+                if @transport == 'https'
+			@url       = @transport + '://' + @ip + '/nos/api/login/'
+                end
+		
+		begin
+			RestClient::Request.execute(method: :get, url: @url, user: @user, password: @password, timeout: 10, :verify_ssl => false)
+		rescue RestClient::Unauthorized, RestClient::Forbidden => err
+  			@cookie =  err.response.cookies['auth_cookie']
+		end
+		
+		@hdr = {}
+		tmp_ckie = 'auth_cookie=' + @cookie + ';user=' + @user + '; Max-Age=3600; Path=/'
+		@hdr['Cookie'] = tmp_ckie
+		resp = RestClient::Request.execute(method: :get, url: @url, headers: @hdr, user: @user, password: @password, timeout: 10, :verify_ssl => false)
+		@cookie = resp.cookies['auth_cookie']
+		@hdr['Content-type'] = 'application/json'
+
+	end
+
+
+	# This API returns Transport protocol for the current node connection.
+        # 
+        # 
+        #  parameters:
+        #
+        #  return: transport - string	
+	def getTransport()
+		return @transport
+	end
+
+	# This API returns Port for the current node connection.
+        # 
+        # 
+        #  parameters:
+        #
+        #  return: port - string	
+	def getPort()
+                return @port
+	end
+	
+	# This API returns IP  for the current node connection.
+        # 
+        # 
+        #  parameters:
+        #
+        #  return: IP	- string
+	def getIp()
+                return @ip
+	end
+	
+	# This API returns User for the current node connection.
+        # 
+        # 
+        #  parameters:
+        #
+        #  return: User	- string 
+	def getUser()
+		return @user
+	end
+	
+	# This API returns Password for the current node connection.
+        # 
+        # 
+        #  parameters:
+        #
+        #  return: Password - string	
+	def getPassword()
+                return @password
+	end
+	
+	# This API returns Cookie for the current node connection.
+        # 
+        # 
+        #  parameters:
+        #
+        #  return: Cookie - string
+	def getCookie()
+                return @cookie
+	end
+
+	# This API returns Header Info for the current node connection.
+        # 
+        # 
+        #  parameters:
+        #
+        #  return: header - string	
+	def getHdr()
+		return @hdr
+	end
+
+
+end

data/lib/cnos-rbapi/igmp.rb

@@ -0,0 +1,117 @@
+##
+## Copyright (c) 2017, Lenovo. 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 Igmp class provides a class implementation and methods for managing the IGMP 
+## on the node. This class presents an abstraction
+## 
+class Igmp
+	@cfg  = '/nos/api/cfg/igmp'
+	
+	#  This API gets IGMP Snooping properties of the system.
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #
+        #  return: JSON response 		
+        def self.get_igmp_snoop_prop(conn)
+                url = form_url(conn, @cfg + '/snoop')
+                hdr = form_hdr(conn)
+                Rest.get(conn, url, hdr)
+        end
+
+	#  This API update the global IGMP Snooping properties of the system.
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #  params - dictionary that requires the following format of key-value pairs
+        #                {
+        #                	 "ena_igmp_snoop": "<ena_igmp_snoop>"
+        #                }
+        #  description -              
+        #  ena_igmp_ snoop  :Enables IGMP snooping globally on all VLANs; one of yes
+        #  		     (default), no.
+        #  	             If disabled globally, IGMP snooping is disabled on all VLANs,
+        #  	             regardless of the per‐VLAN setting of IGMP snooping. If IGMP
+        #  		     snooping is enabled globally, the per‐VLAN setting of IGMP
+        #  		     snooping takes effect.              	
+        #
+        #
+        #  return: JSON response 		
+        def self.set_igmp_snoop_prop(conn, params)
+                url = form_url(conn, @cfg + '/snoop')
+                hdr = form_hdr(conn)
+                params = params.to_json
+                Rest.put(conn, url, hdr, params)
+        end
+
+	#  This API gets IGMP Snooping properties of one VLANs.
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #  vlan_id - VLAN number
+        #
+        #  return: JSON response 		
+	def self.get_igmp_vlan_prop(conn, vlan_id)
+		temp = @cfg.dup
+		temp.sub! 'igmp', 'mc_vlan/' + vlan_id.to_s	
+                url = form_url(conn, temp)
+                hdr = form_hdr(conn)
+                Rest.get(conn, url, hdr)
+        end
+
+	#  This API update the global IGMP Snooping properties of the specified VLAN.
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #  vlan_id - VLAN number
+        #  params - dictionary that requires the following format of key-value pairs
+        #                {
+        #                	    "vlan_id": "<vlan_id>",
+        #                	    "ena_igmp_snoop": "<ena_igmp_snoop>",
+        #                	    "fast_leave": "<fast_leave>",
+        #                	    "query_interval": "<query_interval>",
+        #                	    "version": "<version>",
+        #                }
+        #  description - 
+        #  vlan_id        :VLAN number.Note: The VLAN must exist.
+        #  ena_igmp_snoop :(Optional) Whether to enable IGMP snooping on a VLAN; one of
+        #  		    yes, no. Default value: yes.
+        #  fast_leave     :One of yes, no. Default value: no.
+        #  query_interval :(Optional) IGMP query interval, in seconds; an integer from
+        #  		    1‐18000. Default value: 125.
+        #  version        :(Optional) IGMP Snooping version number; one of 2, 3. Default
+        #  		    value: 3   
+        #
+        #  return: JSON response		            
+        def self.set_igmp_vlan_prop(conn, vlan_id, params)
+		temp = @cfg.dup
+                temp.sub! 'igmp', 'mc_vlan/' + vlan_id.to_s
+                url = form_url(conn, temp)
+                hdr = form_hdr(conn)
+                params = params.to_json
+                Rest.put(conn, url, hdr, params)
+        end
+end