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 5.0

Skip to end of metadata
Go to start of metadata

The Cloud tenant admin guide describes the main administrative tasks of the enterprise administrator.

  • Manage your users
  • Manage templates
  • Manage virtual datacenters
  • Manage VM workflows
  • Manage VM backups
  • Administer VMs

For details of how to work with virtual appliances and VMs, see the Cloud tenant user guide.

For details of how to work with networks, firewalls, and load balancers, see the Cloud tenant network guide.


1. Configure your user account

1.1. Edit your user account details

After you log in, you may need to edit your user account to update your details:
  1. Click the User icon in the lower left-hand corner of the screen
  2. From the menu, select Edit user
  3. Change your Password
  4. To receive VM passwords, login authentication codes, and email notifications, enter your E-mail address and Phone number

  5. Go to Advanced and add your Public key for remote access to VMs

If you are using a single sign on, you may need to ask your system administrator to update your details

1.2. Enable two-factor authentication

Your platform may offer or require two-factor authentication (2fa) to improve user login security with an additional authentication code. For platform configuration instructions, see Configure two factor authentication.

Before you begin:

  • To use Google Authenticator to obtain the codes, install the Google Authenticator app on your cell phone. 
  • To use email authentication to obtain the codes, check that you have a valid email address in your user account on the platform.

To enable two-factor authentication for your user account, do these steps:

  1. Click on the user initials or user icon in the lower left corner of the screen, and from the menu, select Two-factor authentication.
  2. Select the authentication method and click Enable
  3. Copy the Backup codes from the configuration window to a secure place. You can use these codes to log in to the platform if the authentication cycle fails

    The platform will display Backup codes ONCE only

  4. Authenticate according to your selected method
    • For Google Authenticator, use the Google Authenticator app on your cell phone to scan the QR code. Google will supply a verification code in the app. During login, the platform will request the Authentication code from the app. 
    • For email, during login, every time you enter your user name and password to log in, a code will be sent to the E-mail address registered in your user account. Enter the Authentication code in the Login dialog
 Click here to show/hide the screenshots

Enabling two factor authentication

Two factor authentication with Google Authenticator with backup codes and QR code

Login with two-factor authentication

2. Manage templates

You can use VM templates to create VMs.

To display VM templates

  1. Select Private or Public
  2. Select a Datacenter or Public cloud region from the list
    • If you do not see the expected templates, you may need to click the double round-arrow Refresh button or contact your system administrator
  3. Optionally select a template Category
  4. Optionally select icon or list view

On the right, the platform will display all the templates available for the selected datacenter or public cloud region

Privilege: Manage VM templates from Apps library

Icon view

In Icon view, to activate the VM template operations menu, select a VM template. This menu will vary, depending on the context.

Screenshot: Options menu of VM template

Screenshot: VM instance template, created from VM disks

In list view, to display the VM Template operations buttons, select a VM template


2.1. Upload Templates from the Local Filesystem

To make new VM templates available in the platform, add them to your Apps library (also called the Appliance library). 

In private cloud you can upload VM templates from a local filesystem in OVA format (multiple disks) or as a single disk. 

Privilege: Upload virtual machine template


Before you begin:

  • For very large files, it may be convenient to use another method of adding templates
  • If you do not have any hypervisors, the platform will convert the template into ALL possible hypervisor formats. So before you add templates to your Apps library, check that there is one physical machine of each hypervisor type that you will require conversions for, in order to reduce unnecessary use of the NFS repository space. See V2V Conversion.


FormatNotes
OVAThe platform reads OVA files such as those created with VMware. The file name must end in the extension ".ova". You can upload a multi-disk template for a single VM. The OVA file must contain an OVF description file for the template. The platform uses the Name tag in the VirtualSystem as the template name. If the Name is not set, the platform falls back to the ID. See OVF Reference.  
Local file

Check for a compatible format of the template disk. You will need to enter number of CPUs, RAM, and the Capacity, which is the deployed size of the VM hard disk. See Determine the size of a VM Disk File.

ISO fileYou will need to enter the number of CPUs and RAM for the VM. You can also specify the size of an empty disk that the platform will create, for example, to install software


To add a new template:

  1. Go to Apps library
  2. Select the datacenter and click the add button
  3. Select one of the upload or download options and enter the appropriate data

2.2. Upload an OVA file

To upload an OVA file: 

  1. Select Create from OVA file, and select the file.
  2. Abiquo will display the File name. Click Save. Abiquo will upload the file and create the template.
  3. When the template has been uploaded, Abiquo will open the Edit template dialog. Check the template details and click Save.

 Click here to expand...


2.3. Upload from local or ISO file

Complete this form to create a new VM template in the appliance library.


Field

Value

Name

A short name to identify the VM template.

Description

A description of the services and applications installed on the VM template

Category

A logical group for organizing the templates. There is a default category ('Other') that cannot be deleted. See Manage VM Templates#OrganizeVMtemplatesintocategories.

CPU

Number of CPUs to assign to this template. It is important to enter a correct value, or a sensible best-guess value because you can edit the template later

RAM

RAM assigned for this template in MB, GB, or TB. It is important to enter a correct value, or a sensible best-guess value because you can edit the template later

Cores per socketMust be a divsor of CPUs

Icon

Enter the URL for the template's icon in PNG, JPG or GIF format. It must be a complete URL with an IP address that is not localhost or 127.0.0.1. It may be a URL on the platform server. Recommendation: use square images with a size of 128x128 pixels. A transparent background looks nice. If the template is shared, the same icon will display for all users.

2.3.1. Disk from local file

When you upload a disk you can enter these disk options.


Field

Value

Type

The disk type of the template. You must enter the correct type (not Unknown) to be able to use the template in the platform. See Disk Format Information. The V2V conversion process will generate the different conversions for each hypervisor installed or for all hypervisors if you have not added any hypervisors yet.

Capacity

The hard disk size required for the deployed disk in MB, GB, or TB. It is important to enter a correct value. See Determine the size of a VM Disk File. This is a required field.

File nameClick Select file and use your browser to choose the file to upload.
Require datastore tierSelect Datastore tier will be required when creating a virtual machine to ensure that the user will select a datastore tier
Controller typeDepending on the hypervisor, the platform supports IDE, SCSI, and on KVM, it also supports VIRTIO.
ControllerOn ESXi you can enter a SCSI controller type. The default value is the lsilogic controller.
NameDisk name in the platform
BootableSelect this checkbox to indicate that this is a system disk that can be used to boot the VM

Capacity of the Hard Disk

