Abiquo Documentation Cookies Policy

Our Documentation website uses cookies to improve your experience. Please visit our Cookie Policy page for more information about cookies and how we use them.


Abiquo 4.6

Skip to end of metadata
Go to start of metadata

This page describes how to configure VMs in detail. Before you read this page, you may like to work through Manage Virtual Machines to help you get started working with VMs. After you add your VMs to a virtual appliance, you can configure the VMs before deployment or reconfigure after deployment. Each of these configuration topics is also available as a separate page. 

Prepare to configure a VM

Abiquo supports hot-add and hot-reconfigure of VMs on ESXi hypervisors. If your VM template and VM operating system support hot-add and hot-reconfigure, you can configure the VM while it is powered on. 

Privilege: Edit virtual appliance details

After deployment, power off the VM before you reconfigure. Abiquo recommends that you configure the network before you deploy. You can configure captured VMs in the same way as VMs created in Abiquo.

  1. If the virtual appliance is deployed, select the VM and go to the stop button. If your guest supports graceful shutdown, for example, if you have installed the guest tools, select the Shut down option. 
    Shut down a VM to configure it
    Otherwise, you can connect directly to the VM and perform a graceful shutdown. Or if this option is not successful, or your VM is already prepared with all services shut down, you can select the Power off option.
  2. When the VM is powered off, the status bar on its icon should turn red and the control panel should only display the lock button and the power on button. 
    VM power buttons
  3. From the VM options menu, select Edit to modify the VM configuration. Edit the configuration as described in this manual. Note that some of the VM configuration tabs may or may not be visible, depending on your datacenter configuration and privileges.
  4. After you make your changes click Save. The cloud platform orchestrator will reconfigure the VM. 
  5. Deploy or power on the VM as appropriate.
VM names and power on order

VMs will be powered on in ascending alphanumeric order. Thus it may be helpful to number your VMs in front of the their names. As an example, 1_WebServer will power on before 2_Database. You should remember that although the VMs will be powered on in this order, there is no guarantee that the machines will finish powering on in the same order.

Infrastructure updates

The periodic infrastructure check will detect direct changes to the VMs (CPU, RAM and hard disk) and these changes will be reflected in platform statistics and accounting, as well as the VM general configuration page.

General configuration

A VM with hardware profiles in private cloud

Do NOT change the Abiquo tag in public cloud

Do not change the Abiquo platform's tag on a VM in public cloud provider (e.g. on an AWS instance) because you could break the link between Abiquo and the VM. If the link is broken, you will not be able to manage the VM with Abiquo.


The DVD functionality has been replaced with the ISO functionality.

Field

Description

UUID

The Unique Identifier of the VM

Name

The Name of the VM. Defaults to the VM template name

Fully qualified domain nameOptionally enter the fully qualified domain name (FQDN) of the VM. You can edit this value before you deploy the VM. If you don't enter a FQDN, the platform will automatically generate one. The hostname will be the VM name (format ABQ-uuid) or another Abiquo identifier (format ABQ-id). The domain will be the domain value of the private or external networks that the VM belongs to, or localdomain. After you deploy the VM, if you change the value in the operating system, then Abiquo will synchronize and obtain the new value.

Owner

The enterprise and user that owns the VM

Guest initial passwordGenerate an initial root or Administrator password for the VM and email it to the owner. You can change this value before you deploy the VM. See Guest setup

CPU

The number of CPUs. You may only change this value when the VM is undeployed or stopped or when using hot add/reconfigure. Requires the privilege to Edit VM details. The virtual datacenter and enterprise allocation limits will be checked when you enter this number. The number of CPUs available in the hypervisors will be checked when the VM is deployed or restarted. Read-only value when hardware profiles are used.

Cores per socketThe number of cores per socket. The number of CPUs must be divisible by the number of cores per socket. Not shown when hardware profiles are used.

RAM

