test-oneview 5.18.0

data/lib/oneview-sdk/resource/api500/c7000/user.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/user'
+
+module OneviewSDK
+  module API500
+    module C7000
+      # User resource implementation for API500 C7000
+      class User < OneviewSDK::API300::C7000::User
+      end
+    end
+  end
+end

data/lib/oneview-sdk/resource/api500/c7000/version.rb

@@ -0,0 +1,23 @@
+# (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/version'
+
+module OneviewSDK
+  module API500
+    module C7000
+      # Version resource implementation for API500 C7000
+      class Version < OneviewSDK::API300::C7000::Version
+
+      end
+    end
+  end
+end

data/lib/oneview-sdk/resource/api500/c7000/volume.rb

@@ -0,0 +1,221 @@
+# (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/volume'
+
+module OneviewSDK
+  module API500
+    module C7000
+      # Volume resource implementation on API500 C7000
+      class Volume < OneviewSDK::API300::C7000::Volume
+
+        # Method is not available
+        # @raise [OneviewSDK::MethodUnavailable] method is not available.
+        def set_storage_system(*)
+          unavailable_method
+        end
+
+        # Creates the volume
+        # @note properties and templateUri parameters are required for creation, but not afterwards; after creation, they will be removed.
+        # @param [Hash] header The header options for the request (key-value pairs)
+        # @raise [OneviewSDK::IncompleteResource] if the client is not set.
+        # @raise [StandardError] if the resource creation fails.
+        # @return [Resource] self
+        def create(header = {})
+          properties = Hash[@data['properties'].map { |k, v| [k.to_sym, v] }]
+          family = properties[:dataProtectionLevel].nil? ? 'StoreServ' : 'StoreVirtual'
+          template_data = {
+            isRoot: true,
+            family: family
+          }
+          @data['templateUri'] = get_volume_template_uri(template_data) unless @data['templateUri']
+
+          OneviewSDK::Resource.instance_method(:create).bind(self).call(DEFAULT_REQUEST_HEADER.merge(header))
+          @data.delete('properties')
+          @data.delete('templateUri')
+          self
+        end
+
+        # Update resource attributes
+        # @param [Hash] attributes attributes to be updated
+        # @return [OneviewSDK::Volume] self
+        def update(attributes = {})
+          @data.delete('properties')
+          OneviewSDK::Resource.instance_method(:update).bind(self).call(attributes)
+        end
+
+        # Deletes the resource from OneView or from Oneview and storage system
+        # @param [Symbol] flag Delete storage system from Oneview only or in storage system as well.
+        #   Flags: :all = removes the volume from oneview and storage system. :oneview = removes from oneview only.
+        # @param [Hash] header The header options for the request (key-value pairs)
+        # @raise [InvalidResource] if an invalid flag is passed.
+        # @return [true] if resource was deleted successfully.
+        def delete(flag = :all, header = {})
+          ensure_client && ensure_uri
+          raise InvalidResource, 'Invalid flag value, use :oneview or :all' unless %i[oneview all].include?(flag)
+          uri = @data['uri']
+          uri << '?suppressDeviceUpdates=true' if flag == :oneview
+          response = @client.rest_delete(uri, DEFAULT_REQUEST_HEADER.merge(header).merge('If-Match' => @data['eTag']))
+          @client.response_handler(response)
+          true
+        end
+
+        # Sets the storage pool to the volume
+        # @param [OneviewSDK::StoragePool] storage_pool Storage pool.
+        # @note The storagePoolUri attribute should not be set in the updated. Once created, this attribute is read only.
+        def set_storage_pool(storage_pool)
+          assure_uri(storage_pool)
+          @data['properties'] ||= {}
+          @data['properties']['storagePool'] = storage_pool['uri']
+        end
+
+        # Sets the snapshot pool to the volume
+        # @param [OneviewSDK::StoragePool] storage_pool Storage Pool to use for snapshots.
+        def set_snapshot_pool(storage_pool)
+          assure_uri(storage_pool)
+          if @data['uri']
+            @data['deviceSpecificAttributes'] ||= {}
+            @data['deviceSpecificAttributes']['snapshotPoolUri'] = storage_pool['uri']
+          else
+            @data['properties'] ||= {}
+            @data['properties']['snapshotPool'] = storage_pool['uri']
+          end
+        end
+
+        # Creates a new volume on the storage system from a snapshot of a volume.
+        # @note Volumes can only be created on storage pools managed by the appliance.
+        # @param [String] snapshot_name The snapshot name.
+        # @param [Hash] properties Storage Pool to use for snapshots.
+        # @option properties [String] :provisioningType The provision type. Values: Full or Thin.
+        # @option properties [String] :name The name for new volume.
+        # @option properties [String] :isShareable Indicates whether or not the volume can be shared by multiple profiles.
+        # @param [OneviewSDK::VolumeTemplate] volume_template The Volume Template resource.
+        # @param [Boolean] is_permanent If true, indicates that the volume will persist when the profile using this volume is deleted.
+        # @raise [IncompleteResource] if the snapshot or volume template are not found.
+        # @return [OneviewSDK::Volume] The volume created.
+        def create_from_snapshot(snapshot_name, properties, volume_template = nil, is_permanent = true)
+          snapshot = get_snapshot(snapshot_name)
+          raise IncompleteResource, 'Snapshot not found!' unless snapshot
+          storage_pool_uri = nil
+          volume_template_uri = if volume_template.nil?
+                                  storage_pool_uri = @data['storagePoolUri']
+                                  get_volume_template_uri(isRoot: true, family: 'StoreServ')
+                                else
+                                  raise IncompleteResource, 'Volume Template not found!' unless volume_template.retrieve!
+                                  storage_pool_uri = volume_template['storagePoolUri']
+                                  volume_template['uri']
+                                end
+
+          data = {
+            'properties' => properties.merge('storagePool' => storage_pool_uri, 'snapshotPool' => storage_pool_uri),
+            'snapshotUri' => snapshot['uri'],
+            'templateUri' => volume_template_uri,
+            'isPermanent' => is_permanent
+          }
+
+          response = @client.rest_post("#{BASE_URI}/from-snapshot", { 'body' => data }, @api_version)
+          self.class.new(@client, client.response_handler(response))
+        end
+
+        # Initiates a process to import a volume (created external to OneView) for management by the appliance.
+        # @note Volumes can be added only on the storage system and storage pools managed by the appliance.
+        # @param [OneviewSDK::Client] client The client object for the OneView appliance.
+        # @param [OneviewSDK::StorageSystem] storage_system The storage system in which the volume exists to be managed.
+        # @param [String] volume_name The name of the volume on the actual storage system.
+        # @param [Boolean] is_shareable Describes if the volume is shareable or private.
+        # @param [Hash] options The options to create a volume.
+        # @option options [String] :name The name for new volume.
+        # @option options [String] :description The description for new volume.
+        # @raise [OneviewSDK::IncompleteResource] if storage system is not found
+        # @return [OneviewSDK::Volume] The volume imported.
+        # @deprecated Use {#add} instead.
+        def self.add(client, storage_system, volume_name, is_shareable = false, options = {})
+          raise IncompleteResource, 'Storage system not found!' unless storage_system.retrieve!
+          data = options.merge('storageSystemUri' => storage_system['uri'], 'deviceVolumeName' => volume_name, 'isShareable' => is_shareable)
+          response = client.rest_post("#{BASE_URI}/from-existing", { 'body' => data }, client.api_version)
+          new(client, client.response_handler(response))
+        end
+
+        # Initiates a process to import a volume (created external to OneView) for management by the appliance.
+        # @note Volumes can be added only on the storage system and storage pools managed by the appliance.
+        # @raise [OneviewSDK::IncompleteResource] if the client is not set or required attributes are missing
+        # @return [OneviewSDK::Volume] The volume imported.
+        def add
+          ensure_client
+          required_attributes = %w[deviceVolumeName isShareable storageSystemUri]
+          required_attributes.each { |k| raise IncompleteResource, "Missing required attribute: '#{k}'" unless @data.key?(k) || @data.key?(k.to_sym) }
+          @data['name'] ||= @data['deviceVolumeName']
+          response = @client.rest_post("#{BASE_URI}/from-existing", { 'body' => @data }, @api_version)
+          set_all(client.response_handler(response))
+          self
+        end
+
+        # Retrieve resource details based on this resource's name or URI.
+        # @note one of the UNIQUE_IDENTIFIERS, e.g. name or uri or properties['name'], must be specified in the resource
+        # @param [Hash] header The header options for the request (key-value pairs)
+        # @return [Boolean] Whether or not retrieve was successful
+        def retrieve!(header = {})
+          header = DEFAULT_REQUEST_HEADER.merge(header)
+          return super(header) unless @data['properties']
+          results = find_by_name_in_properties(header)
+          return false unless results.size == 1
+          set_all(results.first.data)
+          true
+        end
+
+        # Check if a resource exists
+        # @note one of the UNIQUE_IDENTIFIERS, e.g. name or uri or properties['name'], must be specified in the resource
+        # @param [Hash] header The header options for the request (key-value pairs)
+        # @return [Boolean] Whether or not resource exists
+        def exists?(header = {})
+          header = DEFAULT_REQUEST_HEADER.merge(header)
+          return super(header) unless @data['properties']
+          find_by_name_in_properties(header).size == 1
+        end
+
+        private
+
+        # Gets the storage volume template URI
+        # @param [Hash] template_data The data of storage volume template to filter the result
+        # @option options [Boolean] :isRoot True if storage volume template is root. False if not
+        # @option options [String] :family The family of storage volume template
+        # @return [String] the URI of storage volume template
+        def get_volume_template_uri(template_data)
+          storage_pool_uri = self['storagePoolUri'] || self['properties']['storagePool']
+          storage_pool = OneviewSDK::API500::C7000::StoragePool.new(@client, uri: storage_pool_uri)
+          raise 'StoragePool or snapshotPool must be set' unless storage_pool.retrieve!
+          storage_system = OneviewSDK::API500::C7000::StorageSystem.new(@client, uri: storage_pool['storageSystemUri'])
+          templates = storage_system.get_templates
+          template = templates.find { |item| item['isRoot'] == template_data[:isRoot] && item['family'] == template_data[:family] }
+          template['uri'] if template
+        end
+
+        # Generates the snapshot data
+        # @param [String] name The name of the snapshot
+        # @param [String] description The description of the snapshot
+        # @return [Hash] snapshot data
+        def generate_snapshot_data(name, description = nil)
+          { description: description, name: name }
+        end
+
+        # Gets the volume
+        # @param [Hash] header The header options for the request (key-value pairs)
+        # @raise [OneviewSDK::IncompleteResource] if the name parameter is not set
+        # @return [Array] the array of volumes
+        def find_by_name_in_properties(header)
+          name = @data['properties']['name'] || @data['properties'][:name]
+          raise IncompleteResource, 'Must set resource name within the properties before trying to retrieve!' unless name
+          self.class.find_by(@client, { 'name' => name }, BASE_URI, header)
+        end
+      end
+    end
+  end
+end

