lenovo-rbapi 0.0.1

data/lib/cnos-rbapi/telemetry.rb

@@ -0,0 +1,285 @@
+##
+## 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 Telemetry class provides a class implementation and methods for managing Telemetry features 
+## on the node. This class presents an abstraction
+## 	
+
+class Telemetry
+	@cfg  = '/nos/api/cfg/telemetry'
+
+	# This API gets system switch properties.
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #
+        #  return: JSON response 		
+        def self.get_sys_feature(conn)
+                url = form_url(conn, @cfg + '/feature')
+                hdr = form_hdr(conn)
+                Rest.get(conn, url, hdr)
+        end
+	 
+	# This API sets system feature.
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #  params - dictionary that requires the following format of key-value pairs
+        #  		{
+        #  		  	 "heartbeat­enable" :  1,        
+        #  		   	 "msg­interval" :  10   
+        #  		}
+        #  description - 
+        #  heartbeat-enable  :When enabled, the Agent asynchronously sends the registration
+        #  	  	      and heartbeat message to the collector. One of:
+        #  		      0: disable heartbeat
+        #  		      1: enable heartbeat (default value)
+        #  msg-interval      :Determines the interval with which the registration and heartbeat
+        #  		      messages are sent to the collector; units of seconds from 1‐600.
+        #  		      Default value: 5 seconds.
+        #
+        #  return: JSON response		      
+	def self.set_sys_feature(conn, params)
+                url = form_url(conn, @cfg + '/feature')
+                hdr = form_hdr(conn)
+		params = params.to_json
+		Rest.put(conn, url, hdr, params)
+	end
+
+	# This API gets BST trackers and the tracking mode on the ASIC.
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #
+        #  return: JSON response 		
+	def self.get_bst_tracking(conn)
+                url = form_url(conn, @cfg + '/bst/tracking')
+                hdr = form_hdr(conn)
+                Rest.get(conn, url, hdr)
+        end
+
+	# This API sets BST trackers and the tracking mode on the ASIC.
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #  params - dictionary that requires the following format of key-value pairs
+        #  		{
+        #  			"track­peak­stats" : 1,
+        #  			"track­ingress­port­priority­group" : 1,
+        #  			"track­ingress­port­service­pool" : 1,
+        #  			"track­ingress­service­pool" : 1,
+        #  			"track­egress­port­service­pool" : 1,
+        #  			"track­egress­service­pool" : 1,
+        #  			"track­egress­rqe­queue" : 1,
+        #  			"track­device" : 1
+        #  		}
+        #  description -
+        #  track­peak­stats                :Set to 1 to peak statistics tracking, 0 to disable
+        #  				    this feature
+        #  track­ingress­portpriority­group:Set to 1 to enable ingress port priority group
+        #  				    tracking, 0 to disable this feature
+        #  track­ingress­portservice­pool  :Set to 1 to enable ingress port service pool
+        #  				    tracking, 0 to disable this feature
+        #  track­ingress­servicepool       :Set to 1 to enable ingress service pool tracking,
+        #  				    0 to disable this feature
+        #  track­egress­portservice­pool   :Set to 1 to enable egress port service pool
+        #  				    tracking, 0 to disable this feature
+        #  track­egress­servicepool	   :Set to 1 to enable egress service pool tracking, 0
+        #  				    to disable this feature
+        #  track­egress­rqe­queue          :Set to 1 to enable egress RQE queue tracking, 0
+        #  				    to disable this feature
+        #  track­device 		   :Set to 1 to enable tracking of this device, 0 to
+        #  				    disable this feature
+        #
+        #  return: JSON response				     
+        def self.set_bst_tracking(conn, params)
+                url = form_url(conn, @cfg + '/bst/tracking')
+                hdr = form_hdr(conn)
+                params = params.to_json
+                Rest.put(conn, url, hdr, params)
+        end
+
+	# This API gets BST information.
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #
+        #  return: JSON response 		
+	def self.get_bst_feature(conn)
+                url = form_url(conn, @cfg + '/bst/feature')
+                hdr = form_hdr(conn)
+                Rest.get(conn, url, hdr)
+        end
+
+	# This API sets BST feature.
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #  params - dictionary that requires the following format of key-value pairs
+        #  		{
+        #  			"bst­enable": 1,
+        #  			"send­async­reports": 1,
+        #  			"collection­interval": 300,
+        #  			"trigger­rate­limit": 5,
+        #  			"trigger­rate­limit­interval": 2,
+        #  			"send­snapshot­on­trigger": 1,
+        #  			"async­full­reports": 1,
+        #  		}
+        #  description -
+        #  bst­enable         		:Set to 1 to enable BST, 0 to disable it. Enabling BST
+        #  		       	 	 allows the switch to track buffer utilization
+        #  		         	 statistics.
+        #  send­async­reports   	:Set to 1 to enable the transmission of periodic
+        # 			 	 asynchronous reports, 0 to disable this feature.
+        #  collection­interval  	:The collection interval, in seconds. This defines how
+        #  			 	 frequently periodic reports will be sent to the
+        #  			 	 configured controller.
+        #  trigger­rate­limit   	:The trigger rate limit, which defines the maximum
+        #  				 number of threshold‐driven triggered reports that
+        #  			 	 the agent is allowed to send to the controller per
+        #  			 	 trigger­rate­limit­interval; an integer
+        #  			 	 from 1‐5.
+        #  trigger­rate­limit-interval :The trigger rate limit interval, in seconds; an integer
+        #  from 10‐60.
+        #  send­snapshot­ontrigger     :Set to 1 to enable sending a complete snapshot of all
+        #  				buffer statistics counters when a trigger happens, 0
+        #  				to disable this feature.
+        #  async­full­report 	       :Set to 1 to enable the async full report feature, 0 to
+        #  				disable it.
+        #  				When this feature is enabled, the agent sends full
+        # 				reports containing data related to all counters.
+        #  				When the feature is disabled, the agent sends
+        #  				incremental reports containing only the counters
+        #  				that have changed since the last report.
+        #
+        #  return: JSON response			
+        def self.set_bst_feature(conn, params)
+                url = form_url(conn, @cfg + '/bst/feature')
+                hdr = form_hdr(conn)
+                params = params.to_json
+                Rest.put(conn, url, hdr, params)
+        end
+
+	# This API gets BST report information.
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #
+        #  return: JSON response 		
+	def self.get_bst_report(conn, params)
+                temp = @cfg.dup
+                temp.sub! 'cfg', 'info'
+                url = form_url(conn, temp + '/bst/report')
+                hdr = form_hdr(conn)
+                params = params.to_json
+                Rest.post(conn, url, hdr, params)
+        end
+	
+	# This API gets BST threshold.
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #
+        #  return: JSON response 		
+	def self.get_bst_threshold(conn, params)
+                url = form_url(conn, @cfg + '/bst/threshold')
+                hdr = form_hdr(conn)
+                params = params.to_json
+                Rest.post(conn, url, hdr, params)
+        end
+
+	# This API sets BST threshold to trigger BST reports.
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #  params - dictionary that requires the following format of key-value pairs for the realms 
+        #  	    given in description
+        #  		{
+        #  			"realm": "ingress­service­pool",       
+        #  			"service­pool" : 0,
+        #  			"um­share­threshold" : 70
+        #  		}
+        #  description - 
+        #
+        #  return: JSON response				
+        def self.set_bst_threshold(conn, params)
+                url = form_url(conn, @cfg + '/bst/threshold')
+                hdr = form_hdr(conn)
+                params = params.to_json
+                Rest.put(conn, url, hdr, params)
+        end
+
+	# This API clears  BST threshold.
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #
+        #  return: JSON response 		
+	def self.clear_bst_threshold(conn)
+                url = form_url(conn, @cfg + '/bst/clear/threshold')
+                hdr = form_hdr(conn)
+                Rest.get(conn, url, hdr)
+        end
+	
+	# This API clear BST statistics.
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #
+        #  return: JSON response 		
+	def self.clear_bst_stats(conn)
+                url = form_url(conn, @cfg + '/bst/clear/statistics')
+                hdr = form_hdr(conn)
+                Rest.get(conn, url, hdr)
+        end
+	
+	# This API clears BST congestion drops.
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #
+        #  return: JSON response 		
+	def self.clear_bst_cgsn_ctrs(conn)
+                url = form_url(conn, @cfg + '/clear-cgsn-drop-counters')
+                hdr = form_hdr(conn)
+                Rest.get(conn, url, hdr)
+        end
+
+
+end
+
+
+
+
+

