oneview-sdk 4.5.1 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 09e027ffed968897551d5a984eb4d543ea14c6e8
-  data.tar.gz: 82e11fc63814dddd9153478513a0f0086b780213
+  metadata.gz: d45265d54a25dcf7c5cdeea02ee2e18bcc028b38
+  data.tar.gz: e0ebab15f6f7cfb82adb872c85d5fffbb3157140
 SHA512:
-  metadata.gz: 313db274cec0f76d473a4e90c2f77560e9a48c951c0f90a67a90f15188890cd82480ab6d7a95c1c7790dc0a768a8944f6e5be36c48d23c7f19c4706fd534697b
-  data.tar.gz: 2b1dbf8c75a58bec1f1b2f55a5981850382c1f897e067d4905fd4764201cc333830dbb2500a3065fbff63095b980e3a740c27a090dd5daefacff840d16b59db5
+  metadata.gz: e8f5d7643953556c36b59b117a9069a7b72f07963b8ccbe197a90642da70ff5f879da91250d61345193bc0cc6f7ebae32d71f02c0dacbb44ecc4fdc8a429b242
+  data.tar.gz: 028524d1c0984bb1b7cb8524e85830c41fd6e9eede503b11f79f9c66db23a4928414f30d7f2bf91de3edd419b0e1245729fbeafc64e48c6eb60f2099b85d1b7c

data/CHANGELOG.md

@@ -1,3 +1,59 @@
+## v5.0.0
+
+#### New Resources:
+This release adds support to HPE OneView Rest API version 200 (for hardware variant C7000), 300 and 500 (both for the hardware variants C7000 and Synergy) to the new features:
+   - Client Certificate
+   - Web Server Certificate
+
+#### Features supported
+This release adds support to OneView Rest API version 500 for the hardware variants C7000 and Synergy to the already existing features:
+   - Connection Template
+   - Datacenter
+   - Drive Enclosure
+   - Enclosure
+   - Enclosure Group
+   - Ethernet Network
+   - Event
+   - Fabric
+   - FC Network
+   - FCoE Network
+   - Firmware Bundle
+   - Firmware Driver
+   - ID Pool
+   - Interconnect
+   - Internal Link Set
+   - Logical Downlink
+   - Logical Enclosure
+   - Logical Interconnect
+   - Logical Interconnect Group
+   - Logical Switch
+   - Logical Switch Group
+   - Managed SANs
+   - Network Set
+   - Power Device
+   - OS Deployment Plan
+   - Rack
+   - SAN Manager
+   - SAS Interconnect
+   - SAS Logical Interconnect
+   - SAS Logical Interconnect Group
+   - Scopes
+   - Server Hardware
+   - Server Hardware Type
+   - Server Profile Template
+   - Storage Pool
+   - Storage System
+   - Switches
+   - Unmanaged Devices
+   - Uplink Set
+   - User
+   - Volume
+   - Volume Attachment
+   - Volume Templates
+
+#### Breaking changes
+1. In the Switch resource, the `statistics` method was fixed, a non-existent endpoint was removed `/rest/switches/statistics/{portName}/subport/{subportNumber}`. Now the method only get statistics of a switch or a specific port.
+
 ## v4.5.1
 
 #### Bug fixes & Enhancements

data/lib/oneview-sdk/resource.rb

@@ -18,6 +18,7 @@ module OneviewSDK
   class Resource
     BASE_URI = '/rest'.freeze
     UNIQUE_IDENTIFIERS = %w(name uri).freeze # Ordered list of unique attributes to search by
+    DEFAULT_REQUEST_HEADER = {}.freeze
 
     attr_accessor \
       :client,
@@ -46,12 +47,13 @@ module OneviewSDK
 
     # Retrieve resource details based on this resource's name or URI.
     # @note one of the UNIQUE_IDENTIFIERS, e.g. name or uri, 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!
+    def retrieve!(header = self.class::DEFAULT_REQUEST_HEADER)
       retrieval_keys = self.class::UNIQUE_IDENTIFIERS.select { |k| !@data[k].nil? }
       raise IncompleteResource, "Must set resource #{self.class::UNIQUE_IDENTIFIERS.join(' or ')} before trying to retrieve!" if retrieval_keys.empty?
       retrieval_keys.each do |k|
-        results = self.class.find_by(@client, k => @data[k])
+        results = self.class.find_by(@client, { k => @data[k] }, self.class::BASE_URI, header)
         next if results.size != 1
         set_all(results[0].data)
         return true
