knife-vcenter 5.0.5 → 5.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff2523f169506ffe2b9099c744fca7d6cb17f78b1491e9d358144e1d241428c8
-  data.tar.gz: 2aba720664dca48806e9e2abe92def20aac39ed8b4a09cb8be8f3bbffbb20f9b
+  metadata.gz: 5deb02621e85d8a3bbd047ac7a93b51c7e39c3c5320738c7f33fb939e648b200
+  data.tar.gz: e2fb1fdb8a4cbcb68211ced8e143ccb671b08bfdb9214c13439d60cc82391d77
 SHA512:
-  metadata.gz: 3182c42e1cf563cc4141087657deaf5abac56f3065dfcc92ede22e5e3e263d29cc6583a4d82e8407bbdbdf285aec024b57c3c377ebcab0a73bb9104ae6422ea4
-  data.tar.gz: 72750e64d6e5de6adab941cd8865f18ddff8ae4b88e269ab2f6a27aa91b5f0bbe8e0aae1551461e8c36ff6d29bb7cbd4335ad42d90013d63f2d2e3e139be2bbb
+  metadata.gz: e4aa67a6997a6a79c8fd46d02a4aafcc9fd375cbb0778e37f4c8b7d9919326196346c6020e6979008596841737fdd470d1e7729dcf1493cfafb42ce7f10cfbba
+  data.tar.gz: 5a9f4a0a63469a836196374ec2fca3bcb1287c17e4bd0751ddf4446147bb3214c278b20b9aaa484d3ec6d5e2e36b7ee623f95fae53b42b36393cd5ce747e810c

