oneview-sdk 3.1.0 → 4.0.0

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

@@ -22,7 +22,7 @@ module OneviewSDK
     # @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)
+      raise "API300 variant '#{variant}' is not supported! Try one of #{SUPPORTED_VARIANTS}" unless SUPPORTED_VARIANTS.include?(variant.to_s)
       new_type = type.to_s.downcase.gsub(/[ -_]/, '')
       api_module = OneviewSDK::API300.const_get(variant)
       api_module.constants.each do |c|
@@ -47,7 +47,7 @@ module OneviewSDK
 
     # Sets the API300 variant
     def self.variant=(variant)
-      raise "API300 variant #{variant} is not supported!" unless SUPPORTED_VARIANTS.include?(variant)
+      raise "API300 variant '#{variant}' is not supported! Try one of #{SUPPORTED_VARIANTS}" unless SUPPORTED_VARIANTS.include?(variant)
       @variant_updated = true
       @variant = variant
     end

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

@@ -10,12 +10,14 @@
 # language governing permissions and limitations under the License.
 
 require_relative '../../api200/enclosure'
+require_relative 'scope'
 
 module OneviewSDK
   module API300
     module C7000
       # Enclosure resource implementation for API300 C7000
       class Enclosure < OneviewSDK::API200::Enclosure
+        include OneviewSDK::API300::C7000::Scope::ScopeHelperMethods
 
         # Create a resource object, associate it with a client, and set its properties.
         # @param [OneviewSDK::Client] client The client object for the OneView appliance
@@ -25,23 +27,9 @@ module OneviewSDK
           @data ||= {}
           # Default values:
           @data['type'] ||= 'EnclosureV300'
+          @data['scopeUris'] ||= []
           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

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

@@ -26,11 +26,64 @@ module OneviewSDK
           # Default values:
           @data['type'] ||= 'EnclosureGroupV300'
           @data['stackingMode'] ||= 'Enclosure'
+          @data['enclosureCount'] ||= 1
           @data['interconnectBayMappingCount'] ||= 8
-          create_interconnect_bay_mapping unless @data['interconnectBayMappings']
           super
         end
 
+        # Adds the logical interconnect group
+        # @param [OneviewSDK::LogicalInterconnectGroup] lig Logical Interconnect Group
+        # @param [Integer] enclosureIndex Enclosure index of bay to add LIG to. If nil, interconnects will be added for all enclosures
+        # @raise [OneviewSDK::NotFound] if the LIG uri is not set and cannot be retrieved
+        # @return [OneviewSDK::API300::C7000::EnclosureGroup] self
+        def add_logical_interconnect_group(lig, enclosureIndex = nil)
+          lig.retrieve! unless lig['uri']
+          raise(NotFound, "The logical interconnect group #{lig['name']} was not found") unless lig['uri']
+          lig['interconnectMapTemplate']['interconnectMapEntryTemplates'].each do |entry|
+            entry['logicalLocation']['locationEntries'].each do |location|
+              next unless location['type'] == 'Bay' && entry['permittedInterconnectTypeUri']
+              add_lig_to_bay(location['relativeValue'], lig, enclosureIndex)
+            end
+          end
+          self
+        end
+
+        # Creates the interconnect bay mapping
+        # @return [OneviewSDK::API300::C7000::EnclosureGroup] self
+        def create_interconnect_bay_mapping
+          @data['interconnectBayMappings'] = []
+          1.upto(@data['enclosureCount']) do |enclosureIndex|
+            1.upto(@data['interconnectBayMappingCount']) do |bay_number|
+              entry = {
+                'enclosureIndex' => enclosureIndex,
+                'interconnectBay' => bay_number,
+                'logicalInterconnectGroupUri' => nil
+              }
+              @data['interconnectBayMappings'] << entry
+            end
+          end
+          self
+        end
+
+        private
+
+        # Add logical interconnect group to bay
+        # @param [Integer] bay Bay number
+        # @param [OneviewSDK::LogicalInterconnectGroup] lig Logical Interconnect Group
+        # @param [Integer] enclosureIndex Enclosure index of bay to add LIG to. If nil, interconnects will be added for all enclosures
+        def add_lig_to_bay(bay, lig, enclosureIndex)
+          @data['interconnectBayMappings'].each do |location|
+            next unless location['interconnectBay'] == bay
+            if enclosureIndex
+              next unless location['enclosureIndex'] == enclosureIndex
+              location['logicalInterconnectGroupUri'] = lig['uri']
+              location['enclosureIndex'] = enclosureIndex
+              break
+            else
+              location['logicalInterconnectGroupUri'] = lig['uri']
+            end
+          end
+        end
       end
     end
   end

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