@@ -61,22 +63,40 @@ module OneviewSDK
 
     # Check if a resource exists
     # @note one of the UNIQUE_IDENTIFIERS, e.g. name or uri, 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?
+    def exists?(header = self.class::DEFAULT_REQUEST_HEADER)
       retrieval_keys = self.class::UNIQUE_IDENTIFIERS.select { |k| !@data[k].nil? }
       raise IncompleteResource, "Must set resource #{self.class::UNIQUE_IDENTIFIERS.join(' or ')} before trying to retrieve!" if retrieval_keys.empty?
       retrieval_keys.each do |k|
-        results = self.class.find_by(@client, k => @data[k])
+        results = self.class.find_by(@client, { k => @data[k] }, self.class::BASE_URI, header)
         return true if results.size == 1
       end
       false
     end
 
+    # Merges the first hash data structure with the second
+    # @note both arguments should be a Ruby Hash object.
+    #       The second hash should have strings as a keys.
+    #       This method will change the second argument.
+    # @raise [StandardError] if the arguments, or one them, is not a Hash object
+    def deep_merge!(other_data, target_data = @data)
+      raise 'Both arguments should be a object Hash' unless other_data.is_a?(Hash) && target_data.is_a?(Hash)
+      other_data.each do |key, value|
+        value_target = target_data[key.to_s]
+        if value_target.is_a?(Hash) && value.is_a?(Hash)
+          deep_merge!(value, value_target)
+        else
+          target_data[key.to_s] = value
+        end
+      end
+    end
+
     # Set the given hash of key-value pairs as resource data attributes
     # @param [Hash, Resource] params The options for this resource (key-value pairs or resource object)
     # @note All top-level keys will be converted to strings
     # @return [Resource] self
-    def set_all(params = {})
+    def set_all(params = self.class::DEFAULT_REQUEST_HEADER)
       params = params.data if params.class <= Resource
       params = Hash[params.map { |(k, v)| [k.to_s, v] }]
       params.each { |key, value| set(key.to_s, value) }
@@ -146,12 +166,14 @@ module OneviewSDK
 
     # Create the resource on OneView using the current data
     # @note Calls the refresh method to set additional data
+    # @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
+    def create(header = self.class::DEFAULT_REQUEST_HEADER)
       ensure_client
-      response = @client.rest_post(self.class::BASE_URI, { 'body' => @data }, @api_version)
+      options = {}.merge(header).merge('body' => @data)
+      response = @client.rest_post(self.class::BASE_URI, options, @api_version)
       body = @client.response_handler(response)
       set_all(body)
       self
@@ -159,21 +181,23 @@ module OneviewSDK
 
     # Delete the resource from OneView if it exists, then create it using the current data
     # @note Calls refresh method to set additional data
+    # @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!
+    def create!(header = self.class::DEFAULT_REQUEST_HEADER)
       temp = self.class.new(@client, @data)
-      temp.delete if temp.retrieve!
-      create
+      temp.delete(header) if temp.retrieve!(header)
+      create(header)
     end
 
     # Updates this object using the data that exists on OneView
     # @note Will overwrite any data that differs from OneView
+    # @param [Hash] header The header options for the request (key-value pairs)
     # @return [Resource] self
-    def refresh
+    def refresh(header = self.class::DEFAULT_REQUEST_HEADER)
       ensure_client && ensure_uri
-      response = @client.rest_get(@data['uri'], @api_version)
+      response = @client.rest_get(@data['uri'], header, @api_version)
       body = @client.response_handler(response)
       set_all(body)
       self
@@ -181,22 +205,25 @@ module OneviewSDK
 
     # Set data and save to OneView
     # @param [Hash] attributes The attributes to add/change for this resource (key-value pairs)
+    # @param [Hash] header The header options for the request (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 = {})
+    def update(attributes = {}, header = self.class::DEFAULT_REQUEST_HEADER)
       set_all(attributes)
       ensure_client && ensure_uri
-      response = @client.rest_put(@data['uri'], { 'body' => @data }, @api_version)
+      options = {}.merge(header).merge('body' => @data)
+      response = @client.rest_put(@data['uri'], options, @api_version)
       @client.response_handler(response)
       self
     end
 
     # 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
+    def delete(header = self.class::DEFAULT_REQUEST_HEADER)
       ensure_client && ensure_uri