data/lib/chef/knife/cloud/ssh_bootstrap_protocol_patch.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+#
+# Author:: Chef Partner Engineering (<partnereng@chef.io>)
+# Copyright:: Copyright (c) 2017-2024 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
+# License:: Apache License, Version 2.0
+#
+# 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 "chef/knife"
+require "chef/knife/cloud/chefbootstrap/ssh_bootstrap_protocol"
+
+class Chef
+  # The main knife class
+  class Knife
+    # The main cloud class from knife-cloud
+    class Cloud
+      # Patches SshBootstrapProtocol: upstream's wait_for_server_ready never
+      # falls back to port 22 when --connection-port/--ssh-port aren't set,
+      # so it probes TCPSocket.new(host, nil) and hangs forever. This adds
+      # the missing default, treats EADDRNOTAVAIL as a transient/retryable
+      # error, and adds backoff plus periodic status output while waiting.
+      class SshBootstrapProtocol
+        # Maximum backoff between probe attempts, in seconds.
+        SSH_PROBE_MAX_BACKOFF = 20
+        # Minimum interval between status updates surfaced to the user, in seconds.
+        SSH_PROBE_STATUS_INTERVAL = 15
+        # Standard SSH port used when neither --connection-port nor --ssh-port is given.
+        DEFAULT_SSH_PORT = 22
+
+        # Waits until sshd is reachable on the bootstrap IP before returning.
+        # Falls back to the standard SSH port 22 when neither
+        # --connection-port nor --ssh-port is configured (see class comment).
+        #
+        # @return [void]
+        def wait_for_server_ready
+          print "\n#{ui.color("Waiting for sshd to host (#{config[:bootstrap_ip_address]})", :magenta)}"
+
+          ssh_gateway = get_ssh_gateway_for(config[:bootstrap_ip_address])
+          ssh_port = config[:connection_port] || config[:ssh_port] || DEFAULT_SSH_PORT
+
+          if ssh_gateway
+            print(".") until tunnel_test_ssh(ssh_gateway, config[:bootstrap_ip_address]) do
+              @initial_sleep_delay = !!config[:subnet_id] ? 40 : 10
+              sleep @initial_sleep_delay
+              puts("done")
+            end
+          else
+            print(".") until tcp_test_ssh(config[:bootstrap_ip_address], ssh_port) do
+              @initial_sleep_delay = !!config[:subnet_id] ? 40 : 10
+              sleep @initial_sleep_delay
+              puts("done")
+            end
+          end
+        end
+
+        # Tests whether sshd is accepting connections on the given host/port
+        #
+        # @param [String] hostname The host to test the SSH connection against
+        # @param [Integer] ssh_port The port to test the SSH connection against
+        # @return [Boolean] true if sshd is accepting connections, false otherwise
+        def tcp_test_ssh(hostname, ssh_port)
+          tcp_socket = TCPSocket.new(hostname, ssh_port)
+          readable = IO.select([tcp_socket], nil, nil, 5)
+          if readable
+            ssh_banner = tcp_socket.gets
+            if ssh_banner.nil? || ssh_banner.empty?
+              record_ssh_probe_failure(hostname, "TCP connected but received no SSH banner yet")
+              false
+            else
+              Chef::Log.debug("ssh accepting connections on #{hostname}, banner is #{tcp_socket.gets}")
+              yield
+              true
+            end
+          else
+            record_ssh_probe_failure(hostname, "TCP connect did not become readable within 5s")
+            false
+          end
+        rescue Errno::EPERM, Errno::ETIMEDOUT => e
+          Chef::Log.debug("ssh timed out: #{hostname}")
+          record_ssh_probe_failure(hostname, e)
+          false
+        rescue SocketError, Errno::ECONNREFUSED, Errno::EHOSTUNREACH, Errno::ENETUNREACH, Errno::EADDRNOTAVAIL, IOError => e
+          Chef::Log.debug("ssh failed to connect: #{hostname}")
+          record_ssh_probe_failure(hostname, e)
+          backoff_before_next_ssh_probe
+          false
+        rescue Errno::ECONNRESET => e
+          Chef::Log.debug("ssh reset its connection: #{hostname}")
+          record_ssh_probe_failure(hostname, e)
+          backoff_before_next_ssh_probe
+          false
+        ensure
+          tcp_socket && tcp_socket.close
+        end
+
+        private
+
+        # Records a failed probe attempt and surfaces a throttled status line.
+        #
+        # @param [String] hostname The host being probed
+        # @param [String, Exception] reason Why this attempt failed
+        # @return [void]
+        def record_ssh_probe_failure(hostname, reason)
+          @ssh_probe_started_at ||= Time.now
+          @ssh_probe_attempts = (@ssh_probe_attempts || 0) + 1
+
+          detail = reason.is_a?(Exception) ? "#{reason.class}: #{reason.message}" : reason
+          elapsed = Time.now - @ssh_probe_started_at
+          Chef::Log.debug(format("SSH readiness probe attempt #%d for %s failed after %.1fs total: %s", @ssh_probe_attempts, hostname, elapsed, detail))
+
+          return if @ssh_probe_last_status_at && (Time.now - @ssh_probe_last_status_at) < SSH_PROBE_STATUS_INTERVAL
+
+          @ssh_probe_last_status_at = Time.now
+          ui.warn(format("\nStill waiting for sshd on %s (attempt #%d, %ds elapsed) - last result: %s", hostname, @ssh_probe_attempts, elapsed.to_i, detail))
+        end
+
+        # Sleeps a capped exponential backoff (with jitter) before the next probe.
+        #
+        # @return [void]
+        def backoff_before_next_ssh_probe
+          attempt = @ssh_probe_attempts || 1
+          base_delay = [2 * (2**(attempt - 1)), SSH_PROBE_MAX_BACKOFF].min
+          sleep(base_delay + rand * 0.5)
+        end
+      end
+    end
+  end
+end

data/lib/chef/knife/cloud/vcenter_service.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 #
 # Author:: Chef Partner Engineering (<partnereng@chef.io>)
-# Copyright:: Copyright (c) 2017-2018 Chef Software, Inc.
+# Copyright:: Copyright (c) 2017-2024 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -25,7 +25,13 @@ require_relative "../../../support/clone_vm"
 require "uri" unless defined?(URI)
 require "json" unless defined?(JSON)
 require "ostruct" unless defined?(OpenStruct)
-require "vsphere-automation-cis"
+require "vsphere-automation-cis/api/session_api"
+require "vsphere-automation-cis/models/cis_session_create_result"
+require "vsphere-automation-cis/models/vapi_std_errors_unauthenticated"
+require "vsphere-automation-cis/models/vapi_std_errors_unauthenticated_error"
+require "vsphere-automation-cis/models/vapi_std_errors_service_unavailable"
+require "vsphere-automation-cis/models/vapi_std_errors_service_unavailable_error"
+require "vsphere-automation-cis/models/vapi_std_localizable_message"
 require "vsphere-automation-vcenter"
 require "set" unless defined?(Set)
 
@@ -41,35 +47,34 @@ class Chef
         attr_reader :api_client, :session_api, :session_id
         attr_reader :connection_options, :ipaddress
 
-        def initialize(options = {})
-          super(options)
+        def initialize(config: nil, host: nil, username: nil, password: nil, verify_ssl: true, logs: false)
+          super(config: config)
 
           configuration = VSphereAutomation::Configuration.new.tap do |c|
-            c.host = options[:host]
-            c.username = options[:username]
-            c.password = options[:password]
+            c.host = host
+            c.username = username
+            c.password = password
             c.scheme = "https"
-            c.verify_ssl = options[:verify_ssl]
-            c.verify_ssl_host = options[:verify_ssl]
+            c.verify_ssl = verify_ssl
+            c.verify_ssl_host = verify_ssl
           end
 
-          Base.log.warn("SSL Verification is turned OFF") if options[:logs] && !options[:verify_ssl]
+          Base.log.warn("SSL Verification is turned OFF") if logs && !verify_ssl
 
           @api_client = VSphereAutomation::ApiClient.new(configuration)
           api_client.default_headers["Authorization"] = configuration.basic_auth_token
 
-          session_api = VSphereAutomation::CIS::SessionApi.new(api_client)
-          session_id = session_api.create("").value
-
-          api_client.default_headers["vmware-api-session-id"] = session_id
-
           # Set the class properties for the rbvmomi connections
           @connection_options = {
-            user: options[:username],
-            password: options[:password],
-            insecure: options[:verify_ssl] ? false : true,
-            host: options[:host],
+            user: username,
+            password: password,
+            insecure: verify_ssl ? false : true,
+            host: host,
           }
+
+          @session_id = create_api_session_id
+
+          api_client.default_headers["vmware-api-session-id"] = @session_id
         end
 
         # Creates the server
@@ -130,6 +135,11 @@ class Chef
             rescue StandardError => e
               puts e.message
             end
+
+            # vm_api.create only returns the new VM's ID as a raw String, not
+            # a summary object with .vm/.name/.power_state (unlike "clone"
+            # above), so fetch the full summary the same way.
+            get_server(options[:name])
           end
         end
 
@@ -137,6 +147,7 @@ class Chef
         #
         def list_servers
           vms = VSphereAutomation::VCenter::VMApi.new(api_client).list.value
+          vms = validate_list_response!(vms, "virtual machines")
 
           # list_resource_command uses .send(:name) syntax, so convert to OpenStruct to keep it compatible
           vms.map { |vmsummary| OpenStruct.new(vmsummary.to_hash) }
@@ -145,19 +156,22 @@ class Chef
         # Return a list of the hosts in the vCenter
         #
         def list_hosts
-          VSphereAutomation::VCenter::HostApi.new(api_client).list.value
+          hosts = VSphereAutomation::VCenter::HostApi.new(api_client).list.value
+          validate_list_response!(hosts, "hosts")
         end
 
         # Return a list of the datacenters in the vCenter
         #
         def list_datacenters
-          VSphereAutomation::VCenter::DatacenterApi.new(api_client).list.value
+          datacenters = VSphereAutomation::VCenter::DatacenterApi.new(api_client).list.value
+          validate_list_response!(datacenters, "datacenters")
         end
 
         # Return a list of the clusters in the vCenter
         #
         def list_clusters
-          VSphereAutomation::VCenter::ClusterApi.new(api_client).list.value
+          clusters = VSphereAutomation::VCenter::ClusterApi.new(api_client).list.value
+          validate_list_response!(clusters, "clusters")
         end
 
         # Checks to see if the datacenter exists in the vCenter
@@ -300,6 +314,32 @@ class Chef
 
         private
 
+        def create_api_session_id
+          session_api = VSphereAutomation::CIS::SessionApi.new(api_client)
+          session_response = session_api.create("")
+
+          if session_response.respond_to?(:value) && session_response.value.is_a?(String) && !session_response.value.empty?
+            return session_response.value
+          end
+
+          response_type = session_response.class.name
+          if response_type.end_with?("VapiStdErrorsUnauthenticatedError") || response_type.end_with?("VapiStdErrorsUnauthenticated")
+            raise format("Authentication to vCenter failed for user %s on host %s", connection_options[:user], connection_options[:host])
+          end
+
+          raise format("Unable to establish a vCenter session on host %s: %s", connection_options[:host], response_type)
+        end
+
+        def validate_list_response!(resources, resource_type)
+          return resources if resources.is_a?(Array)
+
+          if resources.class.name.end_with?("VapiStdErrorsUnauthenticated")
+            raise format("Authentication to vCenter failed for user %s on host %s", connection_options[:user], connection_options[:host])
+          end
+
+          raise format("Unexpected vCenter response while listing %s: %s", resource_type, resources.class.name)
+        end
+
         def cleanup
           session_svc.delete unless session_id.nil?
         end

data/lib/chef/knife/cloud/vcenter_service_helpers.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 #
 # Author:: Chef Partner Engineering (<partnereng@chef.io>)
-# Copyright:: Copyright (c) Chef Software Inc.
+# Copyright:: Copyright (c) 2017-2024 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -32,9 +32,9 @@ class Chef
         #
         def create_service_instance
           Chef::Knife::Cloud::VcenterService.new(username: config[:vcenter_username],
-                                                 password: config[:vcenter_password],
-                                                 host: config[:vcenter_host],
-                                                 verify_ssl: verify_ssl?)
+            password: config[:vcenter_password],
+            host: config[:vcenter_host],
+            verify_ssl: verify_ssl?)
         end
 
         # Do we have valid SSL?

