lenovo-rbapi 0.0.1

data/lib/cnos-rbapi/mstp.rb

@@ -0,0 +1,214 @@
+##
+## 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 Mstp class provides a class implementation and methods for managing Mstp 
+## on the node. This class presents an abstraction
+## 
+
+class Mstp
+	@cfg  = '/nos/api/cfg/mstp'
+	# This API gets global MSTP properties of the system
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #
+        #  return: JSON response 		
+        def self.get_mstp_sys_prop(conn)
+                url = form_url(conn, @cfg)
+                hdr = form_hdr(conn)
+                Rest.get(conn, url, hdr)
+        end
+
+	# This API updates MSTP properties of the system
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #  params - dictionary that requires the following format of key-value pairs
+        #  		{
+        #  		  "region_name": "<region_name>"
+        #  		  "revision": "<revision>"
+        #  		}
+        #  description - 
+        #  region_name  :Region name; a string up to 32 characters long.
+        #  revision     :Revision number; an integer from 0‐65535.
+        #
+        #  return: JSON response 		
+	def self.update_mstp_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 properties of all MSTP instances
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #
+        #  return: JSON response 		
+	def self.get_mstp_inst_all(conn)
+                url = form_url(conn, @cfg + '_instance')
+                hdr = form_hdr(conn)
+                Rest.get(conn, url, hdr)
+        end
+
+	# This API creates an MSTP instance
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #  params - dictionary that requires the following format of key-value pairs
+        #  		{
+        #  		 "instance_id": "<instance_id>",
+        #  		  "instance_prio": "<instance_prio>",
+        #  		  "vlans": [
+        #  		    {
+        #  		      "vlan_id": "<vlan_id>"
+        #  		    }
+        #  		  ]
+        #  		}
+        #  description -
+        #  instance_id   :MST instance ID; an integer from 0‐64. Instance 0 refers to the
+        #  		  CIST.
+        #  instance_prio :Sets the instance bridge priority; an integer from 0‐61440. Default
+        #  		  value: 32768.
+        #  vlans         :Maps a range of VLANs to a multiple spanning tree instance
+        #  		  (MSTI); an integer from 1‐4094.
+        #
+        #  return: JSON response 		
+	def self.create_mstp_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 gets properties of an MSTP instance
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #
+        #  return: JSON response 		
+	def self.get_mstp_inst(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 updates the properties of an MSTP instance
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #  params - dictionary that requires the following format of key-value pairs
+        #  		{
+        #  		 "instance_id": "<instance_id>",
+        #  		  "instance_prio": "<instance_prio>",
+        #  		  "vlans": [
+        #  		    {
+        #  		      "vlan_id": "<vlan_id>"
+        #  		    }
+        #  		  ]
+        #  		}
+        #  description -
+        #  instance_id   :MST instance ID; an integer from 0‐64. Instance 0 refers to the
+        #  		  CIST.
+        #  instance_prio :Sets the instance bridge priority; an integer from 0‐61440. Default
+        #  		  value: 32768.
+        #  vlans         :Maps a range of VLANs to a multiple spanning tree instance
+        #  		  (MSTI); an integer from 1‐4094. 
+	#
+	#  return : JSON response
+	def self.update_mstp_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 an MSTP instance
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #
+        #  return: JSON response 		
+	def self.del_mstp_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 interface properties of an MSTP instance
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #  inst_id - instance id
+        #  intf - interface in the MSTP instance 
+        #
+        #  return: JSON response 		
+	def self.get_mstp_inst_intf(conn, inst_id, intf)
+		intf.sub! '/', '%2F'
+                url = form_url(conn, @cfg + '_instance/' + inst_id.to_s + '/' + intf )
+                hdr = form_hdr(conn)
+                Rest.get(conn, url, hdr)
+        end
+
+	# This API updates interface properties of an MSTP instance
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #  inst_id - instance id
+        #  intf - interface in the MSTP instance 
+        #  params - dictionary that requires the following format of key-value pairs
+        #  		{
+        #  		  "if_name": "<if_name>",
+        #  		  "path_cost": "<path_cost>",
+        #  		  "port_prio": "<port_prio>"
+        #  		}
+        #  description -
+        #  if_name    :Interface name.Note: The interface must exist.
+        #  path_cost  :The port path‐cost value on the specified MST instance; either an
+        #  		integer from 1‐200000000 or auto (default) to base the path‐cost
+        #  		on port speed.
+        #  port_prio  :The port priority, in increments of 32, on the specified MST
+        #  		instance; a multiple of 32 from 0‐224. Default value: 128.
+        #  return: JSON response
+	def self.update_mstp_inst_intf(conn, inst_id, intf, params)
+                intf.sub! '/', '%2F'
+                url = form_url(conn, @cfg + '_instance/' + inst_id.to_s + '/' + intf )
+                hdr = form_hdr(conn)
+		params = params.to_json
+                Rest.put(conn, url, hdr, params)
+
+        end
+
+end
+

data/lib/cnos-rbapi/rest_utils.rb

@@ -0,0 +1,111 @@
+##
+## 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'
+
+##
+## 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 GET request for the given url and switch connection.
+	#        
+	#              
+	# parameters:
+	# conn - connection object to the node
+	# url - URL for the GET request
+	# hdr - header paramters for the GET request
+	#                                                    
+	# return: JSON response
+	def self.get(conn, url, hdr)
+		begin
+                        resp = RestClient::Request.execute method: :get, url: url, headers: hdr, user: conn.getUser, password: conn.getPassword, timeout: 20 ,:verify_ssl => false
+                        response = JSON.parse(resp)
+                        response
+                rescue RestClient::ExceptionWithResponse => err
+                        puts err
+			puts err.response.match(/<p>(.+)<\/p>/)[1]
+
+                end
+	
+	end
+	
+	# This API performs PUT request for the given url and switch connection.
+	#        
+	#              
+	# parameters:
+	# conn - connection object to the node
+	# url - URL for the PUT request
+	# hdr - header paramters for the PUT request
+	# params - JSON body for POST request
+	#                                                    
+	# return: JSON response
+	def self.put(conn, url, hdr, params)
+		begin
+                        resp = RestClient::Request.execute method: :put, url: url, headers: hdr, payload: params, user: conn.getUser, password: conn.getPassword, timeout: 20 ,:verify_ssl => false
+                        response = JSON.parse(resp)
+                        response
+		rescue RestClient::ExceptionWithResponse => err
+                        puts err
+			puts err.response.match(/<p>(.+)<\/p>/)[1]
+                end
+
+	end
+	
+	# This API performs POST request for the given url and switch connection.
+	#        
+	#              
+	# parameters:
+	# conn - connection object to the node
+	# url - URL for the POST request
+	# hdr - header paramters for the POST request
+	# params - JSON body for POST request
+	#                                                    
+	# return: JSON response
+	def self.post(conn, url, hdr, params)
+		begin
+                        resp = RestClient::Request.execute method: :post, url: url, headers: hdr, payload: params, user: conn.getUser, password: conn.getPassword, timeout: 20 ,:verify_ssl => false
+                        response = JSON.parse(resp)
+                        response
+		rescue RestClient::ExceptionWithResponse => err
+                        puts err
+			puts err.response.match(/<p>(.+)<\/p>/)[1]
+
+
+                end	
+	end
+	
+	# This API performs DELETE request for the given url and switch connection.
+	#        
+	#              
+	# parameters:
+	# conn - connection object to the node
+	# url - URL for the DELETE request
+	# hdr - header paramters for the DELETE request
+	#                                                    
+	# return: JSON response
+	def self.delete(conn, url, hdr)
+		begin
+                        resp = RestClient::Request.execute method: :delete, url: url, headers: hdr, user: conn.getUser, password: conn.getPassword, timeout: 20 ,:verify_ssl => false
+                rescue RestClient::ExceptionWithResponse => err
+                        puts err
+			puts err.response.match(/<p>(.+)<\/p>/)[1]
+
+                end
+
+	end
+
+end

data/lib/cnos-rbapi/stp.rb

@@ -0,0 +1,93 @@
+##
+## 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 Stp class provides a class implementation and methods for managing the STP 
+## on the node. This class presents an abstraction
+## 
+
+class Stp
+	@cfg  = '/nos/api/cfg/stp/interface'
+	# This API gets STP properties of all interfaces.
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #
+        #  return: JSON response 		
+        def self.get_all_stp(conn)
+                url = form_url(conn, @cfg)
+                hdr = form_hdr(conn)
+		Rest.get(conn, url, hdr)
+        end
+	
+	# This API gets STP properties of one interface.
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #  intf - Interface name
+        #
+        #  return: JSON response 		
+	def self.get_stp_intf(conn, intf)
+		intf.sub! '/', '%2F'
+                url = form_url(conn, @cfg + '/' + intf)
+                hdr = form_hdr(conn)
+		Rest.get(conn, url, hdr)	
+        end
+
+
+	# This API updates STP properties of one interface.
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #  intf - Interface name
+        #  params - dictionary that requires the following format of key-value pairs
+        #  		{
+        #  			 "if_name":  "<if_name>",
+        #  			  "edge_port":  "<edge_port>",
+        #  			  "bpdu_guard":  "<bpdu_guard>",
+        #  			  "loop_guard":  "<loop_guard>",
+        #  			  "root_guard":  "<root_guard>"
+        # 		}
+        #  description -
+        #  if_name 	:The IP interface name; a string.
+        #  		 Note: The interface must exist.
+        #  edge_port 	:Whether the interface is configured as an edge port, which allows
+        #  		 the port to automatically transition to the STP forwarding state;
+        #  		 one of yes, no. Default value: yes.
+        #  bpdu_guard   :(Optional) Whether BPDU guard is enabled on a port, which
+        #  		 automatically shuts down the interface upon receipt of a BPDU;
+        #  		 one of enable, disable. Default value: disable.
+        #  loop_guard 	:(Optional) Whether look guard is enabled on a port for additional
+        #  		 checks for preventing STP looping; one of enable, disable.
+        # 		 Default value: disable.
+        #  root_guard 	:(Optional) Whether guard mode is set to root guard on interface
+        #
+        #  return: JSON response
+        def self.update_stp(conn, intf, params)
+		intf.sub! '/', '%2F'
+                url = form_url(conn, @cfg + '/' + intf)
+                hdr = form_hdr(conn)
+                params = params.to_json
+		Rest.put(conn, url, hdr, params)
+        end
+end

data/lib/cnos-rbapi/system.rb

@@ -0,0 +1,523 @@
+##
+## 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 System class provides a class implementation and methods for managing and setting up
+## images and config files on the node. This class presents an abstraction
+##
+
+
+class System
+	
+	@cfg  = '/nos/api'
+        # This API downloads a boot image to the switch
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #  params - dictionary that requires the following format of key-value pairs
+        #  		{
+        #  		  "protocol":"<protocol>",
+        #  		  "serverip":"<serverip>",
+        #  		  "srcfile":"<srcfile>",
+        #  		  "imgtype":"<imgtype>",
+        #  		  "username":"<username>",
+        #  		  "passwd":"<passwd>",
+        #  		  "vrf_name":"<vrf_name>"
+        #  		} 
+        #  description -
+        #  protocol :Protocol name; one of ʺtftpʺ, ʺsftpʺ.
+        #  serverip :Server IP address.
+        #  srcfile  :Source file; up to 256 characters long.
+        #  imgtype  :System image type; one of ʺallʺ, ʺbootʺ, ʺonieʺ, ʺosʺ.
+        #  username :Username for the server. Not required for TFTP.
+        #  passwd   :Password for the server username. Not required for TFTP.
+        #  vrf_name :(Optional) VRF name; an alphabetic string up to 64 characters long
+        # 
+        #  return: JSON response
+	def self.download_boot_img(conn, params)
+		temp = @cfg + '/download/image'
+                url = form_url(conn, temp)
+                hdr = form_hdr(conn)
+		params = params.to_json
+                Rest.post(conn, url, hdr, params)
+        end
+        
+	# This API updates the system startup image
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #  params - dictionary that requires the following format of key-value pairs
+        #  		{
+        #    		  “boot software” : “<setting>”
+        # 		}
+        #  description -
+        #  setting :Next startup image setting; one of “active” or “standby”
+        #  
+        #  return: JSON response 		
+        def self.put_startup_sw(conn, params)
+                temp = @cfg + '/startup/software'
+                url = form_url(conn, temp)
+                hdr = form_hdr(conn)
+		params = params.to_json
+                Rest.put(conn, url, hdr, params)
+        end
+	
+	# This API gets the system startup image.
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #
+        #  return: JSON response 		
+	def self.get_startup_sw(conn)
+		temp = @cfg + '/startup/software'
+                url = form_url(conn, temp)
+                hdr = form_hdr(conn)
+                Rest.get(conn, url, hdr)
+        end
+	
+	# This API resets the switch
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #
+        #  return: JSON response 		
+	def self.reset_switch(conn)
+                temp = @cfg + '/reset'
+                url = form_url(conn, temp)
+                hdr = form_hdr(conn)
+                Rest.get(conn, url, hdr)
+        end
+
+	
+	# This API downloads a configuration to the switch
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #  params - dictionary that requires the following format of key-value pairs
+        #  		{
+        #  		  "protocol":"<protocol>",
+        #  		  "serverip":"<serverip>",
+        #  		  "srcfile":"<srcfile>",
+        #  		  "dstfile":"<dstfile>",
+        #  		  "username":"<username>",
+        #  		  "passwd":"<passwd>",
+        #  		  "vrf_name":"<vrf_name>"
+        #  		}
+        #  description -
+        #  protocol :Protocol name; one of ʺtftpʺ, ʺsftpʺ.
+        #  serverip :Server IP address.
+        #  srcfile  :Source file; up to 256 characters long.
+        #  dstfile  :Destination file; one of 'running_config', 'startup_config'.
+        #  username :(Optional) Username for the server.
+        #  passwd   :(Optional) Password for the server username.
+        #  vrf_name :(Optional) VRF name; an alphabetic string up to 64 characters long
+        #
+        #  return: JSON response 			
+	def self.download_sw_config(conn, params)
+                temp = @cfg + '/download/config'
+                url = form_url(conn, temp)
+                hdr = form_hdr(conn)
+                params = params.to_json
+                Rest.post(conn, url, hdr, params)
+        end
+	
+	# This API saves the running configuration to the flash memory
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #
+        #  return: JSON response 			
+	def self.save_config(conn)
+                temp = @cfg + '/save/config'
+                url = form_url(conn, temp)
+                hdr = form_hdr(conn)
+                Rest.get(conn, url, hdr)
+        end
+
+	# This API uploads a configuration file from the switch to the server
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #  params - dictionary that requires the following format of key-value pairs
+        #  		{
+        #  		  "protocol":"<protocol>",
+        #  		  "serverip":"<serverip>",
+        #  		  "srcfile":"<srcfile>",
+        #  		  "dstfile":"<dstfile>",
+        #  		  "username":"<username>",
+        #  		  "passwd":"<passwd>",
+        #  		  "vrf_name":"<vrf_name>"
+        #  		}
+        #  description -
+        #  protocol :Protocol name; one of ʺtftpʺ, ʺsftpʺ.
+        #  serverip :Server IP address.
+        #  srcfile  :Source file; up to 256 characters long.
+        #  dstfile  :Destination file; one of 'running_config', 'startup_config'.
+        #  username :(Optional) Username for the server.
+        #  passwd   :(Optional) Password for the server username.
+        #  vrf_name :(Optional) VRF name; an alphabetic string up to 64 characters long
+        #
+        #  return: JSON response 			
+	def self.upload_sw_config(conn, params)
+                temp = @cfg + '/upload/config'
+                url = form_url(conn, temp)
+                hdr = form_hdr(conn)
+                params = params.to_json
+                Rest.post(conn, url, hdr, params)
+        end
+        
+	# This API uploads technical support information from the switch to the server
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #  params - dictionary that requires the following format of key-value pairs
+        #  		{
+        #  		  "protocol":"<protocol>",
+        #  		  "serverip":"<serverip>",
+        #  		  "dstfile":"<dstfile>",
+        #  		  "username":"<username>",
+        #  		  "passwd":"<passwd>",
+        #  		  "vrf_name":"<vrf_name>"
+        #  		}
+        #  description -
+        #  protocol :Protocol name; one of ʺtftpʺ, ʺsftpʺ.
+        #  serverip :Server IP address.
+        #  dstfile  :Destination file; one of 'running_config', 'startup_config'.
+        #  username :(Optional) Username for the server.
+        #  passwd   :(Optional) Password for the server username.
+        #  vrf_name :(Optional) VRF name; an alphabetic string up to 64 characters long
+        #
+        #  return: JSON response 		
+	def self.upload_tech_support(conn, params)
+                temp = @cfg + '/upload/tech_support'
+                url = form_url(conn, temp)
+                hdr = form_hdr(conn)
+                params = params.to_json
+                Rest.post(conn, url, hdr, params)
+        end
+
+	# This API gets the status of a downloading transfer.
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #  content - One of 'image', 'running_config', 'startup_config'
+        #  type - 'upload' or 'download'
+        #
+        #  return: JSON response 		
+	def self.get_transfer_status(conn, type, content)
+                temp = @cfg + '/' + type + '/status/' + content
+                url = form_url(conn, temp)
+                hdr = form_hdr(conn)
+                Rest.get(conn, url, hdr)
+        end
+	
+	# This API gets the hostname of the system
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #
+        #  return: JSON response 		
+	def self.get_hostname(conn)
+                temp = @cfg + '/cfg/hostname'
+                url = form_url(conn, temp)
+                hdr = form_hdr(conn)
+                Rest.get(conn, url, hdr)
+        end
+	
+	# This API sets the system boot image.
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #  params - dictionary that requires the following format of key-value pairs
+        #                  {
+        #                      "hostname":"<hostname>"
+        #                  }
+        #  description - 
+        #  hostname :The hostname of the system; a string from 1‐64 characters long                    
+        #
+        #  return: JSON response 		
+	def self.set_hostname(conn, params)
+                temp = @cfg + '/cfg/hostname'
+                url = form_url(conn, temp)
+                hdr = form_hdr(conn)
+		params = params.to_json
+                Rest.put(conn, url, hdr, params)
+        end
+
+	# This API gets the date of the system
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #
+        #  return: JSON response 		
+	def self.get_clock(conn)
+                temp = @cfg + '/cfg/clock'
+                url = form_url(conn, temp)
+                hdr = form_hdr(conn)
+                Rest.get(conn, url, hdr)
+        end
+
+	# This API sets the system date.
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #  params - dictionary that requires the following format of key-value pairs
+        #                  {
+        #                    	"time": "<HH:MM:SS>" ,
+        #                    	"day": <day>,
+        #                    	"month": <month> ,
+        #                    	"year": <year>
+        #                  }
+        #  description - 
+        #  time  :System time in the format ʺHH:MM:SSʺ.
+        #  day   :The day of the month; an integer from 1‐31.
+        #  month :The month; one of the following case‐insensitive strings:
+        #   January
+        #   February
+        #   March
+        #   April
+        #   May
+        #   June
+        #   July
+        #   August
+        #   September
+        #   October
+        #   November
+        #   December
+        #  year  :The year; an integer from 2000‐2030.
+        #
+        #  return: JSON response 		
+        def self.set_clock(conn, params)
+                temp = @cfg + '/cfg/clock'
+                url = form_url(conn, temp)
+                hdr = form_hdr(conn)
+                params = params.to_json
+                Rest.put(conn, url, hdr, params)
+        end
+
+	# This API sets the clock format to 12 hour or 24 hour format.
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #  params - dictionary that requires the following format of key-value pairs
+        #                  {
+        #                  	 "format": <format>
+        #                  }
+        #  description - 
+        #  format :System clock format; one of:
+        #   		12 (12 hour format)
+        #   		24 (24 hour format)
+        #
+        #   return: JSON response                
+	def self.set_clock_format(conn, params)
+                temp = @cfg + '/cfg/clock/format/'
+                url = form_url(conn, temp)
+                hdr = form_hdr(conn)
+                params = params.to_json
+                Rest.put(conn, url, hdr, params)
+        end
+
+	# This API sets the protocol to either manual or Network Time Protocol.
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #  params - dictionary that requires the following format of key-value pairs
+        #                  {
+        #                  	 "protocol": "<protocol>"
+        #                  }
+        # description -
+        # protocol :System clock protocol; one of:
+        #           none ‐ the clock is manually configured
+        #           ntp ‐ the clock is configured through NTP
+        # 	    Default value: “ntp”. 
+        #
+	# return: JSON response
+	def self.set_clock_protocol(conn, params)
+                temp = @cfg + '/cfg/clock/protocol/'
+                url = form_url(conn, temp)
+                hdr = form_hdr(conn)
+                params = params.to_json
+                Rest.put(conn, url, hdr, params)
+        end
+
+	# This API sets the clock time zone for the switch
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #  params - dictionary that requires the following format of key-value pairs
+        #                  {
+        #                  	 ""timezone": "<timezone>",
+        #                  	  "offsethour": "<offsethour>",
+        #                  	  "offsetmin": "<lag_mode>",
+        #                  }
+        # description -
+        # timezone   :One to five letter string denoting the local system time zone.
+        # offsethour :Hours offset from UTC; an integer from ‐23 through 23.
+        # offsetmin  :Minutes offset from UTC; an integer from 0‐59. 
+        #
+	# return: JSON response          
+	def self.set_clock_timezone(conn, params)
+                temp = @cfg + '/cfg/clock/timezone/'
+                url = form_url(conn, temp)
+                hdr = form_hdr(conn)
+                params = params.to_json
+                Rest.put(conn, url, hdr, params)
+        end
+	
+	# This API gets the device contact.
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #
+        #  return: JSON response
+	def self.get_device_contact(conn)
+                temp = @cfg + '/cfg/contact'
+                url = form_url(conn, temp)
+                hdr = form_hdr(conn)
+                Rest.get(conn, url, hdr)
+        end
+
+	# This API updates the device contact.
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #  params - dictionary that requires the following format of key-value pairs
+        #                  {
+        #                  	  "contact": <contact>
+        #                  }
+        #  description - 
+        #  contact   :Device contact; a string up to 256 characters long
+        #
+        #  return: JSON response
+        def self.set_device_contact(conn, params)
+                temp = @cfg + '/cfg/contact'
+                url = form_url(conn, temp)
+                hdr = form_hdr(conn)
+                params = params.to_json
+                Rest.put(conn, url, hdr, params)
+        end
+
+	# This API gets the device descr.
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #
+        #  return: JSON response
+	def self.get_device_descr(conn)
+                temp = @cfg + '/cfg/descr'
+                url = form_url(conn, temp)
+                hdr = form_hdr(conn)
+                Rest.get(conn, url, hdr)
+        end
+
+	# This API updates the device description.
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #  params - dictionary that requires the following format of key-value pairs
+        #                  {
+        #                  	  "descr": <descr>
+        #                  }
+        #  description - 
+        #  descr   :Device description; a string up to 256 characters long.
+        #
+        #  return: JSON response
+        def self.set_device_descr(conn, params)
+                temp = @cfg + '/cfg/descr'
+                url = form_url(conn, temp)
+                hdr = form_hdr(conn)
+                params = params.to_json
+                Rest.put(conn, url, hdr, params)
+        end
+
+	# This API set the transition to and from a summer time zone adjustment.
+        # 
+        # 
+        #  parameters:
+        #  conn - connection object to the node
+        #  params - dictionary that requires the following format of key-value pairs
+        #                  {
+        #                  	  "timezone": <time_zone>,
+        #                  	  "startweek": <start_week>,
+        #                  	  "startweekday": <start_weekday>,
+        #                  	  "startmonth": <start_month>,
+        #                  	  "starttime" :  "<HH:MM>",
+        #                  	  "endweek"   : <end_week>,
+        #                  	  "endweekday": <end_weekday>,
+        #                  	  "endmonth"  : <end_month>,
+        #                  	  "endtime"   :  “<HH:MM>”,
+        #                  	  "offsetmin" : <minutes>
+        #                  }
+        #  description -
+        #  timezone     :Local time zone of the system; a three to five character
+        #  		 string such as ʺPSTʺ, ʺMSTʺ, ʺCSTʺ, or ʺESTʺ.
+        #  startweek    :Week number in the month in which to start Daylight
+        #  		 Saving time; an integer from 1‐5 (first week=1, last
+        #  		 week=5).
+        #  startweekday :Weekday on which to start DST; one of the following
+        #  		 case‐insensitive strings:
+        #   		 monday - sunday
+        #  startmonth   :Month to start DST; one of the following
+        #   		 case‐insensitive strings:
+        #   		 january - december
+        #  starttime    :Time to start DST; a string in the format ʺHH:MMʺ.
+        #   		 endweek Week number in which to end DST; an integer from
+        #                1‐5 (first week=1, last week=5).
+        #  endweekday   :Weekday on which to end DST; one of the following
+        #   	         case‐insensitive strings:
+        #   		 monday - sunday
+        #  endmonth     :Month in which DST ends; one of the following
+        # 	         case‐insensitive strings:
+        #   		 january - december
+        #  endtime      :Time to end DST; a string in the format ʺHH:MMʺ
+        #  offsetmin    :Offset to add, in minutes; an integer from 1‐1440.
+        #
+	#  return: JSON response
+	def self.set_clock_summertime(conn, params)
+                temp = @cfg + '/cfg/clock/summertime'
+                url = form_url(conn, temp)
+                hdr = form_hdr(conn)
+                params = params.to_json
+                Rest.put(conn, url, hdr, params)
+        end
+
+
+end