Add support for using guest.ipAddress for older versions of VM Tools #684
Conversation
Older versions of VMTools do not populate the IpStack and Net propreties in GuestInfo which is what is currently used to find the VM's IP address. With this change we now have the option to wait for the IpAddress property instead which does get populated with older versions of VMTools. In order to ensure that we wait for the guest IpAddress property to be populated, a new wait_for_guest_ip_timeout configuration option has been added. This option is disabled by default but can be enabled by setting the timeout to the number of minutes to wait for the guest IpAddress property to be populated.
|
Hi @cbascom! Thanks for asking about this. Which version is guest.ipAddress supported in? I don't know right off where the cutoff is. I'd like to support as much as possible with the vSphere provider, but we can't go too far back without adding a lot of potential issues and complexity. |
|
@bill-rich The version of VMTools I am forced to deal with for now is 9.4.6.33107 (build-1770165). Based on the VMware docs I have looked at, I think it has been available from the beginning. The guest.ipStack that is currently being used wasn't added until API version 4.1. FWIW, The guest.ipAddress field is what the vSphere client uses to display the primary IP address of the VM I believe. I understand about not wanting to go too far back, if this is a no go I will just have to maintain my fork for the time being. If you have any other ideas on how I can work around being stuck with the older VMTools, I'm all ears - this was the only way I have come up with so far that gets me what I need. Thanks! |
Some VMs have default IP addresses that show up before DHCP has given an actual IP address. The new ignored_guest_ips attribute allows the user to configure one or more IP addresses that should be ignored by the IP address waiters.
| // | ||
| // The timeout is specified in minutes. If zero or a negative value is passed, | ||
| // the waiter returns without error immediately. | ||
| func WaitForGuestIP(client *govmomi.Client, vm *object.VirtualMachine, timeout int, ignoredGuestIPs []interface{}) error { |
There was a problem hiding this comment.
What does this do differently than WaitForGuestNet with wait_for_guest_net_routable set to false?
There was a problem hiding this comment.
The only real difference is that it waits for the string guest.ipAddress property instead of the ArrayOfGuestNicInfo guest.net property. I thought about just adding guest.ipAddress to the list of properties that WaitForGuestNet monitors with a new case statement in the switch, but then it becomes a race between which one gets populated first in newer VMTools versions I believe. This seemed like a potential backwards compatibility problem, so I chose to make them completely independent waiters to be safe.
Added doc for the new wait_for_guest_ip_timeout and ignored_guest_ips properties. Updated docs for the existing wait_for_guest_net_timeout and wait_for_guest_net_routable properties to document their relationship with these new properties.
ghost
locked and limited conversation to collaborators
Description
There are two parts to this change:
wait_for_guest_ip_timeoutproperty that is disabled by default. This waiter is intended to be used in place of thewait_for_guest_net_timeoutwaiter.default_ip_addressandguest_ip_addresseswill first look atguest.netandguest.ipStackto find the IP address. Only if no IP address is found via that method will it then fall back to looking at theguest.ipAddressproperty instead.Use Case
The VMs I am creating unfortunately have an older version of VM Tools that does not populate the
guest.netorguest.ipStackproperties. However, the VMs I am creating do populate theguest.ipAddressproperty which can be used for this same purpose. This change allows me to just wait forguest.ipAddressand use that IP address to proceed with provisioning.Todo
I wanted to see if there was a chance of getting something like this in before I spent time adding those as well.