oneview-sdk 2.2.1 → 3.0.0

data/lib/oneview-sdk/resource/api300/c7000/volume_attachment.rb

@@ -0,0 +1,21 @@
+# (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 '../../api200/volume_attachment'
+
+module OneviewSDK
+  module API300
+    module C7000
+      class VolumeAttachment < OneviewSDK::API200::VolumeAttachment
+      end
+    end
+  end
+end

data/lib/oneview-sdk/resource/api300/c7000/volume_snapshot.rb

@@ -0,0 +1,21 @@
+# (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 '../../api200/volume_snapshot'
+
+module OneviewSDK
+  module API300
+    module C7000
+      class VolumeSnapshot < OneviewSDK::API200::VolumeSnapshot
+      end
+    end
+  end
+end

data/lib/oneview-sdk/resource/api300/c7000/volume_template.rb

@@ -0,0 +1,32 @@
+# (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 '../../api200/volume_template'
+
+module OneviewSDK
+  module API300
+    module C7000
+      # Volume Template resource implementation for API300 Synergy
+      class VolumeTemplate < OneviewSDK::API200::VolumeTemplate
+        # Create the client object, establishes connection, and set up the logging and api version.
+        # @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.
+        # Defaults to client.api_version if exists, or OneviewSDK::Client::DEFAULT_API_VERSION.
+        # Defaults type to StorageVolumeTemplate when API version is 120
+        # Defaults type to StorageVolumeTemplateV3 when API version is 200
+        def initialize(client, params = {}, api_ver = nil)
+          super
+        end
+      end
+    end
+  end
+end

data/lib/oneview-sdk/resource/api300/synergy.rb

@@ -0,0 +1,27 @@
+# (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 API300
+    # Module for API300 Synergy
+    module Synergy
+      # Get resource class that matches the type given
+      # @param [String] type Name of the desired class type
+      # @return [Class] Resource class or nil if not found
+      def self.resource_named(type)
+        OneviewSDK::API300.resource_named(type, 'Synergy')
+      end
+    end
+  end
+end
+
+# Load all API-specific resources:
+Dir[File.dirname(__FILE__) + '/synergy/*.rb'].each { |file| require file }

data/lib/oneview-sdk/resource/api300/synergy/connection_template.rb

@@ -0,0 +1,30 @@
+# (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 '../../api200/connection_template'
+
+module OneviewSDK
+  module API300
+    module Synergy
+      # Connection template resource implementation for API300 Synergy
+      class ConnectionTemplate < OneviewSDK::API200::ConnectionTemplate
+
+        # Get the default network connection template
+        # @param [OneviewSDK::Client] client The client object for the OneView appliance
+        # @return [OneviewSDK::API300::Synergy::ConnectionTemplate] Connection template
+        def self.get_default(client)
+          response = client.rest_get(BASE_URI + '/defaultConnectionTemplate')
+          OneviewSDK::API300::Synergy::ConnectionTemplate.new(client, client.response_handler(response))
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# (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 '../../api200/datacenter'
+
+module OneviewSDK
+  module API300
+    module Synergy
+      # Datacenter resource implementation for API300 Synergy
+      class Datacenter < OneviewSDK::API200::Datacenter
+      end
+    end
+  end
+end

data/lib/oneview-sdk/resource/api300/synergy/drive_enclosure.rb

