oneview-sdk 2.2.1 → 3.0.0

data/lib/oneview-sdk/resource/api200/volume_snapshot.rb

@@ -0,0 +1,50 @@
+# (C) Copyright 2016 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 API200
+    # Volume snapshot resource implementation
+    class VolumeSnapshot < Resource
+      BASE_URI = nil
+
+      # 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)
+        super
+        # Default values
+        @data['type'] ||= 'Snapshot'
+      end
+
+      # 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
+
+      # Sets the volume
+      # @param [OneviewSDK::Volume] volume Volume
+      def set_volume(volume)
+        volume.retrieve! unless volume['uri']
+        @data['storageVolumeUri'] = volume['uri']
+      end
+    end
+  end
+end

data/lib/oneview-sdk/resource/api200/volume_template.rb

@@ -0,0 +1,99 @@
+# (C) Copyright 2016 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 API200
+    # Volume template resource implementation
+    class VolumeTemplate < Resource
+      BASE_URI = '/rest/storage-volume-templates'.freeze
+
+      # Create the client object, establishes connection, and set up the logging and api version.
+      # @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 client.api_version if exists, or OneviewSDK::Client::DEFAULT_API_VERSION.
+      # Defaults type to StorageVolumeTemplate when API version is 120
+      # Defaults type to StorageVolumeTemplateV3 when API version is 200
+      def initialize(client, params = {}, api_ver = nil)
+        super
+        # Default values:
+        @data['provisioning'] ||= {}
+        @data['type'] ||= 'StorageVolumeTemplateV3'
+      end
+
+      # Create the resource on OneView using the current data
+      # @note Calls refresh method to set additional data
+      # @raise [OneviewSDK::IncompleteResource] if the client is not set
+      # @raise [StandardError] if the resource creation fails
+      # @return [Resource] self
+      def create
+        ensure_client
+        response = @client.rest_post(self.class::BASE_URI, { 'Accept-Language' => 'en_US', 'body' => @data }, @api_version)
+        body = @client.response_handler(response)
+        set_all(body)
+      end
+
+      # Deletes the volume template from OneView
+      # @return [TrueClass] if the volume template was deleted successfully
+      def delete
+        ensure_client && ensure_uri
+        response = @client.rest_delete(@data['uri'], { 'Accept-Language' => 'en_US' }, @api_version)
+        @client.response_handler(response)
+        true
+      end
+
+      # Updates the volume template from OneView
+      # @return [Resource] self
+      def update(attributes = {})
+        set_all(attributes)
+        ensure_client && ensure_uri
+        response = @client.rest_put(@data['uri'], { 'Accept-Language' => 'en_US', 'body' => @data }, @api_version)
+        @client.response_handler(response)
+        self
+      end
+
+      # Sets the storage pool
+      # @param [Boolean] shareable
+      # @param [String] provisionType 'Thin' or 'Full'
+      # @param [String] capacity (in bytes)
+      # @param [OneviewSDK::StoragePool] storage_pool
+      def set_provisioning(shareable, provisionType, capacity, storage_pool)
+        @data['provisioning']['shareable'] = shareable
+        @data['provisioning']['provisionType'] = provisionType
+        @data['provisioning']['capacity'] = capacity
+        storage_pool.retrieve! unless storage_pool['uri']
+        @data['provisioning']['storagePoolUri'] = storage_pool['uri']
+      end
+
+      # Sets the storage system
+      # @param [OneviewSDK::StorageSystem] storage_system Storage System to be used to create the template
+      def set_storage_system(storage_system)
+        storage_system.retrieve! unless storage_system['uri']
+        @data['storageSystemUri'] = storage_system['uri']
+      end
+
+      # Sets the snapshot pool
+      # @param [OneviewSDK::StoragePool] storage_pool Storage Pool to generate the template
+      def set_snapshot_pool(storage_pool)
+        storage_pool.retrieve! unless storage_pool['uri']
+        @data['snapshotPoolUri'] = storage_pool['uri']
+      end
+
+      # Gets the connectable volume templates by its attributes
+      # @param [Hash] attributes Hash containing the attributes name and value
+      def get_connectable_volume_templates(attributes = {})
+        OneviewSDK::Resource.find_by(@client, attributes, BASE_URI + '/connectable-volume-templates')
+      end
+    end
+  end
+end

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

