oneview-sdk 2.2.1 → 3.0.0

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

@@ -0,0 +1,116 @@
+# (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 interconnect group resource implementation
+    class LogicalInterconnectGroup < Resource
+      BASE_URI = '/rest/logical-interconnect-groups'.freeze
+
+      attr_reader :bay_count
+
+      # 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['enclosureType'] ||= 'C7000'
+        @data['state'] ||= 'Active'
+        @data['uplinkSets'] ||= []
+        @data['type'] ||= 'logical-interconnect-groupV3'
+        @data['interconnectMapTemplate'] ||= {}
+        @data['interconnectMapTemplate']['interconnectMapEntryTemplates'] ||= []
+
+        # User friendly values:
+        @bay_count = 8
+
+        # Create all entries if empty
+        parse_interconnect_map_template if @data['interconnectMapTemplate']['interconnectMapEntryTemplates'] == []
+      end
+
+      # Adds an interconnect
+      # @param [Fixnum] bay Bay number
+      # @param [String] type Interconnect type
+      # @raise [StandardError] if a invalid type is given then raises an error
+      def add_interconnect(bay, type)
+        @data['interconnectMapTemplate']['interconnectMapEntryTemplates'].each do |entry|
+          entry['logicalLocation']['locationEntries'].each do |location|
+            if location['type'] == 'Bay' && location['relativeValue'] == bay
+              entry['permittedInterconnectTypeUri'] = OneviewSDK::Interconnect.get_type(@client, type)['uri']
+            end
+          end
+        end
+      rescue StandardError
+        list = OneviewSDK::Interconnect.get_types(@client).map { |t| t['name'] }
+        raise "Interconnect type #{type} not found! Supported types: #{list}"
+      end
+
+      # Adds an uplink set
+      # @param [OneviewSDK::LIGUplinkSet] uplink_set
+      def add_uplink_set(uplink_set)
+        @data['uplinkSets'] << uplink_set.data
+      end
+
+      # Get the logical interconnect group default settings
+      # @return [Hash] The logical interconnect group settings
+      def get_default_settings
+        get_uri = self.class::BASE_URI + '/defaultSettings'
+        response = @client.rest_get(get_uri, @api_version)
+        @client.response_handler(response)
+      end
+
+      # Gets the logical interconnect group settings
+      # @return [Hash] The logical interconnect group settings
+      def get_settings
+        get_uri = @data['uri'] + '/settings'
+        response = @client.rest_get(get_uri, @api_version)
+        @client.response_handler(response)
+      end
+
+      # Saves the current data attributes to the Logical Interconnect Group
+      # @param [Hash] attributes attributes to be updated
+      # @return Updated instance of the Logical Interconnect Group
+      def update(attributes = {})
+        set_all(attributes)
+        update_options = {
+          'If-Match' =>  @data.delete('eTag'),
+          'Body' => @data
+        }
+        response = @client.rest_put(@data['uri'], update_options, @api_version)
+        body = @client.response_handler(response)
+        set_all(body)
+      end
+
+      private
+
+      # Parse interconnect map template structure
+      def parse_interconnect_map_template
+        1.upto(@bay_count) do |bay_number|
+          entry = {
+            'logicalDownlinkUri' => nil,
+            'logicalLocation' => {
+              'locationEntries' => [
+                { 'relativeValue' => bay_number, 'type' => 'Bay' },
+                { 'relativeValue' => 1, 'type' => 'Enclosure' }
+              ]
+            },
+            'permittedInterconnectTypeUri' => nil
+          }
+          @data['interconnectMapTemplate']['interconnectMapEntryTemplates'] << entry
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,188 @@
+# (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 switch resource implementation
+    class LogicalSwitch < Resource
+      BASE_URI = '/rest/logical-switches'.freeze
+
+      attr_accessor :logical_switch_credentials
+
+      # 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-switch'
+        @logical_switch_credentials = {}
+      end
+
+      # Create method
+      # @raise [OneviewSDK::IncompleteResource] if the client is not set
+      # @raise [StandardError] if the resource creation fails
+      # @return [OneviewSDK::LogicalSwitch] self
+      def create
+        ensure_client
+        request_body = {}
+        request_body['logicalSwitchCredentials'] = generate_logical_switch_credentials
+        request_body['logicalSwitch'] = @data.clone
+        request_body['logicalSwitch']['switchCredentialConfiguration'] = generate_logical_switch_credential_configuration
+        response = @client.rest_post(self.class::BASE_URI, { 'body' => request_body }, @api_version)
+        body = @client.response_handler(response)
+        set_all(body)
+        self
+      end
+
+      # Updates this object using the data that exists on OneView
+      # @note Will overwrite any data that differs from OneView
+      # @return [Resource] self
+      def refresh
+        response = @client.rest_put(@data['uri'] + '/refresh')
+        @client.response_handler(response)
+      end
+
+
+      # @!group Credentials
+      CredentialsSSH = Struct.new(:user, :password)
+
+      CredentialsSNMPV1 = Struct.new(:port, :community_string, :version) do
+        # @return [String] Returns SNMPv1
+        def version
+          'SNMPv1'
+        end
+      end
+
+      CredentialsSNMPV3 = Struct.new(:port, :user, :auth_protocol, :auth_password, :privacy_protocol, :privacy_password, :version) do
+        # @return [String] Returns SNMPv3
+        def version
+          'SNMPv3'
+        end
+      end
+
+      # Sets switch credentials
+      # @param [String] host IP address or host name
+      # @param [CredentialsSSH] ssh_credentials SSH credentials
+      # @param [CredentialsSNMP] snmp_credentials SNMP credentials
+      # @return [Array] An Array containing the SSH and SNMP credentials
+      def set_switch_credentials(host, ssh_credentials, snmp_credentials)
+        raise TypeError, 'Use struct<OneviewSDK::LogicalSwitch::CredentialsSSH>' if ssh_credentials.class != OneviewSDK::LogicalSwitch::CredentialsSSH
+        raise TypeError, 'Use struct<OneviewSDK::LogicalSwitch::CredentialsSNMP>' unless snmp_credentials.respond_to?('version')
+        raise TypeError, 'Use struct<OneviewSDK::LogicalSwitch::CredentialsSNMP>' if snmp_credentials.version != 'SNMPv1' &&
+          snmp_credentials.version != 'SNMPv3'
+        @logical_switch_credentials[host] = [ssh_credentials.clone, snmp_credentials.clone]
+        @logical_switch_credentials[host]
+      end
+
+      # @!endgroup
+
+
+      # Sets the logical switch group
+      # @param [OneviewSDK::logicalSwitchGroup] logical_switch_group Logical switch group
+      def set_logical_switch_group(logical_switch_group)
+        @data['logicalSwitchGroupUri'] = logical_switch_group['uri']
+      end
+
+      private
+
+      # Generates the logical switch credentials for POST and PUT requests
+      # @return [Array] List of connection properties for each logical switch
+      def generate_logical_switch_credentials
+        credentials = []
+        @logical_switch_credentials.each do |_, switch|
+          switch_credentials = []
+          switch_credentials << {
+            'valueFormat' => 'Unknown',
+            'propertyName' => 'SshBasicAuthCredentialUser',
+            'valueType' => 'String',
+            'value' => switch[0].user
+          }
+
+          switch_credentials << {
+            'valueFormat' => 'SecuritySensitive',
+            'propertyName' => 'SshBasicAuthCredentialPassword',
+            'valueType' => 'String',
+            'value' => switch[0].password
+          }
+
+          if switch[1].version == 'SNMPv3'
+            switch_credentials << {
+              'valueFormat' => 'SecuritySensitive',
+              'propertyName' => 'SnmpV3AuthorizationPassword',
+              'valueType' => 'String',
+              'value' => switch[1].auth_password
+            }
+
+            switch_credentials << {
+              'valueFormat' => 'Unknown',
+              'propertyName' => 'SnmpV3User',
+              'valueType' => 'String',
+              'value' => switch[1].user
+            }
+
+            if switch[1].privacy_password
+              switch_credentials << {
+                'valueFormat' => 'SecuritySensitive',
+                'propertyName' => 'SnmpV3PrivacyPassword',
+                'valueType' => 'String',
+                'value' => switch[1].privacy_password
+              }
+            end
+          end
+
+          credentials << { 'connectionProperties' => switch_credentials }
+        end
+        credentials
+      end
+
+      # Generates the logical switch credential configuration for POST and PUT requests
+      # @return [Array] List of logical switch credential configuration for each switch
+      def generate_logical_switch_credential_configuration
+        configuration = []
+        @logical_switch_credentials.each do |host, switch|
+          switch_configuration = {
+            'snmpPort' => switch[1].port,
+            'snmpV3Configuration' => nil,
+            'snmpV1Configuration' => nil,
+            'logicalSwitchManagementHost' => host,
+            'snmpVersion' => switch[1].version
+          }
+
+          if switch[1].version == 'SNMPv3'
+            switch_configuration['snmpV1Configuration'] = nil
+            switch_configuration['snmpV3Configuration'] = {
+              'authorizationProtocol' => switch[1].auth_protocol
+            }
+
+            if switch[1].privacy_protocol
+              switch_configuration['snmpV3Configuration']['securityLevel'] = 'AuthPrivacy'
+              switch_configuration['snmpV3Configuration']['privacyProtocol'] = switch[1].privacy_protocol
+            else
+              switch_configuration['snmpV3Configuration']['securityLevel'] = 'Auth'
+            end
+
+          elsif switch[1].version == 'SNMPv1'
+            switch_configuration['snmpV3Configuration'] = nil
+            switch_configuration['snmpV1Configuration'] = {
+              'communityString' => switch[1].community_string
+            }
+          end
+          configuration << switch_configuration
+        end
+        configuration
+      end
+    end
+  end
+end

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

