oneview-sdk 1.0.0 → 2.0.0

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

@@ -0,0 +1,83 @@
+# (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
+  # Rack resource implementation
+  class Rack < Resource
+    BASE_URI = '/rest/racks'.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::Rack] 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['rackMounts'] ||= []
+    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 rack resource with specified options
+    # @param [OneviewSDK::Resource] resource Resource to be added
+    # @param [String] options rack options
+    def add_rack_resource(resource, options = {})
+      rack_resource_options = {}
+      # Write values to hash and transform any symbol to string
+      options.each { |key, val| rack_resource_options[key.to_s] = val }
+
+      # Verify if the rack resource exists in the rack, if not init add it
+      rack_resource = @data['rackMounts'].find { |resource_from_rack| resource_from_rack['mountUri'] == resource['uri'] }
+      if rack_resource
+        rack_resource_options.each { |key, val| rack_resource[key] = val }
+      else
+        # Set default values if not given
+        rack_resource_options['mountUri'] = resource['uri']
+        rack_resource_options['location'] = 'CenterFront' unless rack_resource_options['location']
+        @data['rackMounts'] << rack_resource_options
+      end
+    end
+
+    # Remove resources from the rack
+    # @param [OneviewSDK::Resource] resource Resource to be removed from rack
+    def remove_rack_resource(resource)
+      @data['rackMounts'].reject! { |rack_resource| rack_resource['mountUri'] == resource['uri'] }
+    end
+
+    # Gets topology information for the rack
+    # @return [Hash] Environmental analysis
+    def get_device_topology
+      response = @client.rest_get(@data['uri'] + '/deviceTopology')
+      @client.response_handler(response)
+    end
+  end
+end

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

@@ -0,0 +1,88 @@
+# (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
+  # SAN manager resource implementation
+  class SANManager < Resource
+    BASE_URI = '/rest/fc-sans/device-managers'.freeze
+    PROVIDERS_URI = '/rest/fc-sans/providers'.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'] = 'FCDeviceManagerV2'
+    end
+
+    # Adds the resource on OneView using the current data
+    # @return [OneviewSDK::SANManager] self
+    def add
+      ensure_client
+      fail 'providerDisplayName' unless @data['providerDisplayName']
+      @data['providerUri'] = get_provider_uri
+      response = @client.rest_post(@data['providerUri'] + '/device-managers', { 'body' => @data }, @api_version)
+      body = @client.response_handler(response)
+      set_all(body)
+      self
+    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
+
+    # Refreshes the san manager state or change connection information
+    # @param [Hash] options
+    def update(options)
+      ensure_client && ensure_uri
+      response = @client.rest_put(@data['uri'], 'body' => options)
+      new_data = @client.response_handler(response)
+      set_all(new_data)
+    end
+
+    # Retrieves the default connection information for a specific provider
+    # @param [OneviewSDK::Client] client The client object for the OneView appliance
+    # @param [String] provider_name Providers name
+    # @return [Hash] A hash with default connectionInfo information
+    def self.get_default_connection_info(client, provider_name)
+      response = client.rest_get(PROVIDERS_URI)
+      providers = client.response_handler(response)['members']
+      desired_provider = providers.find { |provider| provider['displayName'] == provider_name || provider['name'] == provider_name }
+      desired_provider['defaultConnectionInfo']
+    end
+
+    private
+
+    # Gets the provider uri
+    # @return [String] provider uri
+    def get_provider_uri
+      return @data['providerUri'] if @data['providerUri']
+      response = @client.rest_get(PROVIDERS_URI)
+      providers = @client.response_handler(response)['members']
+      desired_provider = providers.find { |provider| provider['displayName'] == @data['providerDisplayName'] }
+      desired_provider['uri']
+    end
+  end
+end

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

@@ -1,32 +1,52 @@
+# (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
   # Server hardware resource implementation
   class ServerHardware < Resource
     BASE_URI = '/rest/server-hardware'.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'] ||= 'server-hardware-4'
     end
 
-    # @!group Validates
-
-    VALID_LICENSING_INTENTS = ['OneView', 'OneViewNoiLO', 'OneViewStandard', nil].freeze
-    def validate_licensingIntent(value)
-      fail 'Invalid licensingIntent' unless VALID_LICENSING_INTENTS.include?(value)
+    # Method is not available
+    # @raise [OneviewSDK::MethodUnavailable] method is not available
+    def create
+      unavailable_method
     end
 
-    VALID_CONFIGURATION_STATES = ['Managed', 'Monitored', nil].freeze
-    def validate_configurationState(value)
-      fail 'Invalid configurationState' unless VALID_CONFIGURATION_STATES.include?(value)
+    # Method is not available
+    # @raise [OneviewSDK::MethodUnavailable] method is not available
+    def delete
+      unavailable_method
     end
 
-    # @!endgroup
-
-    def create
+    # Adds the resource on OneView using the current data
+    # @raise [OneviewSDK::IncompleteResource] if the client is not set or required attributes are missing
+    # @return [OneviewSDK::ServerHardware] self
+    def add
       ensure_client
       required_attributes = %w(hostname username password licensingIntent)
-      required_attributes.each { |k| fail "Missing required attribute: '#{k}'" unless @data.key?(k) }
+      required_attributes.each { |k| fail IncompleteResource, "Missing required attribute: '#{k}'" unless @data.key?(k) }
 
       optional_attrs = %w(configurationState force restore)
       temp_data = @data.select { |k, _v| required_attributes.include?(k) || optional_attrs.include?(k) }
@@ -37,26 +57,128 @@ module OneviewSDK
       self
     end
 