-      response = @client.rest_delete(@data['uri'], {}, @api_version)
+      response = @client.rest_delete(@data['uri'], header, @api_version)
       @client.response_handler(response)
       true
     end
@@ -231,7 +258,7 @@ module OneviewSDK
     # @param [OneviewSDK::Client] client The client object for the OneView appliance
     # @return [Hash] Schema
     def self.schema(client)
-      response = client.rest_get("#{self::BASE_URI}/schema", client.api_version)
+      response = client.rest_get("#{self::BASE_URI}/schema", {}, client.api_version)
       client.response_handler(response)
     rescue StandardError => e
       client.logger.error('This resource does not implement the schema endpoint!') if e.message =~ /404 NOT FOUND/
@@ -260,9 +287,10 @@ module OneviewSDK
     # @param [OneviewSDK::Client] client The client object for the OneView appliance
     # @param [Hash] attributes Hash containing the attributes name and value
     # @param [String] uri URI of the endpoint
+    # @param [Hash] header The header options for the request (key-value pairs)
     # @return [Array<Resource>] Results matching the search
-    def self.find_by(client, attributes, uri = self::BASE_URI)
-      all = find_with_pagination(client, uri)
+    def self.find_by(client, attributes, uri = self::BASE_URI, header = self::DEFAULT_REQUEST_HEADER)
+      all = find_with_pagination(client, uri, header)
       results = []
       all.each do |member|
         temp = new(client, member)
@@ -274,11 +302,12 @@ module OneviewSDK
     # Make a GET request to the uri, and returns an array with all results (search using resource pagination)
     # @param [OneviewSDK::Client] client The client object for the OneView appliance
     # @param [String] uri URI of the endpoint
+    # @param [Hash] header The header options for the request (key-value pairs)
     # @return [Array<Hash>] Results
-    def self.find_with_pagination(client, uri)
+    def self.find_with_pagination(client, uri, header = self::DEFAULT_REQUEST_HEADER)
       all = []
       loop do
-        response = client.rest_get(uri)
+        response = client.rest_get(uri, header)
         body = client.response_handler(response)
         members = body['members']
         break unless members
@@ -290,9 +319,11 @@ module OneviewSDK
     end
 
     # Make a GET request to the resource base uri, and returns an array with all objects of this type
+    # @param [OneviewSDK::Client] client The client object for the OneView appliance
+    # @param [Hash] header The header options for the request (key-value pairs)
     # @return [Array<Resource>] Results
-    def self.get_all(client)
-      find_by(client, {})
+    def self.get_all(client, header = self::DEFAULT_REQUEST_HEADER)
+      find_by(client, {}, self::BASE_URI, header)
     end
 
     # Builds a Query string corresponding to the parameters passed

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

