oneview-sdk 4.5.1 → 5.0.0

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

@@ -10,12 +10,52 @@
 # language governing permissions and limitations under the License.
 
 require_relative '../../api300/c7000/logical_enclosure'
+require_relative '../../../resource_helper'
 
 module OneviewSDK
   module API500
     module C7000
+      # Contains helper methods to include operation with firmware of a given logical enclosure resource
+      module FirmwareHelper
+        include ResourceHelper
+
+        # Updates  the firmware attributes of a given logical enclosure resource
+        # @param [Hash] attributes Hash with firmware attributes
+        # @option options [String] :firmwareUpdateOn Specifies the component types within the enclosure which has to be updated
+        # @option options [Boolean] :forceInstallFirmware Specifies whether the firmware operation to be carried forcefully or not
+        # @option options [String] :firmwareBaselineUri Firmware-drivers URI for the firmware bundle containing the baseline firmware
+        # @return [OneviewSDK::API500::C7000::LogicalEnclosure] self
+        def update_firmware(attributes = {})
+          patch('replace', '/firmware', attributes, 'If-Match' => @data['eTag'])
+          retrieve!
+          self
+        end
+      end
+
       # Logical Enclosure resource implementation on API500 C7000
       class LogicalEnclosure < OneviewSDK::API300::C7000::LogicalEnclosure
+        include OneviewSDK::API500::C7000::FirmwareHelper
+
+        # 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 delete(*)
+          unavailable_method
+        end
+
+        # Updates a logical enclosure
+        # @param [Hash] attributes attributes to be updated
+        # @return [OneviewSDK::API500::C7000::LogicalEnclosure] self
+        def update(attributes = {})
+          super(attributes)
+          retrieve!
+          self
+        end
       end
     end
   end

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

@@ -16,6 +16,16 @@ module OneviewSDK
     module C7000
       # Managed SAN resource implementation for API500 C7000
       class ManagedSAN < OneviewSDK::API300::C7000::ManagedSAN
+
+        # Set public attributes
+        # @param [Hash] attributes Public attributes
+        # @option attributes [String] :name
+        # @option attributes [String] :value
+        # @option attributes [String] :valueType
+        # @option attributes [String] :valueFormat
+        def set_public_attributes(attributes)
+          OneviewSDK::API200::ManagedSAN.instance_method(:set_public_attributes).bind(self).call(attributes)
+        end
       end
     end
   end

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

@@ -16,6 +16,55 @@ module OneviewSDK
     module C7000
       # Scope resource implementation for API500 C7000
       class Scope < OneviewSDK::API300::C7000::Scope
+        # 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.
+        #   Defaults to the client.api_version if it exists, or the OneviewSDK::Client::DEFAULT_API_VERSION.
+        def initialize(client, params = {}, api_ver = nil)
+          @data ||= {}
+          @data['type'] ||= 'ScopeV2'
+          super
+        end
+
+        # Modifies scope membership by adding or removing resource assignments
+        # @param [Array] resources The array of resources (or any number of resources separated by comma)
+        # @raise [OneviewSDK::IncompleteResource] if the client or uri is not set
+        def change_resource_assignments(add_resources: [], remove_resources: [])
+          if !add_resources.empty? || !remove_resources.empty?
+            ensure_uri && ensure_client
+            add_uris = ensure_and_get_uris(add_resources)
+            remove_uris = ensure_and_get_uris(remove_resources)
+            body = []
+
+            add_uris.each do |uri|
+              body << { 'op' => 'add', 'path' => '/addedResourceUris/-', 'value' => uri }
+            end
+            body << { 'op' => 'replace', 'path' => '/removedResourceUris', 'value' => remove_uris }
+
+            response = @client.rest_patch(@data['uri'], { 'Content-Type' => 'application/json-patch+json', 'body' => body }, @api_version)
+            @client.response_handler(response)
+          end
+          self
+        end
+
+        # Performs a specific patch operation for the given server.
+        # If the server supports the particular operation, the operation is performed
+        # and a response is returned to the caller with the results.
+        # @param [String] operation The operation to be performed
+        # @param [String] path The path of operation
+        # @param [String] value The value
+        # @note This attribute is subject to incompatible changes in future release versions, including redefinition or removal.
+        def patch(operation, path, value = nil)
+          ensure_client && ensure_uri
+          body = {
+            'op' => operation,
+            'path' => path,
+            'value' => value
+          }
+          response = @client.rest_patch(@data['uri'], { 'Content-Type' => 'application/json-patch+json', 'body' => [body] }, @api_version)
+          @client.response_handler(response)
+        end
       end
     end
   end

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

