test-oneview 5.18.0

data/lib/oneview-sdk/image-streamer/resource/api300/deployment_plan.rb

@@ -0,0 +1,33 @@
+# (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 'resource'
+
+module OneviewSDK
+  module ImageStreamer
+    module API300
+      # Deployment Plan resource implementation for Image Streamer
+      class DeploymentPlan < Resource
+        BASE_URI = '/rest/deployment-plans'.freeze
+
+        # Create a resource object, associate it with a client, and set its properties.
+        # @param [OneviewSDK::ImageStreamer::Client] client The client object for the Image Streamer 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)
+          super
+          # Default values:
+          @data['type'] ||= 'OEDeploymentPlan'
+        end
+      end
+    end
+  end
+end

data/lib/oneview-sdk/image-streamer/resource/api300/golden_image.rb

@@ -0,0 +1,89 @@
+# (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 'resource'
+
+module OneviewSDK
+  module ImageStreamer
+    module API300
+      # Golden Image resource implementation for Image Streamer
+      class GoldenImage < Resource
+        BASE_URI = '/rest/golden-images'.freeze
+        ACCEPTED_FORMATS = %w[.zip .ZIP].freeze # Supported upload extensions
+
+        # Create a resource object, associate it with a client, and set its properties.
+        # @param [OneviewSDK::ImageStreamer::Client] client The client object for the Image Streamer 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)
+          super
+          # Default values:
+          @data['type'] ||= 'GoldenImage'
+        end
+
+        # Download the details of the golden image capture logs which has been archived based on the specific attribute ID.
+        # @param [String] file_path
+        # @return [True] When was saved successfully
+        def download_details_archive(file_path)
+          ensure_client && ensure_uri
+          resp = @client.rest_api(:get, "#{BASE_URI}/archive/#{@data['uri'].split('/').last}")
+          File.open(file_path, 'wb') { |file| file.write(resp.body) }
+          true
+        end
+
+        # Downloads the content of the selected golden image to the specified file path.
+        # @param [String] file_path
+        # @param [Integer] timeout The number of seconds to wait for the request to complete
+        # @return [True] When it was saved successfully
+        def download(file_path)
+          ensure_client && ensure_uri
+          client.download_file("#{BASE_URI}/download/#{@data['uri'].split('/').last}", file_path)
+        end
+
+        # Upload a golden image from the specified local file path.
+        # Only the .zip format file can be used for upload.
+        # @param [OneviewSDK::ImageStreamer::Client] client The client object for the Image Streamer appliance
+        # @param [String] file_path
+        # @param [Hash] data_options Attributes of the golden image, passed in the request
+        # @option data_options [String] :name The name of the Golden Image (required)
+        # @option data_options [String] :description The description of the Golden Image (required)
+        # @param [Integer] timeout The number of seconds to wait for the request to complete
+        # @return [OneviewSDK::ImageStreamer::API300::GoldenImage] if the upload was successful, return a GoldenImage object
+        def self.add(client, file_path, data_options, timeout = OneviewSDK::Rest::READ_TIMEOUT)
+          data_options = Hash[data_options.map { |k, v| [k.to_s, v] }] # Convert symbols hash keys to string
+          raise InvalidFormat, 'ERROR: File with extension not supported!' unless ACCEPTED_FORMATS.include? File.extname(file_path)
+          raise IncompleteResource, 'Please set the name of the golden image!' unless data_options['name']
+          raise IncompleteResource, 'Please set the description of the golden image!' unless data_options['description']
+          data = client.upload_file(file_path, BASE_URI, { 'body' => data_options }, timeout)
+          GoldenImage.new(client, data)
+        end
+
+        # Sets the OS volume
+        # @param [OneviewSDK::ImageStreamer::API300::OSVolume] os_volume
+        # @raise [OneviewSDK::NotFound] if the os volume uri is not set and cannot be retrieved
+        def set_os_volume(os_volume)
+          os_volume.retrieve! unless os_volume['uri']
+          raise NotFound, 'The os volume was not found!' unless os_volume['uri']
+          set('osVolumeURI', os_volume['uri'])
+        end
+
+        # Sets the build plan
+        # @param [OneviewSDK::ImageStreamer::API300::BuildPlan] build_plan
+        # @raise [OneviewSDK::NotFound] if the build plan uri is not set and cannot be retrieved
+        def set_build_plan(build_plan)
+          build_plan.retrieve! unless build_plan['uri']
+          raise NotFound, 'The build plan was not found!' unless build_plan['uri']
+          set('buildPlanUri', build_plan['uri'])
+        end
+      end
+    end
+  end
+end

data/lib/oneview-sdk/image-streamer/resource/api300/os_volume.rb

