hpe3par_sdk 1.0.0

data/lib/Hpe3parSdk/multi_log.rb

@@ -0,0 +1,86 @@
+# (c) Copyright 2016-2017 Hewlett Packard Enterprise Development LP
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software distributed
+# under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+# CONDITIONS OF ANY KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations under the License.
+
+module Hpe3parSdk
+  #defined at the Module level. Can be accessed by all classes in the module
+  class << self
+    attr_accessor :logger
+  end
+
+  @logger = nil
+
+
+  class MultiLog
+    attr_reader :level
+
+    def initialize(args={})
+      @level = args[:level] || Logger::Severity::DEBUG
+      @loggers = []
+
+      Array(args[:loggers]).each { |logger| add_logger(logger) }
+    end
+
+    def add_logger(logger)
+      logger.level = level
+      logger.progname = 'ruby-3parclient'
+      @loggers << logger
+    end
+
+    def level=(level)
+      @level = level
+      @loggers.each { |logger| logger.level = level }
+    end
+
+    def close
+      @loggers.map(&:close)
+    end
+
+    def add(level, *args)
+      @loggers.each { |logger| logger.add(level, args) }
+    end
+
+    Logger::Severity.constants.each do |level|
+      define_method(level.downcase) do |*args|
+        @loggers.each { |logger| logger.send(level.downcase, args) }
+      end
+
+      define_method("#{ level.downcase }?".to_sym) do
+        @level <= Logger::Severity.const_get(level)
+      end
+    end
+  end
+
+  class CustomFormatter < Logger::Formatter #:nodoc:
+    def call(severity, datetime, progname, msg)
+      # msg2str is the internal helper that handles different msgs correctly
+      date_format = datetime.strftime('%Y-%m-%d %H:%M:%S%z')
+      "[#{date_format} ##{Process.pid}] [#{progname}] #{severity} -- : "+ msg.join($/) + "#{$/}"
+    end
+  end
+
+  class CustomHTTPFormatter #:nodoc:
+    attr_accessor :level, :logger, :current_time
+
+    def initialize(logger, level)
+      @logger = logger
+      @level  = level.to_sym
+    end
+
+    def format(request, response)
+      http_method    = request.http_method.name.split("::").last.upcase
+      path           = request.path.to_s
+      content_length = response.respond_to?(:headers) ? response.headers['Content-Length'] : response['Content-Length']
+      @logger.send @level, "[#{response.code} #{http_method} #{path} #{content_length || '-'} ]"
+    end
+  end
+
+
+end

data/lib/Hpe3parSdk/port_manager.rb

@@ -0,0 +1,62 @@
+# (c) Copyright 2016-2017 Hewlett Packard Enterprise Development LP
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software distributed
+# under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+# CONDITIONS OF ANY KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations under the License.
+
+require_relative 'util'
+require_relative 'constants'
+require_relative 'exceptions'
+
+module Hpe3parSdk
+  # Port Manager Rest API methods
+  class PortManager
+    def initialize(http)
+      @http = http
+      @ports_uri = '/ports'
+    end
+
+    def get_ports
+      ports_list = []
+      response = @http.get(@ports_uri)
+      response[1]['members'].each do |port|
+          ports_list.push(Port.new(port))
+      end
+      ports_list
+    end
+
+    def get_fc_ports(state)
+      get_protocol_ports(PortProtocol::FC, state)
+    end
+
+    def get_iscsi_ports(state)
+      get_protocol_ports(PortProtocol::ISCSI, state)
+    end
+
+    def get_ip_ports(state)
+      get_protocol_ports(PortProtocol::IP, state)
+    end
+
+    def get_protocol_ports(protocol, state = nil)
+      return_ports = []
+      ports = get_ports
+      if ports
+        ports.each do |port|
+          if port.protocol == protocol
+            if state.nil?
+              return_ports.push(port)
+            elsif port.linkState == state
+              return_ports.push(port)
+            end
+          end
+        end
+      end
+      return_ports
+    end
+  end
+end

