REST API - connect

vcenter vm tools installer: connect

Connects the VMware Tools CD installer as a CD-ROM for the guest operating system. On Windows guest operating systems with autorun, this should cause the installer to initiate the Tools installation which will need user input to complete. On other (non-Windows) guest operating systems this will make the Tools installation available, and a a user will need to do guest-specific actions. On Linux, this includes opening an archive and running the installer. To monitor the status of the Tools install, clients should check the version_status and run_state from get. This operation was added in vSphere API 7.0.0.


HTTP request

POST https://{server}/rest/vcenter/vm/{vm}/tools/installer?action=connect

Path Parameters

Name Type Description
vm string Virtual machine ID.


HTTP Status Code: 200



HTTP Status Code Type Description
404 not_found if the virtual machine is not found.
400 not_allowed_in_current_state if the virtual machine is not powered on.
400 already_in_desired_state if the VMware Tools CD is already connected.
500 error if the Tools installation fails in the guest operating system.