The Capacity is the deployed size of the hard disk. It is used to create the disk when you deploy your VM. With an incorrect value, your deploy may fail with a message such as "is not a virtual disk". For fixed formats, the capacity is the same as the physical size of the template disk, and for sparse formats and compressed formats, such as stream-optimized, it is the provisioning size.

2.3.2. Disk from ISO file

  

Field

Value

Type

ISO

File name

Click Select file and use your browser to choose the file to upload

Datastore tier will be required while creating a virtual machineOptionally select this checkbox to require the user to select a datastore tier. To create a VM, the user will require the privilege to Manage virtual machine hard disks
NameFriendly name of the disk in the platform
BootableSelect this checkbox to indicate that this is a system disk that can be used to boot the VM
Add an extra empty diskIf you enter a disk size, the platform will create this hard disk and use it to install the ISO

2.3.3. Disks tab

The disk you upload is saved as disk 0 in the boot sequence. Abiquo will send this disk to the hypervisor as the boot disk. If your disk is not a bootable system disk, then move the disk to a different position in the boot sequence when you add a bootable system disk.

You can edit the uploaded disk but you cannot delete it before you save the template.

You cannot resize the primary disk before you deploy the VM.


2.3.4. Variables tab

To add variables to a VM template, enter the Key and Value, then click Add

To edit an existing value, click the pencil icon, enter the new Value, then click ok. To save your changes to the template, click Save.

The variables will be added automatically to new VMs. Users can edit the variables when configuring the VM.

2.3.5. Advanced tab

Field

Value

Operating System

For VMware, select a value to set the VMware guest operating system type for the platform. See Extended OVF Support and Template Definition for further details.

OS version

For VMware, enter an OS version, which can be an OS not included in the above list of codes. If you do not enter a value, the latest version supported by the hypervisor is used.

See Extended OVF Support and Template Definition for further details. 

User

Default user for a VM created from this template to access a deployed machine using SSH.

Password

Default password for a VM created from this template

NIC driver

The platform always supports E1000 drivers. On ESXi and vCloud, Abiquo also supports PCNet32 and VMXNET3. On KVM, Abiquo also supports VIRTIO drivers

Click Save to upload the template file. 

After you save the template, you can edit the template and add more disks, edit, reorder and delete disks. You can also add a cost code.

2.4. Create from remote template repository

In private cloud, to create VM templates from a remote repository, do these steps:

Privilege: Download template from remote repository

  1. Select a Repository → select a Category or All categories. 
    The Packages pane will display the available template definitions with an icon, title and brief description
  2. Optionally, click on Show disks
  3. For each VM template to download, select the checkbox next to the template definition
  4. To start the download, click the Download button at the top of the dialog
    1. The platform will check that this template download will not exceed the repository limits for your enterprise or your enterprise in the datacenter.
    2. A status bar will appear next to the selected packages showing the download state.

If a template belongs to a Category in the remote template repository but the Category does not exist in the Apps library, the platform will create it for the download.

 Click here to show/hide the screenshot

Screenshot: Create template from remote template repository

You can now work with the new VM template.

2.5. Add public cloud templates to the Apps library


To import a template from a public cloud region into the platform's template cache, do the following steps:

  1. Go to Apps library → Public → select the public cloud region
  2. Then click the Import template button at the bottom of the screen
  3. The Import template popup will open

  4. Enter the search criteria for your template.

    1. This can be an ID, such as an AMI ID, text from the Name 
    2. Private images are the ones that are only available to your user account in the public cloud provider. In vCloud Director this option displays templates in the same organization

    Then click Search to perform the search. The search can take some time and return several pages of templates.

  5. To import a template, click the import symbol in the top right-hand corner of the template. When a template has been imported, the color of the import symbol will change to gray.

  6. When you have finished importing templates click Close


2.6. Modify VM templates

Before you begin:
  1. Log in or switch enterprises to the tenant that owns the template

To modify a VM template:

  1. Select the template and click on the control menu button in the top-right corner and select Edit

Privilege: Manage VM templates from Apps library

In private cloud datacenters, standard templates have disks that will deploy to the hypervisor datastore, in contrast to persistent templates that have disks on external storage volumes. This documentation describes standard templates.

2.7. Edit template

2.7.1. Basic template details


Field

Value

Name

A short name to identify the VM template. This will be the default name of a VM created from this template.

Description

A description of the services and applications installed on the VM template

Category

Logical grouping of VM templates to enable you to organize them

Icon

Enter the URL for the template's icon. This must be a URL with a public IP address, not localhost or 127.0.0.1. It may contain the IP address of the API server.

If you do not assign an icon, the platform will assign a default icon. Square icon images with a size of 128x128 pixels and a transparent background look best. The compatible image formats are PNG, JPG, and GIF.

If an administrator shares the template with other tenants, then all users will see this icon. If you change the icon of a template with instances, when you create the next instance, it will have the new icon

2.7.2. CPU and RAM values

When you are not using hardware profiles, you can set values for template CPU and RAM as follows

Field

Value

CPU

When you create a VM from the template, it will have this template CPU value

RAM

When you create a VM from the template, it will have this RAM memory size

RAM unitsMB or GB

Min CPU and
Min RAM

In private cloud, the minimum value of CPU or RAM. If 0 or empty, then there is no constraint. You cannot set a minimum below the current template value. Changes apply to new VMs, not existing VMs

Max CPU and
Max RAM 

In private cloud, maximum value of CPU or RAM. If 0 or empty, then there is no constraint. Changes apply to new VMs, not existing VMs

Cores per socketThe number of cores per socket. The number of CPUs must be divisible by the number of cores per socket. The maximum value is 32

Troubleshooting minimum and maximum CPU and RAM values

  • The platform stores 0 as an empty value, so if you enter "0", it will disappear!
  • If users edit existing VMs that already had out-of-range values, the platform displays a warning but does not enforce the range.
  • Changes can affect recommended hardware profiles on the Advanced tab, so you may need to review them
  • Users with the Override VM constraints privilege can enter values outside this range
 

2.7.3. Modify VM template disks

  • In private cloud, when the datastore tier is mandatory for template disks, the platform marks the disks with a star symbol
  • To download a template disk, click the down arrow download button

2.7.4. Share VM templates

To share a template with the enterprises in one or more scopes, select template scopes.

To remove enterprise access to a template, remove the scope containing the enterprise. 

  • You cannot remove a scope from the template if an enterprise in the scope is using the template, for example, if it has deployed VMs or instances of VMs. 