data/lib/chef/knife/cloud/vcenter_service_options.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 #
 # Author:: Chef Partner Engineering (<partnereng@chef.io>)
-# Copyright:: Copyright (c) 2017-2018 Chef Software, Inc.
+# Copyright:: Copyright (c) 2017-2024 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/chef/knife/cloud/winrm_bootstrap_protocol_patch.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+#
+# Author:: Chef Partner Engineering (<partnereng@chef.io>)
+# Copyright:: Copyright (c) 2017-2024 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
+# License:: Apache License, Version 2.0
+#
+# 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.
+#
+
+# knife-cloud's WinrmBootstrapProtocol does
+# `require "winrm" unless defined?(WinRM::Connection)`. The upstream "winrm"
+# gem is unmaintained and not a declared dependency of this plugin, so this
+# raises a LoadError on every --connection-protocol winrm bootstrap. The
+# actively maintained fork "chef-winrm" defines the same WinRM::Connection
+# class, satisfying the guard, so we require it here first (falling back to
+# "winrm" directly in case a future environment has the real gem installed).
+begin
+  require "chef-winrm" unless defined?(WinRM::Connection)
+rescue LoadError
+  require "winrm" unless defined?(WinRM::Connection)
+end
+
+require "chef/knife"
+require "chef/knife/cloud/chefbootstrap/winrm_bootstrap_protocol"
+
+class Chef
+  # The main knife class
+  class Knife
+    # The main cloud class from knife-cloud
+    class Cloud
+      # Patches WinrmBootstrapProtocol: upstream's wait_for_server_ready has
+      # no port default at all (unlike SSH, which falls back to --ssh-port),
+      # so it probes TCPSocket.new(host, nil) and hangs forever. This adds
+      # a default of 5985 (or 5986 with --winrm-ssl) and treats
+      # EADDRNOTAVAIL as a transient/retryable error.
+      class WinrmBootstrapProtocol
+        # Standard WinRM ports used when --connection-port isn't given.
+        DEFAULT_WINRM_PORT = 5985
+        DEFAULT_WINRM_SSL_PORT = 5986
+
+        def wait_for_server_ready
+          print "\n#{ui.color("Waiting for winrm to host (#{@config[:bootstrap_ip_address]})", :magenta)}"
+
+          winrm_port = @config[:connection_port] || (@config[:winrm_ssl] ? DEFAULT_WINRM_SSL_PORT : DEFAULT_WINRM_PORT)
+
+          print(".") until tcp_test_winrm(@config[:bootstrap_ip_address], winrm_port) do
+            sleep @initial_sleep_delay ||= 10
+            puts("done")
+          end
+        end
+
+        def tcp_test_winrm(hostname, port)
+          tcp_socket = TCPSocket.new(hostname, port)
+          true
+        rescue SocketError
+          sleep 2
+          false
+        rescue Errno::ETIMEDOUT
+          false
+        rescue Errno::EPERM
+          false
+        rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH, Errno::ENETUNREACH, Errno::EADDRNOTAVAIL
+          sleep 2
+          false
+        ensure
+          tcp_socket && tcp_socket.close
+        end
+      end
+    end
+  end
+end

data/lib/chef/knife/vcenter_cluster_list.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 #
 # Author:: Chef Partner Engineering (<partnereng@chef.io>)
-# Copyright:: Copyright (c) 2017-2018 Chef Software, Inc.
+# Copyright:: Copyright (c) 2017-2024 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/chef/knife/vcenter_datacenter_list.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 #
 # Author:: Chef Partner Engineering (<partnereng@chef.io>)
-# Copyright:: Copyright (c) 2017-2018 Chef Software, Inc.
+# Copyright:: Copyright (c) 2017-2024 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/chef/knife/vcenter_host_list.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 #
 # Author:: Chef Partner Engineering (<partnereng@chef.io>)
-# Copyright:: Copyright (c) 2017-2018 Chef Software, Inc.
+# Copyright:: Copyright (c) 2017-2024 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/chef/knife/vcenter_vm_clone.rb

@@ -2,7 +2,7 @@
 
 #
 # Author:: Chef Partner Engineering (<partnereng@chef.io>)
-# Copyright:: Copyright (c) Chef Software Inc.
+# Copyright:: Copyright (c) 2017-2024 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -38,6 +38,8 @@ class Chef
         # lazy load this file as it includes vmware deps that we only want at plugin runtime
         deps do
           require_relative "cloud/vcenter_service"
+          require_relative "cloud/ssh_bootstrap_protocol_patch"
+          require_relative "cloud/winrm_bootstrap_protocol_patch"
           include VcenterServiceHelpers
         end
 
@@ -116,6 +118,40 @@ class Chef
 
           ipaddress.nil? ? server.name : ipaddress
         end
+
+        # Retry bootstrap when local networking has a transient source-address failure.
+        # This keeps a successful clone from failing permanently on a temporary route/interface flap.
+        def after_exec_command
+          bootstrap_attempt = 0
+          max_bootstrap_retries = 3
+
+          begin
+            bootstrap
+          rescue Errno::EADDRNOTAVAIL => e
+            bootstrap_attempt += 1
+
+            if bootstrap_attempt <= max_bootstrap_retries
+              retry_wait = bootstrap_attempt * 5
+              ui.warn(format("Transient local networking error while bootstrapping (%s). Retrying in %d seconds (attempt %d/%d).", e.message, retry_wait, bootstrap_attempt, max_bootstrap_retries))
+              sleep retry_wait
+              retry
+            end
+
+            error_message = format("Bootstrap failed after %d retries due to local networking error: %s", max_bootstrap_retries, e.message)
+            ui.fatal(error_message)
+            cleanup_on_failure
+            raise e, error_message
+          rescue CloudExceptions::BootstrapError => e
+            ui.fatal(e.message)
+            cleanup_on_failure
+            raise e
+          rescue StandardError => e
+            error_message = format("Check if --connection-protocol and --image-os-type is correct. %s", e.message)
+            ui.fatal(error_message)
+            cleanup_on_failure
+            raise e, error_message
+          end
+        end
       end
     end
   end

data/lib/chef/knife/vcenter_vm_create.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 #
 # Author:: Chef Partner Engineering (<partnereng@chef.io>)
-# Copyright:: Copyright (c) Chef Software Inc.
+# Copyright:: Copyright (c) 2017-2024 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/chef/knife/vcenter_vm_delete.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 #
 # Author:: Chef Partner Engineering (<partnereng@chef.io>)
-# Copyright:: Copyright (c) 2017-2018 Chef Software, Inc.
+# Copyright:: Copyright (c) 2017-2024 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/chef/knife/vcenter_vm_list.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 #
 # Author:: Chef Partner Engineering (<partnereng@chef.io>)
-# Copyright:: Copyright (c) Chef Software Inc.
+# Copyright:: Copyright (c) 2017-2024 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/chef/knife/vcenter_vm_show.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 #
 # Author:: Chef Partner Engineering (<partnereng@chef.io>)
-# Copyright:: Copyright (c) 2017-2018 Chef Software, Inc.
+# Copyright:: Copyright (c) 2017-2024 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/knife-vcenter/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 #
 # Author:: Chef Partner Engineering (<partnereng@chef.io>)
-# Copyright:: Copyright (c) 2017-2018 Chef Software, Inc.
+# Copyright:: Copyright (c) 2017-2024 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -20,5 +20,5 @@
 # Provisions machines in vCenter
 module KnifeVcenter
   # The version of this amazing Gem, you should <3 it.
-  VERSION = "5.0.5"
+  VERSION = "5.1.1"
 end

data/lib/support/clone_vm.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 #
 # Author:: Chef Partner Engineering (<partnereng@chef.io>)
-# Copyright:: Copyright (c) 2017-2018 Chef Software, Inc.
+# Copyright:: Copyright (c) 2017-2024 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -45,8 +45,8 @@ class Support
       relocate_spec.pool = options[:resource_pool]
 
       clone_spec = RbVmomi::VIM.VirtualMachineCloneSpec(location: relocate_spec,
-                                                        powerOn: options[:poweron],
-                                                        template: false)
+        powerOn: options[:poweron],
+        template: false)
 
       # Set the folder to use
       dest_folder = options[:folder].nil? ? src_vm.parent : options[:folder][:id]
