Merge branch 'master' into ClusterProfiles

CHANGELOG.md

@@ -4,15 +4,22 @@
 This release extends support of the SDK to OneView REST API version 1600 (OneView v5.20).
 
 #### Features supported
+- Artifact Bundle
+- Deployment Group
+- Deployment Plan
 - Enclosure
 - Enclosure Group
 - Ethernet Network
 - FC Network
 - FCOE Network
 - Hypervisor Cluster Profile
+- Hypervisor Manager
 - Logical Enclosure
+- OS Deployment Plan
+- Server Certificate
 - Server Hardware
 - Server Hardware Type
+- Server Profile
 - Server Profile Template
 
 ## v5.11.0

examples/image-streamer/artifact_bundle.rb

@@ -0,0 +1,96 @@
+# (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 'tempfile'
+require_relative '../_client_i3s' # Gives access to @client
+
+# Supported APIs:
+# - 300, 500, 600, 800, 1000, 1020, 1600
+
+# Resources that can be created according to parameters:
+# api_version = 300 & variant = Synergy to OneviewSDK::ImageStreamer::API300::ArtifactBundle
+# api_version = 500 & variant = Synergy to OneviewSDK::ImageStreamer::API500::ArtifactBundle
+# api_version = 600 & variant = Synergy to OneviewSDK::ImageStreamer::API600::ArtifactBundle
+# api_version = 800 & variant = Synergy to OneviewSDK::ImageStreamer::API800::ArtifactBundle
+# api_version = 1000 & variant = Synergy to OneviewSDK::ImageStreamer::API1000::ArtifactBundle
+# api_version = 1020 & variant = Synergy to OneviewSDK::ImageStreamer::API1020::ArtifactBundle
+# api_version = 1600 & variant = Synergy to OneviewSDK::ImageStreamer::API1600::ArtifactBundle
+
+# Example:
+# - Create, update, download, upload, extract and delete an artifact bundle for an Image Streamer
+# - Create, download, upload an backup bundle for an Image Streamer
+# NOTE: It needs a DeploymentGroup and a PlanScript created already
+
+deployment_group_class = OneviewSDK::ImageStreamer.resource_named('DeploymentGroup', @client.api_version)
+deployment_group = deployment_group_class.get_all(@client).first
+plan_script_class = OneviewSDK::ImageStreamer.resource_named('PlanScript', @client.api_version)
+plan_script = plan_script_class.get_all(@client).first
+artifact_bundle_class = OneviewSDK::ImageStreamer.resource_named('ArtifactBundle', @client.api_version)
+
+options = {
+  name: 'ArtifactBundle Name',
+  description: 'Description of ArtifactBundle'
+}
+
+puts "\nCreating an artifact bundle with plan script"
+item = artifact_bundle_class.new(@client, options)
+item.add_plan_script(plan_script, false)
+item.create
+puts "Artifact Bundle with name #{item['name']} and uri #{item['uri']} created successfully."
+puts 'Data:', item.data
+
+puts "\nUpdating the name of the artifact bundle"
+item.update_name("#{item['name']}_Updated")
+puts "Artifact Bundle with name #{item['name']} and uri #{item['uri']} updated successfully."
+
+puts "\nListing all artifact bundles"
+all_items = artifact_bundle_class.get_all(@client)
+all_items.each { |each_item| puts each_item['name'] }
+
+download_file = Tempfile.new(['artifact-bundle', '.zip'])
+download_path = download_file.path
+puts "\nDownloading artifact bundle file and saving at #{download_path}"
+item.download(download_path)
+puts 'Downloaded successfully.' if File.exist?(download_path)
+
+puts "\nCreating artifact bundle from zip file"
+item_uploaded = artifact_bundle_class.create_from_file(@client, download_path, 'ArtifactBundle Uploaded')
+puts "Artifact Bundle with name #{item_uploaded['name']} and uri #{item_uploaded['uri']} created successfully."
+
+puts "\nExtracting artifact bundle uploaded"
+puts 'Artifact Bundle extracted successfully.' if item_uploaded.extract
+
+puts "\nCreating a backup associated to deployment group with name='#{deployment_group['name']}' and uri='#{deployment_group['uri']}'"
+puts artifact_bundle_class.create_backup(@client, deployment_group)
+
+puts "\nListing backups"
+backups = artifact_bundle_class.get_backups(@client)
+backups.each { |bkp| puts bkp['name'] }
+
+backup_download_file = Tempfile.new(['backup-bundle', '.zip'])
+backup_download_path = backup_download_file.path
+puts "\nDownloading backup bundle file and saving at #{backup_download_path}"
+artifact_bundle_class.download_backup(@client, backup_download_path, backups.first)
+puts 'Downloaded successfully.' if File.exist?(backup_download_path)
+
+puts "\nUploading backup bundle"
+puts artifact_bundle_class.create_backup_from_file!(@client, deployment_group, backup_download_path, 'Backup Bundle')
+
+puts "\nExtracting backup bundle uploaded"
+backup = artifact_bundle_class.get_backups(@client).first
+puts artifact_bundle_class.extract_backup(@client, deployment_group, backup)
+puts 'Backup extracted successfully'
+
+puts "\nDeleting the artifact bundles"
+item.delete
+item_uploaded.delete
+puts "#{item['name']} deleted successfully" unless item.retrieve!
+puts "#{item_uploaded['name']} deleted successfully" unless item_uploaded.retrieve!