@@ -0,0 +1,70 @@
+# (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 switch group resource implementation
+    class LogicalSwitchGroup < Resource
+      BASE_URI = '/rest/logical-switch-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['category'] ||= 'logical-switch-groups'
+        @data['state'] ||= 'Active'
+        @data['type'] ||= 'logical-switch-group'
+        @data['switchMapTemplate'] ||= {}
+      end
+
+      # Define how the switches will be grouped, setting the number and the type of the switches
+      # @param [Fixnum] number_of_switches The number of the switch inside the group [1,2]
+      # @param [String] type Switch type name
+      # @raise [StandardError]
+      def set_grouping_parameters(number_of_switches, type)
+        @data['switchMapTemplate']['switchMapEntryTemplates'] = []
+        parse_switch_map_template(number_of_switches)
+        switch_type_uri = OneviewSDK::Switch.get_type(@client, type)['uri']
+        @data['switchMapTemplate']['switchMapEntryTemplates'].each do |entry|
+          entry['logicalLocation']['locationEntries'].each do |location|
+            entry['permittedSwitchTypeUri'] = switch_type_uri if location['type'] == 'StackingMemberId'
+          end
+        end
+      rescue StandardError
+        list = OneviewSDK::Switch.get_types(@client).map { |t| t['name'] }
+        raise "Switch type #{type} not found! Supported types: #{list}"
+      end
+
+      private
+
+      # Parse switch map template structure
+      # @param [Integer] number_of_switches number of switches
+      def parse_switch_map_template(number_of_switches)
+        1.upto(number_of_switches) do |stacking_member_id|
+          entry = {
+            'logicalLocation' => {
+              'locationEntries' => [
+                { 'relativeValue' => stacking_member_id, 'type' => 'StackingMemberId' }
+              ]
+            },
+            'permittedSwitchTypeUri' => nil
+          }
+          @data['switchMapTemplate']['switchMapEntryTemplates'] << entry
+        end
+      end
+    end
+  end
+end

