oneview-sdk 5.13.0 → 5.18.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, 600, 800, 1000, 1200, 1600].freeze
+  SUPPORTED_API_VERSIONS = [200, 300, 500, 600, 800, 1000, 1200, 1600, 1800, 2000, 2200, 2400].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/client.rb

@@ -35,7 +35,7 @@ module OneviewSDK
     # @option options [String] :domain ('LOCAL') The name of the domain directory used for authentication
     # @option options [String] :token (ENV['ONEVIEWSDK_TOKEN']) The token to use for authentication with OneView appliance
     #   Use the token or the username and password (not both). The token has precedence.
-    # @option options [Integer] :api_version (200) This is the API version to use by default for requests
+    # @option options [Integer] :api_version (1800) Appliance's max API version to be used by default for requests
     # @option options [Boolean] :ssl_enabled (true) Use ssl for requests? Respects ENV['ONEVIEWSDK_SSL_ENABLED']
     # @option options [Integer] :timeout (nil) Override the default request timeout value
     def initialize(options = {})
@@ -51,7 +51,7 @@ module OneviewSDK
       if options[:api_version] && options[:api_version].to_i > @max_api_version
         logger.warn "API version #{options[:api_version]} is greater than the appliance API version (#{@max_api_version})"
       end
-      @api_version = options[:api_version] || [OneviewSDK::DEFAULT_API_VERSION, @max_api_version].min
+      @api_version = options[:api_version] || @max_api_version
       # Set the default OneviewSDK module API version
       OneviewSDK.api_version = @api_version unless OneviewSDK.api_version_updated? || !OneviewSDK::SUPPORTED_API_VERSIONS.include?(@api_version)
       @ssl_enabled = true

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

@@ -0,0 +1,39 @@
+# (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 '../../resource'
+
+module OneviewSDK
+  # Module Image Streamer
+  module ImageStreamer
+    # Module API 2000
+    module API2000
+      # 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__) + '/api2000/*.rb'].each { |file| require file }

data/lib/oneview-sdk/image-streamer/resource/api2000/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 '../api1600/artifact_bundle'
+
+module OneviewSDK
+  module ImageStreamer
+    module API2000
+      # Artifact Bundle resource implementation for Image Streamer
+      class ArtifactBundle < OneviewSDK::ImageStreamer::API1600::ArtifactBundle
+      end
+    end
+  end
+end

data/lib/oneview-sdk/image-streamer/resource/api2000/build_plan.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 '../api1600/build_plan'
+
+module OneviewSDK
+  module ImageStreamer
+    module API2000
+      # Build Plan resource implementation for Image Streamer
+      class BuildPlan < OneviewSDK::ImageStreamer::API1600::BuildPlan
+      end
+    end
+  end
+end

data/lib/oneview-sdk/image-streamer/resource/api2000/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 '../api1600/deployment_group'
+
+module OneviewSDK
+  module ImageStreamer
+    module API2000
+      # Deployment Group resource implementation for Image Streamer
+      class DeploymentGroup < OneviewSDK::ImageStreamer::API1600::DeploymentGroup
+      end
+    end
+  end
+end

data/lib/oneview-sdk/image-streamer/resource/api2000/deployment_plan.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 '../api1600/deployment_plan'
+
+module OneviewSDK
+  module ImageStreamer
+    module API2000
+      # Deployment Plan resource implementation for Image Streamer
+      class DeploymentPlan < OneviewSDK::ImageStreamer::API1600::DeploymentPlan
+      end
+    end
+  end
+end

data/lib/oneview-sdk/image-streamer/resource/api2000/golden_image.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 '../api1600/golden_image'
+
+module OneviewSDK
+  module ImageStreamer
+    module API2000
+      # Golden Image resource implementation for Image Streamer
+      class GoldenImage < OneviewSDK::ImageStreamer::API1600::GoldenImage
+      end
+    end
+  end
+end

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

data/lib/oneview-sdk/image-streamer/resource/api2000/plan_script.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 '../api1600/plan_script'
+
+module OneviewSDK
+  module ImageStreamer
+    module API2000
+      # Plan Script resource implementation for Image Streamer
+      class PlanScript < OneviewSDK::ImageStreamer::API1600::PlanScript
+      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, 500, 600, 800, 1000, 1020, 1600].freeze
+    SUPPORTED_API_VERSIONS = [300, 500, 600, 800, 1000, 1020, 1600, 2000].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

