You install the supported Java Runtime Environment, the guest agent, and the Software bootstrap agent on your Windows reference machine to create a template, snapshot, or Amazon Machine Instance that supports Software components.

About this task

Software supports scripting with Windows CMD and PowerShell 2.0.


Because the boot process must not be interrupted, configure the virtual machine so that nothing causes the virtual machine's boot process to pause before reaching the final operating system login prompt. For example, verify that no processes or scripts prompt for user interaction when the virtual machine starts.


  • Identify or create a reference machine.

  • If you have previously installed the guest agent or Software bootstrap agent on this machine, remove the agents and runtime logs. See Updating Existing Virtual Machine Templates in vRealize Automation.

  • If you plan to remotely access the virtual machine Windows remote desktop for troubleshooting or for other reasons, install the Remote Desktop Services (RDS) for Windows.

  • Verify that all of the network configuration artifacts are removed from the network configuration files.

  • If you want to use the most secure approach for establishing trust between the guest agent and your Manager Service machine, obtain the SSL certificate in PEM format from your Manager Service machine. For information about installing a guest agent on a Windows machine, see Install the Guest Agent on a Windows Reference Machine. For more information about how the guest agent establishes trust, see Configuring the Windows Guest Agent to Trust a Server.

  • Verify that the Darwin user has Log on as a service access rights on the Windows reference machine.


  1. Log in to your Windows reference machine as a Windows Administrator and open a command prompt.
  2. Download and install the supported Java Runtime Environment from https://vRealize_VA_Hostname_fqdn/software/index.html.
    1. Download the Java SE Runtime Environment .zip file https://vRealize_VA_Hostname_fqdn/software/download/
    2. Create a c:\opt\vmware-jre folder and unzip the JRE .zip file to the folder.
    3. Open a command prompt window and enter c:\opt\vmware-jre\bin\java -version to verify the installation.

      The installed version of Java appears.

  3. Download and install the vRealize Automation guest agent from https://vRealize_VA_Hostname_fqdn/software/index.html.
    1. Download GugentZip_version to the C drive on the reference machine.

      Select either GuestAgentInstaller.exe (32-bit) or GuestAgentInstaller_x64.exe (64-bit) depending on which is appropriate for your operating system.

    2. Right-click the file and select Properties.
    3. Click General.
    4. Click Unblock.
    5. Extract the files to C:\.

      This produces the directory C:\VRMGuestAgent. Do not rename this directory.

  4. Configure the guest agent to communicate with the Manager Service.
    1. Open an elevated command prompt.
    2. Navigate to C:\VRMGuestAgent.
    3. Configure the guest agent to trust your Manager Service machine.



      Allow the guest agent to trust the first machine to which it connects.

      No configuration required.

      Manually install the trusted PEM file.

      Place the Manager Service PEM file in the C:\VRMGuestAgent\ directory.

    4. Run the following command: winservice -i -h Manager_Service_Hostname_fdqn:portnumber -p ssl.

      The default port number for the Manager Service is 443.



      If you are using a load balancer

      Enter the fully qualified domain name and port number of your Manager Service load balancer. For example, winservice -i -h -p ssl.

      With no load balancer

      Enter the fully qualified domain name and port number of your Manager Service machine. For example, winservice -i -h -p ssl.

      If you are preparing an Amazon machine image

      You need to specify that you are using Amazon. For example, winservice -i -h -p ssl -c ec2

  5. Download the Software Agent bootstrap file from https://vRealize_VA_Hostname_fqdn/software/index.html.
    1. Download the Software bootstrap agent file https://vRealize_VA_Hostname_fqdn/software/download/
    2. Right-click the file and select Properties.
    3. Click General.
    4. Click Unblock.

      If you do not disable this Windows security feature, you cannot use the Software agent bootstrap file.

    5. Unzip the file to the c:\temp folder.
  6. Install the Software bootstrap agent.
    1. Open a Windows CMD console and navigate to the c:\temp folder.
    2. Enter the command to install the agent bootstrap.
      install.bat password=Password managerServicePort=443 httpsMode=true cloudProvider=ec2|vca|vcd|vsphere

      The default port number for the Manager Service is 443. Accepted values for cloudprovider are ec2, vca, vcd, and vsphere. The install.bat script creates a user account called darwin for the software bootstrap agent using the password you set in the install command. The Password you set must meet the Windows password requirements.

      If your install fails due to a .NET dependency, refer to the following article for assistance:

  7. Verify that the user darwin exists.
    1. Enter lusrmgr.msc at a command prompt.
    2. Verify that the user darwin_user exists and belongs to the administrator group.
    3. Set the password to never expire.

      The setting ensures that the template remains usable after 30 days.

    If the user is not available, verify that the Windows server password is accurate.

  8. Shut down the Windows virtual machine.

What to do next

Convert your reference machine into a template for cloning, an Amazon machine image, or a snapshot so your IaaS architects can use your template when creating blueprints.