The amount of RAM. Select MB or GB. You may only change this value when the VM is undeployed or stopped, or with hot add/reconfigure. Requires privilege Edit VM details privilege. The virtual datacenter and enterprise allocation limits will be checked when you enter this number. The number of CPUs available in the hypervisors will be checked when the VM is deployed or restarted. Read-only value when hardware profiles are used.

Enable Remote AccessHypervisors with Remote Access Support only. Enable remote access on this VM. If the VM was created without remote access enabled on the hypervisor, it will be enabled. If you disable remote access, the configuration will remain but you cannot access it via the eye icon. Abiquo does not support remote access through Docker attach.

Remote access

Remote Access to the VM by VNC may be Not Available, usually because the VM is not deployed. If it is available and you have the View datacenter details privilege, the Remote Access IP and Port will be displayed.

Remote Access Password

To open the remote access window to your VM from the eye button on the control panel, you must enter this password. By default Abiquo will generate a random password for your VM. To change the password, enter a maximum of 8 characters that are alphanumeric characters only, i.e. [a..z][A..Z][0..9]. 

If you delete the password, the screen requesting the password will not appear. On ESXi hypervisors, if you set a password and later delete it, the password will be blank, not null. The screen requesting the password will appear, and you should press <Enter> to continue.

If the VM is deployed when you change the password, the change will be applied when you save the VM.

  • Limitation: On ESXi hypervisors you cannot change the password with hot-reconfigure; you must reboot to update the password for the VM
Show passwordOptionally mark the checkbox to show the remote access password
SSH user / passwordThe default user and password from the VM template

VM Keymap

ESX/ESXi only - If Remote Access is Available, you can select the keyboard type for remote access through the eye button for ESXi hypervisors

Description

A description of the VM. The default value is copied from the VM template

Hardware profileIf your provider uses hardware profiles, select a hardware profile for the VM
CreatedDate and time that the VM was created

Configure Network


To attach your VM to virtual networks, create network interfaces.

If you deploy a VM without configuring a network interface, the platform will automatically assign an address in the default network.

Privilege: Edit virtual appliance details, Manage virtual network elements, Manage public IPs, Manage floating IPs, Attach NICs in restricted networks, Detach NICs from restricted networks

Your administrator may create or obtain multiple IP addresses for your virtual datacenters under Virtual datacenters → Networks.

Create NICs and IP addresses

To create NICs and attach them to a VM:

  1. Go to Virtual datacenters → Virtual appliances
  2. If your VM is deployed and you are not using hot-reconfigure of NICs, shut down the VM
  3. Edit the VM and go to Networks
  4. Select a network type and a network
    1. Private networks with private IP addresses that only allow your VMs to communicate with others inside the same virtual datacenter.
    2. External networks that belong to an enterprise and allow VMs to communicate with machines outside their virtual datacenter
    3. Public networks with Internet addressable public IP addresses
  5. Depending on the network type, you may be able to:
    • Request an automatically created NIC and IP by dragging and dropping "Automatically generated IP" to your VM. This IP address will be created and assigned at deploy time.
    • Create a new IP address and NIC using the + button
    • Create a new NIC by dragging and dropping a specific IP address

    For each VM, your administrator may limit the total number of network interfaces and/or the number of network interfaces in the same network

Optionally set Default gateway
  • If you are not sure about the gateway, don't worry! If there is no default gateway selected, the platform uses the gateway address of the network of the first NIC on the VM.
  • If you change the NICs on the VM, check the gateway is still valid, because you won't be able to save your VM until the gateway is valid.

In the Default gateway box, optionally select an address to be the default gateway of the VM.

Edit VM network configuration

To reorder network interfaces in the VM in supported clouds:
  1. Beside a network interface, click the pencil edit button
  2. Enter the desired number in the sequence where you would like to move the interface
  3. Click OK

To remove a NIC from a VM:

  1. Check that its network does not have the default gateway address for the VM
  2. Click the X beside the NIC

To change the default gateway:

  1. Select a new gateway from the list. 

