oneview-sdk 5.3.0 → 5.4.0

data/lib/oneview-sdk.rb

@@ -26,7 +26,7 @@ module OneviewSDK
   env_i3s = %w[I3S_URL I3S_SSL_ENABLED]
   ENV_VARS = env_sdk.concat(env_i3s).freeze
 
-  SUPPORTED_API_VERSIONS = [200, 300, 500].freeze
+  SUPPORTED_API_VERSIONS = [200, 300, 500, 600].freeze
   DEFAULT_API_VERSION = 200
   @api_version = DEFAULT_API_VERSION
   @api_version_updated = false # Whether or not the API version has been set by the user

data/lib/oneview-sdk/image-streamer/resource/api500.rb

@@ -0,0 +1,39 @@
+# (c) Copyright 2018 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 '../../resource'
+
+module OneviewSDK
+  # Module Image Streamer
+  module ImageStreamer
+    # Module API 500
+    module API500
+      # Get resource class that matches the type given
+      # @param [String] type Name of the desired class type
+      # @param [String] variant There is only 1 variant for this module, so this is not used.
+      #   It exists only so that the parameters match API modules that do have multiple variants.
+      # @return [Class] Resource class or nil if not found
+      def self.resource_named(type, _variant = nil)
+        new_type = type.to_s.downcase.gsub(/[ -_]/, '')
+        constants.each do |c|
+          klass = const_get(c)
+          next unless klass.is_a?(Class) && klass < OneviewSDK::Resource
+          name = klass.name.split('::').last.downcase.delete('_').delete('-')
+          return klass if new_type =~ /^#{name}[s]?$/
+        end
+        nil
+      end
+    end
+  end
+end
+
+# Load all API-specific resources:
+Dir[File.dirname(__FILE__) + '/api500/*.rb'].each { |file| require file }

data/lib/oneview-sdk/image-streamer/resource/api500/plan_script.rb

@@ -0,0 +1,22 @@
+# (C) Copyright 2018 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 '../api300/plan_script'
+
+module OneviewSDK
+  module ImageStreamer
+    module API500
+      # Plan Script resource implementation for Image Streamer
+      class PlanScript < OneviewSDK::ImageStreamer::API300::PlanScript
+      end
+    end
+  end
+end

data/lib/oneview-sdk/image-streamer/resource/api600.rb

@@ -0,0 +1,39 @@
+# (c) Copyright 2018 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 '../../resource'
+
+module OneviewSDK
+  # Module Image Streamer
+  module ImageStreamer
+    # Module API 600
+    module API600
+      # Get resource class that matches the type given
+      # @param [String] type Name of the desired class type
+      # @param [String] variant There is only 1 variant for this module, so this is not used.
+      #   It exists only so that the parameters match API modules that do have multiple variants.
+      # @return [Class] Resource class or nil if not found
+      def self.resource_named(type, _variant = nil)
+        new_type = type.to_s.downcase.gsub(/[ -_]/, '')
+        constants.each do |c|
+          klass = const_get(c)
+          next unless klass.is_a?(Class) && klass < OneviewSDK::Resource
+          name = klass.name.split('::').last.downcase.delete('_').delete('-')
+          return klass if new_type =~ /^#{name}[s]?$/
+        end
+        nil
+      end
+    end
+  end
+end
+
+# Load all API-specific resources:
+Dir[File.dirname(__FILE__) + '/api600/*.rb'].each { |file| require file }

data/lib/oneview-sdk/image-streamer/resource/api600/plan_script.rb

@@ -0,0 +1,31 @@
+# (C) Copyright 2018 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 '../api500/plan_script'
+
+module OneviewSDK
+  module ImageStreamer
+    module API600
+      # Plan Script resource implementation for Image Streamer
+      class PlanScript < OneviewSDK::ImageStreamer::API500::PlanScript
+
+        # Retrieves the read only artifacts of the selected Plan Script as per the selected attributes.
+        # @return [Hash] The readonly artifacts of the selected Plan Script.
+        def retrieve_read_only
+          ensure_client && ensure_uri
+          path = "#{BASE_URI}/#{@data['uri'].split('/').last}/usedby/readonly"
+          response = @client.rest_get(path, { 'Content-Type' => 'none' }, @api_version)
+          @client.response_handler(response)
+        end
+      end
+    end
+  end
+end

data/lib/oneview-sdk/image_streamer.rb