data/lib/Hpe3parSdk/qos_manager.rb

@@ -0,0 +1,64 @@
+# (c) Copyright 2016-2017 Hewlett Packard Enterprise Development LP
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software distributed
+# under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+# CONDITIONS OF ANY KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations under the License.
+
+require_relative 'util'
+require_relative 'exceptions'
+
+module Hpe3parSdk
+  class QOSManager
+    def initialize(http)
+      @http = http
+    end
+
+    def query_qos_rules
+      response = @http.get('/qos')
+      qos_members = []
+      response[1]['members'].each do |qos_member|
+        qos_members.push(QoSRule.new(qos_member))
+        end
+      qos_members
+    end
+
+    def query_qos_rule(target_name, target_type)
+      response = @http.get("/qos/#{target_type}:#{target_name}")
+      QoSRule.new(response[1])
+    end
+
+   def qos_rule_exists?(target_name, target_type)
+      begin
+         query_qos_rule(target_name, target_type)
+         return true
+       rescue Hpe3parSdk::HTTPNotFound => ex
+         return false
+       end
+     end
+
+    def create_qos_rules(target_name, qos_rules, target_type)
+      info = { 'name' => target_name,
+               'type' => target_type }
+
+      info = Util.merge_hash(info, qos_rules)
+
+      response = @http.post('/qos', body: info)
+      response[1]
+    end
+
+    def modify_qos_rules(target_name, qos_rules, target_type)
+      response = @http.put("/qos/#{target_type}:#{target_name}", body: qos_rules)
+      response
+    end
+
+    def delete_qos_rules(target_name, target_type)
+      response = @http.delete("/qos/#{target_type}:#{target_name}")
+      response[1]
+    end
+  end
+end

data/lib/Hpe3parSdk/ssh.rb

@@ -0,0 +1,46 @@
+# (c) Copyright 2016-2017 Hewlett Packard Enterprise Development LP
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software distributed
+# under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+# CONDITIONS OF ANY KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations under the License.
+
+require 'net/ssh'
+require_relative 'exceptions'
+require 'logger'
+require_relative 'multi_log'
+
+module Hpe3parSdk
+  class SSH
+    
+    attr_accessor :ip, :username, :password, :port, :conn_timeout, :privatekey, :http_log_debug, :logger  
+  
+    def initialize(ip, username, password, port=nil, conn_timeout=nil, privatekey=nil)
+      @ip = ip
+      @username = username
+      @password = password
+      @port = port
+      @conn_timeout = conn_timeout
+      @privatekey = privatekey
+      @http_log_debug = http_log_debug
+    end
+    
+    def run(command)
+      begin
+        ssh = Net::SSH.start(@ip, @username, :password => @password)
+        cmd = "#{command} -csvtable -nohdtot"
+        Hpe3parSdk.logger.debug("Sending SSH command [#{cmd}]")
+        stdout, stederr = ssh.exec!(cmd)
+        ssh.close()
+        stdout
+      rescue Hpe3parSdk::HPE3PARException => ex
+        Hpe3parSdk.logger.error("(#{__method__}) #{ex.message}")
+      end
+    end 
+  end
+end
+

data/lib/Hpe3parSdk/task_manager.rb

