oneview-sdk 2.2.1 → 3.0.0

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

@@ -1,77 +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
-  # Datacenter resource implementation
-  class Datacenter < Resource
-    BASE_URI = '/rest/datacenters'.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::Datacenter] 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['contents'] ||= []
-    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 existing rack to the datacenter
-    # @param [OneviewSDK::Rack] rack rack
-    # @param [Decimal] pos_x x position
-    # @param [Decimal] pos_y y position
-    # @param [Decimal] rotation Rotation degrees (0-359) around the center of the resource
-    def add_rack(rack, pos_x, pos_y, rotation = 0)
-      @data['contents'] << {
-        'resourceUri' => rack['uri'],
-        'x' => pos_x,
-        'y' => pos_y,
-        'rotation' => rotation
-      }
-    end
-
-    # Removes a rack from the datacenter
-    # @param [OneviewSDK::Rack] rack rack
-    def remove_rack(rack)
-      @data['contents'].reject! { |resource| resource['resourceUri'] == rack['uri'] }
-    end
-
-    # Gets a list of the visual content objects
-    # @return [Hash]
-    def get_visual_content
-      response = @client.rest_get(@data['uri'] + '/visualContent')
-      @client.response_handler(response)
-    end
-  end
-end

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

@@ -1,191 +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.
-
-require 'time'
-require 'date'
-
-module OneviewSDK
-  # Enclosure resource implementation
-  class Enclosure < Resource
-    BASE_URI = '/rest/enclosures'.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'] ||= 'EnclosureV200'
-    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
-
-    # Claim/configure the enclosure and its components to the appliance
-    # @note Calls the refresh method to set additional data
-    # @return [OneviewSDK::Enclosure] self
-    def add
-      ensure_client
-      required_attributes = %w(enclosureGroupUri hostname username password licensingIntent)
-      required_attributes.each { |k| fail IncompleteResource, "Missing required attribute: '#{k}'" unless @data.key?(k) }
-
-      optional_attrs = %w(enclosureUri firmwareBaselineUri force forceInstallFirmware state unmanagedEnclosure updateFirmwareOn)
-      temp_data = @data.select { |k, _v| required_attributes.include?(k) || optional_attrs.include?(k) }
-      response = @client.rest_post(self.class::BASE_URI, { 'body' => temp_data }, @api_version)
-      new_data = @client.response_handler(response)
-      old_name = @data.select { |k, _v| %w(name rackName).include?(k) } # Save name (if given)
-      %w(username password hostname).each { |k| @data.delete(k) } # These are no longer needed
-      set_all(new_data)
-      set_all(old_name)
-      update
-      self
-    end
-
-    # Overrides the update operation because only the name and rackName can be updated (and it uses PATCH).
-    # @param [Hash] attributes attributes to be updated
-    # @return [OneviewSDK::Enclosure] self
-    def update(attributes = {})
-      set_all(attributes)
-      ensure_client && ensure_uri
-      cur_state = self.class.find_by(@client, uri: @data['uri']).first
-      unless cur_state[:name] == @data['name']
-        temp_data = [{ op: 'replace', path: '/name', value: @data['name'] }]
-        response = @client.rest_patch(@data['uri'], { 'body' => temp_data }, @api_version)
-        @client.response_handler(response)
-      end
-      unless cur_state[:rackName] == @data['rackName']
-        temp_data = [{ op: 'replace', path: '/rackName', value: @data['rackName'] }]
-        response = @client.rest_patch(@data['uri'], { 'body' => temp_data }, @api_version)
-        @client.response_handler(response)
-      end
-      self
-    end
-
-    # Reapplies the enclosure configuration
-    def configuration
-      ensure_client && ensure_uri
-      response = @client.rest_put(@data['uri'] + '/configuration', {}, @api_version)
-      new_data = @client.response_handler(response)
-      set_all(new_data)
-    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,
-          refreshForceOptions: options
-        }
-      }
-      response = @client.rest_put(@data['uri'] + '/refreshState', requestBody, @api_version)
-      new_data = @client.response_handler(response)
-      set_all(new_data)
-    end
-
-    # Gets the enclosure script content
-    # @return [String] Script content
-    def script
-      ensure_client && ensure_uri
-      response = @client.rest_get(@data['uri'] + '/script', @api_version)
-      @client.response_handler(response)
-    end
-
-    # Gets the enclosure settings that describe the environmental configuration
-    # @return [Hash] The enclosure envirnomental 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
-
-    # Updates specific attributes of a given enclosure resource
-    # @param [String] operation operation to be performed
-    # @param [String] path path
-    # @param [String] value value
-    def patch(operation, path, value)
-      ensure_client && ensure_uri
-      response = @client.rest_patch(@data['uri'], { 'body' => [{ op: operation, path: path, value: value }] }, @api_version)
-      @client.response_handler(response)
-    end
-
-    # Associates an enclosure group to the enclosure
-    # @param [OneviewSDK<Resource>] eg Enclosure Group associated
-    def set_enclosure_group(eg)
-      eg.retrieve! unless eg['uri']
-      @data['enclosureGroupUri'] = eg['uri']
-    end
-
-    private
-
-    # Converts Date, Time, or String objects to iso8601 string
-    # @raise [InvalidResource] if time is not formatted correctly
-    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
-  end
-end

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