To remove the current default gateway:

  1. Select the gateway address
  2. Click the X delete button beside the gateway address

For public cloud network configurations, please check for the following:

  • Automatic network configuration or network requirements, for example, a required public IP
  • Charges for public IPs that are not used by running VMs. When you remove an IP from a VM or undeploy the VM, if you no longer need the same IP address, remove it from your VDC and the platform.
  • Different public IP address when you remove a public IP and add another public IP to your virtual datacenter and VM
  • Limits for public IPs that are independent of any public IP limit in the platform


Privilege: Manage floating IPs

A public IP that is not part of any network in the platform is called a floating IP.

A VM with a floating public IP, such as an elastic IP

To remove a public IP from your VM

  1. Power off or undeploy the VM
  2. Click the trash bin delete button near the IP address.

Configure Storage

In private cloud datacenters, VMs can have the following storage types, when supported in your environment:

  • Volumes of managed storage

  • Hard disks on the hypervisor datastore

  • ISO hard disks on datastore DVD drives
Display VM storage


Privilege: Edit virtual appliance details, Manage virtual storage elements, Manage virtual storage controller

To display VM storage, including the details of the primary disk and attached storage,

  1. Go to Virtual datacenters → select VM
  2. Go to the VM control panel → Storage

To display and configure VM storage:

  1. Go to Virtual datacenters → select VM
  2. To configure storage, if you are not using hot-reconfigure of disks, power off the VM
  3. Edit the VM




Attach Volumes of Managed Storage

Storage volumes are persistent, which means they will still be available after you undeploy the VM. For information about how to create volumes, see Manage Persistent Storage and VMs#Managepersistentvolumes.

To attach storage volumes to a VM

  1. Go to Virtual datacenters → select VM
  2. If you are not using hot reconfigure, power off the VM
  3. Edit the VM and go to Storage
  4. The left pane displays a list of volumes available to you in the virtual datacenter.  To attach a volume to your VM, drag and drop it from the Volumes pane to the main Storage pane. 
  5. To save all your changes to the VM, click Save. If the VM is deployed, it will be automatically reconfigured.

If a volume does not attach properly but you do not see an error message, a problem may have occurred in the storage device. Contact your System Administrator

Create Hard Disks on Hypervisor Datastores

In private cloud datacenters, you can create secondary hard disks that are not persistent. This means that when you undeploy the VM or remove the hard disk the platform will delete your hard disks and destroy all data on them.
  • Administrators can control the display of the Hard Disk Tab in Configuration View#General Tab
  • The administrator can force the use of the same controller type and controller as for the primary template disk using the appropriate Abiquo Configuration property.


Privilege: Edit virtual appliance details, Manage virtual storage elements, Manage virtual machine hard disks, Manage allocation when attaching a disk, Manage virtual storage controller.

(minus) To save data before you undeploy, create a backup, or create an Abiquo instance template, or copy data to a persistent volume. See Manage VMs#SaveVMdiskstocreateaninstancetemplate and Manage Persistent Storage and VMs

To add a VM hard disk:

  1. Go to Virtual datacenters → edit VM → Storage

  2. Click the add button at the top right of the tab

  3. Select Assign virtual disk and complete the dialog

  4. Click Save to create the disk, then finish editing the VM, then click Save

Field

Description

Size

The size of the hard disk and units

Datastore tierOptional. Storage service level
Allocation typeOptional. Allocation type of the disk.
Controller type

The controller type of disk

 

Controller

Optional. On supported hypervisors (ESXi), to force the creation of a new controller of the same type as an existing one, assign a new bus value. Access ESXi to confirm bus values.

Bus

Optional. Select an existing an existing bus number or to create a new controller, specify a new bus number. The user requests a bus number but the platform will use the bus number assigned by ESXi. When there is more than one controller, to identify the controller and bus number, the platform displays the bus number as a suffix to the controller. Access ESXi to confirm bus numbers that are not displayed

Name

The name of the hard disk

Add an ISO Disk to Install Software