@@ -0,0 +1,98 @@
+# (c) Copyright 2016-2017 Hewlett Packard Enterprise Development LP
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software distributed
+# under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+# CONDITIONS OF ANY KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations under the License.
+
+require_relative 'exceptions'
+require_relative 'models'
+
+module Hpe3parSdk
+  # Task Manager Rest API methods
+  class TaskManager
+    def initialize(http)
+      @http = http
+    end
+
+    def get_all_tasks
+      tasks = Array[]
+      response = @http.get('/tasks')
+      response[1]['members'].each do |member|
+        tasks.push(Task.new(member))
+      end
+      tasks
+    end
+
+    def get_task(task_id)
+      if task_id.is_a? Integer
+        response = @http.get("/tasks/#{task_id}")
+        Task.new(response[1])
+      else
+        raise Hpe3parSdk::HTTPBadRequest.new(
+            nil, "Task id '#{task_id}' is not of type integer"
+        )
+      end
+    end
+
+    def cancel_task(task_id)
+      if task_id.is_a? Integer
+        _body = Hash.new
+        _body['action'] = Hpe3parSdk::TaskAction::CANCEL_TASK
+        @http.put("/tasks/#{task_id}", body: _body)
+      else
+        raise HPE3PARException.new(
+            nil, "Task id #{task_id} is not of type integer"
+        )
+      end
+    end
+
+    def wait_for_task_to_end(task_id, poll_rate_secs)
+      _wait_for_task_to_end_loop(task_id, poll_rate_secs)
+    end
+
+    def _wait_for_task_to_end_loop(task_id, poll_rate_secs)
+      task = get_task(task_id)
+
+      while task != nil do #loop begin
+        state = task.status
+        if state == Hpe3parSdk::TaskStatus::DONE
+          break
+        end
+
+        if state == Hpe3parSdk::TaskStatus::CANCELLED
+          Hpe3parSdk.logger.info("Task #{task.task_id} was CANCELLED!!!")
+          break
+        end
+
+        if state == Hpe3parSdk::TaskStatus::FAILED
+          msg = "Task '#{task.task_id}' has FAILED!!!"
+          Hpe3parSdk.logger.info(msg)
+          raise Hpe3parSdk::HPE3PARException.new(message: msg)
+        end
+
+        if state == Hpe3parSdk::TaskStatus::ACTIVE
+          sleep(poll_rate_secs)
+          task = get_task(task.task_id);
+          Hpe3parSdk.logger
+              .info("Polling task #{task.task_id} current status: #{Hpe3parSdk::TaskStatus.get_string(task.status)}")
+        end
+
+      end #loop end
+
+      #Return the Task Result
+      if task != nil && task.status != nil && task.status == 'DONE'
+        return true
+
+      else
+        return false
+      end
+
+    end
+
+  end
+end

data/lib/Hpe3parSdk/tcl_parser.rb

@@ -0,0 +1,15 @@
+# (c) Copyright 2016-2017 Hewlett Packard Enterprise Development LP
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software distributed
+# under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+# CONDITIONS OF ANY KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations under the License.
+
+module Hpe3parSdk
+  class TCL_Parser
+  end
+end

data/lib/Hpe3parSdk/util.rb

@@ -0,0 +1,30 @@
+# (c) Copyright 2016-2017 Hewlett Packard Enterprise Development LP
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software distributed
+# under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+# CONDITIONS OF ANY KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations under the License.
+
+module Hpe3parSdk
+  class Util
+    def self.merge_hash(hash1, hash2)
+      raise TypeError, 'hash1 is not a hash' unless hash1.class == Hash
+      raise TypeError, 'hash2 is not a hash' unless hash2.class == Hash
+
+      hash3 = hash2.merge(hash1)
+      hash3
+    end
+
+    def self.log_exception(exception, caller_location)
+      formatted_stack_trace = exception.backtrace
+                                  .map { |line| "\t\tfrom #{line}" }
+                                  .join($/)
+      err_msg = "(#{caller_location}) #{exception}#{$/}  #{formatted_stack_trace}"
+      Hpe3parSdk.logger.error(err_msg)
+    end
+  end
+end

data/lib/Hpe3parSdk/version.rb

@@ -0,0 +1,14 @@
+# (c) Copyright 2016-2017 Hewlett Packard Enterprise Development LP
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software distributed
+# under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+# CONDITIONS OF ANY KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations under the License.
+
+module Hpe3parSdk
+  VERSION = '1.0.0'.freeze
+end

data/lib/Hpe3parSdk/vlun_manager.rb