@@ -30,7 +30,7 @@ module OneviewSDK
     # @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.
-    #   Defaults to the client.api_version if it exists, or the OneviewSDK::Client::DEFAULT_API_VERSION.
+    #   Defaults to the client.api_version if it exists, or  Appliance's max API version to be used by default for requests
     def initialize(client, params = {}, api_ver = nil)
       raise InvalidClient, 'Must specify a valid client'\
         unless client.is_a?(OneviewSDK::Client) || client.is_a?(OneviewSDK::ImageStreamer::Client)

data/lib/oneview-sdk/resource/api1600/synergy/scope.rb

@@ -9,13 +9,13 @@
 # CONDITIONS OF ANY KIND, either express or implied. See the License for the specific
 # language governing permissions and limitations under the License.
 
-require_relative '../../api1200/c7000/scope'
+require_relative '../c7000/scope'
 
 module OneviewSDK
   module API1600
     module Synergy
       # Scope resource implementation for API1600 Synergy
-      class Scope < OneviewSDK::API1200::C7000::Scope
+      class Scope < OneviewSDK::API1600::C7000::Scope
       end
     end
   end

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

@@ -0,0 +1,66 @@
+# (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.
+
+module OneviewSDK
+  # Module for API v1800
+  module API1800
+    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 "API1800 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::API1800.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 API1800 variant
+    def self.variant
+      @variant
+    end
+
+    # Has the API1800 variant been set by the user?
+    # @return [TrueClass, FalseClass]
+    def self.variant_updated?
+      @variant_updated
+    end
+
+    # Sets the API1800 variant
+    def self.variant=(variant)
+      raise "API1800 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 API1800 variant
+    def self.const_missing(const)
+      api1800_module = OneviewSDK::API1800.const_get(@variant.to_s)
+      api1800_module.const_get(const)
+    rescue NameError
+      raise NameError, "The #{const} method or resource does not exist for OneView API1800 variant #{@variant}."
+    end
+  end
+end
+
+# Load all API1800-specific resources:
+Dir[File.dirname(__FILE__) + '/api1800/*.rb'].each { |file| require file }

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

@@ -0,0 +1,27 @@
+# (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.
+
+module OneviewSDK
+  module API1800
+    # Module for API1800 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::API1800.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/api1800/c7000/connection_template.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 '../../api1600/c7000/connection_template'
+
+module OneviewSDK
+  module API1800
+    module C7000
+      # Connection template resource implementation for API1800 C7000
+      class ConnectionTemplate < OneviewSDK::API1600::C7000::ConnectionTemplate
+      end
+    end
+  end
+end

data/lib/oneview-sdk/resource/api1800/c7000/enclosure.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 '../../api1600/c7000/enclosure'
+
+module OneviewSDK
+  module API1800
+    module C7000
+      # Enclosure resource implementation for API1800 C7000
+      class Enclosure < OneviewSDK::API1600::C7000::Enclosure
+      end
+    end
+  end
+end

data/lib/oneview-sdk/resource/api1800/c7000/enclosure_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 '../../api1600/c7000/enclosure_group'
+
+module OneviewSDK
+  module API1800
+    module C7000
+      # Enclosure group resource implementation on API1800 C7000
+      class EnclosureGroup < OneviewSDK::API1600::C7000::EnclosureGroup
+      end
+    end
+  end
+end

data/lib/oneview-sdk/resource/api1800/c7000/ethernet_network.rb

@@ -0,0 +1,28 @@
+# (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 '../../api1600/c7000/ethernet_network'
+
+module OneviewSDK
+  module API1800
+    module C7000
+      # Ethernet network resource implementation for API1800 C7000
+      class EthernetNetwork < OneviewSDK::API1600::C7000::EthernetNetwork
+        # Bulk delete the ethernet networks
+        def self.bulk_delete(client, options)
+          response = client.rest_post(BASE_URI + '/bulk-delete', { 'body' => options }, client.api_version)
+          client.response_handler(response)
+          true
+        end
+      end
+    end
+  end
+end