data/lib/oneview-sdk/resource/api500/c7000/volume_attachment.rb

@@ -0,0 +1,45 @@
+# (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/volume_attachment'
+
+module OneviewSDK
+  module API500
+    module C7000
+      # Storage Volume Attachment resource implementation for API500 C7000
+      class VolumeAttachment < OneviewSDK::API300::C7000::VolumeAttachment
+
+        # 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)
+          # Default values:
+          @data ||= {}
+          @data['type'] ||= @data[:type] || 'StorageVolumeAttachmentV2'
+          super
+        end
+
+        # Method is not available
+        # @raise [OneviewSDK::MethodUnavailable] method is not available
+        def get_paths
+          unavailable_method
+        end
+
+        # Method is not available
+        # @raise [OneviewSDK::MethodUnavailable] method is not available
+        def get_path(*)
+          unavailable_method
+        end
+      end
+    end
+  end
+end

data/lib/oneview-sdk/resource/api500/c7000/volume_snapshot.rb

@@ -0,0 +1,32 @@
+# (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/volume_snapshot'
+
+module OneviewSDK
+  module API500
+    module C7000
+      # Volume snapshot resource implementation for API500 C7000
+      class VolumeSnapshot < OneviewSDK::API300::C7000::VolumeSnapshot
+
+        # 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
+          # Removing the type property in API500
+          @data.delete('type')
+        end
+      end
+    end
+  end
+end

