oneview-sdk 2.2.1 → 3.0.0

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

@@ -1,63 +0,0 @@
-# (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
-  # Storage pool resource implementation
-  class StoragePool < Resource
-    BASE_URI = '/rest/storage-pools'.freeze
-
-    # Add the resource on OneView using the current data
-    # @note Calls the refresh method to set additional data
-    # @raise [OneviewSDK::IncompleteResource] if the client is not set
-    # @raise [StandardError] if the resource creation fails
-    # @return [OneviewSDK::StoragePool] self
-    alias add create
-
-    # Remove resource from OneView
-    # @return [true] if resource was removed successfully
-    alias remove delete
-
-    # 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'] ||= 'StoragePoolV2'
-    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
-
-    # Method is not available
-    # @raise [OneviewSDK::MethodUnavailable] method is not available
-    def update
-      unavailable_method
-    end
-
-    # Sets the storage system
-    # @param [OneviewSDK::StorageSystem] storage_system
-    def set_storage_system(storage_system)
-      fail IncompleteResource, 'Please set the storage system\'s uri attribute!' unless storage_system['uri']
-      set('storageSystemUri', storage_system['uri'])
-    end
-  end
-end

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

@@ -1,113 +0,0 @@
-# (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
-  # Storage system resource implementation
-  class StorageSystem < Resource
-    BASE_URI = '/rest/storage-systems'.freeze
-
-    # Remove resource from OneView
-    # @return [true] if resource was removed successfully
-    alias remove delete
-
-    # 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'] ||= 'StorageSystemV3'
-    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
-
-    # 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
-      task = @client.rest_post(self.class::BASE_URI, { 'body' => self['credentials'] }, @api_version)
-      temp = @data.clone
-      task = @client.wait_for(task['uri'] || task['location'])
-      @data['uri'] = task['associatedResource']['resourceUri']
-      refresh
-      temp.delete('credentials')
-      update(temp)
-      self
-    end
-
-    # Checks if the resource already exists
-    # @note name,uri or ip_hostname must be specified inside resource
-    # @return [Boolean] Whether or not resource exists
-    def exists?
-      ip_hostname = self['credentials'][:ip_hostname] || self['credentials']['ip_hostname'] if self['credentials']
-      return true if @data['name'] && self.class.find_by(@client, name: @data['name']).size == 1
-      return true if @data['uri']  && self.class.find_by(@client, uri:  @data['uri']).size == 1
-      return true if ip_hostname && self.class.find_by(@client, credentials: { ip_hostname: ip_hostname }).size == 1
-      unless @data['name'] || @data['uri'] || ip_hostname
-        fail IncompleteResource, 'Must set resource name, uri or ip_hostname before trying to retrieve!'
-      end
-      false
-    end
-
-    # Retrieves the resource details based on this resource's name or URI.
-    # @note Name,URI or ip_hostname must be specified inside resource
-    # @return [Boolean] Whether or not retrieve was successful
-    # @raise [OneviewSDK::IncompleteResource] if attributes are not filled
-    def retrieve!
-      ip_hostname = self['credentials'][:ip_hostname] || self['credentials']['ip_hostname'] if self['credentials']
-      return super if @data['name'] || @data['uri']
-
-      fail IncompleteResource, 'Must set resource name, uri or ip_hostname before trying to retrieve!' unless ip_hostname
-      results = self.class.find_by(@client, credentials: { ip_hostname: ip_hostname })
-      return false unless results.size == 1
-      set_all(results[0].data)
-      true
-    end
-
-    # Gets the host types for the storage system resource
-    # @param [OneviewSDK::Client] client The client object for the OneView appliance
-    # @return [String] response body
-    def self.get_host_types(client)
-      response = client.rest_get(BASE_URI + '/host-types')
-      response.body
-    end
-
-    # Lists the storage pools
-    def get_storage_pools
-      response = @client.rest_get(@data['uri'] + '/storage-pools')
-      response.body
-    end
-
-    # Lists all managed target ports for the specified storage system,
-    # or only the one specified
-    # @param [String] port Target port
-    def get_managed_ports(port = nil)
-      response = if port.nil?
-                   @client.rest_get("#{@data['uri']}/managedPorts")
-                 else
-                   @client.rest_get("#{@data['uri']}/managedPorts/#{port}")
-                 end
-      response.body
-    end
-  end
-end

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

