test-oneview 5.18.0

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

@@ -0,0 +1,85 @@
+# (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
+    # Switch resource implementation
+    class Switch < Resource
+      BASE_URI = '/rest/switches'.freeze
+      TYPE_URI = '/rest/switch-types'.freeze
+      UNIQUE_IDENTIFIERS = %w[name uri serialNumber].freeze
+
+      # Remove resource from OneView
+      # @return [true] if resource was removed successfully
+      alias remove delete
+
+      # 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 refresh(*)
+        unavailable_method
+      end
+
+      # Method is not available
+      # @raise [OneviewSDK::MethodUnavailable] method is not available
+      def delete(*)
+        unavailable_method
+      end
+
+      # Retrieves the switch types
+      # @param [OneviewSDK::Client] client The client object for the OneView appliance
+      # @return [Array] All the Switch types
+      def self.get_types(client)
+        response = client.rest_get(TYPE_URI)
+        response = client.response_handler(response)
+        response['members']
+      end
+
+      # Retrieves the switch type with the name
+      # @param [OneviewSDK::Client] client The client object for the OneView appliance
+      # @param [String] name Switch type name
+      # @return [Array] Switch type
+      def self.get_type(client, name)
+        results = get_types(client)
+        results.find { |switch_type| switch_type['name'] == name }
+      end
+
+      # Get statistics for a switch or for the specified port.
+      # @param [String] port_name port to retrieve statistics
+      # @return [Hash] Switch statistics
+      def statistics(port_name = nil)
+        response = @client.rest_get("#{@data['uri']}/statistics/#{port_name}")
+        response.body
+      end
+
+      # Get settings that describe the environmental configuration
+      # @return [Hash] Configuration parameters
+      def environmental_configuration
+        ensure_client && ensure_uri
+        response = @client.rest_get(@data['uri'] + '/environmentalConfiguration', {}, @api_version)
+        @client.response_handler(response)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+# (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
+    # Unmanaged Device resource implementation
+    class UnmanagedDevice < Resource
+      BASE_URI = '/rest/unmanaged-devices'.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::UnmanagedDevice] self
+      alias add create
+
+      # Remove resource from OneView
+      # @return [true] if resource was removed successfully
+      alias remove delete
+
+      # 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
+
+      # Gets a list of unmanaged devices
+      # @param [OneviewSDK::Client] client The client object for the OneView appliance
+      # @return [Array] list of unmanaged devices
+      def self.get_devices(client)
+        response = client.rest_get(BASE_URI)
+        client.response_handler(response)['members']
+      end
+
+      # Get settings that describe the environmental configuration
+      def environmental_configuration
+        ensure_client && ensure_uri
+        response = @client.rest_get(@data['uri'] + '/environmentalConfiguration')
+        @client.response_handler(response)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,92 @@
+# (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 set resource implementation
+    class UplinkSet < Resource
+      BASE_URI = '/rest/uplink-sets'.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['fcNetworkUris'] ||= []
+        @data['fcoeNetworkUris'] ||= []
+        @data['networkUris'] ||= []
+        @data['portConfigInfos'] ||= []
+        @data['primaryPortLocation'] = nil
+        @data['type'] ||= 'uplink-setV3'
+      end
+
+      # Adds the portConfigInfos to the array
+      # @param [String] portUri
+      # @param [String] speed
+      # @param [Hash] locationEntries
+      def add_port_config(portUri, speed, locationEntries)
+        entry = {
+          'portUri' => portUri,
+          'desiredSpeed' => speed,
+          'location' => {
+            'locationEntries' => locationEntries
+          }
+        }
+        @data['portConfigInfos'] << entry
+      end
+
+      # Sets the logical interconnect uri
+      # @param [OneviewSDK::LogicalInterconnect, Hash] logical_interconnect
+      def set_logical_interconnect(logical_interconnect)
+        uri = logical_interconnect[:uri] || logical_interconnect['uri']
+        raise IncompleteResource, 'Invalid object' unless uri
+        @data['logicalInterconnectUri'] = uri
+      end
+
+      # Adds an ethernet network to the uplink set
+      # @param [OneviewSDK::EthernetNetwork, Hash] network
+      def add_network(network)
+        uri = network[:uri] || network['uri']
+        raise IncompleteResource, 'Must set network uri attribute' unless uri
+        @data['networkUris'].push(uri)
+      end
+
+      # Adds an fc network to the uplink set
+      # @param [OneviewSDK::FCNetwork, Hash] network must accept hash syntax
+      def add_fcnetwork(network)
+        uri = network[:uri] || network['uri']
+        raise IncompleteResource, 'Must set network uri attribute' unless uri
+        @data['fcNetworkUris'].push(uri)
+      end
+
+      # Adds an fcoe network to the uplink set
+      # @param [OneviewSDK::FCoENetwork, Hash] network must accept hash syntax
+      def add_fcoenetwork(network)
+        uri = network[:uri] || network['uri']
+        raise IncompleteResource, 'Must set network uri attribute' unless uri
+        @data['fcoeNetworkUris'].push(uri)
+      end
+
+      # Gets the unassigned uplink ports
+      # @return [Array] List of unassigned uplink-ports
+      def get_unassigned_ports
+        ensure_client && ensure_uri
+        response = @client.rest_post(BASE_URI + '/unassignedUplinkPorts', { 'body' => @data }, @api_version)
+        result = @client.response_handler(response)
+        result['members']
+      end
+    end
+  end
+end

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