To make a template private to the owner enterprise, unselect all scopes. 


2.7.5. Recommend VM template configurations

Field

Value

Enable only recommended HPsSelect this checkbox to allow the user to select from recommended hardware profiles only.
Hardware profiles - RecommendedTo recommend a hardware profile for this template, mark the checkbox beside the hardware profile name. The platform will display these profiles in the selection list with "(Recommended)" beside them. Remember that the administrator must allow the user's tenant to access the hardware profiles.
Enable only recommended DS TiersIn private cloud, select this checkbox to allow the user to select from recommended datastore tiers only.
Datastore tiers - RecommendedTo recommend a datastore tier for this template, select the checkbox beside the datastore tier name. The platform will display the these tiers in the selection list with "(Recommended)" beside them. Remember that the administrator must allow the user's tenant to access the datastore tiers.

2.7.6. Advanced VM template configuration

 

FieldValue
Guest setupCloud-init or Hypervisor tools (private cloud only, requires installation of guest tools).
All public cloud templates will work with cloud-init, even if this option is not marked. See Abiquo Chef Integration Guide
Guest initial passwordCreate a root or administrator password and send it by email or SMS
Cost code

Pricing cost code for this template. Requires the privilege to Add a cost code when editing a VM template.

Operating systemSets the VMware guest operating system type. Select from the pull-down list.
See Guest operating system definition for VMware vSphere 5 and 6 and Extended OVF Support and Template Definition for further details.
OS VersionOS version is used to:
  • add operating systems not included in the list of codes
  • provide details of operating systems
  • set the VMware guest operating system type
See Guest operating system definition for VMware vSphere 5 and 6 and Extended OVF Support and Template Definition for further details. 
UserDefault user for a VM created from this template for SSH access. Enter a valid user name for this template. Users should change their password immediately after first login.
PasswordDefault password for the default User of a VM created from this template. Enter a valid user password. Users should change their password immediately after first login.
NIC driverPrivate cloud only
Enable hot/add reconfigure in VMRequires hypervisor or provider support. On ESXi, with remote access hot reconfigure you cannot reset the guest password
Creation userIn AWS this is the user identifier. Read only value
Creation dateRead only value

3. Manage virtual datacenters

3.1. Introduction to virtual datacenters

In the Virtual datacenters view you can manage your compute, network and storage resources. Each virtual datacenter (VDC) is a separate cloud environment in a single datacenter or public cloud region. To access Virtual datacenters view, click the cloud virtual datacenters button


3.2. Create virtual datacenters

To create a new virtual datacenter:
  1. Go to Virtual datacenters
  2. Above the V. datacenters list, click the + add button
  3. Select Create a new virtual datacenter from the pull-down menu
  4. Complete the dialog as described below
  5. Click Save

3.2.1. General information

This section describes the basic details to enter when creating a virtual datacenter. The following sections describe further configuration.


Field

Description

Name

The name of the virtual datacenter

Location

The datacenter or public cloud region where virtual appliances will be deployed. You can select any of your allowed locations

Hypervisor

The type of the hypervisor for the virtual datacenter. This option will not display if there is only one choice.

Network

  • Default: Create a VLAN (default private or external) in the pre-configured range
  • Custom Private: Create a custom private VLAN (see form below)

If your environment supports NAT you may also be able to select the IP address for the default SNAT rule

Field

Description

NAT networkOptionally select the NAT network to use for the default SNAT rule
Default NAT IPOptionally select the NAT IP address for the default SNAT rule for the virtual datacenter




3.3. Create a virtual datacenter with custom networks

When you create a virtual datacenter, the platform always creates a private network and it counts as part of your VLAN allocation limits, even if the default network is another type of network.

The private network can be the "Automatically-created private VLAN", which is called "default_private_network", or a custom private network, which will be set as the default network.

To create a Custom private network, complete the Network section of this dialog.

 Click here to show/hide the screenshot

Field

Description

Network name

The name of the VLAN to create

NetmaskThe network mask

Network address

The network address

Gateway

The IP of the gateway of the VLAN

Availability zonePublic cloud - AWS: The availability zone where VMs attached to this network will deploy.

Primary DNS

The primary DNS of the network

Secondary DNS

The secondary DNS of the VLAN

DNS suffix

The DNS suffix for the VLAN

Static routesMark the checkbox to define static routes

To manage the VLANs or other networks of your virtual datacenter, go to Virtual datacentersNetwork. See Manage Networks.




3.4. Manage resource allocation limits for a virtual datacenter

  • Hard limit is the maximum amount of a virtual resource (e.g. RAM) that an entity will be allowed to consume. 
  • Soft limit warns users and administrators that the entity is running out of a resource.

The rules for creating allocation limits are as follows:

  • You cannot have a hard limit only
  • Soft limits must always be less than or equal to hard limits
  • When a limit is equal to 0, it means that there is no limit to resource usage at this level
  • When editing limits, you cannot set the hard limits below the existing resource usage.

 

LimitChecked atDescription

Memory

Deployment

Total amount of RAM that may be used by VMs including hardware profiles assigned to VMs

Virtual CPUs

Deployment

Total number of virtual CPU cores that may be used by VMs including hardware profiles assigned to VMs

Local hard disk

Deployment

Total size of hard disk that may be used by VMs on hypervisor datastores and in public cloud providers

External storage

Configuration

Total size of external storage that may be created for VMs

VLANs

Configuration

Total number of private VLANs that may be defined. Note that a private VLAN is automatically created for every VDC, so this limit may restrict the number of VDCs that users can create

Public /floating/NAT IPs

Configuration

Total number of public IPs, floating IPs (in public cloud), and NAT IPs that may be used

Virtual machinesDeploymentTotal number of VMs that users can deploy in the location using their allowed resources

In public cloud regions, the platform does not use Repository (Apps library storage) features or limits. 


 Click here to show/hide allocation limit message details

Consider a virtual datacenter with a soft limit of 1 virtual CPU and a hard limit of 4 virtual CPUs.
  • The user will exceed the soft limit if they deploy a virtual appliance with more than 1 CPU in the virtual datacenter.
  • The user will exceed the hard limit if they attempt to deploy a virtual appliance with more than 4 CPUs in the virtual datacenter.

3.4.1. Soft limits message

A soft-limits message popup will allow the user to to acknowledge the message and continue with the operation.

By default, the message will provide details of the limits, used, and requested resources.

For example, the limits are 5 CPUs, the users have 2 CPUs in deployed VMs, and they have requested 3 more CPUs.