To add an ISO disk from the Apps library to install software on your VM:

Privilege: Manage virtual machine ISO disks

  1. Go to Virtual datacenters → edit VM → Storage
  2. Click the + button at the top right of the tab
  3. Choose Select an ISO disk
  4. From the Apps library browser window that opens, select an ISO disk 
  5. Click Save

Abiquo will create a DVD hard disk on the hypervisor datastore that contains the ISO disk. You cannot resize an ISO hard disk.

 Click here to show/hide screenshots

Add an ISO disk from the Apps library

Create a hard disk for a VM on the hypervisor datastore

Select an ISO disk

Select an ISO disk to add to a virtual machine


Detach Volumes and Delete Hard Disks

When you detach a volume, it will be available in the virtual datacenter again. For ESXi, you can only detach an iSCSI external storage volume if the VM does not have VMware snapshots. If you cannot detach a volume as expected, please contact your System Administrator.

When you detach a hard disk, the platform will destroy it and all data on it.

To delete a hard disk or to detach a volume of virtual storage:

  1. Go to Virtual datacenters → edit VM → Storage

  2. Select the hard disk or volume

  3. Click the detach/delete button at the top right of the Storage tab

  4. Click Yes to confirm the delete or detach operation

  5. Click Cancel to discard changes or Save to reconfigure the VM in the hypervisor

A volume that has been detached will now be available again in the virtual datacenter.

 Click here to show/hide the screenshot

Detach the selected storage volume or hard disk from the VM


Change VM Storage Boot Order

Abiquo recommends that you change the boot order by itself, without making any other disk configuration changes at the same time. Disk hot-reconfigure on ESXi only supports changes to the boot order as part of disk add or disk remove operations. Other changes made in the platform will not be implemented until the VM is powered off and reconfigured. Note that the platform will ignore Cloud-init ISO disks in the boot order.

To change the boot order:

  1. Go to Virtual datacenters → edit VM → Storage
  2. Click the pencil button beside the element number in the boot order
  3. Enter the number in the boot order where you want the disk to go and click ok.
  4. Repeat for other disks, as required 
  5. The platform will ensure that each disk has a unique number in the boot order and the boot order is contiguous (without gaps between disk numbers).
  6. Click Save to reconfigure the VM with the new order
 Click here to show/hide the screenshot

Change the order of the disks in the boot sequence

 The platform will change the boot order.

Modify VM Volumes

After you add a volume of external storage to a VM, save the VM before you modify the volume.

To modify a VM volume:

  1. Go to Virtual datacenters → edit VM → Storage
  2. Select the attached volume and click the pencil edit button
  3. Modify the controller type and controller as required

AttributeDescription
Controller type

Select from SCSI or IDE on all hypervisors. Also VIRTIO on KVM.

Controller

ESXi only. The user can enter one of the controllers supported by their platform, which may include:

  • "paravirtual" - ParaVirtualSCSIController
  • "bus" - VirtualBusLogicController
  • "sas" - VirtualLsiLogicSASController
  • "lsilogic" - VirtualLsiLogicController

To make other changes to a volume (e.g. resize), go to the Virtual datacenters view on the Volumes tab. See Manage Persistent Storage and VMs#Managepersistentvolumes

Modify VM Hard Disks

You can edit hard disks, for example, to change the name and resize them, including in an existing deployed VM on demand.