@@ -0,0 +1,71 @@
+# (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 API300
+    module Synergy
+      # Drive enclosure resource implementation for API300 Synergy
+      class DriveEnclosure < Resource
+        BASE_URI = '/rest/drive-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
+
+        # Method is unavailable
+        # @raise [OneviewSDK::MethodUnavailable] method is not available
+        def create
+          unavailable_method
+        end
+
+        # Method is unavailable
+        # @raise [OneviewSDK::MethodUnavailable] method is not available
+        def delete
+          unavailable_method
+        end
+
+        # Method is unavailable
+        # @raise [OneviewSDK::MethodUnavailable] method is not available
+        def update
+          unavailable_method
+        end
+
+        # Retrieve the drive enclosure I/O adapter port to SAS interconnect port connectivity
+        def get_port_map
+          response = @client.rest_get(@data['uri'] + '/port-map')
+          response.body
+        end
+
+        # Refresh a drive enclosure
+        # @param [String] state Indicates if the resource is currently refreshing
+        def set_refresh_state(state)
+          response = @client.rest_put(@data['uri'] + '/refreshState', 'body' => { refreshState: state })
+          @client.response_handler(response)
+        end
+
+        # Update specific attributes of a given drive enclosure
+        # @param [String] operation Operation to be performed
+        # @param [String] path Path
+        # @param [String] value Value
+        def patch(operation, path, value)
+          response = @client.rest_patch(@data['uri'], 'body' => [{ op: operation, path: path, value: value }])
+          @client.response_handler(response)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,110 @@
+# (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 '../../api200/enclosure'
+
+module OneviewSDK
+  module API300
+    module Synergy
+      # Enclosure resource implementation for API300 Synergy
+      class Enclosure < OneviewSDK::API200::Enclosure
+
+        # 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.
+        # @note Renames the enclosures only if @data['name']. Pattern used is: <@data['name']>+<1..number of enclosures added>.
+        def initialize(client, params = {}, api_ver = nil)
+          @data ||= {}
+          # Default values:
+          @data['type'] ||= 'EnclosureV300'
+          super
+        end
+
+        # Claim/configure the enclosure and its components to the appliance
+        # @note Calls the update_enclosure_names method to set the enclosure names
+        # @return [Array<OneviewSDK:API300:Synergy::Enclosure>] containing the added enclosures
+        def add
+          ensure_client
+          required_attributes = %w(hostname)
+          required_attributes.each { |k| raise IncompleteResource, "Missing required attribute: '#{k}'" unless @data.key?(k) }
+
+          temp_data = @data.select { |k, _v| required_attributes.include?(k) }
+          response = @client.rest_post(self.class::BASE_URI, { 'body' => temp_data }, @api_version)
+          @client.response_handler(response)
+
+          # Renames the enclosures if the @data['name'] is not nil, otherwise only returns the enclosures
+          @data['name'] ||= ''
+          OneviewSDK::API300::Synergy::Enclosure.update_enclosure_names(@client, @data['hostname'], @data['name'])
+        end
+
+        # Update specific attributes of a given enclosure
+        # @param [String] operation Operation to be performed
+        # @param [String] path Path
+        # @param [String] value Value
+        def patch(operation, path, value = nil)
+          ensure_client && ensure_uri
+          body = if value
+                   { op: operation, path: path, value: value }
+                 else
+                   { op: operation, path: path }
+                 end
+          response = @client.rest_patch(@data['uri'], { 'body' => [body] }, @api_version)
+          @client.response_handler(response)
+        end
+
+        # Method is not available
+        # @raise [OneviewSDK::MethodUnavailable] method is not available
+        def set_environmental_configuration
+          unavailable_method
+        end
+
+        # Method is not available
+        # @raise [OneviewSDK::MethodUnavailable] method is not available
+        def set_enclosure_group
+          unavailable_method
+        end
+
+        # Method for renaming all enclosures that share the same frameLinkModuleDomain.
+        # The naming pattern for the enclosures is <name><1..number of enclosures>.
+        # @param [OneviewSDK::Client] client The client object for the OneView appliance
+        # @param [String] hostname The ipv6 of the enclosure to be added
+        # @param [String] name The name to be used for renaming the enclosures
+        # @return [Array<OneviewSDK:API300:Synergy::Enclosure>] which had their name changed
+        # @raise [OneviewSDK::IncompleteResource] if a client and hostname are nil
+        def self.update_enclosure_names(client, hostname, name = '')
+          raise IncompleteResource, 'Missing parameters for update_enclosure_names' unless client && hostname
+          frame_link = ''
+
+          # Retrieve the frameLinkModuleDomain of the specified enclosure, then use it to find all enclosures
+          # that share that frameLinkModuleDomain.
+          all_enclosures = OneviewSDK::API300::Synergy::Enclosure.find_by(client, {})
+          all_enclosures.each do |encl|
+            frame_link = encl['frameLinkModuleDomain'] if encl['managerBays'].first['ipAddress'] == hostname
+          end
+          enclosures = all_enclosures.select { |encl| encl['frameLinkModuleDomain'] == frame_link }
+
+          # Return enclosures without modifying them if a name has not been specified
+          return enclosures if name == ''
+
+          # Updates the enclosure names and return the array containing the enclosures
+          number_of_enclosures = enclosures.count
+          enclosures.each do |encl|
+            encl['name'] = "#{name}#{number_of_enclosures}"
+            encl.update
+            number_of_enclosures -= 1
+          end
+          enclosures
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# (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 '../../api200/enclosure_group'
+
+module OneviewSDK
+  module API300
+    module Synergy
+      # Enclosure group resource implementation on API300 Synergy
+      class EnclosureGroup < OneviewSDK::API200::EnclosureGroup
+
+        # 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)
+          @data ||= {}
+          # Default values:
+          @data['type'] ||= 'EnclosureGroupV300'
+          @data['stackingMode'] ||= 'Enclosure'
+          @data['ipAddressingMode'] ||= 'DHCP'
+          @data['interconnectBayMappingCount'] ||= 6
+          super
+        end
+
+        # Method is not available
+        # @raise [OneviewSDK::MethodUnavailable] method is not available
+        def set_script
+          unavailable_method
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# (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 '../../api200/ethernet_network'
+
+module OneviewSDK
+  module API300
+    module Synergy
+      # Ethernet network resource implementation for API300 Synergy
+      class EthernetNetwork < OneviewSDK::API200::EthernetNetwork
+
+        # 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)
+          @data ||= {}
+          # Default values:
+          @data['ethernetNetworkType'] ||= 'Tagged'
+          @data['type'] ||= 'ethernet-networkV300'
+          super
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+# (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 '../../api200/fabric'
+
+module OneviewSDK
+  module API300
+    module Synergy
+      # Fabric resource implementation for API300 Synergy
+      class Fabric < OneviewSDK::API200::Fabric
+
+        # Gets the reserved vlan ID range for the fabric
+        # @raise [OneviewSDK::IncompleteResource] if the client is not set
+        # @raise [OneviewSDK::IncompleteResource] if the uri is not set
+        # @raise [StandardError] if retrieving fails
+        # @return [OneviewSDK::Fabric] self
+        def get_reserved_vlan_range
+          ensure_client && ensure_uri
+          response = @client.rest_get("#{@data['uri']}/reserved-vlan-range", @api_version)
+          @client.response_handler(response)
+        end
+
+        # Updates the reserved vlan ID range for the fabric.
+        # @param [Hash] params The options for this resource (key-value pairs)
+        # @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::Fabric] self
+        def set_reserved_vlan_range(params)
+          ensure_client && ensure_uri
+          response = @client.rest_put("#{@data['uri']}/reserved-vlan-range", { 'body' => params }, @api_version)
+          @client.response_handler(response)
+          self
+        end
+      end
+    end
+  end
+end