The platform will also display this type of message when the users exceed soft limits at another level, for example, enterprise, enterprise in provider, or enterprise in location.

3.4.2. Hard limits message

A hard-limits message pop-up will allow the user to acknowledge the message and terminate the operation.

By default, the message will provide details of the limits, used, and requested resources.

For example, the limits are 5 CPUs, the users have 5 CPUs in deployed VMs, and they have requested 1 more CPU. Because the user will exceed the hard limit, the platform will not allow the user to obtain 1 CPU.

The platform will also display this type of message when the users exceed soft limits at another level, for example, enterprise, enterprise in provider, or enterprise in location.




3.5. Set virtual datacenter defaults

Field

Description

Default datastore tier

Select the default disk service level for your non-persistent virtual machine disks on the hypervisor. This is the default datastore tier for the virtual datacenter.

  • To use your cloud provider's default tier, select "Configured by location"
  • Or select a default tier, according to the available service levels

To clear the current tier, click the black x symbol beside the tier name




3.6. Limit user access to the virtual datacenter

If you are able to manage user roles, you can limit user access to the virtual datacenter for users that are subject to VDC restriction, for example, to give users read-only access.

Privilege: Manage roles, No VDC restriction


Field

Description

Role

To limit access to the VDC for cloud users, select a more restrictive role to replace user roles within this VDC. For example, to give users read only access, select the ENTERPRISE_VIEWER role

User exceptionsTo create exceptions to the VDC role, select a username and an exception role for the user and click Add. The exception will enable all privileges that are included in both the user's role and the exception role

After you have entered Allocation limits, Defaults, and Role, click Save.

The platform will create the virtual datacenter and the default private VLAN and display it in the Virtual datacenters view. 


3.7. Create a virtual datacenter using the API

API Documentation

For the Abiquo API documentation of this feature, see Abiquo API Resources and the page for this resource VirtualDatacentersResource.

3.8. Create availability sets

You can use availability sets to ensure high availability for your VMs in Azure. Each VM in the availability set will deploy on separate, isolated hardware, in a cluster. This is similar to the platform's concept of anti-affinity layers in private cloud. To attach Azure VMs to a load balancer, you must add them to the same Availability set. All of the VMs in an Availability set must be in the same Azure Virtual Network, which means they must be in the same virtual datacenter. 

To create an availablity set:

  1. Go to Virtual datacenters
  2. select All virtual datacenters → select a location OR
    select an Azure virtual datacenter
  3. Go to Network → Availability sets
  4. Click the + add button
  5. Complete the dialog and click Save




Field

Value

Name

The name of the availability set. It must be unique in your location

Location

The platform will create the availability set in Azure at the level of the cloud location.

Virtual datacenterThe virtual datacenter where you will use the availability set

Fault domains

From Azure documentation: "VMs in the same fault domain share common storage as well as a common power source and network switch".

Update domains

From Azure documentation: "An update domain is a group of VMs and underlying physical hardware that can be rebooted at the same time."


For more information about Azure Availability sets, see Azure documentation, for example, https://docs.microsoft.com/en-us/azure/virtual-machines/windows/tutorial-availability-sets.

4. Manage users

4.1. Create a user

To create a user:
  1. If you manage users in multiple enterprises, optionally select an Enterprise where the platform will create the user. Otherwise, it will create the user in the enterprise that you are logged into
  2. Click the + Add button and complete the dialog

4.1.1. Enter general user details

Field

Description

Enterprise

The enterprise that the user will belong to.

Full Name

The user's first name and family name

Role

The Role of the user defining their set of privileges on the platform

ScopeThe Scope of a user defining the set of enterprise and datacenters that they can manage on the platform

Username

The username for login. After you create the user, you cannot change the username

Password

The user account password. Requirements are set by the options of Configuration → Security. See also Manually reset a user password

Repeat password

Re-enter the password

Email

The contact e-mail address of the user for platform messages, including password reset. The platform will display a Gravatar icon associated with this address on the Users's card

Phone numberThe phone number of the user. The platform will not validate this field.

4.1.2. Restrict a user to a set of virtual datacenters

 

By default, all users can access all virtual datacenters. This tab will not display if the user you are creating or editing has the No VDC restriction privilege.

Select one or more checkboxes to create a list of virtual datacenters to allow the user access.

If none are selected, the user can access all VDCs.

4.1.3. Enter advanced user details

Field

Description

Description

Optional description of the user account, maximum 100 characters

Public keySSH key for secure access to VMs. Add this key before you create your VMs
Allowed CIDRsTo restrict user access, enter the allowed network addresses in CIDR format. This network address will have priority inherited allowed CIDRs. Requires the Manage user allowed CIDRs privilege. By default users can access the platform from any IP address.
Inherited allowed CIDRsIf the user does not have allowed CIDRs, and the user's role and/or scope have CIDRs, then the platform will display the allowed CIDRs that apply to the user, which are inherited from the role and/or scope.
Reset password on next login

If this checkbox is selected, the user must reset their password the next time they log in.

Activated

If this checkbox is selected, the user account is active and the user can log in.



4.2. Suspend or enable a user account

If you need to stop a user from working with or logging in to the platform on a temporary basis, you can suspend the user account. 

To suspend a user account:

  1. Go to Users → Select user
  2. Click the edit button. The user dialog will open
  3. Go to Advanced, and unselect the Activated checkbox

The platform will suspend the account. When a user account is suspended, the platform will log the user out immediately. Be careful not to disable your own account! Fortunately, the main cloud administrator account cannot be disabled.

To enable the user account again, select the Activated checkbox.

If the user makes too many failed login attempts, the platform will automatically suspend their account for the account lock duration or until it is enabled by an administrator.




4.3. Manually reset a user password

If a user cannot automatically reset their password or if the user account is locked for too many password attempts, you can manually reset the password and unlock the account. 

To manually reset a user password:

  1. Open the Users view and select the user
  2. Click the Edit button at the top-right of the Users page. The user form will open.
  3. Enter the new password
  4. Recommended: go to Advanced and select the checkbox to Reset password on next login
  5. If the user account is locked and you wish to unlock it, go to Advanced, and select the Activated option
  6. Click Save. If the user is currently logged in, they will be automatically logged out when you save a new password,

The user password will be reset. Notify the user of their new password.



4.4. Manage users with the API

API Documentation

For the Abiquo API documentation of this feature, see Abiquo API Resources and the page for this resource UsersResource.



4.5. Display and filter users

To display the users in card view, select the card view tab from the view selectors in the top right-hand corner.

 Click here to show/hide the screenshot