To edit a hard disk

  1. Go to Virtual datacenters → edit VM → Storage
  2. Select the hard disk and click the pencil edit button at the top right of the Storage popup

    For ESXi, you can modify disks as permitted by ESXi functionality. See VMware knowledge base article. You can only modify iSCSI disks on SCSI controllers with thin provisioning. And the VM cannot have VMware snapshots. If you cannot modify a hard drive as expected, please contact your System Administrator.

    For SCSI disks, you cannot modify disk size and position at the same time

    Field

    Description

    Size

    You can increase the size of the hard disk

    • Expanding a disk can damage the data or operating system installed on the disk. You may need to apply additional operating system tools or processes before you can use an expanded disk
    • Remember that if you resize a system disk and then undeploy the VM or create an instance, when you deploy again the platform will copy the hard disk and/or its size from the template, which may change the size
    Datastore tierOptional. Storage service level
    Allocation type

    You cannot modify the Allocation type after the VM has been deployed

    Controller type

    The controller type of disk

     

    Controller

    Optional. On supported hypervisors (ESXi), to force the creation of a new controller of the same type as an existing one, assign a new bus value. Access ESXi to confirm bus values.

    Bus

    Optional. Select an existing an existing bus number or to create a new controller, specify a new bus number. The user requests a bus number but the platform will use the bus number assigned by ESXi. When there is more than one controller, to identify the controller and bus number, the platform displays the bus number as a suffix to the controller. Access ESXi to confirm bus numbers that are not displayed

    Name

    The name of the hard disk

  3. Click Save on the Edit virtual disk size popup
  4. Click Save on the Edit VM dialog to reconfigure the VM


Configure VM Backups

The platform uses backup systems, such as Veeam or Avamar, and it creates backups for VMs that are deployed on the hypervisor.

When you configure a backup for your VM, the platform will display the backup symbol in the lower right-hand corner of the VM icon. 

Virtual machine icon with backup symbol because a backup is configured

In some environments the backup system may support restore for VMs that were previously deployed and are now undeployed. If you delete the VM, you cannot access the backup system through the platform. 

Create a manual backup now

To request a manual backup of a VM now:
  1. Go to Virtual datacenters → edit VM → Backup
  2. In the top right-hand corner of the Backup tab, click the Backup now button
    Backup now button to request an immediate backup

The platform will request an immediate backup of the VM.

Configure a VM backup

To configure your VM backup by selecting the backup policy and the disks, do these steps:

Privilege: Manage virtual machine backup disks, Manage virtual machine backup configuration

  1. Open the Backup tab to the Backup policies page
  2. Select from the list of backup policies
  3. Click Show details

Select a backup policy to assign to a VM

Select disks

 To select disks for a complete backup, do these steps:

Privilege: Manage virtual machine backup configuration, Manage virtual machine backup disks

Some backup systems will ignore your disk selection and create a backup of all disks. Check your cloud provider's documentation for more information


  1. Click Select Disks
  2. Select the disks for backup 
    1. The disks are shown in sequence order
    2. The system disk is the first one in the list
    Select disks for backup


Configure backup schedule

The administrator can set the date and time in the backup policy or they can require the user to set the date and time.

Privilege: Manage virtual machine backup configuration, Manage virtual machine backup schedule

To enter backup date(s) and time(s), you must have the privilege to Manage virtual machine backup schedule, and you must configure the exact date and time of a backup.

Backup Times

Abiquo uses ISO 8601 and datacenter owners should inform users of the time standard used in the datacenter

Time zones in ISO 8601 are represented as local time (with the location unspecified), as UTC, or as an offset from UTC

Screenshot: The administrator has configured backup schedule

The backup schedule was configured by the administrator and the user cannot select it

Screenshot: The user must configure the backup schedule

The administrator requires that the user configures the backup schedule

 

Backup results

To display backup results:
  1. Go to Virtual datacenters → edit VM → Backup → Backup results

The results shown may vary depending on your datacenter's backup system. Backups with a status of "done" or "completed" will have a Restore link enabled in the Action column. 

VM backup results page of the Backup tab

Restore a Backup

The administrator may allow users to restore their own backups.

Privilege: Restore virtual machine backups

To restore a VM backup:

  1. Go to Virtual datacenters → edit VM → Backups → Backup results
  2. In the Latest backups section, in the Action column on the right-hand side, click a Restore link

    Restore a completed backup by clicking on the restore link

To display the details of the restore, click on the backup in the Backups list. After the restore is completed, the status is displayed, for example, "done" or "failed".

