Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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. 

...

The following table describes Abiquo remote services required for datacenters and public cloud regions. 

Remote service

Datacenter

Public cloud region

Type in Abiquo

Protocol

Default port

Path

Virtualization Manager

(tick) (blue star)

(tick) (blue star)

VIRTUAL_FACTORY

http://

8009

virtualfactory

Monitor

manager

Manager

(tick) (blue star)

(tick) (blue star)

VIRTUAL_SYSTEM_MONITOR

http://

8009

vsm

Appliance

manager

Manager

(tick) (info) + NFS

APPLIANCE_MANAGER

http://

8009

am

Discovery

manager

Manager

(tick)

(tick)

NARS

http://

8009

nodecollectorStorage manager

nars

Service Manager

-

-

XAS

http://

8009

ssm

xas

Business

process manager

Process Manager

(tick) (info)

BPM_SERVICE

http://

8009

bpm-async

DHCP

service

Service

(tick) (star)

DHCP_SERVICE

omapi:// or dnsmasq://

7911

 DHCPV6 service

or 823

DHCPv6 Service

(tick) (star)

DHCPv6

omapi:// or dnsmasq://

7911

 

...

or 823

Remote Access Manager

(tick)

(tick)

REMOTE_ACCESS

guacd://

4822

You can configure the ports as required, for example, for example, to avoid CORS issues, you might decide to configure AM access through HTTPS on port 443.

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.

The XaaS remote service is required to use X as a Service. You should add it to a datacenter or public cloud region in your platform. 

Key to symbols

(info) - Location-restricted remote services: the appliance manager and the business process manager CANNOT BE SHARED and each Appliance Manager remote service requires a separate NFS repository to hold the Datacenter Apps Library. 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 datacenter is deleted. 

(blue star)  When sharing these remotes services, they require access to ONE shared remote service Redis instance

(red star)  To create a vCloud Director public cloud region, you must have already registered a Discovery Manager remote service in Abiquo

(star)  You do not need Abiquo DHCP servers when VMs receive their network configuration outside Abiquo (e.g. unmanaged networks, SDN, guest setup). For standard Abiquo cloud networks, the DHCP Servers are essential to the proper functioning of VM networking.

Retrieve Existing Remote Services

...

Prerequisites

Before you begin working with remote services, create a datacenter, using the UI or the API, as described in the API infrastructure tutorial.

...

Retrieve existing remote services

To retrieve all the remote services currently registered in Abiquo, use a GET request to the RemoteServices Resource.

See Remote Services Resource

...

https://wiki.abiquo.com/api/latest/RemoteServicesResource.html#list-remote-services

...

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_PROXYNARS remote service. If you want to check other remote services, just replace cloud provider proxy details with the other details replace the remote service details in the example below. For a list of remote service types, see Create infrastructure 

Check a remote service from the IP address

cURL:

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

...

Code Block
{
  "links":[],
  "type":"CLOUD_PROVIDER_PROXYNARS",
  "uri":"http://mjsrs.bcn.abiquo.com:8009/cppnars"
}

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 Resourcehttps://wiki.abiquo.com/api/latest/RemoteServicesResource.html#check-a-remote-service

...

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 PUT request with a remote service entity containing the links to the locations where you want to add the remote service. Include PagePUT_adm_rs_X_CT_rs_j_AC_rs_jPUT_adm_rs_X_CT_rs_j_AC_rs_j 

https://wiki.abiquo.com/api/latest/RemoteServicesResource.html#update-a-remote-service