Abiquo 5.4

Skip to end of metadata
Go to start of metadata


Introduction to guest setup in private cloud

In private cloud datacenters, Abiquo supports guest setup with:

  • cloud-init/cloudbase-init
  • hypervisor tools, which are VMware guest tools, with the following options for VM IP addresses:
    • DHCP
    • static IP


 

Introduction to guest setup for static IP address without DHCP

Unable to render {include} The included page could not be found.



Configure abiquo properties for static IP injection Windows

To configure guest setup to use static IP addresses when DCHP is not available, do these steps.

  1. To ignore the unattend file, on the Remote Services server and on the API Server, edit the abiquo.properties files and set this property to "false".

    com.abiquo.esxi.experimental.customize.win.unattendfile=false 
  2. Optionally configure the time zone, which can be per datacenter. To get your time zone codes, see https://docs.vmware.com/en/vRealize-Orchestrator/5.5.2/com.vmware.vsphere.vco_use_plugins.doc/GUID-83EBD74D-B5EC-4A0A-B54E-8E45BE2928C2.html
    On the Remote Services server, edit the abiquo.properties file, and add the timezone property. The default is 110, which is "Western Europe Standard Time". 

    com.abiquo.esxi.experimental.customize.win.timezone=110
  3. To require users to enter the correct VM password when adding a NIC to a deployed VM, set a value greater than 0 for the password wait timeout, on the Remote Services server, edit the abiquo.properties file. The recommended value of 900000 milliseconds is 15 minutes.

    com.abiquo.esxi.experimental.customize.waitpassword.timeoutms=900000

    If the user enters an incorrect password, the reconfigure will fail and the CMP will roll back the changes to the VM. 

    The default value of 0 means the platform will not check the password. It will set the password entered by the user as the new administrator password.

    You can also change the default time to wait between checks to determine if guest tools has applied the new password 

    com.abiquo.esxi.experimental.customize.waitpassword.periodms=10000
  4. You can also ensure the operating system has time to start up and run guest tools.

    # Time in milliseconds to wait for guest tools to be running after power on. The default value is 15 minutes
    com.abiquo.esxi.experimental.customize.configure.timeoutms=900000
    
    # Time in milliseconds to wait between checks when checking if guest tools is running after power on
    com.abiquo.esxi.experimental.customize.configure.periodms=10000
    



Configure abiquo properties for static IP injection Linux

To configure guest setup to use static IP addresses when DCHP is not available, set the following Abiquo Configuration Properties as required for Linux.

  1. Abiquo will use these waitpassword properties to prevent user access to a newly deployed VM until the user can access the VM with the initial password.
    On the Remote Services server, edit the abiquo.properties file, and add the following property with a value greater than 0.

    com.abiquo.esxi.experimental.customize.waitpassword.timeoutms=900000

    The recommended value is 900000 milliseconds, which is 15 minutes.

    You can also change the default time to wait between checks when checking if guest tools has applied the new password 

    com.abiquo.esxi.experimental.customize.waitpassword.periodms=10000
  2. You can also change the default number of times to validate the template credentials.

    com.abiquo.esxi.experimental.customize.configure.currentloginretry=5
  3. You can also configure these additional properties for your environment to ensure the operating system has time to start up and run guest tools.

    # Time in milliseconds to wait for guest tools to be running after power on. The default value is 15 minutes
    com.abiquo.esxi.experimental.customize.configure.timeoutms=900000
    
    # Time in milliseconds to wait between checks when checking if guest tools is running after power on
    com.abiquo.esxi.experimental.customize.configure.periodms=10000
    



Configure guest initial password

The platform can set an initial password for a VM before it deploys. The administrator can configure this option in a VM template but the user may then edit the VM to change the option.

To configure guest initial passwords, do these steps.

  1. To configure the length and characters, on the Abiquo API edit abiquo.properties and set the abiquo.guest.password.length property.
    See Abiquo Configuration Properties#guest

  2. To customize messages, see the following pages.
    1. Customize emails for guest password
    2. Customize emails for guest password SMS
  3. To enable guest initial passwords, in Abiquo, go to Configuration view Security (see Configuration View#Security).
    1. To enable password emails, select this option
    2. To enable password SMS, enter SMS gateway address
  4. In Abiquo, load and configure appropriate VM templates! See Edit VM templates for guest setup


In the Abiquo UI on the VM details panel, the key guest password button enables the user to check the initial guest password. See Display VM initial password

  • The VM owner can display their own VM password
  • To allow a user to display the initial guest passwords of all VMs they can access, assign the privilege to Display initial virtual machine password


Troubleshooting guest initial password

  1. Check your mail server configurations
    1. On the Abiquo API Server in abiquo.properties, check the address of the mail server and the mail user See Abiquo Configuration Properties#mail
    2. If you have resellers, check in the reseller enterprise configuration
  2. Check that all VM owners have a valid email address and phone number
    1. Check the documentation of your SMS gateway provider for format requirements



Configure default FQDNs for guest setup

Abiquo can set a hostname and fully qualified domain name (FQDN) before the VM is deployed.

If a user enters an FQDN when they configure the VM, this will override the defaults because is the highest priority FQDN

If the user does not enter an FQDN, Abiquo uses the following default:

  • Abiquo database ID (on Windows) or the VM_uuid (on Linux, etc); and
  • VM network domain name (from VM NIC or VDC default network) or localdomain

To change the default to always generate the automatic VM name from the database ID:

  1. Login to the Abiquo API Server as administrator
  2. Edit the abiquo.properties file and set the following property
# Generate VM name from database ID. If false use VM_uuid on Linux and VM_database ID on Windows  
abiquo.api.experimental.hostname13charsFromVirtualMachineDatabaseId=true

After the user deploys the VM, the user can change the FQDN in the VM operating system. In this case, Abiquo will update the FQDN stored in the platform.



Prepare VM templates for guest setup

For Linux:
  1. Download a minimal CentOS OVA, for example, https://sourceforge.net/projects/virtualappliances/files/Linux/CentOS/CentOS-7.0-amd64-minimal.ova/download
  2. If Perl is not installed, then install it
  3. Install VMware tools from vCenter, following the instructions for Option 2 at: https://webhostinggeeks.com/howto/how-to-install-vmware-tools/

For Windows:

  1. Download a Windows template such as WS-2019-template-40GB-BIOS-1.vmdk
  2. Install VMware tools
  3. In Abiquo, after you select the Guest setup option of Hypervisor tools, select the "Guest initial password" option



Edit VM templates for guest setup

To edit VM templates and prepare them for guest setup
  1. Load a VM template with support for cloud-init (configuration drive) support OR hypervisor guest tools installed. 
  2. In the Apps library, edit the template and go to Advanced
  3. Select the appropriate Guest setup option (e.g. Cloud-Init or Hypervisor tools)
  4. Select Set initial guest password
    1. For Windows this option is strongly recommended
  5. To use the guest initial password, set the appropriate User for the template
    1. On Linux, enter "root"
    2. On Windows, enter "Administrator"
  6. Select the correct Operating system and optionally enter the OS version

The user can edit a VM before they deploy it, and change the Guest initial password option.

The platform does not save the initial password or any subsequent passwords. On Linux, before deploying an instance template, edit the instance template's password to set it to the current VM password. 

Remember to add the SSH public key to your user before you deploy VMs. Some connections will require the SSH key pair, for example, the remote access connection to Windows VMs in public cloud via RDP.

 


  • No labels