After you restore a backup, the VM disks are under the control of the backup system, not the platform. So when you undeploy after restoring a VM, the platform will display a warning popup and delete and remove the VM's disks.

If your environment allows, you may request that a backup be restored more than once. If the Restore requests Status is success or failed, Abiquo will reactivate the Restore link and you can click the Restore link to request a new restore of the same backup.

Backup events

For users the backup feature will produce the events described in the Events View#Virtualmachine under METADATA_MODIFIED and RESTORE_BACKUP.

To display VM backup events:

  1. Go to Virtual datacenters → edit VM → Backup → Events

This page will display events from backup integrations. 

The platform displays backup events on the Events page of the Backup tab

To view the details of an event, click on the event.

Click on a backup event to display details of the event

Configure Bootstrap Scripts

Before you begin:
  1. Create your VM with a template that is compatible with cloud-init version 0.7.9 or above, or cloudbase-init
  2. In private cloud, check that there are fewer than four IDE disks attached to the VM before you begin, so Abiquo can create an ISO disk for Configuration drive

To add a VM bootstrap configuration or script in public cloud:

  1. Go to create or edit VM → Bootstrap script
  2. Paste your configuration or script in the text box
  3. Continue to configure the VM or click Save to finish

Assign Firewalls

If your provider offers firewall policies, first create them in your virtual datacenters, then assign firewall policies to your VMs.

Privilege: Assign firewall

To assign a firewall from the virtual datacenter to a VM:

  1. Go to Virtual datacenters → edit VM → Firewalls
  2. Mark the required firewall policy with a tick in the Firewall policies checklist
  3. Click Save or continue editing the VM as required


Edit VM to assign firewall policies

Troubleshooting:

  • If you cannot assign more firewall policies, check your cloud provider's limit. For example, for AWS, see http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html#VPCSecurityGroups
  • If your provider's default firewall policy does not display, you may need to synchronize your virtual datacenter or firewall policies before you continue
  • If an expected firewall policy does not display, for example, a firewall policy that you recently created, you may need to wait for the firewall policy to propagate through the provider's API because of eventual consistency
  • You can remove the default firewall when editing a VM. However, if the provider requires a firewall and you do not supply another one, the platform will assign the default firewall again.

Configure Chef

Chef is an infrastructure automation product that uses configuration recipes. You can use Abiquo Chef Integration to deploy a virtual machine that will then configure itself using Chef recipes and roles. In datacenters, the Abiquo Chef integration works with Cloud-init or Cloud-base-init, so you will need compatible templates. In AWS, it uses

Configure Chef Recipes and Roles

The Chef tab is enabled if the enterprise is Chef-enabled and the VM template is marked for Cloud-init support. Before you deploy the VM, you can select from the available roles and recipes. By default, you can select roles. Mark the "Select individual components" checkbox to select individual recipes too. The platform will add your selection to the Virtual Appliance's runlist in order of selection. When you deploy the VM, it will download the roles and recipes, and run them in order.

Edit VM to add Chef recipes and roles to automate configuration

To change the order of the runlist, click on the pencil button beside a role or recipe, then edit the order number, then click OK.

Change the order of recipes in a Chef runlist

If you change the runlist after deploy, Abiquo will update the Chef server, and your Chef-client recipe can obtain these changes from the Chef server.

Related links:

Configure Chef Attributes

The Abiquo Chef integration now supports Chef attributes, which are passed to Chef for your recipes. You can find lists of attributes in the Chef recipe configuration files. See https://docs.chef.io/nodes.html  
  1. Edit the virtual machine and  open the Chef tab at the Attributes page.
  2. Enter the parameters for each recipe in JSON format. 
    • The Chef attributes must be enclosed in "{ }". You must enter a valid JSON document and Abiquo will validate it.
    • Abiquo does not validate the attributes, so check them carefully.
  3. Click Save, which will save the entire virtual machine configuration

Add attributes for the Chef recipes that will run on your VM

Assign Load Balancers


Privilege: Assign load balancers

