...
...
...
| Table of Contents | |
|---|---|
|
...
|
...
| Info |
|---|
How to edit VM cost codes, lock and protect VMs, relocate a VM, troubleshoot VM launch, manage VMs with workflow feature, and perform power operations with the API on the hybrid cloud platform. |
...
...
Edit extra charges with cost codes for a VM
...
| Include Page | ||||
|---|---|---|---|---|
|
...
...
Protect a VM
...
| Include Page | ||||
|---|---|---|---|---|
|
...
Reset VM password
...
| Include Page | ||||
|---|---|---|---|---|
|
...
Restrict virtual appliances and VMs
| Excerpt |
|---|
...
|
...
Virtual machine states
The VM lifecycle may include all the states in the following table. The VM is usually only in the Allocated and Configured states for a short time.
...
State
...
Description
...
Not Allocated
...
The VM does not exist on the cloud node; it is just a template of the VM to be deployed and it only exists in Abiquo. The physical machine and other resources are not allocated in the cloud node and it is not consuming resources. For example, if you add a VM template to a virtual appliance with a VM that is deployed, the VM you just created is not deployed and its state is not allocated. If you undeploy a virtual appliance, then all the VMs in the virtual appliance will be undeployed, and these VMs will be in the not allocated state.
...
Allocated
...
The VM does not exist on the cloud node but a physical machine or provider has been assigned to it. When you deploy a VM, the first step in the deploy process is the resource scheduling or allocation. After resource allocation, the VM is in the allocated state. This state is usually a short step in the deploy process.
...
Configured
...
The VM exists on the cloud node. Resources such as network and volumes are allocated to it on the physical machine or in the provider. After the VM is configured in the hypervisor or provider, the VM is in the configured state. This state is usually a short step in the deploy process.
...
On
...
...
The final step in the deploy process is to power on the VM. A VM in the on state is exists in the cloud node and is running.
...
Paused
...
The VM exists on the cloud node and the VM is suspended.
...
Off
...
The VM exists in the cloud node but it is not running. Resources are still allocated in the cloud node.
...
Locked
...
An operation is being performed on the VM. The status bar shows LOCKED but it is covered by the progress notification. VMs awaiting workflow review will be locked with the progress notification "Waiting to be reviewed"
...
Unknown
...
The platform does not have information about the current state of the VM but the machine exists on the cloud node. VMs may be put in the UNKNOWN state if there is an issue with a connection to the hypervisor or provider, To delete a VM in the unknown state, you need the "Delete unknown virtual machine" privilege and also access to the enterprise or the "Administer all enterprises privilege". The platform does not display VMs in the UNKNOWN state and their resources on the dashboard and it does not count them in allocation limits for CPU, RAM, and storage.
...
Maintenance
...
The administrator can lock or protect a VM for maintenance when it is in any of the deployed states of on, paused, or off. See Protect a VM
Virtual appliance states
The virtual appliance states are calculated from the VM states as described below. The state name in the table has the color code for the Virtual appliance in each state.
...
State
...
Description
...
o Empty
...
There are no VMs in the virtual appliance
...
o Deployed
...
All of the VMs are not in the Undeployed state. All the VMs exist in the hypervisor or provider and none are in the Unknown or Locked state. Resources are allocated in the cloud node.
...
o Undeployed
...
All the VMs are in the Undeployed state. None of the VMs exist in the hypervisor or provider, and none are in the Unknown or Locked state. The virtual appliance can be seen as a template. Resources are not allocated in the cloud node.
...
o Partially deployed
...
This state occurs when a virtual appliance that is in the Deployed state is modified, for example, by adding a new VM. This state indicates that the configuration of the virtual appliance in the cloud node is different to the configuration of the virtual appliance in the Abiquo Server (database). To update the cloud node with the changes, click Deploy all VMs.
...
o Locked
...
One or more of the VMs is in the Locked state and none is in the Unknown state. Note: Virtual appliances awaiting workflow review will be locked with VM state Waiting to be reviewed
...
o Unknown
...
Some or all of the VMs are in the Unknown state. The virtual appliance state is unknown when the VM states cannot be recovered from the hypervisor or provider. To continue working with this virtual appliance, the system administrator must take action.
Some of these states are shown in the virtual appliances lists in following screenshot:
| Note |
|---|
Deployed State and Powered Off Virtual Machines The fact that all the VMs in a virtual appliance are powered off does not imply that the virtual appliance is undeployed. A deployed virtual appliance is always consuming resources because the VMs exist in the cloud nodes. An undeployed virtual appliance is not consuming resources. In Microsoft Azure a deployed VM in the "Off - deallocated" state is not consuming cloud resources |
Relocate a deployed VM to another host
...
What happens when the user clicks deploy?
The VM scheduler deploys the VM.
A simplified description of the deploy process is shown in the following diagram.
...
Deploy errors
When an error occurs during a VM deploy, the platform displays one or more of the following:
A yellow warning or red error notification message
An error state on the VM icon
A VM warning symbol in the lower part of the VM icon.
The user and the administrator may be notified of the error.
The user can click on the error icon to display the events and the user can click on an event in the list to display its tracer message.
...
The platform displays the full details of an error in the Events view and on the Events panel in the Home view.
...
Here is an example of an event for a failed reconfigure.
| Panel | ||
|---|---|---|
| ||
Source: Abiquo / admin / |
The VM warning symbol is based on the VM task state. The VM tasks are a collection of jobs. For example, a Deploy task includes jobs to allocate, configure, and power on the VM. If a job fails, then the task will also fail and the platform will display the warning symbol on the VM.
To acknowledge and delete a warning symbol, click on the symbol to remove it.
If your user role is an administrator role with the privilege to "Manage Users", then you can also delete warnings for the users of the enterprises that you manage.
States of VApps and VMs
It is important that administrators clearly understand the different states that virtual appliances and VMs can have in the Abiquo platform and the differences between them. In order to change the state of VMs, users will require the Perform virtual machine actions privilege.
| Panel |
|---|
Privileges: Perform virtual machine actions |
| Tip |
|---|
API Feature In the API the valid VM states are: NOT_ALLOCATED, ALLOCATED, CONFIGURED, ON, PAUSED, OFF, LOCKED and UNKNOWN. See VirtualMachineResource An additional state for protecting VMs by locking them against user actions is the MAINTENANCE state, which is represented by the action to Protect a VM. See also VM power actions using the API |
Virtual machine states table
...
Virtual appliance states table
...
Manage workflow tasks
| Excerpt | ||
|---|---|---|
| ||
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
To filter workflow tasks, enter text in the filter box at the top of the tasks list.  To continue a queued workflow task, click the Accept link beside the task. To cancel a queued workflow task, click the Reject link beside the taskTo restrict a VM by moving it to a restricted VApp:
|
...
Relocate a deployed VM to another host
The relocate VM feature enables you to move a deployed VM to another hypervisor on the same rack with the same manager. This feature is available for VMware ESXi and uses the vMotion feature. This feature requires the "Relocate a VM into a compatible host" privilege. The Relocate VM button is on the VM control panel near the Protect VM padlock button.
| Panel |
|---|
Privileges: Relocate a VM into a compatible host |
To relocate a VM:
Go to Virtual datacenters → open a virtual appliance → go to Virtual machines → select a VM
On the VM control panel on the lower right-hand side of the screen, click the Relocate VM button
The platform will display a dialog with a list of hypervisor hosts where you can relocate the VM
Click the Show details link to display the host metrics and the Relocate button
Select the host with the same manager where you wish to relocate the VM, go to the host section and click Relocate. The platform will display the VM status as Relocating
After relocation, the new hypervisor location will display in the control panel, for example, with a new Remote access address. If you click the Relocate button again, you should see a different host list, including the original host.
Screenshot: Select the VM and click relocate
...
Screenshot: Host selection list
...
Screenshot: Host metrics and Relocate button
...
Screenshot: You can check the relocation by clicking the Relocate button again, which will show the original host as a new candidate
...
...
What happens when the user clicks deploy?
The VM scheduler deploys the VM.
A simplified description of the deploy process is shown in the following diagram.
...
Deploy errors
When an error occurs during a VM deploy, the platform displays one or more of the following:
A yellow warning or red error notification message
An error state on the VM icon
A VM warning symbol in the lower part of the VM icon.
The user and the administrator may be notified of the error.
The user can click on the error icon to display the events and the user can click on an event in the list to display its tracer message.
...
The platform displays the full details of an error in the Events view and on the Events panel in the Home view.
Here is an example of an event for a failed reconfigure.
| Panel | ||
|---|---|---|
| ||
Source: Abiquo / admin / |
The platform displays the VM warning symbol for the VM task state. The VM tasks are a collection of jobs. For example, a Deploy task includes jobs to allocate, configure, and power on the VM. If a job fails, then the task will also fail and the platform will display the warning symbol on the VM.
To acknowledge and delete a warning symbol, click on the symbol to remove it.
If your user role is an administrator role with the privilege to Manage users, then you can also delete warnings for the users of the enterprises that you manage.
...
Virtual machine states table
| Include Page | ||||
|---|---|---|---|---|
|
Virtual appliance states
| Include Page | ||||
|---|---|---|---|---|
|
...
Retrieve a VM using the API
This section describes how to retrieve a virtual machine with the REST API.
Before you begin, create a VM with the Abiquo UI and power it off. Open the browser console. This example uses Chrome, so we clicked F12.
Select the Network view
Click the red arrow record button and the clear button next to it
In the platform on the VM control panel, click the Start button
...
Scroll up to the first request, which should be a PUT request to the virtual machine state URL. Click on the request
If you can't see the Method column, right click on a column heading and select Method from the list
...
Select the link to the VM up to the end of the VM ID number (before "/state")
...
Use a cURL request similar to the one the example below or a REST API tool such as Postman to perform a GET request to this link. For this basic testing, you can use the -k option to avoid security warnings.
| Code Block |
|---|
curl -X GET https://mjsabiquo.bcn.abiquo.com/api/cloud/virtualdatacenters/2/virtualappliances/1/virtualmachines/47 \
-H 'Accept:application/vnd.abiquo.virtualmachine+json;version=56.01' \
-u admin:xabiquo -k --verbose |
| Expand | ||
|---|---|---|
| ||
Success status code: 200 Response payload:
|
Manage VM power states using the API
...
...
Manage VM power states using the API
To manage the
...
Vm using the API, first you need to retrieve the
...
VM and find the links for different actions.
Remember to see VirtualMachinesResource for full details of
...
VM operations using the Abiquo API.
| Insert excerpt | ||||||||
|---|---|---|---|---|---|---|---|---|
|
...
Related pages
Work with VMs
Administer virtual resources