Users in card view

To display groups of users, click on the pages to display the following:

  • All users on the All page
  • Active users on the Activated page
  • Suspended users on the Suspended page

4.5.1. User status

The user status is displayed either by a colored dot in the Activated column or in the colored tag on the user card:

  • Green for active accounts
  • Red for suspended accounts
    • Red with padlock symbol for accounts suspended automatically after too many failed login attempts 

4.5.2. Filter users

To filter users and display only those with a certain text in the user details:

  1. In the filter box on the right-hand side, enter a text string to search for which can include wildcards. For more details, see Search for VMs and filter the search




4.6. Delete a user

To delete a user:
  1. Select the user account and click the Delete button
  2. Confirm the delete

Abiquo will delete the user account but the user's VMs and other resources will remain on the cloud platform and users in the same enterprise with the appropriate permissions can work with them.

5. Onboard virtual datacenters

You can onboard virtual resources from public cloud into the platform. If the cloud provider supports virtual datacenter (VDC) entities, such as AWS VPCs or Azure virtual networks, you can onboard them as VDCs and synchronize them. If the cloud provider does not support VDCs, then you can onboard the resources from the public cloud regions, such as RackSpace and OpenStack regions. 


5.1. Onboard virtual datacenters from public cloud

To onboard a virtual datacenter from public cloud:

  1. Go to Virtual datacenters
  2. At the bottom of the V. Datacenters list, click the + add button
  3. Select Synchronize public cloud
  4. On the General information tab, select the region and the resources to onboard 

    FieldDescription
    LocationSelect the public cloud region to synchronize from the pull down list
    Virtual datacenterSelect the virtual datacenter entity to onboard. In AWS, this will be a VPC. In Azure, it will be a virtual network and its resources.

    If the provider does not support a virtual datacenter entity, the paltform will onboard all of the compatible virtual resources in the region into a default virtual datacenter.
    See classicClick here to display classic VMs that the platform does not onboard



5.2. View classic VMs

To display classic VMs in public cloud:

  1. Go to Virtual datacenters
  2. Click the + Add button and select Synchronize public cloud
  3. Select the public cloud region
  4. Click the See classic link



5.3. Synchronize VDCs and resources

To update a virtual datacenter and onboard any changes made in the provider, synchronize the virtual datacenter:
  1. Go to Virtual datacentersV. Datacenters list
  2. Beside the virtual datacenter name, click the round double arrow Refresh button

To synchronize specific resources such as networks, public IPs, and so on, go to the resource tab and click the double arrow Synchronize button. For more information, see the resource documentation.

 Click here to show/hide the screenshot

Screenshot: Synchronize networks



5.4. Manage resources that were deleted directly in the cloud provider

When administrators delete resources in the provider, the platform will display the resource name in light gray to indicate that the user cannot work with the resource. The resource types include:
  • External networks
  • Firewalls 
  • Classic firewalls 
  • Load balancers 
  • NAT network
  • NAT IPs

To delete these resources (if they are not in use), select the resource and click the delete button.

 Click here to show/hide the screenshot



5.5. Delete or release virtual resources in public cloud

The virtual resources that you onboarded or created in public cloud will be grouped with their associated virtual datacenters.

Before you begin:

  1. If you recently created virtual resources, such as load balancers, synchronize the virtual datacenter to ensure that the platform can find and delete all the dependencies of the virtual datacenter.

To delete onboarded resources in public cloud:

  1. Delete each virtual datacenter
    • You can choose to delete each virtual datacenter in the platform only, or in the platform and the provider. 
    • If you delete in the platform only, the platform will automatically remove VMs, virtual appliances, load balancers, public IPs, and firewalls from the virtual datacenter. The firewalls will remain in the enterprise and you can reuse them.
    • When you delete a virtual datacenter, public IPs that are not used by VMs will remain in the provider and the synchronization process will delete them
    • Remember to check which is the default VDC in your provider, e.g. AWS default VPC, because it may be inconvenient to delete this VPC


If the enterprise does not have valid credentials for the public cloud provider, when you delete public cloud entities in the platform, they will continue to exist in the public cloud provider



5.6. Onboard from public cloud using the API


Abiquo API Feature

This feature is available in the Abiquo API. See VirtualDatacentersResource for synchronization and AllowedLocationsResource for retrieval of virtual datacenters and VMs.



5.7. Onboard from public cloud regions without virtual datacenters

The platform onboards and synchronizes virtual resources in public cloud regions for providers that do not use virtual datacenters or similar entities, for example, OpenStack clouds and Rackspace. You can only synchronize these providers at the public cloud region level. You cannot synchronize a VDC or an individual resource, for example, a load balancer. 

If your public cloud provider does not support virtual datacenter entities, to onboard virtual resources do the following steps:

  1. Go to Virtual datacenters
  2. At the bottom of the V. Datacenters list, click the + add button
  3. Select Synchronize public cloud
  4. Select a public cloud region

The platform will place all VMs and network resources that are not related to existing virtual resources into a generic virtual datacenter. The platform names this virtual datacenter with the same name as the public cloud region, but the user can rename it. The platform will use this virtual datacenter for future synchronizations, adding or removing resources to match the cloud provider.

If there are already virtual resources in the platform for this provider, then these entities will already be part of a virtual datacenter. The platform will check if any new entities in the provider are related to the existing ones in the platform and place them in the existing virtual datacenter.

If the integration with the provider supports entities that are not in a virtual datacenter, such as firewalls, load balancers, or floating IPs, the platform may load these as separate entities.

If conflicts occur during synchronization, the platform will cancel the synchronization. This would occur if two VMs already exist in different VDCs but are related by a firewall or load balancer. Or if two firewall policies or load balancers exist in different virtual datacenters but are related by a VM.

6. Save configurations in virtual appliance specs

6.1. Introduction to virtual appliance specs

The virtual appliance specifications (VApp specs) feature enables administrators to save complex virtual appliance configurations and present them to users for simple, self-service deployment across their virtual datacenters. Specs are similar to blueprints because the platform uses them to define the configurations to recreate. Administrators select the locations where users can work with each spec, including datacenters and public cloud regions, such as AWS and Azure ARM.

With specs, you can save the configuration of virtual appliances including VMs, storage, networks, monitoring, Chef, firewalls, and load balancers. When users create a new virtual appliance based on a spec (also referred to as to "materialize" a spec), the platform will automatically use existing virtual resources or create new ones for this virtual appliance.