@@ -1,86 +0,0 @@
-# (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
-  # Switch resource implementation
-  class Switch < Resource
-    BASE_URI = '/rest/switches'.freeze
-    TYPE_URI = '/rest/switch-types'.freeze
-
-    # Remove resource from OneView
-    # @return [true] if resource was removed successfully
-    alias remove delete
-
-    # 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 refresh
-      unavailable_method
-    end
-
-    # Method is not available
-    # @raise [OneviewSDK::MethodUnavailable] method is not available
-    def delete
-      unavailable_method
-    end
-
-    # Retrieves the switch types
-    # @param [OneviewSDK::Client] client The client object for the OneView appliance
-    # @return [Array] All the Switch types
-    def self.get_types(client)
-      response = client.rest_get(TYPE_URI)
-      response = client.response_handler(response)
-      response['members']
-    end
-
-    # Retrieves the switch type with the name
-    # @param [OneviewSDK::Client] client The client object for the OneView appliance
-    # @param [String] name Switch type name
-    # @return [Array] Switch type
-    def self.get_type(client, name)
-      results = get_types(client)
-      results.find { |switch_type| switch_type['name'] == name }
-    end
-
-    # Get statistics for an interconnect, for the specified port or subport
-    # @param [String] port_name port to retrieve statistics
-    # @param [String] subport_number subport to retrieve statistics
-    # @return [Hash] Switch statistics
-    def statistics(port_name = nil, subport_number = nil)
-      uri = if subport_number
-              "#{@data['uri']}/statistics/#{port_name}/subport/#{subport_number}"
-            else
-              "#{@data['uri']}/statistics/#{port_name}"
-            end
-      response = @client.rest_get(uri)
-      response.body
-    end
-
-    # Get settings that describe the environmental configuration
-    # @return [Hash] Configuration parameters
-    def environmental_configuration
-      ensure_client && ensure_uri
-      response = @client.rest_get(@data['uri'] + '/environmentalConfiguration', @api_version)
-      @client.response_handler(response)
-    end
-  end
-end

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

@@ -1,55 +0,0 @@
-# (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
-  # Storage system resource implementation
-  class UnmanagedDevice < Resource
-    BASE_URI = '/rest/unmanaged-devices'.freeze
-
-    # Add the resource on OneView using the current data
-    # @note Calls the refresh method to set additional data
-    # @raise [OneviewSDK::IncompleteResource] if the client is not set
-    # @raise [StandardError] if the resource creation fails
-    # @return [OneviewSDK::UnmanagedDevice] self
-    alias add create
-
-    # Remove resource from OneView
-    # @return [true] if resource was removed successfully
-    alias remove delete
-
-    # 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 a list of unmanaged devices
-    # @param [OneviewSDK::Client] client The client object for the OneView appliance
-    # @return [Array] list of unmanaged devices
-    def self.get_devices(client)
-      response = client.rest_get(BASE_URI)
-      client.response_handler(response)['members']
-    end
-
-    # Get settings that describe the environmental configuration
-    def environmental_configuration
-      ensure_client && ensure_uri
-      response = @client.rest_get(@data['uri'] + '/environmentalConfiguration')
-      @client.response_handler(response)
-    end
-  end
-end

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

