test-oneview 5.18.0

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

@@ -0,0 +1,106 @@
+# (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
+    # Uplink sets resource implementation to be used in logical interconnect groups
+    class LIGUplinkSet < Resource
+      BASE_URI = '/rest/logical-interconnect-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['logicalPortConfigInfos'] ||= []
+        @data['lacpTimer'] ||= 'Short' unless @data['networkType'] == 'FibreChannel' # FibreChannel does not need set up lacpTimer
+        @data['mode'] ||= 'Auto'
+        @data['networkUris'] ||= []
+      end
+
+      # Add an existing network to the network list.
+      # Ethernet and FibreChannel networks are allowed.
+      # @param [OneviewSDK::Resource] network The resource to be added to the list
+      def add_network(network)
+        network.retrieve! unless network['uri']
+        @data['networkUris'] << network['uri']
+      end
+
+      # Specify one uplink passing the virtual connect bay and the port to be attached.
+      # @param [Fixnum] bay number to identify the VC
+      # @param [String, Fixnum] port to attach the uplink. Examples: X1, D1, Q1, Q1.1, Q1:1, 67 ...
+      # @param [String] interconnect model name
+      # @param [Fixnum] enclosure number for multi-frame configurations
+      def add_uplink(bay, port, type = nil, enclosure_index = 1)
+        enclosure_index = type && type.include?('Virtual Connect SE 16Gb FC Module for Synergy') ? -1 : enclosure_index
+        port = if type
+                 fetch_relative_value_of(port, type)
+               else
+                 # Detect Integer port: for example 67 or '67'
+                 port.to_s == port.to_i.to_s ? port.to_i : relative_value_of(port)
+               end
+
+        entry = {
+          'desiredSpeed' => 'Auto',
+          'logicalLocation' => {
+            'locationEntries' => [
+              { 'relativeValue' => bay, 'type' => 'Bay' },
+              { 'relativeValue' => enclosure_index, 'type' => 'Enclosure' },
+              { 'relativeValue' => port, 'type' => 'Port' }
+            ]
+          }
+        }
+        @data['logicalPortConfigInfos'] << entry
+      end
+
+      # Sets all params
+      # @overload sets networkType first
+      def set_all(params = {})
+        params = params.data if params.class <= Resource
+        params = Hash[params.map { |(k, v)| [k.to_s, v] }]
+        network_type = params.delete('networkType')
+        params.each { |key, value| set(key.to_s, value) }
+        set('networkType', network_type) if network_type
+      end
+
+      private
+
+      # Relative values:
+      #   Downlink Ports: D1 is 1, D2 is 2, ....,D15 is 15, D16 is 16;
+      #   Uplink Ports: X1 is 17, X2 is 18, ....,X9 is 25, X10 is 26.
+      def relative_value_of(port)
+        identifier = port.slice!(0)
+        offset = case identifier
+                 when 'D' then 0
+                 when 'X' then 16
+                 else raise InvalidResource, "Port not supported: #{identifier} type not found"
+                 end
+        port.to_i + offset
+      end
+
+      def fetch_relative_value_of(port, type)
+        port_formats = [port.sub('.', ':'), port.sub(':', '.')].uniq
+        interconnect_type = OneviewSDK::Interconnect.get_type(@client, type)
+        unless interconnect_type
+          list = OneviewSDK::Interconnect.get_types(@client).map { |t| t['name'] }
+          raise OneviewSDK::NotFound, "Interconnect type #{type} not found! Supported types: #{list}"
+        end
+        type_port = interconnect_type['portInfos'].find { |p| port_formats.include? p['portName'] }
+        raise OneviewSDK::NotFound, "Port #{port} not found!" unless type_port
+        type_port['portNumber']
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+# (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
+    # Logical downlink resource implementation
+    class LogicalDownlink < Resource
+      BASE_URI = '/rest/logical-downlinks'.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
+
+      # Gets a list of logical downlinks, excluding any existing ethernet network
+      # @param [OneviewSDK::Client] client The client object for the OneView appliance
+      # @return [Array<OneviewSDK::LogicalDownlink] Logical downlink array
+      def self.get_without_ethernet(client)
+        result = []
+        response = client.rest_get(BASE_URI + '/withoutEthernet')
+        members = client.response_handler(response)['members']
+        members.each { |member| result << new(client, member) }
+        result
+      end
+
+      # Gets a logical downlink, excluding any existing ethernet network
+      # @return [OneviewSDK::LogicalDownlink] Logical downlink array
+      def get_without_ethernet
+        response = @client.rest_get(@data['uri'] + '/withoutEthernet')
+        OneviewSDK::LogicalDownlink.new(@client, @client.response_handler(response))
+      end
+    end
+  end
+end