data/lib/oneview-sdk/resource/api500/c7000/volume_template.rb

@@ -0,0 +1,111 @@
+# (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 API500
+    module C7000
+      # Volume Template resource implementation for API500 C7000
+      class VolumeTemplate < Resource
+        BASE_URI = '/rest/storage-volume-templates'.freeze
+
+        # Delete resource from OneView
+        # @param [Hash] header The header options for the request (key-value pairs)
+        # @return [true] if resource was deleted successfully
+        def delete(header = {})
+          super(DEFAULT_REQUEST_HEADER.merge(header).merge('If-Match' => @data['eTag']))
+        end
+
+        # Sets the root template
+        # @param [VolumeTemplate] root_template The Volume Template resource
+        def set_root_template(root_template)
+          self['properties'] = root_template['properties'].clone
+          self['rootTemplateUri'] = root_template['uri']
+        end
+
+        # Sets the "locked" property of property passed to true or false
+        # @param [String] property The property for change value
+        # @param [Boolean] locked The value to set to "locked" property. Default: true.
+        # @raise [OneviewSDK::IncompleteResource] if the rootTemplateUri or properties are not set
+        def lock(property, locked = true)
+          verify_if_root_template_is_set!
+          self['properties'][property.to_s]['meta']['locked'] = locked
+        end
+
+        # Sets the "locked" property of property passed to false
+        # @param [String] property The property for change value
+        # @raise [OneviewSDK::IncompleteResource] if the rootTemplateUri or properties are not set
+        def unlock(property)
+          lock(property, false)
+        end
+
+        # Verify if property is locked
+        # @param [String] property The property
+        # @raise [OneviewSDK::IncompleteResource] if the rootTemplateUri or properties are not set
+        # @return [Boolean] true if property is locked or false if not
+        def locked?(property)
+          verify_if_root_template_is_set!
+          self['properties'][property.to_s]['meta']['locked']
+        end
+
+        # Sets the value of property
+        # @param [String] property The property for change value
+        # @param [Object] value The new value of property
+        # @raise [OneviewSDK::IncompleteResource] if the rootTemplateUri or properties are not set
+        def set_default_value(property, value)
+          verify_if_root_template_is_set!
+          value = value['uri'] if value.is_a?(Resource)
+          self['properties'][property.to_s]['default'] = value
+        end
+
+        # Gets the value of property
+        # @param [String] property The property to get value
+        # @raise [OneviewSDK::IncompleteResource] if the rootTemplateUri or properties are not set
+        # @return [Object] the default value of property
+        def get_default_value(property)
+          verify_if_root_template_is_set!
+          self['properties'][property.to_s]['default']
+        end
+
+        # Retrieves a collection of all storage systems that is applicable to this storage volume template
+        # @raise [OneviewSDK::IncompleteResource] if the client or the URI is not set
+        # @return [Array] collection of Storage Systems
+        def get_compatible_systems
+          ensure_client && ensure_uri
+          self.class.find_with_pagination(@client, self['compatibleStorageSystemsUri'])
+        end
+
+        # Gets the storage templates that are connected on the specified networks based on the storage system port's expected network connectivity.
+        # @param [OneviewSDK::Client] client The client object for the OneView appliance
+        # @param [Array] networks Set of networks to filter the storage templates connected
+        # @param [Hash] attributes Hash containing the attributes name and value to filter storage templates
+        # @return [Array] the collection of volume templates
+        def self.get_reachable_volume_templates(client, networks = [], attributes = {})
+          uri = self::BASE_URI + '/reachable-volume-templates'
+          unless networks.empty?
+            network_uris = networks.map { |item| item['uri'] }
+            uri += "?networks='#{network_uris.join(',')}'"
+          end
+          find_by(client, attributes, uri)
+        end
+
+        private
+
+        # Verify if rootTemplateUri or properties are set
+        # @raise [OneviewSDK::IncompleteResource] if the rootTemplateUri or properties were set set before
+        def verify_if_root_template_is_set!
+          raise IncompleteResource, 'Must set a valid root template' if self['rootTemplateUri'].nil? || self['properties'].nil?
+        end
+      end
+    end
+  end
+end