To assign a virtual machine to a load balancer, select the load balancer from the list.

Edit VM to assign a load balancer

Configure Metrics

The platform may automatically enable metrics for all VMs. If you have the privilege to Manage virtual machine monitoring and it is configured in your virtual datacenter, you can enable the option to fetch built-in metrics from the hypervisor or public cloud region, as well as any custom metrics defined for your VM.
Enable Monitoring and Metrics

To enable VM monitoring and metrics:

  1. Go to Virtual datacenters → edit VM → Monitoring
    Edit VM to retrieve metrics and select metrics to display
  2. Select the fetch metrics checkbox. This will retrieve all metrics while the VM is deployed
  3. Select from the available options, for example, for AWS offers detailed or basic monitoring.
  4. Select the individual metrics you would like to display for your VM. The functionality and list of available metrics depend on the underlying virtualization technology and the platform configuration. The platform will always retrieve all metrics, so you can change the metrics to display at any time. And you can use any metric for alarms and alerts, even you do not display it. You may need to wait a short time for the first metrics to load.
Display Metrics for a VM

To display and filter metrics for a VM:
  1. Go to Virtual datacenters → select VM → click the Monitoring symbol
    Click monitoring symbol on VM icon to display VM metrics
  2. The metrics panel will open and you can dynamically filter and select which metrics to display. 

VM metrics panel with selection list of metrics to display

To update the display of a metric, select the refresh button 

Filter metric display and configure frequency and dimensions

To configure the display of the metric

  1. Select the filter button 
  2. Set the following as required
    1. Granularity, which is how often the metric is sampled
    2. Statistic, which determines how the raw values will be processed over time
    3. "Last" period, which is how long the display will look behind at the processed data
    4. Metric dimensions: for metrics with more than one possible element being monitored, for example, multiple hard disks, you can display metric dimensions, which are metrics for separate elements.
      1. To view metric dimensions, click Get dimensions. Select a dimension.
      2. If no dimension is selected, the default value is the average of all dimensions
  3. Click Accept to save the values.

To view the exact metric values in a call-out box, mouse over the monitoring graph line.

To create a highlight point, click on the metric graph line.

Create a highlight point on a metric graph

To simultaneously view the data for more than one VM, use the virtual appliance monitoring view.

Configure Variables

Add VM variables

Before you deploy a VM, you can set guest variables to pass user data to your VMs. This functionality uses cloud-init and requires appropriate templates. In private cloud, the templates must have the guest setup flag set to cloud init. The administrator can add default variables for the VM template.

This functionality is available through the API. The platform stores variables in the VirtualMachine "variables" attribute, which is a dictionary of keys and values. See Update a virtual machine in VirtualMachinesResource

To add VM variables:

  1. Go to Virtual datacenters → edit VM that is not deployed → Variables

  2. Enter each variable and click Add

    Edit the VM to set variables that will be added to the VM at deploy time

    Field

    Description

    Key

    Identifier of the variable. Maximum length of 255 characters

    ValueValue of the variable. Maximum length of 255 characters

  3. To apply changes to variables, and other changes to the VM, click Save


Edit variable values

To edit a variable:

  1. Click the pencil edit button next to the value
  2. Click ok
  3. To apply changes to variables, and other changes to the VM, click Save
Delete variables

To delete a variable:

  1. Click the X in the left column beside the variable name.
  2. To apply changes to variables, and other changes to the VM, click Save
Read Guest Variables

The variable location will depend on the method of guest setup that you are using for your VM.

Private cloud:

When using cloud-init, the variables are stored on the cloud-init ISO, which has the label "config-2". The variables file is "openstack/latest/vm-variables.rc"

When using hypervisor tools, you should use the appropriate method for your hypervisor, for example:

  • ESXi:
    • Run the following command in the guest to get the value of a variable:

      vmtoolsd --cmd "info-get guestinfo.abiquo.<variable-name>"

Public cloud:

The variables are stored in the /opt/abiquo-env.rc file


Related pages


  • No labels