data/lib/cnos-rbapi/vlag.rb

@@ -0,0 +1,275 @@
+##
+## 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 Vlag class provides a class implementation and methods for managing the Vlags 
+## on the node. This class presents an abstraction
+## 
+
+class Vlag
+	@cfg  = '/nos/api/cfg/vlag'
+
+	# This API gets VLAG global configuration.
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #
+        #  return: JSON response 		
+        def self.get_vlag_conf(conn)
+                url = form_url(conn, @cfg)
+                hdr = form_hdr(conn)
+		Rest.get(conn, url, hdr)
+        end
+	
+	# This API updates VLAG global configuration.
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #  params - dictionary that requires the following format of key-value pairs
+        #  		{
+        #  		 	"status": "<status>",
+        #  		  	"tier_id": "<tier_id>",
+        #  		  	"priority": "<priority>",
+        #  		  	"auto_recover" : "<auto_recover>",
+        #  		  	"startup_delay": "<startup_delay>",
+        #  		}
+        #  description - 
+        #  status        :Whether the vLAG is enabled or disabled; one of enable, disable.
+        #  	          Default value; disable
+        #  tier_id       :vLAG tier ID value; an intger from 1‐512. Default value: 0.
+        #  priority      :vLAG priority value; an integer from 0‐65535. Default value: 0.
+        #  auto_recover  :Time interval, in seconds; an integer from 240‐3600. Default
+        #  		  value: 300.
+        #  startup_delay :Delay time, in seconds; an integer from 0‐3600. Default value: 120	
+        #
+        #  return: JSON response	
+	def self.update_vlag_conf(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 global VLAG information.
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #
+        #  return: JSON response 		
+	def self.get_global_vlag(conn)
+		temp = @cfg.dup
+		temp.sub! 'cfg' , 'info'
+                url = form_url(conn, temp)
+                hdr = form_hdr(conn)
+		Rest.get(conn, url, hdr)
+        end
+	
+	# This API gets VLAG Inter Switch Link Information.
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #
+        #  return: JSON response 		
+	def self.get_vlag_isl(conn)
+		temp = @cfg.dup
+		temp.sub! 'cfg' , 'info'
+                url = form_url(conn, temp + '/isl')
+                hdr = form_hdr(conn)
+		Rest.get(conn, url, hdr)
+        end
+	
+	# This API configures the port aggregator for the VLAG ISL.
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #  params - dictionary that requires the following format of key-value pairs
+        #  		{
+        #  			 "port_aggregator": ʺ<port_aggregator>ʺ
+        #  		}
+        #  description -
+        #  port_aggregator :Port aggregator for the vLAG ISL. 
+        #
+        #  return: JSON response
+	def self.update_vlag_isl(conn, params)
+                url = form_url(conn, @cfg + '/isl')
+                hdr = form_hdr(conn)
+                params = params.to_json
+		Rest.put(conn, url, hdr, params)
+        end
+	
+	# This API gets VLAG health check information.
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #
+        #  return: JSON response 		
+	def self.get_vlag_health(conn)
+                temp = @cfg.dup
+                temp.sub! 'cfg' , 'info'
+                url = form_url(conn, temp + '/health_check')
+                hdr = form_hdr(conn)
+		Rest.get(conn, url, hdr)
+        end
+	
+	# This API configures the VLAG health check parameters
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #  params - dictionary that requires the following format of key-value pairs
+        #  		{
+        #  			  "peer_ip": "<peer_ip>",
+        #  			  "vrf": "<vrf>",
+        #  			  “retry_interval": "<retry_interval>",
+        #  			  "keepalive_attempts" : "<keepalive_attempts>",
+        #  			  "keepalive_interval" : "<keepalive_interval>",ʺ
+        #  		}
+        #  description -
+        #  peer_ip            :IP address of peer switch. This can be the management IP address
+        #  		       of the peer switch.
+        #  vrf                :VRF context string.
+        #  retry_interval     :Time interval, in seconds; an integer from 1‐300. Default value:
+        # 		       30.
+        #  keepalive_attempts :Number of keepalive attempts made before declaring the peer is
+        #  		       down; an integer from 1‐24. Default value: 3.
+        #  keepalive_interval :Time interval, in seconds; an integer from 2‐300. Default value: 5	
+        #  
+        #  return: JSON response
+	def self.update_vlag_health(conn, params)
+                url = form_url(conn, @cfg + '/health_check')
+                hdr = form_hdr(conn)
+                params = params.to_json
+		Rest.put(conn, url, hdr, params)
+        end
+	
+	# This API creates a VLAG instance.
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #  params - dictionary that requires the following format of key-value pairs
+        #  		{
+        #  			  "inst_id": "<inst_id>",
+        #  			  "port_aggregator": "<port_aggregator>",
+        #  			  "status": "<status>",
+        #  		}
+        #  description -
+        #  inst_id          :vLAG instance ID number; an integer from 1‐64.
+        #  port_ aggregator :LAG identifier; an integer from 1‐4096.
+        #  status           : vLAG status; one of enable, disable. Default value: disable.
+        #
+        #  return: JSON response
+	def self.create_vlag_inst(conn, params)
+                url = form_url(conn, @cfg + '/instance')
+                hdr = form_hdr(conn)
+                params = params.to_json
+		Rest.post(conn, url, hdr, params)
+
+        end
+
+	# This API updates VLAG instance.
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #  inst_id - Vlan instance ID number 
+        #  params - dictionary that requires the following format of key-value pairs
+        #  		{
+        #  			  "port_aggregator": "<port_aggregator>",
+        #  			  "status": "<status>",
+        #  		}
+        #  description -
+        #  port_ aggregator :LAG identifier; an integer from 1‐4096.
+        #  status           : vLAG status; one of enable, disable. Default value: disable.
+        #
+        #  return: JSON response
+	def self.update_vlag_inst(conn, inst_id, params)
+                url = form_url(conn, @cfg + '/instance/' + inst_id.to_s)
+                hdr = form_hdr(conn)
+                params = params.to_json
+		Rest.post(conn, url, hdr, params)
+
+        end
+
+	# This API deletes a  Vlag Instance.
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #  inst_id - Vlag instance ID number 
+        #
+        # return: JSON response
+	def self.delete_vlag_inst(conn, inst_id)
+		url = form_url(conn, @cfg + '/instance/' + inst_id.to_s)
+		hdr = form_hdr(conn)
+		Rest.delete(conn, url, hdr)
+        end
+	
+	# This API gets configuration paramteres for the specified VLAG instance.
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #  inst_id - Vlag instance ID number
+        #
+        #  return: JSON response 		
+	def self.get_vlag_inst_confg(conn, inst_id)
+                url = form_url(conn, @cfg + '/instance/' + inst_id.to_s)
+                hdr = form_hdr(conn)
+		Rest.get(conn, url, hdr)
+        end
+       
+	# This API gets configuration paramteres for all  VLAG instance.
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #
+        #  return: JSON response 		
+	def self.get_all_vlag(conn)
+                url = form_url(conn, @cfg + '/instance')
+                hdr = form_hdr(conn)
+		Rest.get(conn, url, hdr)
+        end
+
+	# This API get information about a VLAG instance.
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #  inst_id - Vlag instance ID number
+        #
+        #  return: JSON response 		
+	def self.get_vlag_inst_info(conn, inst_id)
+		temp = @cfg.dup
+                temp.sub! 'cfg' , 'info'
+		url = form_url(conn, temp + '/instance/' + inst_id.to_s)
+                hdr = form_hdr(conn)
+		Rest.get(conn, url, hdr)
+        end
+	
+end