@@ -1,82 +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
-  # Enclosure group resource implementation
-  class EnclosureGroup < Resource
-    BASE_URI = '/rest/enclosure-groups'.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['type'] ||= 'EnclosureGroupV200'
-      @data['interconnectBayMappingCount'] ||= 8
-      create_interconnect_bay_mapping unless @data['interconnectBayMappings']
-    end
-
-    # Get the script executed by enclosures in this enclosure group
-    # @return [String] The script for this enclosure group
-    def get_script
-      ensure_client && ensure_uri
-      response = @client.rest_get(@data['uri'] + '/script', @api_version)
-      @client.response_handler(response)
-    end
-
-    # Changes the script executed by the enclosures in this enclosure group
-    # @param [String] body The script to be executed
-    # @return true if set successfully
-    def set_script(body)
-      ensure_client && ensure_uri
-      response = @client.rest_put(@data['uri'] + '/script', { 'body' => body }, @api_version)
-      @client.response_handler(response)
-      true
-    end
-
-    # Adds the logical interconnect group
-    # @param [OneviewSDK::LogicalInterconnectGroup] lig Logical Interconnect Group
-    def add_logical_interconnect_group(lig)
-      lig.retrieve! unless lig['uri']
-      lig['interconnectMapTemplate']['interconnectMapEntryTemplates'].each do |entry|
-        entry['logicalLocation']['locationEntries'].each do |location|
-          add_lig_to_bay(location['relativeValue'], lig) if location['type'] == 'Bay' && entry['permittedInterconnectTypeUri']
-        end
-      end
-    end
-
-    # Creates the interconnect bay mapping
-    def create_interconnect_bay_mapping
-      @data['interconnectBayMappings'] = []
-      1.upto(@data['interconnectBayMappingCount']) do |bay_number|
-        entry = {
-          'interconnectBay' => bay_number,
-          'logicalInterconnectGroupUri' => nil
-        }
-        @data['interconnectBayMappings'] << entry
-      end
-    end
-
-    private
-
-    # Add logical interconnect group to bay
-    # @param [Integer] bay Bay number
-    # @param [OneviewSDK::LogicalInterconnectGroup] lig Logical Interconnect Group
-    def add_lig_to_bay(bay, lig)
-      @data['interconnectBayMappings'].each do |location|
-        return location['logicalInterconnectGroupUri'] = lig['uri'] if location['interconnectBay'] == bay
-      end
-    end
-
-  end
-end

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

@@ -1,56 +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
-  # Ethernet network resource implementation
-  class EthernetNetwork < Resource
-    BASE_URI = '/rest/ethernet-networks'.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['ethernetNetworkType'] ||= 'Tagged'
-      @data['type'] ||= 'ethernet-networkV3'
-    end
-
-    # Bulk create the ethernet networks
-    # @param [OneviewSDK::Client] client The client object for the OneView appliance
-    # @param [Hash] options information necessary to create networks
-    # @return [Array] list of ethernet networks created
-    def self.bulk_create(client, options)
-      range = options[:vlanIdRange].split('-').map(&:to_i)
-      options[:type] = 'bulk-ethernet-network'
-      response = client.rest_post(BASE_URI + '/bulk', { 'body' => options }, client.api_version)
-      client.response_handler(response)
-      network_names = []
-      range[0].upto(range[1]) { |i| network_names << "#{options[:namePrefix]}_#{i}" }
-      OneviewSDK::EthernetNetwork.get_all(client).select { |network| network_names.include?(network['name']) }
-    end
-
-    # Gets the associated profiles
-    def get_associated_profiles
-      ensure_client && ensure_uri
-      response = @client.rest_get("#{@data['uri']}/associatedProfiles", @api_version)
-      response.body
-    end
-
-    # Gets the associated uplink groups
-    def get_associated_uplink_groups
-      ensure_client && ensure_uri
-      response = @client.rest_get("#{@data['uri']}/associatedUplinkGroups", @api_version)
-      response.body
-    end
-  end
-end

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

@@ -1,41 +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
-  # FC network resource implementation
-  class Fabric < Resource
-    BASE_URI = '/rest/fabrics'.freeze
-
-    # 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 delete
-      unavailable_method
-    end
-
-    # Method is not available
-    # @raise [OneviewSDK::MethodUnavailable] method is not available
-    def refresh
-      unavailable_method
-    end
-  end
-end