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.


Documentation

Skip to end of metadata
Go to start of metadata

This page describes basic remote services management with the Abiquo API.

Introduction to Remote Services and Locations

When you create a location (datacenter or public cloud region), you will supply the URLs of remote services. These remote services will be registered in Abiquo and they will also be assigned to the location you are creating.

There are some requirements when dealing with remote services:

  • The appliance manager and the business process manager are location-restricted remote services. These remote services can only be assigned to a single datacenter and you must supply the datacenter when they are created and they must be deleted when the location is deleted.
  • To create an OpenStack region, you need to pre-create a cloud provider proxy remote service.

When you delete a location, the location-restricted remote services will be deleted, but the other remote services may remain in Abiquo. These remote services will not be assigned to any location.

Details of Remote Services

The details of the Abiquo remote services are listed in the following table. 

Remote serviceProtocolPortExtension
Virtualization managerhttp://8009virtualfactory
Monitor managerhttp://8009vsm
Appliance managerhttp://8009am
Discovery managerhttp://8009nodecollector
Storage managerhttp://8009ssm
Business process managerhttp://8009bpm-async
DHCP serviceomapi://7911 
DHCPV6 serviceomapi://7911 

Depending on your system, other configurations are possible, for example, to avoid CORS issues, you might decide to configure AM access through HTTPS on port 443.

Retrieve Existing Remote Services

Retrieve all the remote services currently registered in Abiquo.

See Remote Services Resource#RetrievealistofRemoteServices

Check Remote Services

The following example shows how to check a remote service from the IP address (as with the check button in the UI). In this case we are checking a CLOUD_PROVIDER_PROXY. If you want to check other remote services, just replace cloud provider proxy details with the other details in the example below. For a list of remote service types, see Infrastructure View#Remoteservicesrequiredfordatacentersandpubliccloudregions 

Check a remote service from the IP address

cURL:

curl -X POST https://mjspac.bcn.abiquo.com:443/api/config/action/remoteservicecheck \ 
	-H 'Content-Type:application/vnd.abiquo.remoteservice+json;version=3.8' \
	-d @requestpayload.json \ 
	-u admin:xabiquo --verbose


Success status code: 204

Request payload:

{
  "links":[],
  "type":"CLOUD_PROVIDER_PROXY",
  "uri":"http://mjsrs.bcn.abiquo.com:8009/cpp"
}

Response payload:

--none--

Check a remote service that is already registered in Abiquo

To check a remote service that is already registered in Abiquo, you can use the link in the remote service entity or its ID. 

See Remote Services Resource#CheckthestatusofaRemoteService

Modify a remote service to add it to locations

To modify a remote service to add it to public cloud regions or datacenters, perform a put request with a remote service entity containing the links to the locations where you want to add the remote service.

API example removed: PUT_adm_rs_X_CT_rs_j_AC_rs_j
You can download the API examples archive from ABI38Confluence-space-export-152334-314.html.zip