Introduction
This tutorial continues on from Get started with the Abiquo API.
In this tutorial, you will use the Abiquo API to do the following.
Configure a VM by adding an IP address (NIC)
Delete a VM
There is also a link to another section that describes how to power cycle a VM.
Requirements
This tutorial requires two VMs that are:
Not deployed
Have no IP addresses (NICs)
You will also need 2 free IP addresses in private networks in the virtual datacenter with the VMs.
To use VMs from the previous tutorial, in the UI undeploy it and delete its IP address.
Working with Deployed VMs
A deployed VM must always have a NIC. If you want to add another NIC, you may need to create another network to avoid trying to add two IP addresses in the same network.
To change the configuration of a deployed VM, if the VM doesn't have network hot-reconfigure, then you will need to shut it down first.
Get and modify an entity using the API
In general, to modify an entity using the Abiquo API, do these steps.
Use a
GETrequest to retrieve the entity's data objectModify the data object
Use a
PUTrequest to update the entity
Within a data object, links can define an entity's configuration.
When you edit the VM data object, be careful not to accidentally delete links because you could change the configuration, such as by deleting a disk from your VM!
Configure a VM to add a NIC using the UI
First perform the action using the Abiquo UI, to view the API request that the UI makes.
To the first VM, which is not deployed, add a network interface card (NIC) with an IP address in a private network.
Open the browser console to the Network tab and record actions
Edit the VM and go to Network → Private
Select the network and drag an IP address into the NICs panel, and Save the VM
Find the
PUTrequest and copy it, or get theniclink and VM data object
Obtain the link to the NIC
In the VM object, find the link to the NIC (with a rel attribute with a value of nic1 near the end of the VM links section.
{
"title":"privateip",
"rel":"nic1",
"type":"application/vnd.abiquo.privateip+json",
"href":"https://mjsabiquo.lab.abiquo.com:443/api/cloud/virtualdatacenters/12/privatenetworks/9/ips/11"
},
Get an IP address to add to the VM
To find a free IP address:
From the link to the NIC in the previous step, get only the networks IPs link
https://mjsabiquo.lab.abiquo.com:443/api/cloud/virtualdatacenters/12/privatenetworks/9/ips
Use a GET request to obtain the first 3 IP addresses in this network, and add the query parameter
limitwith a value of3curl --verbose 'https://mjsabiquo.lab.abiquo.com:443/api/cloud/virtualdatacenters/12/privatenetworks/9/ips?limit=3' \ -H 'Accept: application/vnd.abiquo.privateips+json; version=6.1' \ -u user:password -k | jq .
To retrieve IPs that are available for use only, use the query parameter freewith a value oftrueThe response has 3 IP addresses: the gateway and the IP addresses we created specifically for this exercise.
√ ~ % curl --verbose -k 'https://mjsabiquo.lab.abiquo.com:443/api/cloud/virtualdatacenters/12/privatenetworks/9/ips?limit=3' \ -H 'Accept: application/vnd.abiquo.privateips+json; version=6.1' \ -u user:password | jq . > GET /api/cloud/virtualdatacenters/12/privatenetworks/9/ips?limit=3 HTTP/1.1 > Host: mjsabiquo.lab.abiquo.com > Authorization: Basic XXXXXX > User-Agent: curl/7.88.1 > Accept: application/vnd.abiquo.privateips+json; version=6.1 > < HTTP/1.1 200 200 < Date: Wed, 07 Jun 2023 13:54:46 GMT < Server: Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips < Set-Cookie: ABQSESSIONID=5848743475559326145; Max-Age=1800; Expires=Wed, 07-Jun-2023 14:24:46 GMT; Path=/; Secure; HttpOnly; SameSite=strict < X-Abiquo-TracerContext: c2b1df27-14c5-4e28-917d-f793d7dc3a71 < X-Abiquo-Token: XXXXXX < Cache-Control: no-cache, no-store, max-age=0, must-revalidate < Pragma: no-cache < Expires: 0 < Strict-Transport-Security: max-age=31536000 ; includeSubDomains < X-XSS-Protection: 1; mode=block < X-Frame-Options: DENY < X-Content-Type-Options: nosniff < Content-Type: application/vnd.abiquo.privateips+json; version=6.1 < Transfer-Encoding: chunked < { "totalSize": 4, "links": [ { "rel": "first", "href": "https://mjsabiquo.lab.abiquo.com:443/api/cloud/virtualdatacenters/12/privatenetworks/9/ips?limit=3&by=ip&asc=true" }, { "rel": "next", "href": "https://mjsabiquo.lab.abiquo.com:443/api/cloud/virtualdatacenters/12/privatenetworks/9/ips?startwith=3&limit=3&by=ip&asc=true" }, { "rel": "last", "href": "https://mjsabiquo.lab.abiquo.com:443/api/cloud/virtualdatacenters/12/privatenetworks/9/ips?startwith=1&limit=3&by=ip&asc=true" } ], "collection": [ { "id": 8, "ip": "192.168.0.1", "mac": "00:50:56:2F:D8:F3", "name": "0050562FD8F3_captured", "networkName": "default_private_network", "ipv6": false, "quarantine": false, "available": true, "links": [ { "title": "default_private_network", "rel": "privatenetwork", "type": "application/vnd.abiquo.vlan+json", "href": "https://mjsabiquo.lab.abiquo.com:443/api/cloud/virtualdatacenters/12/privatenetworks/9" }, { "title": "privateip", "rel": "self", "type": "application/vnd.abiquo.privateip+json", "href": "https://mjsabiquo.lab.abiquo.com:443/api/cloud/virtualdatacenters/12/privatenetworks/9/ips/8" }, { "title": "vdcbcdc", "rel": "virtualdatacenter", "type": "application/vnd.abiquo.virtualdatacenter+json", "href": "https://mjsabiquo.lab.abiquo.com:443/api/cloud/virtualdatacenters/12" } ] }, { "id": 11, "ip": "192.168.0.2", "mac": "00:50:56:1A:2E:18", "name": "0050561A2E18_captured", "networkName": "default_private_network", "ipv6": false, "usedBy": "1979e77f-32b1-430d-9b92-9f6347dbd416", "quarantine": false, "available": true, "links": [ { "title": "default_private_network", "rel": "privatenetwork", "type": "application/vnd.abiquo.vlan+json", "href": "https://mjsabiquo.lab.abiquo.com:443/api/cloud/virtualdatacenters/12/privatenetworks/9" }, { "title": "privateip", "rel": "self", "type": "application/vnd.abiquo.privateip+json", "href": "https://mjsabiquo.lab.abiquo.com:443/api/cloud/virtualdatacenters/12/privatenetworks/9/ips/11" }, { "title": "vdcbcdc", "rel": "virtualdatacenter", "type": "application/vnd.abiquo.virtualdatacenter+json", "href": "https://mjsabiquo.lab.abiquo.com:443/api/cloud/virtualdatacenters/12" }, { "title": "vapbcdc", "rel": "virtualappliance", "type": "application/vnd.abiquo.virtualappliance+json", "href": "https://mjsabiquo.lab.abiquo.com:443/api/cloud/virtualdatacenters/12/virtualappliances/4" }, { "title": "vmapihowto", "rel": "virtualmachine", "type": "application/vnd.abiquo.virtualmachine+json", "href": "https://mjsabiquo.lab.abiquo.com:443/api/cloud/virtualdatacenters/12/virtualappliances/4/virtualmachines/304" } ] }, { "id": 12, "ip": "192.168.0.3", "mac": "00:50:56:18:63:13", "name": "005056186313_host", "networkName": "default_private_network", "ipv6": false, "quarantine": false, "available": true, "links": [ { "title": "default_private_network", "rel": "privatenetwork", "type": "application/vnd.abiquo.vlan+json", "href": "https://mjsabiquo.lab.abiquo.com:443/api/cloud/virtualdatacenters/12/privatenetworks/9" }, { "title": "privateip", "rel": "self", "type": "application/vnd.abiquo.privateip+json", "href": "https://mjsabiquo.lab.abiquo.com:443/api/cloud/virtualdatacenters/12/privatenetworks/9/ips/12" }, { "title": "vdcbcdc", "rel": "virtualdatacenter", "type": "application/vnd.abiquo.virtualdatacenter+json", "href": "https://mjsabiquo.lab.abiquo.com:443/api/cloud/virtualdatacenters/12" } ] } ] }
In the above example, the NIC for the IP address of 192.168.0.2 is the one that we just added to the VM called vmapihowto and it has a link to the VM.
The available IP address of 192.168.0.3 is the one we will use, and it has an ID of 12.
Create a NIC link
From the IP address object in the above step, get the link with a rel attribute that has a value of self.
{
"title": "privateip",
"rel": "self",
"type": "application/vnd.abiquo.privateip+json",
"href": "https://mjsabiquo.lab.abiquo.com:443/api/cloud/virtualdatacenters/12/privatenetworks/9/ips/12"
},
To prepare it for the VM, change the rel attribute from a value of self to nicX, where X represents the number of the new NIC in the VM. So if there are no NICs, add nic1 as shown here.
{
"title": "privateip",
"rel": "nic1",
"type": "application/vnd.abiquo.privateip+json",
"href": "https://mjsabiquo.lab.abiquo.com:443/api/cloud/virtualdatacenters/12/privatenetworks/9/ips/12"
},
Add the NIC link to the VM object
Get the VM object that you created using the API in the first part of this tutorial.
To get the VM entity again, you can send a GET request to the cloud/virtualmachines link.
In this case, we are using a vmname query parameter to filter on the number 2 in the VM name to only retrieve the VM from the first part of the tutorial.
√ ~ % curl --verbose 'https://mjsabiquo.lab.abiquo.com:443/api/cloud/virtualmachines?vmname=2' \
-H 'Accept: application/vnd.abiquo.virtualmachines+json; version=6.1' \
-u user:password -k | jq .
This request returns a collection of VMs, so you will need to select the individual VM from the collection.
In the VM object, go the end of the links section and add the NIC link from the previous step.
If this is the last link, remember to add a comma before it, and remove any comma after it.
This is an example of a modified VM object, with the nic1 link at the end of a shortened links section. We shortened the links section to make the example more readable
{
"id": 305,
"uuid": "eb613c22-ffa1-4498-827a-ccaf37385c2e",
"fqdn": "box.localdomain",
"description": "A virtual machine",
"coresPerSocket": 1,
"idState": 1,
"idType": 0,
"type": "MANAGED",
"highDisponibility": 0,
"monitored": false,
"monitoringLevel": "DEFAULT",
"protected": false,
"variables": {},
"backuppolicies": [],
"lastSynchronize": 1686046081000,
"generateGuestInitialPassword": false,
"natrules": [],
"vdrpEnabled": true,
"vdrpPort": 0,
"password": "6t51rgZ9",
"deallocated": false,
"name": "vmapihowto2",
"ram": 48,
"cpu": 1,
"state": "NOT_ALLOCATED",
"creationTimestamp": 1686042455000,
"birthTimestamp": 1686045726000,
"links": [
{
"title": "Abiquo",
"rel": "enterprise",
"type": "application/vnd.abiquo.enterprise+json",
"href": "https://mjsabiquo.lab.abiquo.com:443/api/admin/enterprises/1"
},
{
"title": "vmapihowto2",
"rel": "edit",
"type": "application/vnd.abiquo.virtualmachine+json",
"href": "https://mjsabiquo.lab.abiquo.com:443/api/cloud/virtualdatacenters/12/virtualappliances/4/virtualmachines/305"
},
...
{
"title": "VMware vCenter Cluster",
"rel": "hypervisortype",
"type": "application/vnd.abiquo.hypervisortype+json",
"href": "https://mjsabiquo.lab.abiquo.com:443/api/config/hypervisortypes/VCENTER_CLUSTER"
},
{
"title": "yVM",
"rel": "virtualmachinetemplate",
"type": "application/vnd.abiquo.virtualmachinetemplate+json",
"href": "https://mjsabiquo.lab.abiquo.com:443/api/admin/enterprises/1/datacenterrepositories/2/virtualmachinetemplates/145"
},
{
"title": "Others",
"rel": "category",
"type": "application/vnd.abiquo.category+json",
"href": "https://mjsabiquo.lab.abiquo.com:443/api/config/categories/1"
},
{
"title": "privateip",
"rel": "nic1",
"type": "application/vnd.abiquo.privateip+json",
"href": "https://mjsabiquo.lab.abiquo.com:443/api/cloud/virtualdatacenters/12/privatenetworks/9/ips/12"
}
],
"usageStatistics": []
}
Update the VM to add the NIC
Create a PUT request to update the whole VM, including all the links.
To easily manage the large data object, you can save it to a JSON file, and use the @ notation to reference the file in the PUT request.
In our example, we called the file vmapihowto2.json.
curl --verbose -X PUT 'https://mjsabiquo.lab.abiquo.com:443/api/cloud/virtualdatacenters/12/virtualappliances/4/virtualmachines/305' \ -H 'Content-Type: application/vnd.abiquo.virtualmachine+json; version=6.1' \ -H 'Accept: application/vnd.abiquo.acceptedrequest+json; version=6.1' \ -u user:password \ -d @vmapihowto2.json -k
Send the PUT request.
If the platform updates the VM successfully, the response status and message will be 204 No content for an undeployed VM.
An example of the request is given here.
√ api_tutorials % curl --verbose -X PUT 'https://mjsabiquo.lab.abiquo.com:443/api/cloud/virtualdatacenters/12/virtualappliances/4/virtualmachines/305' \
-H 'Content-Type: application/vnd.abiquo.virtualmachine+json; version=6.1' \
-H 'Accept: application/vnd.abiquo.acceptedrequest+json; version=6.1' \
-u user:password \
-d @vmapihowto2.json -k
> PUT /api/cloud/virtualdatacenters/12/virtualappliances/4/virtualmachines/305 HTTP/1.1
> Host: mjsabiquo.lab.abiquo.com
> Authorization: Basic XXXXXXX
> User-Agent: curl/7.88.1
> Content-Type: application/vnd.abiquo.virtualmachine+json; version=6.1
> Accept: application/vnd.abiquo.acceptedrequest+json; version=6.1
> Content-Length: 12498
>
< HTTP/1.1 204 204
< Date: Wed, 07 Jun 2023 15:06:58 GMT
< Server: Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips
< Set-Cookie: ABQSESSIONID=7288756894413749700; Max-Age=1800; Expires=Wed, 07-Jun-2023 15:36:58 GMT; Path=/; Secure; HttpOnly; SameSite=strict
< X-Abiquo-TracerContext: e54d1e2f-6b6a-4338-ba9e-4c770f4e9813
< X-Abiquo-Token: XXXXXX
< Cache-Control: no-cache, no-store, max-age=0, must-revalidate
< Pragma: no-cache
< Expires: 0
< Strict-Transport-Security: max-age=31536000 ; includeSubDomains
< X-XSS-Protection: 1; mode=block
< X-Frame-Options: DENY
< X-Content-Type-Options: nosniff
<
Check your VM in the UI
In the UI, when you select the VM, and open the VM details panel to the NICs tab, the NIC should display.
Change the power states of a VM
To prepare a VM to change power states, deploy a VM using the UI or the API.
To deploy the VM you were using in the previous step, send a POST request to the deploy link.
Then see Administer and troubleshoot VMs in the "Manage VM power states using the API" section
Delete a VM using the API
To delete a VM (or another entity), simply perform a DELETE request to the API link.
Note that there may be restrictions on what you can delete. For example, you cannot delete a virtual datacenter that contains virtual appliances.
If we delete the VM as shown here, it will be removed from the platform (and if it exists on the hypervisor, it will be destroyed). And the IP address will return to the virtual datacenter.
curl -X DELETE https://mjsabiquo.lab.abiquo.com:443/api/cloud/virtualdatacenters/12/virtualappliances/4/virtualmachines/305 \ -H 'Accept: text/json,application/json;' \ -u user:password -k
Conclusion
Congratulations, you have now completed the Abiquo API tutorials. You can now continue to experiment using the API together with the UI. And you can find more examples in the API Howtos section.
And of course don't forget to check out the Java and Python libraries. Enjoy!
Related links