hpe3par_sdk 1.0.0

data/lib/Hpe3parSdk/flash_cache_manager.rb

@@ -0,0 +1,54 @@
+# (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 'models'
+
+module Hpe3parSdk
+  # Adaptive Flash Cache Rest API methods
+  class FlashCacheManager
+    def initialize(http)
+      @http = http
+      @flash_cache_uri = '/flashcache'
+    end
+
+    def create_flash_cache(size_in_gib, mode)
+      flash_cache = { 'sizeGiB' => size_in_gib }
+
+      unless mode.nil?
+        mode = { 'mode' => mode }
+        flash_cache = Util.merge_hash(flash_cache, mode)
+      end
+
+      info = { 'flashCache' => flash_cache }
+      _response, body = @http.post('/', body: info)
+      body
+    end
+
+    def get_flash_cache
+      _response, body = @http.get(@flash_cache_uri)
+      FlashCache.new(body)
+    end
+
+    def flash_cache_exists?
+      begin
+        get_flash_cache
+        return true
+      rescue Hpe3parSdk::HTTPNotFound => ex
+        return false  
+      end
+    end
+
+    def delete_flash_cache
+      _response, _body = @http.delete(@flash_cache_uri)
+    end
+  end
+end

data/lib/Hpe3parSdk/host_manager.rb

@@ -0,0 +1,152 @@
+# (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'
+require_relative 'models'
+
+module Hpe3parSdk
+  # Host Manager Rest API methods
+  class HostManager
+    def initialize(http, vlun_query_supported = false)
+      @http = http
+      @vlun_query_supported = vlun_query_supported
+      @host_uri = '/hosts'
+    end
+
+    def get_hosts
+      response = @http.get(@host_uri)
+      host_members = []
+      response[1]['members'].each do |host_member|
+        host_members.push(Host.new(host_member)) if host_member.key?('name')
+      end
+      host_members
+    end
+
+    def get_host(name)
+      if name.nil? || name.strip.empty?
+        raise HPE3PARException.new(nil, 'Host name cannot be nil or empty')
+      else
+        response = @http.get("#{@host_uri}/#{name}")
+        Host.new(response[1])
+      end
+    end
+
+    def create_host(name, iscsi_names, fcwwns, optional)
+      info = { 'name' => name }
+
+      if !iscsi_names.nil? && !iscsi_names.empty?
+        iscsi = { 'iSCSINames' => iscsi_names }
+        info = Util.merge_hash(info, iscsi)
+      end
+
+      if !fcwwns.nil? && !fcwwns.empty?
+        fc = { 'FCWWNs' => fcwwns }
+        info = Util.merge_hash(info, fc)
+      end
+
+      if !optional.nil? && !optional.empty?
+        info = Util.merge_hash(info, optional)
+      end
+
+      response = @http.post(@host_uri, body: info)
+      response[1]
+    end
+
+    def modify_host(name, mod_request)
+      response = @http.put("#{@host_uri}/#{name}", body: mod_request)
+      response[1]
+    end
+
+    def delete_host(name)
+      response = @http.delete("#{@host_uri}/#{name}")
+      response[1]
+    end
+
+    def query_host_by_fc_path(wwn)
+      wwn_query = ''
+      if wwn
+        tmp_query = []
+        tmp_query.push("wwn==#{wwn}")
+        wwn_query = "FCPaths[#{tmp_query.join(' OR ')}]"
+      end
+
+      query = ''
+      query = wwn_query if !wwn_query.nil? && !wwn_query.empty?
+
+      query = %("#{query}")
+
+      response = @http.get("#{@host_uri}?query=#{query}")
+      if response[1] && response[1].include?('total') && response[1]['total'] > 0
+        return Host.new(response[1]['members'][0])
+      else
+        return nil
+      end
+    end
+
+    def query_host_by_iscsi_path(iqn)
+      iqn_query = ''
+      if iqn
+        tmp_query = []
+        tmp_query.push("name==#{iqn}")
+        iqn_query = "iSCSIPaths[#{tmp_query.join(' OR ')}]"
+      end
+
+      query = ''
+      query = iqn_query if !iqn_query.nil? && !iqn_query.empty?
+
+      query = %("#{query}")
+
+      response = @http.get("#{@host_uri}?query=#{query}")
+      if response[1] && response[1].include?('total') && response[1]['total'] > 0
+        return Host.new(response[1]['members'][0])
+      else
+        return nil
+      end
+    end
+
+    def get_host_vluns(host_name)
+      # calling getHost to see if the host exists and raise not found
+      # exception if it's not found.
+      get_host(host_name)
+
+      vluns = []
+      # Check if the WSAPI supports VLUN querying. If it is supported
+      # request only the VLUNs that are associated with the host.
+      if @vlun_query_supported
+        query = %("hostname EQ #{host_name}")
+        response = @http.get("/vluns?query=#{query}")
+        response[1]['members'].each do |vlun|
+          vluns.push(VLUN.new(vlun))
+        end
+      else
+        all_vluns = VlunManager.new(@http).get_vluns
+
+        if all_vluns
+          all_vluns.each do |vlun|
+            vluns.push(vlun) if !vlun.hostname.nil? && (vlun.hostname == host_name)
+          end
+        end
+      end
+      vluns
+    end
+
+    def host_exists?(host_name)
+      begin
+        get_host(host_name)
+        return true
+      rescue Hpe3parSdk::HTTPNotFound => ex
+        return false
+      end
+    end
+
+  end
+end