@@ -57,19 +57,56 @@ class Support
       task.wait_for_completion
 
       # get the IP address of the machine for bootstrapping
-      # machine name is based on the path, e.g. that includes the folder
-      name = options[:folder].nil? ? options[:name] : format("%s/%s", options[:folder][:name], options[:name])
-      new_vm = dc.find_vm(name)
+      new_vm = locate_new_vm(dc)
 
       if new_vm.nil?
-        puts format("Unable to find machine: %s", name)
+        puts format("Unable to find machine: %s", options[:name])
       else
         puts "Waiting for network interfaces to become available..."
-        sleep 2 while new_vm.guest.net.empty? || !new_vm.guest.ipAddress
-        new_vm.guest.net[0].ipConfig.ipAddress.detect do |addr|
-          addr.origin != "linklayer"
-        end.ipAddress
+        bootstrap_ip_for_vm(new_vm)
       end
     end
+
+    private
+
+    def locate_new_vm(datacenter)
+      vm_name = options[:name]
+
+      if options[:folder]
+        folder_vm_name = format("%s/%s", options[:folder][:name], vm_name)
+        vm = datacenter.find_vm(folder_vm_name)
+        return vm unless vm.nil?
+      end
+
+      datacenter.find_vm(vm_name)
+    end
+
+    def bootstrap_ip_for_vm(vm, timeout: 300, interval: 2)
+      deadline = Time.now + timeout
+
+      loop do
+        ipaddress = extract_bootstrap_ip(vm)
+        return ipaddress unless ipaddress.nil?
+
+        return nil if Time.now >= deadline
+
+        sleep interval
+      end
+    end
+
+    def extract_bootstrap_ip(vm)
+      guest = vm.guest
+
+      addresses = guest.net.to_a.flat_map do |nic|
+        nic.ipConfig&.ipAddress.to_a.map(&:ipAddress)
+      end.compact
+
+      ipv4 = addresses.find { |addr| addr.include?(".") && !addr.start_with?("169.254.") }
+      return ipv4 unless ipv4.nil?
+
+      return nil if guest.ipAddress.nil? || !guest.ipAddress.include?(".")
+
+      guest.ipAddress.start_with?("169.254.") ? nil : guest.ipAddress
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knife-vcenter
 version: !ruby/object:Gem::Version
-  version: 5.0.5
+  version: 5.1.1
 platform: ruby
 authors:
 - Chef Partner Engineering
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-21 00:00:00.000000000 Z
+date: 2026-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '15.11'
+        version: '18.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '15.11'
+        version: '18.0'
 - !ruby/object:Gem::Dependency
   name: knife-cloud
   requirement: !ruby/object:Gem::Requirement
@@ -94,9 +94,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE
+- lib/chef/knife/cloud/ssh_bootstrap_protocol_patch.rb
 - lib/chef/knife/cloud/vcenter_service.rb
 - lib/chef/knife/cloud/vcenter_service_helpers.rb
 - lib/chef/knife/cloud/vcenter_service_options.rb
+- lib/chef/knife/cloud/winrm_bootstrap_protocol_patch.rb
 - lib/chef/knife/vcenter_cluster_list.rb
 - lib/chef/knife/vcenter_datacenter_list.rb
 - lib/chef/knife/vcenter_host_list.rb
@@ -119,14 +121,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.3.27
 signing_key: 
 specification_version: 4
 summary: Knife plugin to VMware vCenter.