data/lib/oneview-sdk/resource/api200/managed_san.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.
+
+require_relative 'resource'
+
+module OneviewSDK
+  module API200
+    # Managed SAN resource implementation
+    class ManagedSAN < Resource
+      BASE_URI = '/rest/fc-sans/managed-sans'.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 delete
+        unavailable_method
+      end
+
+      # Method is not available
+      # @raise [OneviewSDK::MethodUnavailable] method is not available
+      def update
+        unavailable_method
+      end
+
+      # Retrieves a list of endpoints
+      # @return [Array] List of endpoints
+      def get_endpoints
+        response = @client.rest_get(@data['uri'] + '/endpoints')
+        @client.response_handler(response)['members']
+      end
+
+      # Set refresh state for managed SAN
+      # @param [String] state Desired refresh state
+      def set_refresh_state(state)
+        response = @client.rest_put(@data['uri'], 'body' => { refreshState: state })
+        @client.response_handler(response)
+      end
+
+      # Set public attributes
+      # @param [Hash] attributes Public attributes
+      # @option attributes [String] :name
+      # @option attributes [String] :value
+      # @option attributes [String] :valueType
+      # @option attributes [String] :valueFormat
+      def set_public_attributes(attributes)
+        response = @client.rest_put(@data['uri'], 'body' => { publicAttributes: attributes })
+        @client.response_handler(response)
+      end
+
+      # Set public attributes
+      # @param [Hash] policy SAN policy
+      # @option attributes [String] :zoningPolicy
+      # @option attributes [String] :zoneNameFormat
+      # @option attributes [String] :enableAliasing
+      # @option attributes [String] :initiatorNameFormat
+      # @option attributes [String] :targetNameFormat
+      # @option attributes [String] :targetGroupNameFormat
+      def set_san_policy(policy)
+        response = @client.rest_put(@data['uri'], 'body' => { sanPolicy: policy })
+        @client.response_handler(response)
+      end
+
+      # Creates unexpected zoning report for a SAN
+      def get_zoning_report
+        response = @client.rest_post(@data['uri'] + '/issues', 'body' => {})
+        @client.response_handler(response)
+      end
+    end
+  end
+end