3.1 Register an Extension

To create a custom extension, you must POST a service element. A service element describes the name, namespace, routing key, exchange to use, and URL patterns (APIFilters) and ServiceLink elements to be used as API filters.

• Namespace – Service namespace, which must be unique among all registered extension services. Service namespace names must follow the naming convention used for Java packages.

• Exchange – AMQP exchange name that vCloud Director must use when routing messages to the service. The service must create the specified exchange on the AMQP service that vCloud Director uses.

o This example uses the AMQP exchange name vcdext, which is different than the one that was configured with vCloud Director. The exchange used for extensions must be of the type Direct.

• APIFilters – One or more URL patterns that the vCloud Director REST service must treat as extension requests. URL patterns can include regular expressions recognizable by java.util.regex.Pattern.

 In this case, the addition to org is limited. If you wanted to also allow this creation on individual VMs, you could specify:

The XML for the API extension is created in a file called ext-reg.xml (https://github.com/johnnycuse/vcd-api-examples/blob/master/ticketing/ext-reg.xml), and this will be passed to vCloud to register the extension:

<vmext:Service xmlns="http://www.vmware.com/vcloud/v1.5" xmlns:vmext="http://www.vmware.com/vcloud/extension/v1.5" name="gcp-ticketing">

# http --verify no --session=vcloud-gcp-admin POST https://vcd.gcp.local/api/admin/extension/service 'Content-type: application/vnd.vmware.admin.service+xml' 'Accept:application/*+xml;version=5.6' < ext-reg.xml

<?xml version="1.0" encoding="UTF-8"?>

<vmext:Service xmlns:vmext="http://www.vmware.com/vcloud/extension/v1.5" xmlns:vcloud="http://www.vmware.com/vcloud/v1.5" name="gcp-test" id="urn:vcloud:externalService:f79f562a-8d7a-44d6-9bab-82ddf40589f7" href="https://vcd.gcp.local/api/admin/extension/service/f79f562a-8d7a-44d6-9bab-82ddf40589f7" type="application/vnd.vmware.admin.service+xml" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.vmware.com/vcloud/extension/v1.5 http://vcd.gcp.local/api/v1.5/schema/vmwextensions.xsd http://www.vmware.com/vcloud/v1.5 http://vcd.gcp.local/api/v1.5/schema/master.xsd">

<vcloud:Link rel="remove" href="https://vcd.gcp.local/api/admin/extension/service/f79f562a-8d7a-44d6-9bab-82ddf40589f7"/>

<vcloud:Link rel="edit" href="https://vcd.gcp.local/api/admin/extension/service/f79f562a-8d7a-44d6-9bab-82ddf40589f7" type="application/vnd.vmware.admin.service+xml"/>

<vcloud:Link rel="rights" href="https://vcd.gcp.local/api/admin/extension/service/f79f562a-8d7a-44d6-9bab-82ddf40589f7/rights" type="application/vnd.vmware.admin.rights+xml"/>

<vcloud:Link rel="down:serviceLinks" href="https://vcd.gcp.local/api/admin/extension/service/f79f562a-8d7a-44d6-9bab-82ddf40589f7/links" type="application/vnd.vmware.vcloud.query.records+xml"/>

<vcloud:Link rel="bundle:upload" href="https://vcd.gcp.local/api/admin/extension/service/localizationbundles" type="application/vnd.vmware.admin.bundleUploadParams+xml"/>

<vcloud:Link rel="add" href="https://vcd.gcp.local/api/admin/extension/service/f79f562a-8d7a-44d6-9bab-82ddf40589f7/links" type="application/vnd.vmware.admin.serviceLink+xml"/>

<vcloud:Link rel="down:apiFilters" href="https://vcd.gcp.local/api/admin/extension/service/f79f562a-8d7a-44d6-9bab-82ddf40589f7/apifilters" type="application/vnd.vmware.vcloud.query.records+xml"/>

<vcloud:Link rel="add" href="https://vcd.gcp.local/api/admin/extension/service/f79f562a-8d7a-44d6-9bab-82ddf40589f7/apifilters" type="application/vnd.vmware.admin.apiFilter+xml"/>

<vcloud:Link rel="add" href="https://vcd.gcp.local/api/admin/extension/service/f79f562a-8d7a-44d6-9bab-82ddf40589f7/apidefinitions" type="application/vnd.vmware.admin.apiDefinition+xml"/>

<vcloud:Link rel="down:apiDefinitions" href="https://vcd.gcp.local/api/admin/extension/service/f79f562a-8d7a-44d6-9bab-82ddf40589f7/apidefinitions" type="application/vnd.vmware.vcloud.query.records+xml"/>

<vcloud:Link rel="add" href="https://vcd.gcp.local/api/admin/extension/service/f79f562a-8d7a-44d6-9bab-82ddf40589f7/resourceclasses" type="application/vnd.vmware.admin.resourceClass+xml"/>

<vcloud:Link rel="down:resourceClasses" href="https://vcd.gcp.local/api/admin/extension/service/f79f562a-8d7a-44d6-9bab-82ddf40589f7/resourceclasses" type="application/vnd.vmware.vcloud.query.records+xml"/>

<vcloud:Link rel="authorization:check" href="https://vcd.gcp.local/api/admin/extension/service/f79f562a-8d7a-44d6-9bab-82ddf40589f7/authorizationcheck" type="application/vnd.vmware.admin.authorizationCheckParams+xml"/>

<vmext:Namespace>local.gcp.ticketing</vmext:Namespace>

<vmext:Enabled>true</vmext:Enabled>

<vmext:AuthorizationEnabled>false</vmext:AuthorizationEnabled>

<vmext:RoutingKey>gcp-ticketing</vmext:RoutingKey>

<vmext:Priority>0</vmext:Priority>

<vmext:Exchange>vcdext</vmext:Exchange>

# http --verify no --session=vcloud-gcp-admin --pretty colors GET https://vcd.gcp.local/api/admin/extension/service/query

When this test command is executed, the call will hang for 10 seconds, and eventually return a 504 error message, “External service ‘gcp-ticketing’ failed to respond in the specified timeout (10 SECONDS).” This verifies that the new extension was registered successfully, however, nothing was configured yet to handle the message that was added to the message queue.