oneview-sdk 2.2.1 → 3.0.0

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

@@ -0,0 +1,68 @@
+# (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.
+
+require_relative 'resource'
+
+module OneviewSDK
+  module API200
+    # Network set resource implementation
+    class NetworkSet < Resource
+      BASE_URI = '/rest/network-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['connectionTemplateUri'] ||= nil
+        @data['nativeNetworkUri'] ||= nil
+        @data['networkUris'] ||= []
+        @data['type'] ||= 'network-set'
+      end
+
+      # Sets the native network for the network set
+      # @param [OneviewSDK::EthernetNetwork] ethernet_network Ethernet Network
+      def set_native_network(ethernet_network)
+        @data['nativeNetworkUri'] = ethernet_network['uri']
+        @data['networkUris'] << ethernet_network['uri'] unless @data['networkUris'].include?(ethernet_network['uri'])
+      end
+
+      # Adds an ethernet network to the network set
+      # @param [OneviewSDK::EthernetNetwork] ethernet_network Ethernet Network
+      def add_ethernet_network(ethernet_network)
+        @data['networkUris'] << ethernet_network['uri'] unless @data['networkUris'].include?(ethernet_network['uri'])
+      end
+
+      # Removes an ethernet network from the network set
+      # @param [OneviewSDK::EthernetNetwork] ethernet_network Ethernet Network
+      def remove_ethernet_network(ethernet_network)
+        @data['networkUris'].delete(ethernet_network['uri']) if @data['networkUris'].include?(ethernet_network['uri'])
+      end
+
+      # Lists network sets excluding ethernet networks
+      # @param [OneviewSDK::Client] client The client object for the OneView appliance
+      # @return [Array] List of network sets
+      def self.get_without_ethernet(client)
+        response = client.rest_get(BASE_URI + '/withoutEthernet')
+        client.response_handler(response)
+      end
+
+      # Lists network set excluding ethernet networks
+      # @return [OneviewSDK::NetworkSet] Network set
+      def get_without_ethernet
+        response = @client.rest_get(@data['uri'] + '/withoutEthernet')
+        @client.response_handler(response)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,178 @@
+# (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.
+
+require_relative 'resource'
+
+module OneviewSDK
+  module API200
+    # Power device resource implementation
+    class PowerDevice < Resource
+      BASE_URI = '/rest/power-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::PowerDevice] 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['deviceType'] ||= 'BranchCircuit'
+        @data['phaseType'] ||= 'Unknown'
+        @data['powerConnections'] ||= []
+      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 an iPDU and bring all components under management by discovery of its management modules
+      # @param [OneviewSDK::Client] client The client object for the OneView appliance
+      # @param [Hash] options options for the iPDU
+      # @return [OneviewSDK::PowerDevice] The iPDU power device created in OneView
+      def self.discover(client, options)
+        options['force'] ||= options[:force] || false
+        response = client.rest_post(BASE_URI + '/discover', 'body' => options)
+        power_device_info = client.response_handler(response)
+        new(client, power_device_info)
+      end
+
+      # Retrieves the list of power devices given an iPDU hostname
+      # @param [OneviewSDK::Client] client The client object for the OneView appliance
+      # @param [String] hostname The iPDU hostname
+      # @return [Array] array of OneviewSDK::PowerDevice
+      def self.get_ipdu_devices(client, hostname)
+        find_by(client, managedBy: { hostName: hostname })
+      end
+
+      # Gets the power state of a power device
+      # @return [String] Power state
+      def get_power_state
+        response = @client.rest_get(@data['uri'] + '/powerState')
+        response.body
+      end
+
+      # Adds a power connection
+      # @param [OneviewSDK::Resource] resource
+      # @param [Integer] connection connection number
+      def add_connection(resource, connection)
+        @data['powerConnections'] << {
+          'connectionUri' => resource['uri'],
+          'deviceConnection' => connection,
+          'sourceConnection' => connection
+        }
+      end
+
+      # Removes the power connection
+      # @param [OneviewSDK::Resource] resource
+      # @param [Integer] connection connection number
+      def remove_connection(resource, connection)
+        @data['powerConnections'].reject! do |conn|
+          conn['connectionUri'] == resource['uri'] && conn['deviceConnection'] == connection
+        end
+      end
+
+      # Sets the power state of the power delivery device
+      # @param [String] state On|Off
+      def set_power_state(state)
+        response = @client.rest_put(@data['uri'] + '/powerState', 'body' => { powerState: state })
+        @client.response_handler(response)
+      end
+
+      # Refreshes a power delivery device
+      # @param [Hash] options
+      # @option options [String] :refreshState
+      # @option options [String] :username
+      # @option options [String] :password
+      def set_refresh_state(options)
+        response = @client.rest_put(@data['uri'] + '/refreshState', 'body' => options)
+        @client.response_handler(response)
+      end
+
+      # Retrieves the unit identification state of the specified power outlet
+      # @return [String] Uid state
+      def get_uid_state
+        response = @client.rest_get(@data['uri'] + '/uidState')
+        response.body
+      end
+
+      # Sets the unit identification light state of the power delivery device
+      # @param [String] state On|Off
+      def set_uid_state(state)
+        response = @client.rest_put(@data['uri'] + '/uidState', 'body' => { uidState: state })
+        @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
+      # @return [Hash] Utilization data
+      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 raise "Invalid time format '#{t.class}'. Valid options are Time, Date, or String"
+        end
+      rescue StandardError => e
+        raise "Failed to parse time value '#{t}'. #{e.message}"
+      end
+    end
+  end
+end

data/lib/oneview-sdk/resource/api200/rack.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.
+
+require_relative 'resource'
+
+module OneviewSDK
+  module API200
+    # Rack resource implementation
+    class Rack < Resource
+      BASE_URI = '/rest/racks'.freeze
+      UNIQUE_IDENTIFIERS = %w(name uri serialNumber).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
+end

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

@@ -0,0 +1,18 @@
+# (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
+  module API200
+    # Base Resource implementation for API200 resources
+    class Resource < OneviewSDK::Resource
+    end
+  end
+end

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

@@ -0,0 +1,92 @@
+# (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.
+
+require_relative 'resource'
+
+module OneviewSDK
+  module API200
+    # 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
+        raise '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
+end