@@ -1,79 +0,0 @@
-# (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
-  # Uplink set resource implementation
-  class UplinkSet < Resource
-    BASE_URI = '/rest/uplink-sets'.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['fcNetworkUris'] ||= []
-      @data['fcoeNetworkUris'] ||= []
-      @data['networkUris'] ||= []
-      @data['portConfigInfos'] ||= []
-      @data['primaryPortLocation'] = nil
-      @data['type'] ||= 'uplink-setV3'
-    end
-
-    # Adds the portConfigInfos to the array
-    # @param [String] portUri
-    # @param [String] speed
-    # @param [Hash] locationEntries
-    def add_port_config(portUri, speed, locationEntries)
-      entry = {
-        'portUri' => portUri,
-        'desiredSpeed' => speed,
-        'location' => {
-          'locationEntries' => locationEntries
-        }
-      }
-      @data['portConfigInfos'] << entry
-    end
-
-    # Sets the logical interconnect uri
-    # @param [OneviewSDK::LogicalInterconnect, Hash] logical_interconnect
-    def set_logical_interconnect(logical_interconnect)
-      uri = logical_interconnect[:uri] || logical_interconnect['uri']
-      fail IncompleteResource, 'Invalid object' unless uri
-      @data['logicalInterconnectUri'] = uri
-    end
-
-    # Adds an ethernet network to the uplink set
-    # @param [OneviewSDK::EthernetNetwork, Hash] network
-    def add_network(network)
-      uri = network[:uri] || network['uri']
-      fail IncompleteResource, 'Must set network uri attribute' unless uri
-      @data['networkUris'].push(uri)
-    end
-
-    # Adds an fc network to the uplink set
-    # @param [OneviewSDK::FCNetwork, Hash] network must accept hash syntax
-    def add_fcnetwork(network)
-      uri = network[:uri] || network['uri']
-      fail IncompleteResource, 'Must set network uri attribute' unless uri
-      @data['fcNetworkUris'].push(uri)
-    end
-
-    # Adds an fcoe network to the uplink set
-    # @param [OneviewSDK::FCoENetwork, Hash] network must accept hash syntax
-    def add_fcoenetwork(network)
-      uri = network[:uri] || network['uri']
-      fail IncompleteResource, 'Must set network uri attribute' unless uri
-      @data['fcoeNetworkUris'].push(uri)
-    end
-  end
-end

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