@@ -0,0 +1,119 @@
+# (c) Copyright 2016-2017 Hewlett Packard Enterprise Development LP
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software distributed
+# under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+# CONDITIONS OF ANY KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations under the License.
+
+require_relative 'util'
+require_relative 'exceptions'
+
+module Hpe3parSdk
+  class VlunManager
+    def initialize(http, vlun_query_supported = false)
+      @http = http
+      @vlun_query_supported = vlun_query_supported
+    end
+
+    def create_vlun(volume_name, host_name, lun, port_pos, no_vcn, override_lower_priority, auto)
+      info = {}
+      info['volumeName'] = volume_name
+      info['lun'] = lun unless lun.nil?
+      info['hostname'] = host_name if host_name
+      info['portPos'] = port_pos if port_pos
+      info['noVcn'] = no_vcn if no_vcn
+      if override_lower_priority
+        info['overrideLowerPriority'] = override_lower_priority
+      end
+      if auto
+        info['autoLun'] = true
+        info['maxAutoLun'] = 0
+        info['lun'] = 0
+      end
+      response = @http.post('/vluns', body: info)
+      if response[0]
+        location = response[0]['location'].gsub!('/api/v1/vluns/', '')
+        return location
+      else
+        return nil
+      end
+    end
+    
+    def vlun_exists?(volume_name, lunid, hostname, port)
+       begin 
+         vlun_id = ''
+         if volume_name
+           vlun_id = volume_name
+         end
+         if lunid
+           vlun_id = vlun_id + ",#{lunid}"
+         end
+         if hostname
+           vlun_id = vlun_id + ',' + hostname
+         end
+         if port
+           if hostname.nil?
+             vlun_id = vlun_id + ","
+           end
+           vlun_id = vlun_id + ',' + "#{port[:node].to_s}:#{port[:slot].to_s}:#{port[:cardPort].to_s}"
+         end      
+         if (volume_name.nil? or volume_name.empty?) or lunid.nil? and (hostname.nil? or port.nil?)
+           raise HPE3PARException.new(nil, "Some or all parameters are missing : volume_name, lunid, hostname or port")
+         end
+        
+         @http.get("/vluns/#{vlun_id}")
+         return true
+       rescue Hpe3parSdk::HTTPNotFound => ex
+        return false
+        end
+     end
+     
+    def delete_vlun(volume_name, lun_id, host_name, port)
+      vlun = "#{volume_name},#{lun_id}"
+      vlun += ",#{host_name}" if host_name
+      if port
+        vlun += "," if host_name.nil?
+        vlun += ",#{port[:node]}:#{port[:slot]}:#{port[:cardPort]}"
+      end
+      response, body = @http.delete("/vluns/#{vlun}")
+    end
+
+    def get_vluns
+      response = @http.get('/vluns')
+      vluns_list=[]
+      response[1]['members'].each do |vlun_member|
+        vluns_list.push(VLUN.new(vlun_member))
+       end
+      vluns_list
+    end
+
+    def get_vlun(volume_name)
+      # This condition if true is untested
+      if volume_name.nil? || volume_name.strip.empty?
+        raise HPE3PARException.new(nil, "Invalid volume name #{volume_name}")
+      end
+      if @vlun_query_supported
+        query = %("volumeName EQ #{volume_name}")
+        response, body = @http.get("/vluns?query=#{query}")
+        # Return the first VLUN found for the volume.
+        if body.key?('members') && !body['members'].empty?
+          return VLUN.new(body['members'][0])
+        else
+          raise HTTPNotFound.new(nil, "No VLUNs for volumeName #{volume_name} found", nil, 404)
+        end
+      else
+        vluns = get_vluns
+        if vluns
+          vluns.each do |vlun|
+            return vlun if vlun.volume_name == volume_name
+          end
+        end
+        raise HTTPNotFound.new(nil, 'Vlun doesnt exist', nil, 404)
+      end
+    end
+  end
+end