oneview-sdk 1.0.0

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

@@ -0,0 +1,169 @@
+require 'time'
+require 'date'
+
+module OneviewSDK
+  # Enclosure resource implementation
+  class Enclosure < Resource
+    BASE_URI = '/rest/enclosures'.freeze
+
+    def initialize(client, params = {}, api_ver = nil)
+      super
+      # Default values:
+      @data['type'] ||= 'EnclosureV200'
+    end
+
+    # @!group Validates
+
+    VALID_LICENSING_INTENTS = %w(NotApplicable OneView OneViewNoiLO OneViewStandard).freeze
+    def validate_licensingIntent(value)
+      fail 'Invalid licensingIntent' unless VALID_LICENSING_INTENTS.include?(value) || value.nil?
+    end
+
+    VALID_REFRESH_STATES = %w(NotRefreshing RefreshFailed RefreshPending Refreshing).freeze
+    def validate_refreshState(value)
+      fail 'Invalid refreshState' unless VALID_REFRESH_STATES.include?(value)
+    end
+
+    # @!endgroup
+
+    # Claim/configure the enclosure and its components to the appliance
+    def create
+      ensure_client
+      required_attributes = %w(enclosureGroupUri hostname username password licensingIntent)
+      required_attributes.each { |k| fail "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
+
+    # Override update operation because only the name and rackName can be updated (& it uses PATCH).
+    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
+
+    # Reapply 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
+
+
+    # Refresh 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
+      validate_refreshState(s) # Validate refreshState
+      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
+
+    # Get 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
+
+    # Get 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
+
+    # Update specific attributes of a given enclosure resource
+    # @param [String] operation operation to be performed
+    # @param [String] path path
+    # @param [String] value value
+    def update_attribute(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 one Enclosure Group to the enclosure to be added
+    # @param [OneviewSDK<Resource>] eg Enclosure Group associated
+    def set_enclosure_group(eg)
+      eg.retrieve! unless eg['uri']
+      @data['enclosureGroupUri'] = eg['uri']
+    end
+
+
+    private
+
+    # Convert 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 "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

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

@@ -0,0 +1,98 @@
+module OneviewSDK
+  # Enclosure group resource implementation
+  class EnclosureGroup < Resource
+    BASE_URI = '/rest/enclosure-groups'.freeze
+
+    def initialize(client, params = {}, api_ver = nil)
+      super
+      # Default values:
+      @data['type'] ||= 'EnclosureGroupV200'
+      @data['interconnectBayMappingCount'] ||= 8
+      create_interconnect_bay_mapping unless @data['interconnectBayMappings']
+    end
+
+    # @!group Validates
+
+    VALID_INTERCONNECT_BAY_MAPPING_COUNTS = (1..8).freeze
+    def validate_interconnectBayMappingCount(value)
+      fail 'Interconnect Bay Mapping Count out of range 1..8' unless VALID_INTERCONNECT_BAY_MAPPING_COUNTS.include?(value)
+    end
+
+    VALID_IP_ADDRESSING_MODES = %w(DHCP External IpPool).freeze
+    def validate_ipAddressingMode(value)
+      return if !@data['enclosureTypeUri'] || /c7000/ =~ @data['enclosureTypeUri']
+      is_not_a_c7000_without_ip_addressing_mode = !(/c7000/ =~ @data['enclosureTypeUri']) && !value
+      fail "Invalid ip AddressingMode: #{value}" if !VALID_IP_ADDRESSING_MODES.include?(value) || is_not_a_c7000_without_ip_addressing_mode
+    end
+
+    VALID_PORT_MAPPING_COUNTS = (0..8).freeze
+    def validate_portMappingCount(value)
+      fail 'Port Mapping Count out of range 0..8' unless VALID_PORT_MAPPING_COUNTS.include?(value)
+    end
+
+    VALID_POWER_MODES = ['RedundantPowerFeed', 'RedundantPowerSupply', nil].freeze
+    def validate_powerMode(value)
+      fail 'Invalid powerMode' unless VALID_POWER_MODES.include?(value)
+    end
+
+    VALID_STACKING_MODES = %w(Enclosure MultiEnclosure None SwitchPairs).freeze
+    def validate_stackingMode(value)
+      fail 'Invalid stackingMode' unless VALID_STACKING_MODES.include?(value)
+    end
+
+    # @!endgroup
+
+    # Get the script executed by enclosures in this enclosure group
+    # @return [String] 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
+
+    # Change the script executed by enclosures in this enclosure group
+    # @param [String] body 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
+
+    # Add 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
+
+    # Create 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

@@ -0,0 +1,60 @@
+module OneviewSDK
+  # Ethernet network resource implementation
+  class EthernetNetwork < Resource
+    BASE_URI = '/rest/ethernet-networks'.freeze
+
+    def initialize(client, params = {}, api_ver = nil)
+      super
+      # Default values:
+      @data['ethernetNetworkType'] ||= 'Tagged'
+      @data['type'] ||= 'ethernet-networkV3'
+    end
+
+    # @!group Validates
+
+    VALID_ETHERNET_NETWORK_TYPES = %w(NotApplicable Tagged Tunnel Unknown Untagged).freeze
+    # Validate ethernetNetworkType
+    # @param [String] value Notapplicable, Tagged, Tunnel, Unknown, Untagged
+    def validate_ethernetNetworkType(value)
+      fail 'Invalid network type' unless VALID_ETHERNET_NETWORK_TYPES.include?(value)
+    end
+
+    VALID_PURPOSES = %w(FaultTolerance General Management VMMigration).freeze
+    # Validate purpose
+    # @param [String] value FaultTolerance, General, Management, VMMigration
+    def validate_purpose(value)
+      fail 'Invalid ethernet purpose' unless VALID_PURPOSES.include?(value)
+    end
+
+    # @!endgroup
+
+    # Bulk create ethernet networks
+    # @param [Client] client client to connect with OneView
+    # @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
+
+    # Get associatedProfiles
+    def get_associated_profiles
+      ensure_client && ensure_uri
+      response = @client.rest_get("#{@data['uri']}/associatedProfiles", @api_version)
+      response.body
+    end
+
+    # Get associatedUplinkGroups
+    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/fc_network.rb

@@ -0,0 +1,31 @@
+module OneviewSDK
+  # FC network resource implementation
+  class FCNetwork < Resource
+    BASE_URI = '/rest/fc-networks'.freeze
+
+    def initialize(client, params = {}, api_ver = nil)
+      super
+      # Default values
+      @data['autoLoginRedistribution'] ||= false
+      @data['type'] ||= 'fc-networkV2'
+      @data['linkStabilityTime'] ||= 30
+      @data['fabricType'] ||= 'FabricAttach'
+    end
+
+    # @!group Validates
+
+    VALID_FABRIC_TYPES = %w(DirectAttach FabricAttach).freeze
+    def validate_fabricType(value)
+      fail 'Invalid fabric type' unless VALID_FABRIC_TYPES.include?(value)
+    end
+
+    VALID_LINK_STABILITY_TIMES = (1..1800).freeze
+    def validate_linkStabilityTime(value)
+      return unless @data['fabricType'] && @data['fabricType'] == 'FabricAttach'
+      fail 'Link stability time out of range 1..1800' unless VALID_LINK_STABILITY_TIMES.include?(value)
+    end
+
+    # @!endgroup
+
+  end
+end

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

@@ -0,0 +1,25 @@
+module OneviewSDK
+  # FCoE network resource implementation
+  class FCoENetwork < Resource
+    BASE_URI = '/rest/fcoe-networks'.freeze
+
+    def initialize(client, params = {}, api_ver = nil)
+      super
+      # Default values:
+      @data['connectionTemplateUri'] ||= nil
+      @data['type'] ||= 'fcoe-network'
+    end
+
+    # @!group Validates
+
+    VALID_VLAN_IDS = (1..4094).freeze
+    # Validate vlanId
+    # @param [Fixnum] value 1..4094
+    def validate_vlanId(value)
+      fail 'vlanId out of range 1..4094' unless VALID_VLAN_IDS.include?(value)
+    end
+
+    # @!endgroup
+
+  end
+end

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

@@ -0,0 +1,37 @@
+module OneviewSDK
+  # Firmware bundle resource implementation
+  class FirmwareBundle
+    BASE_URI = '/rest/firmware-bundles'.freeze
+    BOUNDARY = '---OneView-SDK-RubyFormBoundaryWzS4H31b7UMbKMCx'.freeze
+
+    # Upload a firmware bundle file
+    # @param [OneviewSDK::Client] client
+    # @param [String] file_path
+    # @return [OneviewSDK::FirmwareDriver] if the upload was sucessful, return a FirmwareDriver object
+    def self.upload(client, file_path)
+      fail "ERROR: File '#{file_path}' not found!" unless File.file?(file_path)
+      type = case File.extname(file_path)
+             when '.zip' then 'application/x-zip-compressed'
+             when '.exe' then 'application/x-msdownload'
+             else 'application/octet-stream'
+             end
+
+      body = "--#{BOUNDARY}\r\n"
+      body << "Content-Disposition: form-data; name=\"file\"; filename=\"#{File.basename(file_path)}\"\r\n"
+      body << "Content-Type: #{type}\r\n\r\n"
+      body << File.read(file_path)
+      body << "\r\n--#{BOUNDARY}--"
+
+      options = {
+        'Content-Type' => "multipart/form-data; boundary=#{BOUNDARY}",
+        'uploadfilename' => File.basename(file_path),
+        'body' => body
+      }
+
+      response = client.rest_post(BASE_URI, options)
+      data = client.response_handler(response)
+      OneviewSDK::FirmwareDriver.new(client, data)
+    end
+
+  end
+end

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

@@ -0,0 +1,21 @@
+module OneviewSDK
+  # Firmware driver resource implementation
+  class FirmwareDriver < Resource
+    BASE_URI = '/rest/firmware-drivers'.freeze
+
+    def initialize(client, params = {}, api_ver = nil)
+      super
+      # Default values
+      @data['type'] ||= 'firmware-baselines'
+    end
+
+    def create
+      fail 'Method not available for this resource!'
+    end
+
+    def update
+      create
+    end
+
+  end
+end