examples/image-streamer/deployment_group.rb

@@ -0,0 +1,35 @@
+# (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 '../_client_i3s' # Gives access to @client
+
+# Supported APIs:
+# - 300, 500, 600, 800, 1000, 1020, 1600
+
+# Resources that can be created according to parameters:
+# api_version = 300 & variant = Synergy to OneviewSDK::ImageStreamer::API300::DeploymentGroup
+# api_version = 500 & variant = Synergy to OneviewSDK::ImageStreamer::API500::DeploymentGroup
+# api_version = 600 & variant = Synergy to OneviewSDK::ImageStreamer::API600::DeploymentGroup
+# api_version = 800 & variant = Synergy to OneviewSDK::ImageStreamer::API800::DeploymentGroup
+# api_version = 1000 & variant = Synergy to OneviewSDK::ImageStreamer::API1000::DeploymentGroup
+# api_version = 1020 & variant = Synergy to OneviewSDK::ImageStreamer::API1020::DeploymentGroup
+# api_version = 1600 & variant = Synergy to OneviewSDK::ImageStreamer::API1600::DeploymentGroup
+
+# Example:
+# - Gets the Deployment Groups
+# NOTE: It needs an existing DeploymentGroup
+
+deployment_group_class = OneviewSDK::ImageStreamer.resource_named('DeploymentGroup', @client.api_version)
+
+# List all deployments
+list = deployment_group_class.get_all(@client)
+puts "\n#Listing all Deployment Groups:"
+list.each { |p| puts "  #{p['name']}" }

examples/image-streamer/deployment_plan.rb

@@ -11,7 +11,7 @@
 
 require_relative '../_client_i3s' # Gives access to @client
 # Supported APIs:
-# - 300, 500, 600, 800, 1000, 1020
+# - 300, 500, 600, 800, 1000, 1020, 1600
 
 # Resources that can be created according to parameters:
 # api_version = 300 & variant = Synergy to OneviewSDK::ImageStreamer::API300::DeploymentPlan
@@ -20,6 +20,7 @@
 # api_version = 800 & variant = Synergy to OneviewSDK::ImageStreamer::API800::DeploymentPlan
 # api_version = 1000 & variant = Synergy to OneviewSDK::ImageStreamer::API1000::DeploymentPlan
 # api_version = 1020 & variant = Synergy to OneviewSDK::ImageStreamer::API1020::DeploymentPlan
+# api_version = 1600 & variant = Synergy to OneviewSDK::ImageStreamer::API1600::DeploymentPlan
 
 # Example: Create a deployment plan for an Image Streamer
 # NOTE: This will create a deployment plan named 'Deployment_Plan_1', then delete it.

examples/shared_samples/hypervisor_manager.rb

@@ -1,4 +1,4 @@
-# (C) Copyright 2018 Hewlett Packard Enterprise Development LP
+# (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.
@@ -21,6 +21,8 @@
 # - API1000 for Synergy
 # - API1200 for C7000
 # - API1200 for Synergy
+# - API1600 for C7000
+# - API1600 for Synergy
 
 # Resources that can be created according to parameters:
 # api_version = 800 & variant = C7000 to OneviewSDK::API800::C7000::HypervisorManager
@@ -29,6 +31,8 @@
 # api_version = 1000 & variant = Synergy to OneviewSDK::API1000::Synergy::HypervisorManager
 # api_version = 1200 & variant = C7000 to OneviewSDK::API1200::C7000::HypervisorManager
 # api_version = 1200 & variant = Synergy to OneviewSDK::API1200::Synergy::HypervisorManager
+# api_version = 1600 & variant = C7000 to OneviewSDK::API1600::C7000::HypervisorManager
+# api_version = 1600 & variant = Synergy to OneviewSDK::API1600::Synergy::HypervisorManager
 
 raise 'ERROR: Must set @hypervisor_manager_ip in _client.rb' unless @hypervisor_manager_ip
 raise 'ERROR: Must set @hypervisor_manager_username in _client.rb' unless @hypervisor_manager_username

examples/shared_samples/server_certificate.rb

@@ -12,10 +12,10 @@
 require_relative '../_client' # Gives access to @client
 
 # NOTE: You'll need to add the following instance variable to the _client.rb file with valid values for your environment:
-#   @storage_system_ip
+#   @hypervisor_manager_ip
 
 # All supported APIs for  Server Certificate:
-# - 600, 800, 1000, 1200
+# - 600, 800, 1000, 1200, 1600
 # # Resources classes that you can use for Server Certificate in this example:
 # server_certificate_class = OneviewSDK::API600::C7000::ServerCertificate
 # server_certificate_class = OneviewSDK::API600::Synergy::ServerCertificate
@@ -25,20 +25,21 @@
 # server_certificate_class = OneviewSDK::API1000::Synergy::ServerCertificate
 # server_certificate_class = OneviewSDK::API1200::C7000::ServerCertificate
 # server_certificate_class = OneviewSDK::API1200::Synergy::ServerCertificate
+# server_certificate_class = OneviewSDK::API1600::C7000::ServerCertificate
+# server_certificate_class = OneviewSDK::API1600::Synergy::ServerCertificate
 
 # Initialize the resources
 server_certificate_class = OneviewSDK.resource_named('ServerCertificate', @client.api_version)
 
 # Gets certificates from remote IP
 puts 'Fetching Certificate:-'
 certificate = server_certificate_class.new(@client)
-certificate.data['remoteIp'] = '172.18.13.11'
+certificate.data['remoteIp'] = @hypervisor_manager_ip
 puts certificate.get_certificate
 
 # Imports the certificates
 puts 'Importing the certificate:- '
-item = server_certificate_class.new(@client, aliasName: @storage_system_ip)
-item.data['type'] = certificate.get_certificate['type']
+item = server_certificate_class.new(@client, aliasName: @hypervisor_manager_ip)
 item.data['certificateDetails'] = []
 item.data['certificateDetails'][0] = {
   'type' => certificate.get_certificate['certificateDetails'][0]['type'],
@@ -54,9 +55,9 @@
 
 # Retrieve the certificates as per the aliasName
 puts 'Retrieving Imported Certificate:-'
-item = server_certificate_class.new(@client, aliasName: @storage_system_ip)
+item = server_certificate_class.new(@client, aliasName: @hypervisor_manager_ip)
 puts item.data if item.retrieve!
 
-# Deleres the certificate as per the aliasName
+# Deletes the certificate as per the aliasName
 puts 'Removing certificate:-'
 puts 'Successfully Removed.' if item.remove

examples/shared_samples/server_profile.rb

@@ -71,9 +71,14 @@
 item3.retrieve!
 puts "\nServer Profile updated successfully! Name: #{item3['name']}"
 
+# This method supports till OneView REST API Version 1200
 puts "\nGetting the available servers"
-servers = server_profile_class.get_available_servers(@client)
-puts "\nAvailable servers: \n#{servers}"
+begin
+  servers = server_profile_class.get_available_servers(@client)
+  puts "\nAvailable servers: \n#{servers}"
+rescue OneviewSDK::MethodUnavailable
+  puts "\nThe method #get_available_servers is available for API version <= 1200"
+end
 
 puts "\nGetting the available networks"
 query_options = {
@@ -109,6 +114,7 @@
 item2.update_from_template
 puts "\nServer Profile updated successfully!"
 
+# This method supports till OneView REST API Version 1200
 puts "\nGetting a new profile template of a given server profile"
 begin
   new_template = item2.get_profile_template

lib/oneview-sdk/image-streamer/resource/api1000/artifact_bundle.rb

@@ -0,0 +1,22 @@
+# (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 '../api800/artifact_bundle'
+
+module OneviewSDK
+  module ImageStreamer
+    module API1000
+      # Artifact Bundle resource implementation for Image Streamer
+      class ArtifactBundle < OneviewSDK::ImageStreamer::API800::ArtifactBundle
+      end
+    end
+  end
+end

lib/oneview-sdk/image-streamer/resource/api1000/deployment_group.rb

@@ -0,0 +1,22 @@
+# (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 '../api800/deployment_group'
+
+module OneviewSDK
+  module ImageStreamer
+    module API1000
+      # Deployment Group resource implementation for Image Streamer
+      class DeploymentGroup < OneviewSDK::ImageStreamer::API800::DeploymentGroup
+      end
+    end
+  end
+end

lib/oneview-sdk/image-streamer/resource/api1020/artifact_bundle.rb

@@ -0,0 +1,22 @@
+# (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 '../api1000/artifact_bundle'
+
+module OneviewSDK
+  module ImageStreamer
+    module API1020
+      # Artifact Bundle resource implementation for Image Streamer
+      class ArtifactBundle < OneviewSDK::ImageStreamer::API1000::ArtifactBundle
+      end
+    end
+  end
+end

lib/oneview-sdk/image-streamer/resource/api1020/deployment_group.rb

@@ -0,0 +1,22 @@
+# (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 '../api1000/deployment_group'
+
+module OneviewSDK
+  module ImageStreamer
+    module API1020
+      # Deployment Group resource implementation for Image Streamer
+      class DeploymentGroup < OneviewSDK::ImageStreamer::API1000::DeploymentGroup
+      end
+    end
+  end
+end