@@ -0,0 +1,66 @@
+# (c) Copyright 2016 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 v300
+  module API300
+    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 "API300 variant #{variant} is not supported!" unless SUPPORTED_VARIANTS.include?(variant)
+      new_type = type.to_s.downcase.gsub(/[ -_]/, '')
+      api_module = OneviewSDK::API300.const_get(variant)
+      api_module.constants.each do |c|
+        klass = api_module.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
+
+    # Get the current API300 variant
+    def self.variant
+      @variant
+    end
+
+    # Has the API300 variant been set by the user?
+    # @return [TrueClass, FalseClass]
+    def self.variant_updated?
+      @variant_updated
+    end
+
+    # Sets the API300 variant
+    def self.variant=(variant)
+      raise "API300 variant #{variant} is not supported!" unless SUPPORTED_VARIANTS.include?(variant)
+      @variant_updated = true
+      @variant = variant
+    end
+
+    # Helps redirect resources to the correct API300 variant
+    def self.const_missing(const)
+      api300_module = OneviewSDK::API300.const_get(@variant.to_s)
+      api300_module.const_get(const)
+    rescue NameError
+      raise NameError, "The #{const} method or resource does not exist for OneView API300 variant #{@variant}."
+    end
+  end
+end
+
+# Load all API300-specific resources:
+Dir[File.dirname(__FILE__) + '/api300/*.rb'].each { |file| require file }

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

@@ -0,0 +1,27 @@
+# (c) Copyright 2016 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 API300
+    # Module for API300 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::API300.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/api300/c7000/connection_template.rb

@@ -0,0 +1,30 @@
+# (c) Copyright 2016 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 '../../api200/connection_template'
+
+module OneviewSDK
+  module API300
+    module C7000
+      # Connection template resource implementation for API300 C7000
+      class ConnectionTemplate < OneviewSDK::API200::ConnectionTemplate
+
+        # Get the default network connection template
+        # @param [OneviewSDK::Client] client The client object for the OneView appliance
+        # @return [OneviewSDK::API300::C7000::ConnectionTemplate] Connection template
+        def self.get_default(client)
+          response = client.rest_get(BASE_URI + '/defaultConnectionTemplate')
+          OneviewSDK::API300::C7000::ConnectionTemplate.new(client, client.response_handler(response))
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,48 @@
+# (c) Copyright 2016 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 '../../api200/enclosure'
+
+module OneviewSDK
+  module API300
+    module C7000
+      # Enclosure resource implementation for API300 C7000
+      class Enclosure < OneviewSDK::API200::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'] ||= 'EnclosureV300'
+          super
+        end
+
+        # Update specific attributes of a given enclosure
+        # @param [String] operation Operation to be performed
+        # @param [String] path Path
+        # @param [String] value Value
+        def patch(operation, path, value = nil)
+          ensure_client && ensure_uri
+          body = if value
+                   { op: operation, path: path, value: value }
+                 else
+                   { op: operation, path: path }
+                 end
+          response = @client.rest_patch(@data['uri'], { 'body' => [body] }, @api_version)
+          @client.response_handler(response)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# (C) Copyright 2016 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 '../../api200/enclosure_group'
+
+module OneviewSDK
+  module API300
+    module C7000
+      # Enclosure group resource implementation on API300 C7000
+      class EnclosureGroup < OneviewSDK::API200::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 ||= {}
+          # Default values:
+          @data['type'] ||= 'EnclosureGroupV300'
+          @data['stackingMode'] ||= 'Enclosure'
+          @data['interconnectBayMappingCount'] ||= 8
+          create_interconnect_bay_mapping unless @data['interconnectBayMappings']
+          super
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# (C) Copyright 2016 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 '../../api200/ethernet_network'
+
+module OneviewSDK
+  module API300
+    module C7000
+      # Ethernet network resource implementation for API300 C7000
+      class EthernetNetwork < OneviewSDK::API200::EthernetNetwork
+
+        # 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['ethernetNetworkType'] ||= 'Tagged'
+          @data['type'] ||= 'ethernet-networkV300'
+          super
+        end
+
+      end
+    end
+  end
+end

data/lib/oneview-sdk/resource/api300/c7000/fabric.rb

@@ -0,0 +1,22 @@
+# (C) Copyright 2016 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 '../../api200/fabric'
+
+module OneviewSDK
+  module API300
+    module C7000
+      # Fabric resource implementation for API300 C7000
+      class Fabric < OneviewSDK::API200::Fabric
+      end
+    end
+  end
+end