data/lib/Hpe3parSdk/host_set_manager.rb

@@ -0,0 +1,128 @@
+# (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'
+require_relative 'models'
+
+module Hpe3parSdk
+  # Host Set Manager Rest API methods
+  class HostSetManager
+    def initialize(http, host_and_vv_set_filter_supported = false)
+      @http = http
+      @host_set_uri = '/hostsets'
+      @host_set_filter_supported = host_and_vv_set_filter_supported
+    end
+
+    def get_host_sets
+      response = @http.get(@host_set_uri)
+      host_set_members = []
+      response[1]['members'].each do |host_set_member|
+        host_set_members.push(HostSet.new(host_set_member))
+      end
+      host_set_members
+    end
+
+    def get_host_set(name)
+      if name.nil? || name.strip.empty?
+        raise HPE3PARException.new(nil, 'HostSet name cannot be nil or empty')
+      else
+        response = @http.get("#{@host_set_uri}/#{name}")
+        HostSet.new(response[1])
+      end
+    end
+
+    def create_host_set(name, domain, comment, setmembers)
+      info = { 'name' => name }
+
+      info['domain'] = domain if domain
+
+      info['comment'] = comment if comment
+
+      if setmembers
+        members = { 'setmembers' => setmembers }
+        info = Util.merge_hash(info, members)
+      end
+
+      response = @http.post(@host_set_uri, body: info)
+      if response[0] && response[0].include?('location')
+        host_set_id = response[0]['location'].rpartition('/api/v1/hostsets/')[-1]
+        return host_set_id
+      else
+        return nil
+      end
+    end
+
+    def delete_host_set(name)
+      @http.delete("#{@host_set_uri}/#{name}")
+    end
+
+    def modify_host_set(name, action, setmembers, newName = nil, comment = nil)
+      info = {}
+
+      info['action'] = action if action
+
+      info['newName'] = newName if newName
+
+      info['comment'] = comment if comment
+
+      if setmembers
+        members = { 'setmembers' => setmembers }
+        info = Util.merge_hash(info, members)
+      end
+
+      response = @http.put("#{@host_set_uri}/#{name}", body: info)
+      response[1]
+    end
+
+    def add_hosts_to_host_set(set_name, setmembers)
+      modify_host_set(set_name, SetCustomAction::MEM_ADD, setmembers)
+    end
+
+    def remove_hosts_from_host_set(set_name, setmembers)
+      modify_host_set(set_name, SetCustomAction::MEM_REMOVE, setmembers)
+    end
+
+    def find_host_sets(host_name)
+      host_sets = []
+      if @host_set_filter_supported
+        query = %("setmembers EQ #{host_name}")
+        response = @http.get("#{@host_set_uri}?query=#{query}")
+        host_sets_list = response[1]['members']
+        host_sets_list.each do |host_set|
+          host_sets.push(HostSet.new(host_set))
+        end
+      else
+        host_sets_list = get_host_sets
+        host_sets_list.each do |host_set|
+          if !host_set.setmembers.nil? && !host_set.setmembers.empty? && host_set.setmembers.include?(host_name)
+            host_sets.push(host_set)
+          end
+        end
+      end
+      host_sets
+    end
+
+    def host_set_exists?(host_name)
+      begin
+        get_host_set(host_name)
+        return true
+      rescue Hpe3parSdk::HTTPNotFound => ex
+        return false
+      end
+    end
+
+    def host_in_host_set_exists?(set_name, host_name)
+    end   
+
+  end
+end

data/lib/Hpe3parSdk/http.rb