@@ -16,6 +16,26 @@ module OneviewSDK
     module C7000
       # Server Hardware resource implementation on API500 C7000
       class ServerHardware < OneviewSDK::API300::C7000::ServerHardware
+
+        # 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'] ||= 'server-hardware-7'
+          super
+        end
+
+        # Gets the information describing an 'SDX' partition including a list of physical server blades represented by a server hardware.
+        # @note Used with SDX enclosures only
+        # @return [Hash] Hash with the physical server hardware inventory
+        def get_physical_server_hardware
+          ensure_client && ensure_uri
+          response = @client.rest_get(@data['uri'] + '/physicalServerHardware')
+          @client.response_handler(response)
+        end
       end
     end
   end

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

@@ -14,6 +14,7 @@ require_relative '../../api300/c7000/server_hardware_type'
 module OneviewSDK
   module API500
     module C7000
+      # Server hardware type resource implementation for API500 C7000
       class ServerHardwareType < OneviewSDK::API300::C7000::ServerHardwareType
       end
     end

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

@@ -9,13 +9,72 @@
 # 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/server_profile'
+require_relative '../c7000/server_profile'
 
 module OneviewSDK
   module API500
     module C7000
       # Server Profile resource implementation on API500 C7000
       class ServerProfile < OneviewSDK::API300::C7000::ServerProfile
+
+        # 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 interacting with this resource.
+        def initialize(client, params = {}, api_ver = nil)
+          @data ||= {}
+          # Default values
+          @data['type'] ||= 'ServerProfileV7'
+          super
+        end
+
+        # Adds volume attachment entry and creates a new Volume associated in the Server profile
+        # @param [OneviewSDK::Volume] volume Volume Resource to add an attachment
+        # @param [Hash] volume_options Options to create a new Volume.
+        #   Please refer to OneviewSDK::Volume documentation for the data necessary to create a new Volume.
+        # @param [Hash] attachment_options Options of the new attachment
+        # @option attachment_options [Fixnum] 'id' The ID of the attached storage volume. Do not use it if you want it to be created automatically.
+        # @option attachment_options [String] 'lun' The logical unit number.
+        # @option attachment_options [String] 'lunType' The logical unit number type: Auto or Manual.
+        # @option attachment_options [Boolean] 'permanent' Required. If true, indicates that the volume will persist when the profile is deleted.
+        #   If false, then the volume will be deleted when the profile is deleted.
+        # @option attachment_options [Array] 'storagePaths' A list of host-to-target path associations.
+        # @return Returns the connection hash if found, otherwise returns nil
+        def create_volume_with_attachment(storage_pool, volume_options, attachment_options = {})
+          raise IncompleteResource, 'Storage Pool not found!' unless storage_pool.retrieve!
+          # Convert symbols keys to string in volume_options and attachment_options
+          volume_options = Hash[volume_options.map { |k, v| [k.to_s, v] }]
+          attachment_options = Hash[attachment_options.map { |k, v| [k.to_s, v] }]
+
+          self['sanStorage'] ||= {}
+          self['sanStorage']['volumeAttachments'] ||= []
+
+          attachment_options['id'] ||= 0
+          attachment_options['volumeStoragePoolUri'] = storage_pool['uri']
+          attachment_options['volumeStorageSystemUri'] = storage_pool['storageSystemUri']
+          attachment_options['volumeName'] = volume_options['name']
+          attachment_options['volumeDescription'] = volume_options['description']
+          attachment_options['volumeProvisionType'] = volume_options['provisioningType']
+          attachment_options['volumeProvisionedCapacityBytes'] = volume_options['size']
+
+          # Defaults
+          attachment_options['permanent'] ||= true
+          attachment_options['lunType'] ||= 'Auto'
+          attachment_options['lun'] ||= nil
+          attachment_options['storagePaths'] ||= []
+          attachment_options['volumeShareable'] = false
+
+          self['sanStorage']['manageSanStorage'] ||= true
+          self['sanStorage']['volumeAttachments'] << attachment_options
+        end
+
+        # Retrieves the profile template for a given server profile.
+        # @return Returns a ServerProfileTemplate instance
+        def get_profile_template
+          response = @client.rest_get("#{@data['uri']}/new-profile-template")
+          variant = self.class.name.split('::').at(-2)
+          OneviewSDK.resource_named('ServerProfileTemplate', @client.api_version, variant).new(client, @client.response_handler(response))
+        end
       end
     end
   end

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