data/lib/oneview-sdk/resource/api200/logical_enclosure.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
+    # Logical enclosure resource implementation
+    class LogicalEnclosure < Resource
+      BASE_URI = '/rest/logical-enclosures'.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
+      end
+
+      # Reapplies the appliance's configuration on the enclosures
+      # @raise [OneviewSDK::IncompleteResource] if the client is not set
+      # @raise [OneviewSDK::IncompleteResource] if the uri is not set
+      # @raise [StandardError] if the reapply fails
+      # @return [OneviewSDK::LogicalEnclosure] self
+      def reconfigure
+        ensure_client && ensure_uri
+        response = @client.rest_put("#{@data['uri']}/configuration", {}, @api_version)
+        @client.response_handler(response)
+        self
+      end
+
+      # Makes this logical enclosure consistent with the enclosure group
+      # @raise [OneviewSDK::IncompleteResource] if the client is not set
+      # @raise [OneviewSDK::IncompleteResource] if the uri is not set
+      # @raise [StandardError] if the process fails
+      # @return [OneviewSDK::LogicalEnclosure] self
+      def update_from_group
+        ensure_client && ensure_uri
+        response = @client.rest_put("#{@data['uri']}/updateFromGroup", {}, @api_version)
+        @client.response_handler(response)
+        self
+      end
+
+      # Get the configuration script
+      # @raise [OneviewSDK::IncompleteResource] if the client is not set
+      # @raise [OneviewSDK::IncompleteResource] if the uri is not set
+      # @raise [StandardError] if retrieving fails
+      # @return [String] script
+      def get_script
+        ensure_client && ensure_uri
+        response = @client.rest_get("#{@data['uri']}/script", {}, @api_version)
+        response.body
+      end
+
+      # Updates the configuration script for the logical enclosure
+      # @raise [OneviewSDK::IncompleteResource] if the client is not set
+      # @raise [OneviewSDK::IncompleteResource] if the uri is not set
+      # @raise [StandardError] if the reapply fails
+      # @return [OneviewSDK::LogicalEnclosure] self
+      def set_script(script)
+        ensure_client && ensure_uri
+        response = @client.rest_put("#{@data['uri']}/script", { 'body' => script }, @api_version)
+        @client.response_handler(response)
+        self
+      end
+
+      # Generates a support dump for the logical enclosure
+      # @raise [OneviewSDK::IncompleteResource] if the client is not set
+      # @raise [OneviewSDK::IncompleteResource] if the uri is not set
+      # @raise [StandardError] if the process fails when generating the support dump
+      # @return [OneviewSDK::LogicalEnclosure] self
+      def support_dump(options)
+        ensure_client && ensure_uri
+        response = @client.rest_post("#{@data['uri']}/support-dumps", { 'body' => options }, @api_version)
+        @client.wait_for(response.header['location'])
+        self
+      end
+    end
+  end
+end

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