+    # Method is not available
+    # @raise [OneviewSDK::MethodUnavailable] method is not available
     def update(*)
-      fail 'Method not available for this resource!'
+      unavailable_method
     end
 
     # Power on the server hardware
-    # @param [String] force Use 'PressAndHold' action
-    # @return [Boolean] Whether or not server was powered on
+    # @param [Boolean] force Use 'PressAndHold' action?
+    # @return [Boolean] Returns whether or not the server was powered on
     def power_on(force = false)
       set_power_state('on', force)
     end
 
     # Power off the server hardware
-    # @param [String] force Use 'PressAndHold' action
-    # @return [Boolean] Whether or not server was powered off
+    # @param [Boolean] force Use 'PressAndHold' action?
+    # @return [Boolean] Returns whether or not the server was powered off
     def power_off(force = false)
       set_power_state('off', force)
     end
 
+    # Gets a list of BIOS/UEFI values on the physical server
+    # @return [Hash] List with BIOS/UEFI settings
+    def get_bios
+      response = @client.rest_get(@data['uri'] + '/bios')
+      @client.response_handler(response)
+    end
+
+    # Gets a url to the iLO web interface
+    # @return [Hash] url
+    def get_ilo_sso_url
+      response = @client.rest_get(@data['uri'] + '/iloSsoUrl')
+      @client.response_handler(response)
+    end
+
+    # Gets a Single Sign-On session for the Java Applet console
+    # @return [Hash] url
+    def get_java_remote_sso_url
+      response = @client.rest_get(@data['uri'] + '/javaRemoteConsoleUrl')
+      @client.response_handler(response)
+    end
+
+    # Gets a url to the iLO web interface
+    # @return [Hash] url
+    def get_remote_console_url
+      response = @client.rest_get(@data['uri'] + '/remoteConsoleUrl')
+      @client.response_handler(response)
+    end
+
+    # Refreshes the enclosure along with all of its components
+    # @param [String] state NotRefreshing, RefreshFailed, RefreshPending, Refreshing
+    # @param [Hash] options  Optional force fields for refreshing the enclosure
+    def set_refresh_state(state, options = {})
+      ensure_client && ensure_uri
+      s = state.to_s rescue state
+      requestBody = {
+        'body' => {
+          refreshState: s
+        }
+      }
+      requestBody['body'].merge(options)
+      response = @client.rest_put(@data['uri'] + '/refreshState', requestBody, @api_version)
+      new_data = @client.response_handler(response)
+      set_all(new_data)
+    end
+
+    # Updates the iLO firmware on a physical server to a minimum iLO firmware required by OneView
+    def update_ilo_firmware
+      response = @client.rest_put(@data['uri'] + '/mpFirmwareVersion')
+      @client.response_handler(response)
+    end
+
+    # Gets the settings that describe the environmental configuration
+    def environmental_configuration
+      ensure_client && ensure_uri
+      response = @client.rest_get(@data['uri'] + '/environmentalConfiguration', @api_version)
+      @client.response_handler(response)
+    end
+
+    # Retrieves historical utilization
+    # @param [Hash] queryParameters query parameters (ie :startDate, :endDate, :fields, :view, etc.)
+    # @option queryParameters [Array] :fields
+    # @option queryParameters [Time, Date, String] :startDate
+    # @option queryParameters [Time, Date, String] :endDate
+    def utilization(queryParameters = {})
+      ensure_client && ensure_uri
+      uri = "#{@data['uri']}/utilization?"
+
+      queryParameters[:endDate]   = convert_time(queryParameters[:endDate])
+      queryParameters[:startDate] = convert_time(queryParameters[:startDate])
+
+      queryParameters.each do |key, value|
+        next if value.nil?
+        uri += case key.to_sym
+               when :fields
+                 "fields=#{value.join(',')}"
+               when :startDate, :endDate
+                 "filter=#{key}=#{value}"
+               else
+                 "#{key}=#{value}"
+               end
+        uri += '&'
+      end
+      uri.chop! # Get rid of trailing '&' or '?'
+      response = @client.rest_get(uri, @api_version)
+      @client.response_handler(response)
+    end
+
     private
 
+    # Converts Date, Time, or String objects to iso8601 string
+    def convert_time(t)
+      case t
+      when nil then nil
+      when Date then t.to_time.utc.iso8601(3)
+      when Time then t.utc.iso8601(3)
+      when String then Time.parse(t).utc.iso8601(3)
+      else fail InvalidResource, "Invalid time format '#{t.class}'. Valid options are Time, Date, or String"
+      end
+    rescue StandardError => e
+      raise InvalidResource, "Failed to parse time value '#{t}'. #{e.message}"
+    end
+
     # Set power state. Takes into consideration the current state and does the right thing
     def set_power_state(state, force)
       refresh
@@ -83,6 +205,5 @@ module OneviewSDK
       set_all(body)
       true
     end
-
   end
 end

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

@@ -1,18 +1,50 @@
+# (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
   # Server hardware type resource implementation
   class ServerHardwareType < Resource
     BASE_URI = '/rest/server-hardware-types'.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'] ||= 'server-hardware-type-4'
     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
+
+    # Update resource attributes
+    # @param [Hash] attributes attributes to be updated
+    # @option attributes [String] :name server hardware type name
+    # @option attributes [String] :description server hardware type description
+    # @return [OneviewSDK::ServerHardwareType] self
     def update(attributes = {})
       set_all(attributes)
       ensure_client && ensure_uri
@@ -22,6 +54,5 @@ module OneviewSDK
       @client.response_handler(response)
       self
     end
-
   end
 end