@@ -16,6 +16,92 @@ module OneviewSDK
     module C7000
       # Server Profile Template resource implementation on API500 C7000
       class ServerProfileTemplate < OneviewSDK::API300::C7000::ServerProfileTemplate
+
+        # 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'] ||= 'ServerProfileTemplateV3'
+          super
+        end
+
+        # Adds a connection entry to server profile template
+        # @param [OneviewSDK::EthernetNetwork, OneviewSDK::FCNetwork] network Network associated with the connection
+        # @param [Hash<String,String>] connection_options Hash containing the configuration of the connection
+        # @option connection_options [Boolean] 'boot' Indicates that the server will attempt to boot from this connection.
+        # @option connection_options [String] 'functionType' Type of function required for the connection. Values: Ethernet, FibreChannel, iSCSI.
+        # @option connection_options [Integer] 'id' A unique identifier for this connection. If 0, id is automatically assigned.
+        # @option connection_options [String] 'ipv4' The IP information for a connection. This is only used for iSCSI connections.
+        # @option connection_options [String] 'name' Name of the connection.
+        # @option connection_options [String] 'portId' Identifies the port (FlexNIC) used for this connection.
+        # @option connection_options [String] 'requestedMbps' The transmit throughput (mbps) that should be allocated to this connection.
+        # @option connection_options [String] 'requestedVFs' This value can be "Auto" or 0.
+        def add_connection(network, connection_options = {})
+          connection_options = Hash[connection_options.map { |k, v| [k.to_s, v] }]
+          self['connectionSettings'] = {} unless self['connectionSettings']
+          self['connectionSettings']['connections'] = [] unless self['connectionSettings']['connections']
+          self['connectionSettings']['manageConnections'] = true
+          connection_options['id'] ||= 0
+          connection_options['networkUri'] = network['uri'] if network['uri'] || network.retrieve!
+          self['connectionSettings']['connections'] << connection_options
+        end
+
+        # Removes a connection entry in server profile template
+        # @param [String] connection_name Name of the connection
+        # @return Returns the connection hash if found, otherwise returns nil
+        def remove_connection(connection_name)
+          desired_connection = nil
+          return desired_connection unless self['connectionSettings']['connections']
+          self['connectionSettings']['connections'].each do |con|
+            desired_connection = self['connectionSettings']['connections'].delete(con) if con['name'] == connection_name
+          end
+          desired_connection
+        end
+
+        # Adds a volume attachment entry with new volume in Server profile template
+        # @param [OneviewSDK::storage_pool] storage_pool Storage Pool Resource to add an attachment
+        # @param [Hash] volume_options Options to create a new Volume.
+        # @option volume_options [String] 'volumeName' The name of the volume.
+        # @option volume_options [String] 'volumeDescription' The description of the storage volume.
+        # @option volume_options [String] 'volumeProvisionType' The provisioning type of the new volume: Thin", "Full", or "Thin Deduplication".
+        # @option volume_options [Integer] 'volumeProvisionedCapacityBytes' The requested provisioned capacity of the storage volume in bytes.
+        # @param [Hash] attachment_options Options of the new attachment
+        # @option attachment_options [String] 'associatedTemplateAttachmentId' Uniquely identifying of a volume attachment in a template.
+        # @option attachment_options [String] 'dataProtectionLevel' Values specific to a StoreVirtual storage.
+        # @option attachment_options [Integer] 'id' The ID of the storage volume attachment.
+        # @option attachment_options [Boolean] 'isBootVolume' Identifies whether the volume will be used as a boot volume.
+        # @option attachment_options [String] 'lun' Logical Unit Number.
+        # @option attachment_options [String] 'lunType' Type of the LUN. Values: Manual or Auto.
+        # @option attachment_options [Array] 'storagePaths' A list of host-to-target path associations.
+        # @return Returns the connection hash if found, otherwise returns nil
+        def create_volume_with_attachment(storage_pool, volume_options, attachment_options = {})
+          raise IncompleteResource, 'Storage Pool not found!' unless storage_pool.retrieve!
+          # Convert symbols keys to string in volume_options and attachment_options
+          volume_options = Hash[volume_options.map { |k, v| [k.to_s, v] }]
+          attachment_options = Hash[attachment_options.map { |k, v| [k.to_s, v] }]
+
+          self['sanStorage'] ||= {}
+          self['sanStorage']['volumeAttachments'] ||= []
+
+          attachment_options['id'] ||= 0
+          attachment_options['volumeStoragePoolUri'] = storage_pool['uri']
+          attachment_options['volumeStorageSystemUri'] = storage_pool['storageSystemUri']
+          attachment_options['volumeName'] = volume_options['name']
+          attachment_options['volumeDescription'] = volume_options['description']
+          attachment_options['volumeProvisionType'] = volume_options['provisioningType']
+          attachment_options['volumeProvisionedCapacityBytes'] = volume_options['size']
+
+          # Defaults
+          attachment_options['volumeUri'] = nil
+          attachment_options['permanent'] ||= true
+          attachment_options['volumeShareable'] = false
+          self['sanStorage']['manageSanStorage'] ||= true
+
+          self['sanStorage']['volumeAttachments'] << attachment_options
+        end
       end
     end
   end

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