@@ -0,0 +1,164 @@
+# (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 'httparty'
+require 'json'
+require 'logger'
+require_relative 'exceptions'
+require_relative 'multi_log'
+require_relative 'util'
+
+module Hpe3parSdk
+  class HTTPJSONRestClient
+    USER_AGENT = 'ruby-3parclient'.freeze
+    SESSION_COOKIE_NAME = 'X-Hp3Par-Wsapi-Sessionkey'.freeze
+    CONTENT_TYPE = 'application/json'.freeze
+
+    attr_accessor :http_log_debug, :api_url, :session_key, :suppress_ssl_warnings, :timeout, :secure,
+                  :logger, :log_level
+
+    def initialize(api_url, secure = false, http_log_debug = false,
+                   suppress_ssl_warnings = false, timeout = nil)
+      @api_url = api_url
+      @secure = secure
+      @http_log_debug = http_log_debug
+      @suppress_ssl_warnings = suppress_ssl_warnings
+      @timeout = timeout
+      @session_key = nil
+      HTTParty::Logger.add_formatter('custom', CustomHTTPFormatter)
+      @httparty_log_level = :info
+      @httparty_log_format = :custom
+      set_debug_flag
+    end
+
+    # This turns on/off http request/response debugging output to console
+    def set_debug_flag
+      if @http_log_debug
+        @httparty_log_level = :debug
+        @httparty_log_format = :curl
+      end
+    end
+
+    def authenticate(user, password, _optional = nil)
+      begin
+        @session_key = nil
+
+        info = {:user => user, :password => password}
+
+        auth_url = '/credentials'
+        headers, body = post(auth_url, body: info)
+        @session_key = body['key']
+      rescue => ex
+        Util.log_exception(ex, caller_locations(1, 1)[0].label)
+      end
+    end
+
+    def set_url(api_url)
+      # should be http://<Server:Port>/api/v1
+      @api_url = api_url.chomp('/')
+    end
+
+    def get(url, **kwargs)
+      headers, payload = get_headers_and_payload(kwargs)
+      response = HTTParty.get(api_url + url,
+                              headers: headers,
+                              verify: secure, logger: Hpe3parSdk.logger,
+                              log_level: @httparty_log_level,
+                              log_format: @httparty_log_format)
+      process_response(response)
+    end
+
+    def post(url, **kwargs)
+      headers, payload = get_headers_and_payload(kwargs)
+      response = HTTParty.post(api_url + url,
+                               headers: headers,
+                               body: payload,
+                               verify: secure, logger: Hpe3parSdk.logger,
+                               log_level: @httparty_log_level,
+                               log_format: @httparty_log_format)
+      process_response(response)
+    end
+
+    def put(url, **kwargs)
+      headers, payload = get_headers_and_payload(kwargs)
+      response = HTTParty.put(api_url + url,
+                              headers: headers,
+                              body: payload,
+                              verify: secure, logger: Hpe3parSdk.logger,
+                              log_level: @httparty_log_level,
+                              log_format: @httparty_log_format)
+      process_response(response)
+    end
+
+    def delete(url, **kwargs)
+      headers, payload = get_headers_and_payload(kwargs)
+      response = HTTParty.delete(api_url + url,
+                                 headers: headers,
+                                 verify: secure, logger: Hpe3parSdk.logger,
+                                 log_level: @httparty_log_level,
+                                 log_format: @httparty_log_format)
+      process_response(response)
+    end
+
+    def process_response(response)
+      headers = response.headers
+      body = response.parsed_response
+
+      if response.code != 200
+        if !body.nil? && body.key?('code') && body.key?('desc')
+          exception = Hpe3parSdk.exception_from_response(response, body)
+          raise exception
+        end
+      end
+      [headers, body]
+    end
+
+    def 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
+
+    def unauthenticate
+      # delete the session on the 3Par
+      unless @session_key.nil?
+        begin
+          delete('/credentials/%s' % session_key)
+          @session_key = nil
+        rescue => ex
+          Util.log_exception(ex, caller_locations(1, 1)[0].label)
+        end
+      end
+    end
+
+    def get_headers_and_payload(**kwargs)
+      if session_key
+        kwargs['headers'] = kwargs.fetch('headers', {})
+        kwargs['headers'][SESSION_COOKIE_NAME] = session_key
+      end
+
+      kwargs['headers'] = kwargs.fetch('headers', {})
+      kwargs['headers']['User-Agent'] = USER_AGENT
+      kwargs['headers']['Accept'] = CONTENT_TYPE
+      if kwargs.key?(:body)
+        kwargs['headers']['Content-Type'] = CONTENT_TYPE
+        kwargs[:body] = kwargs[:body].to_json
+        payload = kwargs[:body]
+      else
+        payload = nil
+      end
+      [kwargs['headers'], payload]
+    end
+  end
+end
+