@@ -19,13 +19,13 @@ module OneviewSDK
 
         # Method is not available
         # @raise [OneviewSDK::MethodUnavailable] method is not available
-        def self.get_without_ethernet
+        def self.get_without_ethernet(*)
           raise MethodUnavailable, 'The method #self.get_without_ethernet is unavailable for this resource'
         end
 
         # Method is not available
         # @raise [OneviewSDK::MethodUnavailable] method is not available
-        def get_without_ethernet
+        def get_without_ethernet(*)
           unavailable_method
         end
       end

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

@@ -10,12 +10,15 @@
 # language governing permissions and limitations under the License.
 
 require_relative '../../api200/logical_switch'
+require_relative 'scope'
 
 module OneviewSDK
   module API300
     module C7000
       # Logical switch resource implementation for API300 C7000
       class LogicalSwitch < OneviewSDK::API200::LogicalSwitch
+        include OneviewSDK::API300::C7000::Scope::ScopeHelperMethods
+
         INTERNAL_LINK_SET_URI = '/rest/internal-link-sets'.freeze
 
         # Create a resource object, associate it with a client, and set its properties.
@@ -26,6 +29,7 @@ module OneviewSDK
           @data ||= {}
           # Default values:
           @data['type'] ||= 'logical-switchV300'
+          @data['scopeUris'] ||= []
           super
         end
 

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

@@ -27,7 +27,7 @@ module OneviewSDK
 
         # Method is not available
         # @raise [OneviewSDK::MethodUnavailable] method is not available
-        def set_public_attributes(_attributes)
+        def set_public_attributes(*)
           unavailable_method
         end
       end

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

@@ -0,0 +1,142 @@
+# (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 API300
+    module C7000
+      # Scope resource implementation for API300 C7k
+      class Scope < Resource
+        BASE_URI = '/rest/scopes'.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.
+        #   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'] ||= 'Scope'
+          super
+        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
+          options = {
+            'If-Match' => @data.delete('eTag'),
+            'body' => @data
+          }
+          response = @client.rest_put(@data['uri'], options, @api_version)
+          @client.response_handler(response)
+          self
+        end
+
+        # Delete resource from OneView
+        # @raise [OneviewSDK::IncompleteResource] if the client or uri is not set
+        # @return [true] if resource was deleted successfully
+        def delete
+          ensure_client && ensure_uri
+          response = @client.rest_delete(@data['uri'], { 'If-Match' => @data['eTag'] }, @api_version)
+          @client.response_handler(response)
+          true
+        end
+
+        # Adds 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 set_resources(*resources)
+          change_resource_assignments(add_resources: resources.flatten)
+        end
+
+        # Removes 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 unset_resources(*resources)
+          change_resource_assignments(remove_resources: resources.flatten)
+        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 = {
+              'addedResourceUris' => add_uris,
+              'removedResourceUris' => remove_uris
+            }
+            response = @client.rest_patch(@data['uri'] + '/resource-assignments', 'body' => body)
+            @client.response_handler(response)
+          end
+          self
+        end
+
+        # Helper methods for add, remove and replace scopes from the another resources
+        module ScopeHelperMethods
+          # 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'], { 'body' => [body] }, @api_version)
+            @client.response_handler(response)
+          end
+
+          # Add one scope to the resource
+          # @param [OneviewSDK::API300::C7000::Scope] scope The scope resource
+          # @raise [OneviewSDK::IncompleteResource] if the uri of scope is not set
+          def add_scope(scope)
+            scope.ensure_uri
+            patch('add', '/scopeUris/-', scope['uri'])
+          end
+
+          # Remove one scope from the resource
+          # @param [OneviewSDK::API300::C7000::Scope] scope The scope resource
+          # @return [Boolean] True if the scope was deleted and false if enclosure has not the scope
+          # @raise [OneviewSDK::IncompleteResource] if the uri of scope is not set
+          def remove_scope(scope)
+            scope.ensure_uri
+            scope_index = @data['scopeUris'].find_index { |uri| uri == scope['uri'] }
+            return false unless scope_index
+            patch('remove', "/scopeUris/#{scope_index}", nil)
+            true
+          end
+
+          # Change the list of scopes in the resource
+          # @param [Array<OneviewSDK::API300::C7000::Scope>] scopes The scopes list (or scopes separeted by comma)
+          # @raise [OneviewSDK::IncompleteResource] if the uri of each scope is not set
+          def replace_scopes(*scopes)
+            uris = ensure_and_get_uris(scopes.flatten)
+            patch('replace', '/scopeUris', uris)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -10,12 +10,14 @@
 # language governing permissions and limitations under the License.
 
 require_relative '../../api200/server_hardware'