@@ -9,13 +9,68 @@
 # 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/storage_pool'
+require_relative 'resource'
 
 module OneviewSDK
   module API500
     module C7000
       # Storage pool resource implementation for API500 C7000
-      class StoragePool < OneviewSDK::API300::C7000::StoragePool
+      class StoragePool < OneviewSDK::API500::C7000::Resource
+        BASE_URI = '/rest/storage-pools'.freeze
+
+        # 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'] ||= 'StoragePoolV3'
+        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 delete(*)
+          unavailable_method
+        end
+
+        # Gets the storage pools 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<Resource>] networks The list of networks with URI to be used as a filter
+        # @return [Array<OneviewSDK::StoragePool>] the list of storage pools
+        def self.reachable(client, networks = [])
+          uri = self::BASE_URI + '/reachable-storage-pools'
+          unless networks.empty?
+            network_uris = networks.map { |item| item['uri'] }
+            uri += "?networks='#{network_uris.join(',')}'"
+          end
+          find_with_pagination(client, uri)
+        end
+
+        # To manage/unmanage a storage pool
+        # @param [Boolean] be_managed Set true to manage or false to unmanage
+        # @note Storage Pool that belongs to Storage System with family StoreVirtual can't be changed to unmanaged
+        def manage(be_managed)
+          if !be_managed && self['family'] == 'StoreVirtual'
+            raise ArgumentError, 'Attempting to unmanage a StoreVirtual pool is not allowed'
+          end
+          self['isManaged'] = be_managed
+          update
+          refresh
+        end
+
+        # To request a refresh of a storage pool
+        def request_refresh
+          self['requestingRefresh'] = true
+          update
+          refresh
+        end
       end
     end
   end

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

@@ -16,6 +16,138 @@ module OneviewSDK
     module C7000
       # Storage System resource implementation for API500 C7000
       class StorageSystem < OneviewSDK::API300::C7000::StorageSystem