The limitations of specs are as follows:

  • Specs do not store data from VM disks; they use template disks only
  • Specs do not support external networks and NICs or unmanaged networks and NICs
    • In vCloud, specs have basic support for external networks
  • Specs do not support scaling groups

Users should also be aware of differences in features between private and public cloud environments.

Manage VApp specs in the user interface

Users work with spec blueprints in different parts of the UI.
  1. To create VApp specs, go to Virtual datacenters →  Virtual appliances
  2. From the Virtual appliance spec button, select Create new spec
  3. To create a version of a spec, log in to the owner enterprise (that created the spec). Then go to Virtual datacenters and open a virtual appliance created from the spec

  4. From the Virtual appliance spec button, select Create new spec version

     Click here to show or hide the screenshot

    Screenshot: create a spec or spec version

  5. To create a virtual appliance based on a spec, go to Virtual datacenters → V. Appliances list → select Create virtual appliance based on spec.

     Click here to show or hide the screenshot

    Screenshot: create a virtual appliance based on a spec

  6. To manage specs, go to the owner enterprise →  Apps library → Virtual appliance specs

     Click here to show or hide the screenshot

    Screenshot: Apps library specs tab

 

What do virtual appliance specs save and create?

When creating the new virtual appliance based on the spec, the platform will:

  • Try to use the same VM template or offer a selection of VM templates with similar names
  • Create:
    • VMs in layers
    • storage in appropriate matching tiers
      • template disks
      • empty volumes in the available storage device
      • empty hard disks
    • networks allowing the user to select from existing or replace:
      • private network
      • private IPs
      • public IPs (either tenant's pre-purchased or automatically purchased)
      • external IPs (basic support)
    • firewalls with available integration
    • load balancers with available integration

 

 Click here to show/hide table of what specs save and create

The following VM configuration elements are saved and created by virtual appliance specs. Support for elements is marked for datacenters (DC) and public cloud regions (PCR). When creating a virtual appliance from a spec, the platform will assign the spec icon to the virtual appliance.

ElementSave in SpecCreate in VApp from saved configuration

VMs

General information: hardware profiles, CPU, RAM, remote access and descriptionSame. If a matching hardware profile is not found, the platform will activate or create one, or the user can select another available hardware profile
Anti-affinity layersVMs in layersSame
Scaling groups(error) Scaling groups are not supported
VM templatesTemplate name is saved

The system matches the spec template name against the Apps library template name. The user selects from a list of templates with names that contain the spec template name. The match is done with an SQL %LIKE% command from the spec to the template, so spec template "m0n0" will match with "m0n0" and "m0n0wall" in the Apps library. But spec template "m0n0wall" will not match with "m0n0" in the Apps library

Template auxiliary hard disks

Template system disks and other datastore hard disks and their tiers are saved

The platform will create template disks in order as in the template with no gaps in the sequence. Then empty additional hard drives and volumes will be added in the same order as in the base virtual appliance. The platform will search for datastore tiers by name, as for templates

Persistent VMs(error) Persistent VMs are not supported. To create a spec from a persistent VM, first create an instance, which is a non-persistent template 
Private network, Private IPsSave private network characteristics: network address and mask only. Save private IPs

The materialize process will present the addresses of the spec private networks. Abiquo will display matching networks in the virtual datacenter in green text, and ones that are not present in red text. Abiquo will display the number of private IPs to use in each network.

The user can choose to change any private network, even if it matches the spec network. The user can choose to create a new network (specifying the IP address, mask and gateway), or replace the network with an existing VDC network.

Network gatewaysAbiquo will determine if a NIC has a gateway IP address and save this information in the spec
  • If a NIC has a gateway IP address, when using an existing network, the materialize process will attempt to assign the network's gateway address to the NIC
  • Abiquo will not assign the gateway IP address to a NIC that did not have this address in the original configuration
  • If the materialize process is creating a new network, it will attempt to assign the same gateway address from the spec to the gateway NIC in the new network
Public networkNumber of public IPs is saved

The materialize process will try to use public IPs that were already purchased by the enterprise. These public IPs will be momentarily quarantined during the materialization process. If not, the materialize process will purchase new public IPs. The public networks will be used in the order returned by the API. In public cloud, the platform will use floating IPs

External IPs(warning) Not supported, except for basic support in vCloud

If you create a spec containing an external IP, the materialize process will fail because the external IP is unsupported.

In vCloud, specs have basic support for external networks. The validation process will list the network, and you can select it and then continue with the process. The platform will create the VApp correctly. Remember to ensure that there are enough external IP addresses available for the new virtual appliance

Unmanaged IPs(error) Not supportedIf you create a spec containing an unmanaged IP, the materialize process will fail because the unmanaged IP is unsupported.
Volume (data)

(error) Data on external storage volumes is not included. To use data on a volume, create an instance to save it to a template disk

  • Empty volumes with the same specifications as the attached volumes are created. Empty volumes are named vappName-UUID
Volume (specifications)

(warning) The specifications, disk controller types, and tiers of the volumes are saved in private cloud

  • Empty volumes with the same specifications as the attached volumes are created. Empty volumes are named vappName-UUID
  • Volumes are attached to the same disk controller type as in the original VM. If this controller type is not compatible with the target hypervisor, then the platform will use the hypervisor default
  • Matches tier names as for VM templates. If no storage tier is found, then the validate will fail. If the storage tier does not contain pools, then the volume create will fail.
Hard disk (data)

(error) Data on hard disks attached to the VM is not included. To use data on a hard disk, create an instance to save it to the template

Empty hard disks with the same specifications as the attached hard disks are created. Empty disks are named Empty disk-UUID
Hard disk (specifications)

(warning) The specifications, disk controller types and tiers of the hard disks are saved in private cloud

  • Empty hard disks with the same specifications as the attached hard disks are created. Empty disks are named Empty disk-UUID
  • Hard disks are attached to the same disk controller type as in the original VM. If this controller type is not compatible with the target hypervisor, then the platform will use the hypervisor default
  • Matches tier names as for VM templates. If no datastore tier is found, then the validate will fail. If the datastore tier does not contain datastores, then the deploy will fail.
Backup configuration(minus) Configured backups are stored in private cloudBackups are configured
Firewalls

Firewalls attached to VMs or load balancers are saved

  • Access to a firewall integration is required to create firewalls in the new virtual appliance
  • Users can edit firewall rules during virtual appliance creation
  • Users should be aware of compatibility issues between providers
  • If a VM has no firewall in the spec, and the virtual datacenter has a default firewall, then the platform will assign the default firewall to the VM
Load balancersLoad balancers attached to VMs are saved, including health checks and so on
  • Access to a load balancer integration is required to create load balancers in the new virtual appliance
  • Users should be aware of compatibility issues between providers
Monitoring (status)
  • Monitoring status of fetch metrics is saved
  • The selected metrics are saved
  • Access to a monitoring server is required to retrieve metrics
  • The materialize process creates built-in metrics of the exact same name ONLY and creates all custom metrics
Alarms and Alerts

Alarms and alerts are saved 

The materialize process creates all existing alarms and alerts, regardless of the existence of their corresponding metrics

VM variablesVM variables are saved
  • The materialize process creates VMs with VM variables
  • During the materialize process, users can edit the VM variables
Chef

Chef status, runlist and attributes are stored

  • The materialize process sets the status and recipes
  • During the materialize process, users can edit the runlist and the attributes

6.2. Create a spec to save virtual appliance configuration

To create a virtual appliance spec to save a configuration:

Privileges: Manage virtual appliance specs

  1. Go to Virtual datacenters Open the virtual appliance
  2. Go to the virtual appliance options menu → select Create new spec
  3. Enter spec details
  4. Click Accept

The platform will create the new spec for your tenant. This spec will be the default, but an administrator can change or remove the default.

Field

Description

Name

The name of the virtual appliance spec

Description

Describe this spec and this version of the spec to distinguish it from other versions

IconEnter the URL of an icon that will identify the spec for users. Click Validate to check the icon will display correctly - a preview should display below the Icon field

When designing a virtual appliance for use in more than one location, please consider the following differences between private and public cloud:

  • Private cloud datacenters allow multiple disk templates and additional disks. In public cloud, the platform may support only a single disk or use all disks
  • Public networks in private cloud will be translated to floating IPs in public cloud and vice versa
  • A range of IP addresses may be reserved by an SDN system or the cloud provider
  • The number of NICs allowed or required per VM may vary
  • Firewall and load balancer configurations may differ

To save VM disks as templates, see Create instances to save VM disks to templates.

6.3. Manage virtual appliance specs in the Apps Library

Virtual appliance specifications (VApp specs) are saved configurations to help users easily create new virtual appliances.

To display Vapp specs

  1. Go to Apps library → Virtual appliance specs

The platform will display all the specs available in the platform.

Privilege: Manage virtual appliance specs

To display details of a VApp spec, hover over its icon.

To display the details of a VApp spec's Versions, click the options button on the icon and select Versions. The Manage spec versions dialog will open. Click on a Version to display its details.

Screenshot: Virtual appliance specs tab and Details panel


Edit a virtual appliance spec details

To modify a VApp spec, on its icon click from the options menu, and select Edit

Field

Value

Name

A short name to identify the VApp spec. This will be the default name of a VM created from this template.

Description

A description of the configuration of the virtual appliance spec

Icon

Enter the URL for the template's icon. This must be a URL with a public IP address, not localhost or 127.0.0.1. It may be the URL of the Abiquo Server. A default icon is assigned if the spec does not have one.  Abiquo recommends that you use square icon images with a size of 128x128 pixels. A transparent background also makes icons look better. The compatible image formats are PNG, JPG and GIF.

If the spec is shared with other enterprises, then all users will see the icon. Changing the icon of the original spec will not change the icon of virtual appliances you previously created from the spec

Share virtual appliance specs with other tenants

To share a VApp spec with multiple tenants, assign scopes to the spec. A scope is a list of enterprises whose users can access the spec.

Privilege: Allow user to switch enterprises

  1. When creating or editing a spec, open the Scopes tab
  2. Select scopes to allow access to users of the enterprises included in the scopes

When you have finished working with the spec, click Accept

Define the locations where users can work with a spec

To define where a spec can be used, select allowed locations. Users of enterprises that are allowed to access a location can work with the specs allowed in the location.

Privilege: Allow user to switch enterprises

To manage allowed locations:

  1. Go to Apps libraryVirtual appliance specs
  2. Select the spec, click the Options button, and select Edit
  3. Go to Locations → select locations
    1. If the spec should be available in all current and future locations, select Use all locations.
    2. To restrict the spec to a group of current locations:
      1. Clear the Use all locations checkbox
      2. Select the Locations where the spec will be available for use


Troubleshooting spec locations

  • If another user has already assigned locations that you cannot administer and access, then you can maintain or deselect these locations.
  • If you deselect locations that you cannot administer or acccess, you cannot add them again

When designing a virtual appliance for use in more than one location, please consider the following:

  • Support for multiple disks in the provider
  • Public networks in private cloud will be translated to floating IPs in public cloud and vice versa
  • A range of IP addresses may be reserved by an SDN system or cloud provider
  • The number of NICs allowed or required per VM may vary


 Click here to show/hide the screenshot

Define the version of a spec to use

The platform presents users with a single version of a virtual appliance spec. The administrator can configure this to be the default version or the latest version.

When you create a virtual appliance spec, the platform automatically sets this first version as the default version.

When you create another version you can choose to make this version the default.

 Click here to show/hide the screenshot

To change the default version of a spec:

  1. Go to Apps library → Virtual appliance specs
  2. Select the VApp spec icon, click the options button, and select Versions
  3. Click on the Version you want users to work with
  4. On the top, right-hand side of the dialog, click Mark as default version

To unset the default, so that users will always work with the latest version:

  1. Select the VApp spec version and click the pencil Edit button
  2. Clear the Default checkbox

To delete a version of a spec, select it and click the Delete button. If you delete the default version, then the platform will return the latest version to users.

Delete virtual appliance specs

You can delete spec versions or the entire spec. When you delete a virtual appliance spec, the platform will also delete all its versions, even shared versions. When you delete an enterprise, the platform will delete all its specs, even shared specs and shared versions.

7. Manage workflow tasks

7.1. Display VM workflow tasks

When workflow is enabled, the user's requests to deploy, reconfigure and undeploy VMs will be held with the status waiting to be reviewed. 

This can include actions on scaling groups, unless the administrator selects the option to disable workflow in the scaling group. 

To view the list of workflow tasks

  1. Go to Virtual datacenters → Workflow tasks.

To filter workflow tasks, enter text in the filter box at the top of the tasks list.


7.2. Cancel VM workflow tasks

To cancel workflow tasks:
  1. Go to Virtual datacenters → Workflow tasks
  2. If you are an administrator, to refresh the list with all queued tasks for an enterprise, select a Cloud tenant from the Enterprises pull-down list
  3. To cancel a queued task, click the Reject link next to the task.

Screenshot: A user can cancel their own tasks



7.3. Start queued VM workflow tasks

Queued tasks are waiting for workflow control. If there is a problem with the workflow connector integration or tool, users with the privilege to Manage workflow tasks can manually continue the tasks.

To manually start a task and override the workflow control:

  1. Go to Virtual datacenters → Workflow tasks. 
  2. If you are an administrator, to refresh the list with all queued tasks for an enterprise, select a cloud tenant from the pull-down list of enterprises.
  3. To start a task, click the Approve link beside the task

Screenshot: A user with the privilege to Manage workflow tasks can start their own tasks

8. Manage VM backups

8.1. 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 configuration, Manage virtual machine backup disks, Manage virtual machine backup schedule

  1. Edit the virtual machine and go to Backup → Backup policies

  2. Select from the list of Backup policies
  3. Click Show details. Depending on your system configuration and user privileges, you may be required to configure different backup options. Examples of backup options

  4. If required, enter backup frequency, or date and/or time

    Backup Times

    Abiquo uses ISO 8601 and you should check the time standard used in each datacenter with the datacenter owner

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

  5. If required, select disks
    • Note: Some backup systems will ignore your disk selection and create a backup of all disks. Check your cloud provider's documentation for more information


 

8.2. Restore a VM 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, click the Restore link

To display the details of the restore, click on the backup in the Latest backups list. 

After the platform finishes the restore, it will display a status, such as "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 permits, you may request more than one restore of the same backup. If the status of the restore request is "success" or "failed", Abiquo will reactivate the Restore link and you can click it to request a new restore of the same backup.

8.3. View backup events

For users the backup feature will produce the events described on the Events table page in the Virtual machine section, 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. 

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


9. Administer VMs

9.1. Protect a VM

An administrator can block actions on a VM in the platform by other users who do not have the Protect virtual machine privilege.

You can lock or protect a deployed VM when it is powered on, paused, or powered off.

Privilege: Protect virtual machine

To protect a VM

  1. Select the VM and click the padlock protect VM button near the Deploy VM button
  2. In the Protect virtual machine dialog, enter the reason for protecting the VM.

The platform will display a padlock symbol in the top left corner of the VM icon and change the status of the VM to MAINTENANCE. The administrator can customize this status in the UI labels. 

The name of the administrator who blocked the VM and the reason display in VM details → General.

To release a protected VM, click the padlock unprotect VM button

9.2. Display VM initial password

You can select the option to generate an initial guest password when you create a VM. Then when you deploy the VM, the platform will generate a random password and send it to you by email or SMS. After you deploy, you should log in as the root or administrator user and change the initial password.

The owner of the VM and administrators with the privilege to Display initial virtual machine password can also retrieve the guest password from the deployed VM.

To display the initial VM password:

  1. Select the VM
  2. On the control panel, click the key display initial guest password button

9.3. Reset VM password

To reset the initial password of the root or Administrator user for a VM in vCloud Director :
  1. Select a deployed VM
  2. On the control panel, click the key display initial guest password button
  3. On the popup that opens, click Reset password

The platform will automatically shut down the VM and run the process to reset the password, then it will restart the VM. The platform will send the new password by email or SMS as usual.


10. View platform events

10.1. Display events

The Events view allows users to find out what is happening on the platform.

To open the Events view, click on the events icon on the main menu bar. To add new events as they arrive, select the Update automatically checkbox. Otherwise, you must refresh the list manually. 

To display the event details in the panel below the Event list, double-click on an Event. 

Some users may not be allowed to view events. If the events you expected to display do not appear in Events view, check with your system administrator.


10.2. Event attributes

An event in the platform has the following attributes:

Attribute

Description

Entity

The system object that is the source of the event or error. For example, it could be a VIRTUAL_APPLIANCE for a group of virtual machines.

Entity name

The name of the system object that is the source of the event or error, for example, myVirtualAppliance.

ActionThe action that generated the event, for example, DELETE. See Events Table

Performed by

The user who performed the Action, for example, admin.

SeverityThe severity of the event. Can be INFO, WARN or ERROR

Date/time

The date and time when the event was generated.

Message

Additional information about the event. See Events Table for more details.
Note for administrator: The traces displayed in Events view are also found in the Logs, such as catalina.out, which are documented in the Troubleshooting section of the Abiquo Administrator's Guide.

ContextThe identifier of a group of related events. This attribute is in the event detail but not in the event list.

10.3. Filter events

To make it easier to find a specific event, use the filter tool.
  1. Click the filter button  at the top right of Events view. 
  2. Enter your filter criteria as described in the table below and click Accept

To remove the filter, click Clear at the bottom of the popup.

When events are filtered, the text  (events filtered)  will be displayed next to the filter button.

Event fieldDescription
EntityPull-down list of Entities
ActionPull-down list of Actions
Entity name

The name of the entity. The Name field may contain the UUID or the friendly name of the entity.

For alarms, the Entity name field contains the UUID of the alarm. To filter alarm events by name, enter the friendly name of the alarm in the Message field of the filter.

SeverityPull-down list of event severity. See Events severity table
UserThe name of the user who performed the action
EnterpriseThe tenant that the event occurred in
Date fromCalendar selection for start date in format YYYY/MM/DD
Date toCalendar selection for end date in format YYYY/MM/DD
ContextThe platform assigns the same context ID to a group of related entities
MessageThe message field will contain the details of the event, including the friendly name. See Events Table

10.4. Examples of events filter

This example shows events from deallocating a hard disk.


Event context

When you view the event detail, the platform will display the  Context  of the event. The context is an ID that the platform assigns to each event in a group of related events. For example, if you undeploy a virtual appliance, the platform will create events for the undeploy of each VM, the destruction of the related hard disks, and the release of the NICs. And the platform will assign the context ID to each of these events.

To display all the events related to an event, select the Event from the list, from the details view, copy the Context ID and filter by Context.

10.5. Severity table

Events on the cloud platform are classified into three severity categories: info, warning and error. 

Severity

Description

INFO

General information events for the user as part of the normal use of the platform

WARNING

Warning about an abnormal situation that does not block normal use of the platform

ERROR

Error that blocks the normal use of the platform


10.6. Events table

The Events Table describes all the actions that can be performed on each entity and the event that they can generate on the platform. For example, for the Action plan entity, you can perform the Create, Modify and Delete actions, and events will also be generated when you run an action plan.

10.7. Event Streaming

The platform streams events using the Abiquo Outbound API. The format of the streamed events is described at Trace entity.