@@ -1,188 +0,0 @@
-# (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
-  # Volume resource implementation
-  class Volume < Resource
-    BASE_URI = '/rest/storage-volumes'.freeze
-
-    # It's possible to create the volume in 6 different ways:
-    # 1) Common = Storage System + Storage Pool
-    # 2) Template = Storage Volume Template
-    # 3) Common with snapshots = Storage System + Storage Pool + Snapshot Pool
-    # 4) Management = Storage System + wwn
-    # 5) Management by name = Storage System + Storage System Volume Name
-    # 6) Snapshot = Snapshot Pool + Storage Pool + Snapshot
-
-    # Creates the volume
-    # @note provisioning parameters are required for creation, but not afterwards; after creation, they will be removed.
-    # @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, { 'body' => @data }, @api_version)
-      body = @client.response_handler(response)
-      set_all(body)
-      @data.delete('provisioningParameters')
-      self
-    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
-    # @return [true] if resource was deleted successfully
-    def delete(flag = :all)
-      ensure_client && ensure_uri
-      case flag
-      when :oneview
-        response = @client.rest_api(:delete, @data['uri'], { 'exportOnly' => true }, @api_version)
-        @client.response_handler(response)
-      when :all
-        response = @client.rest_api(:delete, @data['uri'], {}, @api_version)
-        @client.response_handler(response)
-      else
-        fail InvalidResource, 'Invalid flag value, use :oneview or :all'
-      end
-      true
-    end
-
-    # Sets the storage system to the volume
-    # @param [OneviewSDK::StorageSystem] storage_system Storage System
-    def set_storage_system(storage_system)
-      assure_uri(storage_system)
-      set('storageSystemUri', storage_system['uri'])
-    end
-
-    # Sets the storage pool to the volume
-    # @param [OneviewSDK::StoragePool] storage_pool Storage pool
-    def set_storage_pool(storage_pool)
-      assure_uri(storage_pool)
-      self['provisioningParameters'] ||= {}
-      self['provisioningParameters']['storagePoolUri'] = storage_pool['uri']
-    end
-
-    # Adds the storage volume template to the volume
-    # @param [OneviewSDK::VolumeTemplate] storage_volume_template Storage Volume Template
-    def set_storage_volume_template(storage_volume_template)
-      assure_uri(storage_volume_template)
-      set('templateUri', storage_volume_template['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)
-      set('snapshotPoolUri', storage_pool['uri'])
-    end
-
-    # Creates a snapshot of the volume
-    # @param [String, OneviewSDK::VolumeSnapshot] snapshot String or OneviewSDK::VolumeSnapshot object
-    # @param [String] description Provide a description
-    # @return [true] if snapshot was created successfully
-    def create_snapshot(snapshot, description = nil)
-      ensure_uri && ensure_client
-      if snapshot.is_a?(OneviewSDK::Resource) || snapshot.is_a?(Hash)
-        name = snapshot[:name] || snapshot['name']
-        description ||= snapshot[:description] || snapshot['description']
-      else
-        name = snapshot
-      end
-      data = {
-        type: 'Snapshot',
-        description: description,
-        name: name
-      }
-      response = @client.rest_post("#{@data['uri']}/snapshots", { 'body' => data }, @api_version)
-      @client.response_handler(response)
-      true
-    end
-
-    # Deletes a snapshot of the volume
-    # @param [String] name snapshot name
-    # @return [true] if snapshot was created successfully
-    def delete_snapshot(name)
-      result = get_snapshot(name)
-      response = @client.rest_api(:delete, result['uri'], {}, @api_version)
-      @client.response_handler(response)
-      true
-    end
-
-    # Retrieves a snapshot by name
-    # @param [String] name
-    # @return [Hash] snapshot data
-    def get_snapshot(name)
-      results = get_snapshots
-      results.each do |snapshot|
-        return snapshot if snapshot['name'] == name
-      end
-    end
-
-    # Gets all the snapshots of this volume
-    # @return [Array] Array of snapshots
-    def get_snapshots
-      ensure_uri && ensure_client
-      results = []
-      uri = "#{@data['uri']}/snapshots"
-      loop do
-        response = @client.rest_get(uri, @api_version)
-        body = @client.response_handler(response)
-        members = body['members']
-        members.each do |member|
-          results.push(member)
-        end
-        break unless body['nextPageUri']
-        uri = body['nextPageUri']
-      end
-      results
-    end
-
-    # Gets all the attachable volumes managed by the appliance
-    # @param [OneviewSDK::Client] client The client object for the OneView appliance
-    # @return [Array<OneviewSDK::Volume>] Array of volumes
-    def self.get_attachable_volumes(client)
-      results = []
-      uri = "#{BASE_URI}/attachable-volumes"
-      loop do
-        response = client.rest_get(uri)
-        body = client.response_handler(response)
-        members = body['members']
-        members.each { |member| results.push(OneviewSDK::Volume.new(client, member)) }
-        break unless body['nextPageUri']
-        uri = body['nextPageUri']
-      end
-      results
-    end
-
-    # Gets the list of extra managed storage volume paths
-    # @param [OneviewSDK::Client] client The client object for the OneView appliance
-    # @return response
-    def self.get_extra_managed_volume_paths(client)
-      response = client.rest_get(BASE_URI + '/repair?alertFixType=ExtraManagedStorageVolumePaths')
-      client.response_handler(response)
-    end
-
-    # Removes extra presentation from the volume
-    # @return response
-    def repair
-      response = client.rest_post(BASE_URI + '/repair', 'body' => { resourceUri: @data['uri'], type: 'ExtraManagedStorageVolumePaths' })
-      client.response_handler(response)
-    end
-
-    private
-
-    # Verify if the resource has a URI
-    # If not, first it tries to retrieve, and then verify for its existence
-    def assure_uri(resource)
-      resource.retrieve! unless resource['uri']
-      fail IncompleteResource, "#{resource.class}: #{resource['name']} not found" unless resource['uri']
-    end
-  end
-end