@@ -0,0 +1,49 @@
+# (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 'resource'
+
+module OneviewSDK
+  module ImageStreamer
+    module API300
+      # OS Volume resource implementation for Image Streamer
+      class OSVolume < Resource
+        BASE_URI = '/rest/os-volumes'.freeze
+
+        # Method is not available
+        # @raise [OneviewSDK::MethodUnavailable] method is not available
+        def create(*)
+          unavailable_method
+        end
+
+        # Method is not available
+        # @raise [OneviewSDK::MethodUnavailable] method is not available
+        def update(*)
+          unavailable_method
+        end
+
+        # Method is not available
+        # @raise [OneviewSDK::MethodUnavailable] method is not available
+        def delete(*)
+          unavailable_method
+        end
+
+        # Get the details of the archived OS volume with the specified attribute.
+        # @return [Hash] The details of the archived OS volume with the specified attribute
+        def get_details_archive
+          ensure_client && ensure_uri
+          response = @client.rest_get("#{BASE_URI}/archive/#{data['uri'].split('/').last}")
+          @client.response_handler(response)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# (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 'resource'
+
+module OneviewSDK
+  module ImageStreamer
+    module API300
+      # Plan Script resource implementation for Image Streamer
+      class PlanScript < Resource
+        BASE_URI = '/rest/plan-scripts'.freeze
+
+        # Create a resource object, associate it with a client, and set its properties.
+        # @param [OneviewSDK::ImageStreamer::Client] client The client object for the Image Streamer 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)
+          super
+          # Default values:
+          @data['type'] ||= 'PlanScript'
+        end
+
+        # Retrieves the modified contents of the selected Plan Script as per the selected attributes.
+        # @return [Hash] The script differences of the selected Plan Script.
+        def retrieve_differences
+          ensure_client && ensure_uri
+          path = "#{BASE_URI}/differences/#{@data['uri'].split('/').last}"
+          response = @client.rest_post(path, { 'Content-Type' => 'none' }, @api_version)
+          @client.response_handler(response)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# (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 '../../../resource'
+
+module OneviewSDK
+  module ImageStreamer
+    module API300
+      class Resource < OneviewSDK::Resource
+      end
+    end
+  end
+end

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/artifact_bundle.rb

@@ -0,0 +1,22 @@
+# (C) Copyright 2020 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/artifact_bundle'
+
+module OneviewSDK
+  module ImageStreamer
+    module API500
+      # Artifact Bundle resource implementation for Image Streamer
+      class ArtifactBundle < OneviewSDK::ImageStreamer::API300::ArtifactBundle
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# (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/build_plan'
+
+module OneviewSDK
+  module ImageStreamer
+    module API500
+      # Build Plan resource implementation for Image Streamer
+      class BuildPlan < OneviewSDK::ImageStreamer::API300::BuildPlan
+        # Create a resource object, associate it with a client, and set its properties.
+        # @param [OneviewSDK::ImageStreamer::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'] ||= 'OeBuildPlanV5'
+          super
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# (C) Copyright 2020 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/deployment_group'
+
+module OneviewSDK
+  module ImageStreamer
+    module API500
+      # Deployment Group resource implementation for Image Streamer
+      class DeploymentGroup < OneviewSDK::ImageStreamer::API300::DeploymentGroup
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# (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/deployment_plan'
+
+module OneviewSDK
+  module ImageStreamer
+    module API500
+      # Deployment Plan resource implementation for Image Streamer
+      class DeploymentPlan < OneviewSDK::ImageStreamer::API300::DeploymentPlan
+
+        # Create a resource object, associate it with a client, and set its properties.
+        # @param [OneviewSDK::ImageStreamer::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'] ||= 'OEDeploymentPlanV5'
+          super
+        end
+
+        # Retrieves the Deployment Plan details as per the selected attributes.
+        # @return [Hash] The OS Deployment Plan.
+        def get_used_by
+          ensure_client && ensure_uri
+          path = "#{BASE_URI}/#{@data['uri'].split('/').last}/usedby/"
+          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/resource/api500/golden_image.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/golden_image'
+
+module OneviewSDK
+  module ImageStreamer
+    module API500
+      # Golden Image resource implementation for Image Streamer
+      class GoldenImage < OneviewSDK::ImageStreamer::API300::GoldenImage
+      end
+    end
+  end
+end

data/lib/oneview-sdk/image-streamer/resource/api500/os_volume.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/os_volume'
+
+module OneviewSDK
+  module ImageStreamer
+    module API500
+      # OS Volume resource implementation for Image Streamer
+      class OSVolume < OneviewSDK::ImageStreamer::API300::OSVolume
+      end
+    end
+  end
+end