@@ -0,0 +1,98 @@
+# (c) Copyright 2017 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
+    # User resource implementation
+    class User < Resource
+      BASE_URI = '/rest/users'.freeze
+      UNIQUE_IDENTIFIERS = %w[userName uri].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'] ||= 'UserAndRoles'
+        @data['enabled'] ||= true
+        @data['roles'] ||= ['Read only']
+      end
+
+      # Create the resource on OneView using the current data
+      # @note Calls the refresh method to set additional data
+      # @note Removes the password attribute after creation
+      # @param [Hash] header The header options for the request (key-value pairs)
+      # @raise [OneviewSDK::IncompleteResource] if the client is not set
+      # @raise [StandardError] if the resource creation fails
+      # @return [Resource] self
+      def create(header = {})
+        ensure_client
+        response = @client.rest_post(BASE_URI, DEFAULT_REQUEST_HEADER.merge(header).merge('body' => @data), @api_version)
+        body = @client.response_handler(response)
+        @data.delete('password')
+        set_all(body)
+        self
+      end
+
+      # Set data and save to OneView
+      # @param [Hash] attributes The attributes to add/change for this resource (key-value pairs)
+      # @raise [OneviewSDK::IncompleteResource] if the client or uri is not set
+      # @raise [StandardError] if the resource save fails
+      # @return [Resource] self
+      def update(attributes = {})
+        set_all(attributes)
+        ensure_client && ensure_uri
+        new_data = @data.reject { |k, _v| k.to_s == 'roles' } # This cannot be updated here. It is updated below
+        response = @client.rest_put(self.class::BASE_URI, { 'body' => new_data }, @api_version)
+        d = @client.response_handler(response)
+        set_roles(@data['roles']) if @data['roles'] && @data['roles'].sort != d['roles'].sort
+        self
+      end
+
+      # Set data and save to OneView
+      # @param [Array] roles The names of the roles to set for this user
+      # @raise [OneviewSDK::IncompleteResource] if the client or uri is not set
+      # @raise [StandardError] if setting the role fails
+      # @return [Resource] self
+      def set_roles(roles)
+        ensure_client && ensure_uri
+        data = roles.map { |r| { roleName: r, type: 'RoleNameDtoV2' } }
+        response = @client.rest_put("#{@data['uri']}/roles?multiResource=true", { 'body' => data }, @api_version)
+        r = @client.response_handler(response)
+        new_roles = r.map { |i| i['roleName'] }
+        set('roles', new_roles)
+        self
+      end
+
+      # Validates the existence of a user with the given user name in the appliance.
+      # @param [OneviewSDK::Client] client The client object for the OneView appliance
+      # @param [String] user_name The user name to validate
+      # @return [Boolean] return true if the user already exists
+      def self.validate_user_name(client, user_name)
+        response = client.rest_post("#{BASE_URI}/validateLoginName/#{user_name}")
+        client.response_handler(response)
+      end
+
+      # Checks for the existence of a user with the specified full name in the appliance.
+      # @param [OneviewSDK::Client] client The client object for the OneView appliance
+      # @param [String] full_name The full name to validate
+      # @return [Boolean] return true if the user already exists
+      def self.validate_full_name(client, full_name)
+        response = client.rest_post("#{BASE_URI}/validateUserName/#{full_name}")
+        client.response_handler(response)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# (C) Copyright 2017 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 API200
+    # Version resource implementation
+    class Version
+      BASE_URI = '/rest/version'.freeze
+
+      # Get current and minimum version
+      # @param [OneviewSDK::Client] client The client object for the OneView appliance
+      # @return [Hash] Version
+      def self.get_version(client)
+        response = client.rest_get(BASE_URI)
+        client.response_handler(response)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,191 @@
+# (C) Copyright 2020 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
+    # Volume resource implementation
+    class Volume < Resource
+      BASE_URI = '/rest/storage-volumes'.freeze
+
+      # It's possible to create the volume in 6 different ways:
+      # 1) Common = Storage System + Storage Pool
+      # 2) Template = Storage Volume Template
+      # 3) Common with snapshots = Storage System + Storage Pool + Snapshot Pool
+      # 4) Management = Storage System + wwn
+      # 5) Management by name = Storage System + Storage System Volume Name
+      # 6) Snapshot = Snapshot Pool + Storage Pool + Snapshot
+
+      # Creates the volume
+      # @note provisioning parameters are required for creation, but not afterwards; after creation, they will be removed.
+      # @param [Hash] header The header options for the request (key-value pairs)
+      # @raise [OneviewSDK::IncompleteResource] if the client is not set
+      # @raise [StandardError] if the resource creation fails
+      # @return [Resource] self
+      def create(header = {})
+        super(DEFAULT_REQUEST_HEADER.merge(header))
+        @data.delete('provisioningParameters')
+        self
+      end
+
+      # Delete the resource from OneView if it exists, then create it using the current data
+      # @note Calls refresh method to set additional data
+      # @param [Hash] header The header options for the request (key-value pairs)
+      # @raise [OneviewSDK::IncompleteResource] if the client is not set
+      # @raise [StandardError] if the resource creation fails
+      # @return [Resource] self
+      def create!(header = {})
+        temp = self.class.new(@client, @data)
+        header = DEFAULT_REQUEST_HEADER.merge(header)
+        temp.delete(:all, header) if temp.retrieve!(header)
+        create(header)
+      end
+
+      # Update resource attributes
+      # @param [Hash] attributes attributes to be updated
+      # @return [OneviewSDK::Volume] self
+      def update(attributes = {})
+        @data.delete('provisioningParameters')
+        super
+      end
+
+      # Deletes the resource from OneView or from Oneview and storage system
+      # @param [Symbol] flag Delete storage system from Oneview only or in storage system as well
+      # @param [Hash] header The header options for the request (key-value pairs)
+      # @return [true] if resource was deleted successfully
+      def delete(flag = :all, header = {})
+        ensure_client && ensure_uri
+        raise InvalidResource, 'Invalid flag value, use :oneview or :all' unless %i[oneview all].include?(flag)
+        header = DEFAULT_REQUEST_HEADER.merge(header).merge('exportOnly' => true) if flag == :oneview
+        super(header)
+      end
+
+      # Sets the storage system to the volume
+      # @param [OneviewSDK::StorageSystem] storage_system Storage System
+      # @note The storageSystemUri attribute should not be set in the updated. Once created, this attribute is read only.
+      def set_storage_system(storage_system)
+        assure_uri(storage_system)
+        set('storageSystemUri', storage_system['uri'])
+      end
+
+      # Sets the storage pool to the volume
+      # @note The storagePoolUri attribute should not be set in the updated. Once created, this attribute is read only.
+      # @param [OneviewSDK::StoragePool] storage_pool Storage pool
+      def set_storage_pool(storage_pool)
+        assure_uri(storage_pool)
+        self['provisioningParameters'] ||= {}
+        self['provisioningParameters']['storagePoolUri'] = storage_pool['uri']
+      end
+
+      # Adds the storage volume template to the volume
+      # @param [OneviewSDK::VolumeTemplate] storage_volume_template Storage Volume Template
+      def set_storage_volume_template(storage_volume_template)
+        assure_uri(storage_volume_template)
+        set('templateUri', storage_volume_template['uri'])
+      end
+
+      # Sets the snapshot pool to the volume
+      # @param [OneviewSDK::StoragePool] storage_pool Storage Pool to use for snapshots
+      def set_snapshot_pool(storage_pool)
+        assure_uri(storage_pool)
+        set('snapshotPoolUri', storage_pool['uri'])
+      end
+
+      # Creates a snapshot of the volume
+      # @param [String, OneviewSDK::VolumeSnapshot] snapshot String or OneviewSDK::VolumeSnapshot object
+      # @param [String] description Provide a description
+      # @return [true] if snapshot was created successfully
+      def create_snapshot(snapshot, description = nil)
+        ensure_uri && ensure_client
+        if snapshot.is_a?(OneviewSDK::Resource) || snapshot.is_a?(Hash)
+          name = snapshot[:name] || snapshot['name']
+          description ||= snapshot[:description] || snapshot['description']
+        else
+          name = snapshot
+        end
+        data = generate_snapshot_data(name, description)
+        response = @client.rest_post("#{@data['uri']}/snapshots", { 'body' => data }, @api_version)
+        @client.response_handler(response)
+        true
+      end
+
+      # Deletes a snapshot of the volume
+      # @param [String] name snapshot name
+      # @return [true] if snapshot was created successfully
+      def delete_snapshot(name)
+        result = get_snapshot(name)
+        response = @client.rest_delete(result['uri'], { 'If-Match' => result['eTag'] }, @api_version)
+        @client.response_handler(response)
+        true
+      end
+
+      # Retrieves a snapshot by name
+      # @param [String] name
+      # @return [Hash] snapshot data
+      def get_snapshot(name)
+        results = get_snapshots
+        results.find { |snap| snap['name'] == name }
+      end
+
+      # Gets all the snapshots of this volume
+      # @return [Array] Array of snapshots
+      def get_snapshots
+        ensure_uri && ensure_client
+        uri = "#{@data['uri']}/snapshots"
+        self.class.find_with_pagination(@client, uri)
+      end
+
+      # Gets all the attachable volumes managed by the appliance
+      # @param [OneviewSDK::Client] client The client object for the OneView appliance
+      # @return [Array<OneviewSDK::Volume>] Array of volumes
+      def self.get_attachable_volumes(client, query = nil)
+        query_uri = build_query(query) if query
+        uri = "#{BASE_URI}/attachable-volumes#{query_uri}"
+        find_by(client, {}, uri)
+      end
+
+      # Gets the list of extra managed storage volume paths
+      # @param [OneviewSDK::Client] client The client object for the OneView appliance
+      # @return response
+      def self.get_extra_managed_volume_paths(client)
+        response = client.rest_get(BASE_URI + '/repair?alertFixType=ExtraManagedStorageVolumePaths')
+        client.response_handler(response)
+      end
+
+      # Removes extra presentation from the volume
+      # @return response
+      def repair
+        response = client.rest_post(BASE_URI + '/repair', 'body' => { resourceUri: @data['uri'], type: 'ExtraManagedStorageVolumePaths' })
+        client.response_handler(response)
+      end
+
+      private
+
+      # Verify if the resource has a URI
+      # If not, first it tries to retrieve, and then verify for its existence
+      # @param [OneviewSDK::Resource] resource The resource object
+      # @raise [OneviewSDK::IncompleteResource] if the resource not found
+      def assure_uri(resource)
+        resource.retrieve! unless resource['uri']
+        raise IncompleteResource, "#{resource.class}: #{resource['name']} not found" unless resource['uri']
+      end
+
+      # Generates the snapshot data
+      # @param [String] name The name of the snapshot
+      # @param [String] description The description of the snapshot
+      # @return [Hash] snapshot data
+      def generate_snapshot_data(name, description = nil)
+        { type: 'Snapshot', description: description, name: name }
+      end
+    end
+  end
+end