+require_relative 'scope'
 
 module OneviewSDK
   module API300
     module C7000
       # Server Hardware resource implementation on API300 C7000
       class ServerHardware < OneviewSDK::API200::ServerHardware
+        include OneviewSDK::API300::C7000::Scope::ScopeHelperMethods
 
         # Create a resource object, associate it with a client, and set its properties.
         # @param [OneviewSDK::Client] client The client object for the OneView appliance
@@ -25,6 +27,7 @@ module OneviewSDK
           @data ||= {}
           # Default values:
           @data['type'] ||= 'server-hardware-5'
+          @data['scopeUris'] ||= []
           super
         end
 
@@ -58,23 +61,6 @@ module OneviewSDK
           results
         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
-        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
-
         private
 
         def uri_generate(uri, filters)

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

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

@@ -28,19 +28,19 @@ module OneviewSDK
 
         # Method is unavailable
         # @raise [OneviewSDK::MethodUnavailable] method is not available
-        def create
+        def create(*)
           unavailable_method
         end
 
         # Method is unavailable
         # @raise [OneviewSDK::MethodUnavailable] method is not available
-        def delete
+        def delete(*)
           unavailable_method
         end
 
         # Method is unavailable
         # @raise [OneviewSDK::MethodUnavailable] method is not available
-        def update
+        def update(*)
           unavailable_method
         end
 

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

@@ -9,25 +9,13 @@
 # CONDITIONS OF ANY KIND, either express or implied. See the License for the specific
 # language governing permissions and limitations under the License.
 
-require_relative '../../api200/enclosure'
+require_relative '../c7000/enclosure'
 
 module OneviewSDK
   module API300
     module Synergy
       # Enclosure resource implementation for API300 Synergy
-      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.
-        # @note Renames the enclosures only if @data['name']. Pattern used is: <@data['name']>+<1..number of enclosures added>.
-        def initialize(client, params = {}, api_ver = nil)
-          @data ||= {}
-          # Default values:
-          @data['type'] ||= 'EnclosureV300'
-          super
-        end
+      class Enclosure < OneviewSDK::API300::C7000::Enclosure
 
         # Claim/configure the enclosure and its components to the appliance
         # @note Calls the update_enclosure_names method to set the enclosure names
@@ -46,30 +34,15 @@ module OneviewSDK
           OneviewSDK::API300::Synergy::Enclosure.update_enclosure_names(@client, @data['hostname'], @data['name'])
         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
-
         # Method is not available
         # @raise [OneviewSDK::MethodUnavailable] method is not available
-        def set_environmental_configuration
+        def set_environmental_configuration(*)
           unavailable_method
         end
 
         # Method is not available
         # @raise [OneviewSDK::MethodUnavailable] method is not available
-        def set_enclosure_group
+        def set_enclosure_group(*)
           unavailable_method
         end