+        # deviceSpecificAttributes['serialNumber'] and deviceSpecificAttributes['wwn'] are supported too
+        UNIQUE_IDENTIFIERS = %w(name uri hostname).freeze
+
+        # 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'] ||= 'StorageSystemV4'
+          super
+        end
+
+        # Method is unavailable
+        # @raise [OneviewSDK::MethodUnavailable] method is not available
+        def get_managed_ports(*)
+          unavailable_method
+        end
+
+        # Method is unavailable
+        # @raise [OneviewSDK::MethodUnavailable] method is not available
+        def set_refresh_state(*)
+          unavailable_method
+        end
+
+        # Adds the resource to OneView using the current data
+        # @note Calls the refresh method to set additional data
+        # @return [OneviewSDK::StorageSystem] self
+        def add
+          ensure_client
+          temp_old_data = JSON.load(@data.to_json)
+          credentials = temp_old_data['credentials'] || {}
+          request_body = {
+            'family'   => @data['family'],
+            'hostname' => @data['hostname'],
+            'username' => @data.delete('username') || credentials['username'],
+            'password' => @data.delete('password') || credentials['password']
+          }
+          response = @client.rest_post(self.class::BASE_URI, { 'body' => request_body }, @api_version)
+          response_body = @client.response_handler(response)
+          set_all(response_body)
+
+          managed_domain = temp_old_data['deviceSpecificAttributes']['managedDomain'] rescue nil
+          if self['family'] == 'StoreServ' && managed_domain
+            deep_merge!(temp_old_data)
+            update
+          end
+          self
+        end
+
+        # Set data and save to OneView
+        # @param [Hash] attributes The attributes to add/change for this resource (key-value pairs)
+        # @raise [OneviewSDK::IncompleteResource] if the client or uri is not set
+        # @raise [StandardError] if the resource save fails
+        # @return [Resource] self
+        def update(attributes = {})
+          set_all(attributes)
+          ensure_client && ensure_uri
+          response = @client.rest_put(@data['uri'] + '/?force=true', { 'body' => @data }, @api_version)
+          @client.response_handler(response)
+          self
+        end
+
+        # Delete resource from OneView
+        # @return [true] if resource was deleted successfully
+        def remove
+          ensure_client && ensure_uri
+          response = @client.rest_delete(@data['uri'], { 'If-Match' => @data['eTag'] }, @api_version)
+          @client.response_handler(response)
+          true
+        end
+
+        # Checks if the resource already exists
+        # @return [Boolean] Whether or not resource exists
+        # @raise [OneviewSDK::IncompleteResource] if required attributes are not filled
+        def exists?
+          temp_item = self.class.new(@client, @data.clone)
+          temp_item.retrieve!
+        end
+
+        # Retrieves the resource details based on this resource's unique identifiers
+        # @note one of the UNIQUE_IDENTIFIERS, deviceSpecificAttributes['serialNumber'] or deviceSpecificAttributes['wwn']
+        #     must be specified in the resource
+        # @return [Boolean] Whether or not retrieve was successful
+        # @raise [OneviewSDK::IncompleteResource] if required attributes are not filled
+        def retrieve!
+          data_temp = JSON.load(@data.to_json)
+          serial_number = data_temp['deviceSpecificAttributes']['serialNumber'] rescue nil
+          wwn = data_temp['deviceSpecificAttributes']['wwn'] rescue nil
+
+          proc_retrieve_temp = proc do |identifier|
+            results = self.class.find_by(@client, identifier)
+            if results.size == 1
+              set_all(results.first.data)
+              return true
+            end
+          end
+          proc_retrieve_temp.call('deviceSpecificAttributes' => { 'serialNumber' => serial_number }) if serial_number
+          proc_retrieve_temp.call('deviceSpecificAttributes' => { 'wwn' => wwn }) if wwn
+
+          super
+        rescue IncompleteResource => e
+          raise e unless serial_number || wwn
+          false
+        end
+
+        # Gets the storage ports that are connected on the specified networks based on the storage system port's expected network connectivity
+        # @param [Array] network Array of networks
+        # @return [Array] Array of reachable storage port
+        def get_reachable_ports(networks = [])
+          ensure_client && ensure_uri
+          uri = @data['uri'] + '/reachable-ports'
+          unless networks.empty?
+            network_uris = ensure_and_get_uris(networks)
+            uri += "?networks='#{network_uris.join(',')}'"
+          end
+          self.class.find_with_pagination(@client, uri)
+        end
+
+        # Gets a list of storage templates.
+        # @return [Array] Array of Storage Template
+        def get_templates
+          ensure_client && ensure_uri
+          self.class.find_with_pagination(@client, @data['uri'] + '/templates')
+        end
+
+        # Refreshes a storage system
+        def request_refresh
+          @data['requestingRefresh'] = true
+          update
+        end
       end
     end
   end