@@ -0,0 +1,134 @@
+# (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 API200
+    # Client certificate resource implementation
+    class ClientCertificate < Resource
+      BASE_URI = '/rest/certificates'.freeze
+      DEFAULT_REQUEST_HEADER = { 'requestername' => 'DEFAULT' }.freeze
+
+      # Imports the given SSL certificate into the appliance trust store
+      # @param [Hash] header The header options of request (key-value pairs)
+      # @option header [String] :requestername Used to identify requester to allow querying of proper trust store.
+      #   Default value is "DEFAULT". List of valid input values are { "DEFAULT", "AUTHN", "RABBITMQ", "ILOOA" }.
+      # @return [ClientCertificate] self
+      alias import create
+
+      # Removes the SSL certificate
+      # @param [Hash] header The header options of request (key-value pairs)
+      # @option header [String] :requestername Used to identify requester to allow querying of proper trust store.
+      #   Default value is "DEFAULT". List of valid input values are { "DEFAULT", "AUTHN", "RABBITMQ", "ILOOA" }.
+      # @return [true] if resource was deleted 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'] ||= 'SSLCertificateDTO'
+        @data['uri']  ||= "#{self.class::BASE_URI}/#{@data['aliasName']}" if @data['aliasName']
+      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
+
+      # Imports the given list of SSL certificates into the appliance trust store.
+      # @param [OneviewSDK::Client] client The client object for the OneView appliance
+      # @param [Array<ClientCertificate>] certificates The Client Certificate list
+      # @param [Hash] header The header options of request (key-value pairs)
+      # @option header [String] :requestername Used to identify requester to allow querying of proper trust store.
+      #   Default value is "DEFAULT". List of valid input values are { "DEFAULT", "AUTHN", "RABBITMQ", "ILOOA" }.
+      # @option header [String] :Accept-Language The language code requested in the response.
+      #   If a suitable match to the requested language is not available, en-US or the appliance locale is used.
+      # @raise [ArgumentError] if the certificates list is nil or empty
+      # @return [Array<ClientCertificate>] list of Client Certificate imported
+      def self.import(client, certificates, header = self::DEFAULT_REQUEST_HEADER)
+        raise ArgumentError, 'the certificates list should be valid' if certificates.nil? || certificates.empty?
+        options = {}.merge(header)
+        options['body'] = certificates.map(&:data)
+        response = client.rest_post(self::BASE_URI + '?multiResource=true', options)
+        body = client.response_handler(response)
+        body.map { |data| new(client, data) }
+      end
+
+      # Replaces a list of existing SSL certificates with a new list of certificates.
+      # @param [OneviewSDK::Client] client The client object for the OneView appliance
+      # @param [Array<ClientCertificate>] certificates The Client Certificate list
+      # @param [Boolean] force If set to true, the operation completes despite any problems with network connectivity or errors on the resource itself
+      # @param [Hash] header The header options of request (key-value pairs)
+      # @option header [String] :requestername Used to identify requester to allow querying of proper trust store.
+      #   Default value is "DEFAULT". List of valid input values are { "DEFAULT", "AUTHN", "RABBITMQ", "ILOOA" }.
+      # @option header [String] :Accept-Language The language code requested in the response.
+      #   If a suitable match to the requested language is not available, en-US or the appliance locale is used.
+      # @return [Array<ClientCertificate>] list of the Client Certificate
+      def self.replace(client, certificates, force = false, header = self::DEFAULT_REQUEST_HEADER)
+        raise ArgumentError, 'the certificates list should be valid' if certificates.nil? || certificates.empty?
+        options = {}.merge(header)
+        options['body'] = certificates.map(&:data)
+        uri = self::BASE_URI + build_query(multi_resource: true, force: force)
+        response = client.rest_put(uri, options)
+        body = client.response_handler(response)
+        body.map { |data| new(client, data) }
+      end
+
+      # Removes a list of SSL certificates based on the list of alias names provided as filter criteria.
+      # @param [OneviewSDK::Client] client The client object for the OneView appliance
+      # @param [Array<String>] alias_names The alias names list used as filter to remove the client certificates
+      # @param [Boolean] force If set to true, the operation completes despite any problems with network connectivity or errors on the resource itself
+      # @param [Hash] header The header options of request (key-value pairs)
+      # @option header [String] :requestername Used to identify requester to allow querying of proper trust store.
+      #   Default value is "DEFAULT". List of valid input values are { "DEFAULT", "AUTHN", "RABBITMQ", "ILOOA" }.
+      # @option header [String] :Accept-Language The language code requested in the response.
+      #   If a suitable match to the requested language is not available, en-US or the appliance locale is used.
+      # @raise [ArgumentError] if the certificates list is nil or empty
+      def self.remove(client, alias_names, force = false, header = self::DEFAULT_REQUEST_HEADER)
+        raise ArgumentError, 'the certificates list should be valid' if alias_names.nil? || alias_names.empty?
+        uri = self::BASE_URI + build_query(multi_resource: true, force: force)
+        uri += '&filter=' + alias_names.join('&filter=')
+        response = client.rest_delete(uri, header)
+        client.response_handler(response)
+      end
+
+      # Validates the input certificate by verifying if it is X509 compliant.
+      # @param [Hash] header The header options of request (key-value pairs)
+      # @option header [String] :requestername Used to identify requester to allow querying of proper trust store.
+      #   Default value is "DEFAULT". List of valid input values are { "DEFAULT", "AUTHN", "RABBITMQ", "ILOOA" }.
+      # @option header [String] :Accept-Language The language code requested in the response.
+      #   If a suitable match to the requested language is not available, en-US or the appliance locale is used.
+      # @raise [OneviewSDK::IncompleteResource] if the client or the uri is not set
+      # @return [OneviewSDK::ClientCertificate] self
+      def validate(header = self.class::DEFAULT_REQUEST_HEADER)
+        ensure_client && ensure_uri
+        options = {}.merge(header)
+        options['body'] = @data
+        response = @client.rest_post(self.class::BASE_URI + '/validator', options, @api_version)
+        body = @client.response_handler(response)
+        set_all(body)
+        self
+      end
+    end
+  end
+end