@@ -19,7 +19,7 @@ Dir[File.dirname(__FILE__) + '/image-streamer/resource/*.rb'].each { |file| requ
 module OneviewSDK
   # Module for interacting with the Image Streamer
   module ImageStreamer
-    SUPPORTED_API_VERSIONS = [300].freeze
+    SUPPORTED_API_VERSIONS = [300, 500, 600].freeze
     DEFAULT_API_VERSION = 300
     @api_version = DEFAULT_API_VERSION
     @api_version_updated = false # Whether or not the API version has been set by the user

data/lib/oneview-sdk/resource.rb

@@ -341,6 +341,7 @@ module OneviewSDK
         words.map!(&:capitalize!)
         words[0] = words.first.downcase
         new_key = words.join
+        v = "'" + v.join(',') + "'" if v.is_a?(Array) && v.any?
         v.retrieve! if v.respond_to?(:retrieve!) && !v['uri']
         if v.class <= OneviewSDK::Resource
           new_key = new_key.concat('Uri')
@@ -351,6 +352,16 @@ module OneviewSDK
       query_path.sub('?&', '?')
     end
 
+    # Make a GET request to the resource base uri, query parameters and returns an array with all objects of this type
+    # @param [OneviewSDK::Client] client The client object for the OneView appliance
+    # @param [Hash] query The query options for the request (key-value pairs)
+    # @param [Hash] header The header options for the request (key-value pairs)
+    # @return [Array<Resource>] Results
+    def self.get_all_with_query(client, query = nil)
+      query_uri = build_query(query) if query
+      find_with_pagination(client, "#{self::BASE_URI}/#{query_uri}")
+    end
+
     protected
 
     # Fail unless @client is set for this resource.

data/lib/oneview-sdk/resource/api600.rb

@@ -0,0 +1,66 @@
+# (c) Copyright 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 OneviewSDK
+  # Module for API v600
+  module API600
+    SUPPORTED_VARIANTS = %w[C7000 Synergy].freeze
+    DEFAULT_VARIANT = 'C7000'.freeze
+    @variant = DEFAULT_VARIANT
+    @variant_updated = false # Whether or not the API variant has been set by the user
+
+    # Get resource class that matches the type given
+    # @param [String] type Name of the desired class type
+    # @param [String] variant Variant (C7000 or Synergy)
+    # @return [Class] Resource class or nil if not found
+    def self.resource_named(type, variant = @variant)
+      raise "API600 variant '#{variant}' is not supported! Try one of #{SUPPORTED_VARIANTS}" unless SUPPORTED_VARIANTS.include?(variant.to_s)
+      new_type = type.to_s.downcase.gsub(/[ -_]/, '')
+      api_module = OneviewSDK::API600.const_get(variant)
+      api_module.constants.each do |c|
+        klass = api_module.const_get(c)
+        next unless klass.is_a?(Class)
+        name = klass.name.split('::').last.downcase.delete('_').delete('-')
+        return klass if new_type =~ /^#{name}[s]?$/
+      end
+      nil
+    end
+
+    # Get the current API600 variant
+    def self.variant
+      @variant
+    end
+
+    # Has the API600 variant been set by the user?
+    # @return [TrueClass, FalseClass]
+    def self.variant_updated?
+      @variant_updated
+    end
+
+    # Sets the API600 variant
+    def self.variant=(variant)
+      raise "API600 variant '#{variant}' is not supported! Try one of #{SUPPORTED_VARIANTS}" unless SUPPORTED_VARIANTS.include?(variant)
+      @variant_updated = true
+      @variant = variant
+    end
+
+    # Helps redirect resources to the correct API600 variant
+    def self.const_missing(const)
+      api600_module = OneviewSDK::API600.const_get(@variant.to_s)
+      api600_module.const_get(const)
+    rescue NameError
+      raise NameError, "The #{const} method or resource does not exist for OneView API600 variant #{@variant}."
+    end
+  end
+end
+
+# Load all API600-specific resources:
+Dir[File.dirname(__FILE__) + '/api600/*.rb'].each { |file| require file }

data/lib/oneview-sdk/resource/api600/c7000.rb

@@ -0,0 +1,27 @@
+# (c) Copyright 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 OneviewSDK
+  module API600
+    # Module for API600 C7000
+    module C7000
+      # Get resource class that matches the type given
+      # @param [String] type Name of the desired class type
+      # @return [Class] Resource class or nil if not found
+      def self.resource_named(type)
+        OneviewSDK::API600.resource_named(type, 'C7000')
+      end
+    end
+  end
+end
+
+# Load all API-specific resources:
+Dir[File.dirname(__FILE__) + '/c7000/*.rb'].each { |file| require file }

data/lib/oneview-sdk/resource/api600/c7000/client_certificate.rb

@@ -0,0 +1,22 @@
+# (C) Copyright 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 '../../api300/c7000/client_certificate'
+
+module OneviewSDK
+  module API600
+    module C7000
+      # Client certificate resource implementation for API600 C7000
+      class ClientCertificate < OneviewSDK::API300::C7000::ClientCertificate
+      end
+    end
+  end
+end

data/lib/oneview-sdk/resource/api600/c7000/connection_template.rb

@@ -0,0 +1,22 @@
+# (c) Copyright 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 '../../api500/c7000/connection_template'
+
+module OneviewSDK
+  module API600
+    module C7000
+      # Connection template resource implementation for API600 C7000
+      class ConnectionTemplate < OneviewSDK::API500::C7000::ConnectionTemplate
+      end
+    end
+  end
+end

data/lib/oneview-sdk/resource/api600/c7000/datacenter.rb

@@ -0,0 +1,22 @@
+# (c) Copyright 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 '../../api300/c7000/datacenter'
+
+module OneviewSDK
+  module API600
+    module C7000
+      # Datacenter resource implementation for API600 C7000
+      class Datacenter < OneviewSDK::API300::C7000::Datacenter
+      end
+    end
+  end
+end

data/lib/oneview-sdk/resource/api600/c7000/enclosure.rb

@@ -0,0 +1,71 @@
+# (c) Copyright 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 '../../api500/c7000/enclosure'
+
+module OneviewSDK
+  module API600
+    module C7000
+      # Enclosure resource implementation for API600 C7000
+      class Enclosure < OneviewSDK::API500::C7000::Enclosure
+        # Create a resource object, associate it with a client, and set its properties.
+        # @param [OneviewSDK::Client] client The client object for the OneView appliance
+        # @param [Hash] params The options for this resource (key-value pairs)
+        # @param [Integer] api_ver The api version to use when interracting with this resource.
+        def initialize(client, params = {}, api_ver = nil)
+          @data ||= {}
+          # Default values:
+          @data['type'] ||= 'EnclosureListV7'
+          super
+        end
+
+        # Generate certificate signing request for the logical enclosure
+        # @raise [OneviewSDK::IncompleteResource] if the client is not set
+        # @raise [OneviewSDK::IncompleteResource] if the uri is not set
+        # @raise [StandardError] if the reapply fails
+        # @return [OneviewSDK::LogicalEnclosure] response
+        def create_csr_request(options, bay_number = nil)
+          ensure_client && ensure_uri
+          uri = "#{@data['uri']}/https/certificaterequest"
+          uri += "?bayNumber=#{bay_number}" if bay_number
+          response = @client.rest_post(uri, { 'body' => options }, @api_version)
+          @client.response_handler(response)
+        end
+
+        # Retrieve certificate signing request for the enclosure
+        # @raise [OneviewSDK::IncompleteResource] if the client is not set
+        # @raise [OneviewSDK::IncompleteResource] if the uri is not set
+        # @raise [StandardError] if the reapply fails
+        # @return [OneviewSDK::LogicalEnclosure] response
+        def get_csr_request(bay_number = nil)
+          ensure_client && ensure_uri
+          uri = "#{@data['uri']}/https/certificaterequest"
+          uri += "?bayNumber=#{bay_number}" if bay_number
+          response = @client.rest_get(uri, {}, @api_version)
+          @client.response_handler(response)
+        end
+
+        # Import certificate into the logical enclosure
+        # @raise [OneviewSDK::IncompleteResource] if the client is not set
+        # @raise [OneviewSDK::IncompleteResource] if the uri is not set
+        # @raise [StandardError] if the reapply fails
+        # @return [OneviewSDK::LogicalEnclosure] response
+        def import_certificate(options, bay_number = nil)
+          ensure_client && ensure_uri
+          uri = "#{@data['uri']}/https/certificaterequest"
+          uri += "?bayNumber=#{bay_number}" if bay_number
+          response = @client.rest_put(uri, options, @api_version)
+          @client.response_handler(response)
+        end
+      end
+    end
+  end
+end

data/lib/oneview-sdk/resource/api600/c7000/enclosure_group.rb

@@ -0,0 +1,39 @@
+# (C) Copyright 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 '../../api500/c7000/enclosure_group'
+
+module OneviewSDK
+  module API600
+    module C7000
+      # Enclosure group resource implementation on API600 C7000
+      class EnclosureGroup < OneviewSDK::API500::C7000::EnclosureGroup
+        # Create a resource object, associate it with a client, and set its properties.
+        # @param [OneviewSDK::Client] client The client object for the OneView appliance
+        # @param [Hash] params The options for this resource (key-value pairs)
+        # @param [Integer] api_ver The api version to use when interracting with this resource.
+        def initialize(client, params = {}, api_ver = nil)
+          @data ||= {}
+          super
+          @data.delete('type')
+          @data.delete('interconnectBayMappingCount')
+          @data.delete('stackingMode')
+        end
+
+        def update(attributes = {})
+          @data['type'] ||= 'EnclosureGroupV7'
+          @data['stackingMode'] ||= 'Enclosure'
+          super
+        end
+      end
+    end
+  end
+end