@@ -0,0 +1,267 @@
+# (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'
+require_relative '../../resource_helper'
+
+module OneviewSDK
+  module API200
+    # Logical interconnect resource implementation
+    class LogicalInterconnect < Resource
+      include OneviewSDK::ResourceHelper::ConfigurationOperation
+
+      BASE_URI = '/rest/logical-interconnects'.freeze
+      LOCATION_URI = '/rest/logical-interconnects/locations/interconnects'.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'] ||= 'logical-interconnectV3'
+      end
+
+      # Creates an Interconnect in the desired bay in a specified enclosure
+      # WARN: It does not create the LOGICAL INTERCONNECT itself.
+      # It will fail if no interconnect is already present on the specified position
+      # @param [Fixnum] bay_number Number of the bay to put the interconnect
+      # @param [OneviewSDK::Resource] enclosure Enclosure to insert the interconnect
+      def create(bay_number, enclosure)
+        enclosure.ensure_uri
+        entry = {
+          'locationEntries' => [
+            { 'value' => bay_number, 'type' => 'Bay' },
+            { 'value' => enclosure['uri'], 'type' => 'Enclosure' }
+          ]
+        }
+        response = @client.rest_post(self.class::LOCATION_URI, { 'body' => entry }, @api_version)
+        @client.response_handler(response)
+      end
+
+      # Deletes an INTERCONNECT
+      # WARN: This will not delete the LOGICAL INTERCONNECT itself, and may cause inconsistency between the enclosure and LIG
+      # @param [Fixnum] bay_number The bay number to locate the logical interconnect
+      # @param [OneviewSDK::Enclosure] enclosure Enclosure to remove the logical interconnect
+      # @return [OneviewSDK::LogicalInterconnect] self
+      def delete(bay_number, enclosure)
+        enclosure.ensure_uri
+        delete_uri = self.class::LOCATION_URI + "?location=Enclosure:#{enclosure['uri']},Bay:#{bay_number}"
+        response = @client.rest_delete(delete_uri, {}, @api_version)
+        @client.response_handler(response)
+        self
+      end
+
+      # Updates internal networks on the logical interconnect
+      # @param [OneviewSDK::EthernetNetworks] networks List of networks to update the Logical Interconnect
+      def update_internal_networks(*networks)
+        uris = []
+        return @client.response_handler(@client.rest_put(@data['uri'] + '/internalNetworks', 'body' => [])) unless networks
+        networks.each do |net|
+          net.retrieve! unless net['uri']
+          uris.push(net['uri'])
+        end
+        response = @client.rest_put(@data['uri'] + '/internalNetworks', 'body' => uris)
+        body = @client.response_handler(response)
+        set_all(body)
+      end
+
+      # Lists internal networks on the logical interconnect
+      # @return [OneviewSDK::Resource] List of networks
+      def list_vlan_networks
+        ensure_client && ensure_uri
+        results = OneviewSDK::Resource.find_by(@client, {}, @data['uri'] + '/internalVlans')
+        internal_networks = []
+        variant = self.class.name.split('::').at(-2)
+        results.each do |vlan|
+          net = if vlan['generalNetworkUri'].include? 'ethernet-network'
+                  OneviewSDK.resource_named('EthernetNetwork', @client.api_version, variant).new(@client, uri: vlan['generalNetworkUri'])
+                elsif vlan['generalNetworkUri'].include? 'fc-network'
+                  OneviewSDK.resource_named('FCNetwork', @client.api_version, variant).new(@client, uri: vlan['generalNetworkUri'])
+                else
+                  OneviewSDK.resource_named('FCoENetwork', @client.api_version, variant).new(@client, uri: vlan['generalNetworkUri'])
+                end
+          net.retrieve!
+          internal_networks.push(net)
+        end
+        internal_networks
+      end
+
+      # Updates ethernet settings of the logical interconnect
+      # @note The attribute is defined inside the instance of the Logical Interconnect
+      # @return Updated instance of the Logical Interconnect
+      def update_ethernet_settings
+        ensure_client && ensure_uri
+        raise IncompleteResource, 'Please retrieve the Logical Interconnect before trying to update' unless @data['ethernetSettings']
+        update_options = {
+          'If-Match' =>  @data['ethernetSettings'].delete('eTag'),
+          'body' => @data['ethernetSettings']
+        }
+        response = @client.rest_put(@data['uri'] + '/ethernetSettings', update_options, @api_version)
+        body = @client.response_handler(response)
+        set_all(body)
+      end
+
+      # Updates settings of the logical interconnect
+      # @param options Options to update the Logical Interconnect
+      # @return Updated instance of the Logical Interconnect
+      def update_settings(options = {})
+        ensure_client && ensure_uri
+        options['type'] ||= 'InterconnectSettingsV3'
+        options['ethernetSettings'] ||= {}
+        options['ethernetSettings']['type'] ||= 'EthernetInterconnectSettingsV3'
+        update_options = {
+          'If-Match' =>  @data['eTag'],
+          'body' => options
+        }
+        response = @client.rest_put(@data['uri'] + '/settings', update_options, @api_version)
+        body = @client.response_handler(response)
+        set_all(body)
+      end
+
+      # Returns logical interconnects to a consistent state.
+      # The current logical interconnect state is compared to the associated logical interconnect group.
+      # @return returns the updated object
+      def compliance
+        ensure_client && ensure_uri
+        response = @client.rest_put(@data['uri'] + '/compliance', {}, @api_version)
+        body = client.response_handler(response)
+        set_all(body)
+      end
+
+      # Gets a collection of uplink ports from the member interconnects
+      # which are eligible for assignment to an analyzer port.
+      # @return [Hash] Hash of uplink ports eligibles for assignment to an analyzer port
+      def get_unassigned_uplink_ports_for_port_monitor
+        ensure_client && ensure_uri
+        response = @client.rest_get("#{@data['uri']}/unassignedUplinkPortsForPortMonitor")
+        @client.response_handler(response)
+        body = @client.response_handler(response)
+        body['members']
+      end
+
+      # Updates port monitor settings of the Logical Interconnect
+      # @note The attribute is defined inside the instance of the Logical Interconnect
+      # @return Updated instance of the Logical Interconnect
+      def update_port_monitor
+        raise IncompleteResource, 'Please retrieve the Logical Interconnect before trying to update' unless @data['portMonitor']
+        update_options = {
+          'If-Match' =>  @data['portMonitor'].delete('eTag'),
+          'body' => @data['portMonitor']
+        }
+        response = @client.rest_put("#{@data['uri']}/port-monitor", update_options, @api_version)
+        body = @client.response_handler(response)
+        set_all(body)
+      end
+
+      # Updates QoS aggregated configuration of the Logical Interconnect
+      # @note The attribute is defined inside the instance of the Logical Interconnect
+      # @return Updated instance of the Logical Interconnect
+      def update_qos_configuration
+        raise IncompleteResource, 'Please retrieve the Logical Interconnect before trying to update' unless @data['qosConfiguration']
+        update_options = {
+          'If-Match' =>  @data['qosConfiguration'].delete('eTag'),
+          'body' => @data['qosConfiguration']
+        }
+        response = @client.rest_put(@data['uri'] + '/qos-aggregated-configuration', update_options, @api_version)
+        body = @client.response_handler(response)
+        set_all(body)
+      end
+
+      # Updates telemetry configuration of the Logical Interconnect
+      # @note The attribute is defined inside the instance of the Logical Interconnect
+      # @return Updated instance of the Logical Interconnect
+      def update_telemetry_configuration
+        raise IncompleteResource, 'Please retrieve the Logical Interconnect before trying to update' unless @data['telemetryConfiguration']
+        update_options = {
+          'If-Match' =>  @data['telemetryConfiguration'].delete('eTag'),
+          'body' => @data['telemetryConfiguration']
+        }
+        response = @client.rest_put(@data['telemetryConfiguration']['uri'], update_options, @api_version)
+        body = @client.response_handler(response)
+        set_all(body)
+      end
+
+      # Updates snmp configuration of the Logical Interconnect
+      # @note The attribute is defined inside the instance of the Logical Interconnect.
+      #   Use helper methods to add the trap destination values: #add_snmp_trap_destination and #generate_trap_options
+      # @return Updated instance of the Logical Interconnect
+      def update_snmp_configuration
+        raise IncompleteResource, 'Please retrieve the Logical Interconnect before trying to update' unless @data['snmpConfiguration']
+        update_options = {
+          'If-Match' =>  @data['snmpConfiguration'].delete('eTag'),
+          'body' => @data['snmpConfiguration']
+        }
+        response = @client.rest_put(@data['uri'] + '/snmp-configuration', update_options, @api_version)
+        body = @client.response_handler(response)
+        set_all(body)
+      end
+
+      # It will add one trap destination to the Logical Interconnect SNMP configuration
+      # @param trap_format [String] SNMP version for this trap destination, `'SNMPv1'` or `'SNMPv2'` or `'SNMPv3'`
+      # @param trap_destination [String] The trap destination IP address or host name
+      # @param community_string [String] The Authentication string for the trap destination
+      # @param trap_options [Hash] Hash with the options of the trap. Create it using generate_trap_options method
+      def add_snmp_trap_destination(trap_destination, trap_format = 'SNMPv1', community_string = 'public', trap_options = {})
+        trap_options['communityString'] = community_string
+        trap_options['trapDestination'] = trap_destination
+        trap_options['trapFormat'] = trap_format
+        @data['snmpConfiguration']['trapDestinations'].push(trap_options)
+      end
+
+      # Generates trap options to be used in add_snmp_trap_destination method
+      # @param enet_trap_categories [Array]  Filter the traps for this trap destination by the list of configured Ethernet traps
+      #   can contain, `'Other'` or `'PortStatus'` or `'PortThresholds'`
+      # @param fc_trap_categories [Array]  Filter the traps for this trap destination by the list of configured Fibre Channel traps
+      #   can contain, `'Other'` or `'PortStatus'`
+      # @param vcm_trap_categories [Array]  Filter the traps for this trap destination by the list of configured VCM trap, `'Legacy'`
+      # @param trap_severities [Array]  Filter the traps for this trap destination by the list of configured severities
+      #   can contain, `'Critical'` or `'Info'` or `'Major'` or `'Minor'` or `'Normal'` or `'Unknown'` or `'Warning'`
+      # @return [Hash] Contains all trap options for one SNMP destination
+      def generate_trap_options(enet_trap_categories = [], fc_trap_categories = [], vcm_trap_categories = [], trap_severities = [])
+        options = {
+          'enetTrapCategories' => enet_trap_categories,
+          'vcmTrapCategories' => vcm_trap_categories,
+          'fcTrapCategories' => fc_trap_categories,
+          'trapSeverities' => trap_severities
+        }
+        options
+      end
+
+      # Gets the installed firmware for a logical interconnect.
+      # @return [Hash] Contains all firmware information
+      def get_firmware
+        ensure_client && ensure_uri
+        response = @client.rest_get(@data['uri'] + '/firmware')
+        @client.response_handler(response)
+      end
+
+      # Update firmware
+      # @param [String] command
+      # @param [OneviewSDK::FirmwareDriver] firmware_driver
+      # @param [Hash] firmware_options
+      # @raise [OneviewSDK::IncompleteResource] if the client or uri is not set
+      def firmware_update(command, firmware_driver, firmware_options)
+        ensure_client && ensure_uri
+        firmware_options['command'] = command
+        firmware_options['sppUri'] =  firmware_driver['uri']
+        firmware_options['sppName'] = firmware_driver['name']
+        update_json = {
+          'If-Match' => '*',
+          'body' => firmware_options
+        }
+        response = @client.rest_put(@data['uri'] + '/firmware', update_json)
+        @client.response_handler(response)
+      end
+    end
+  end
+end