Configuring the vCloud Suite API Plug-In

You can configure vCloud Suite API by running the configuration workflows included in the plug-in.

Import a vCloud Suite API metamodel

The vCloud Suite API plug-in discovers vCloud Suite API services dynamically by querying a vCloud Suite API provider metadata service. vCloud Suite API providers which are not exposing metadata service are not supported.

You must import a vCloud Suite API metamodel and add endpoints afterwards.

You can import up to 20 metamodels. The metamodels you import must have the same version as your vCenter or later. You don't need to import separate metamodels for each endpoint. One metamodel per vCenter is enough for all endpoints with that vCenter version.

Procedure

1. Log in to the Automation Orchestrator Client as an administrator.
2. Navigate to Library > Workflows and enter the vapi tag in the workflow search box.
3. Locate the Import vAPI metamodel workflow and click Run.
4. In the vAPI endpoint URL text box, enter the URL of your vCloud Suite API endpoint.

   https://vCloud_Suite_API_provider_FQDN/api

5. Select whether to use a secure protocol connection.

   Option	Description
   No	Import the vCloud Suite API metamodel, without using a secure protocol connection.
   Yes	To import the vCloud Suite API metamodel with secure protocol connection: Select whether to ignore certificate warnings and accept the vCloud Suite endpoint automatically. Provide the user credentials to authenticate with the vCloud Suite endpoint.

6. Select whether to add a vAPI endpoint using the same credentials.
7. Click Run.

Add a vCloud Suite API endpoint

Add a vCloud Suite API endpoint.

Prerequisites

Import at least one vCloud Suite API metamodel with the same vCenter version or later.

Procedure

1. Log in to the Automation Orchestrator Client as an administrator.
2. Navigate to Library > Workflows and enter the vapi tag in the workflow search box.
3. Locate the Add vAPI endpoint workflow and click Run.
4. In the vAPI endpoint URL text box, enter the URL of your vCloud Suite API endpoint.

   https://vCloud_Suite_API_provider_FQDN/api

5. Choose whether to use a secure protocol connection:

   Option	Description
   No	Import the vCloud Suite API metamodel, without using a secure protocol connection.
   Yes	To import the vCloud Suite API metamodel with secure protocol connection: Choose whether to ignore certificate warnings and accept the vCloud Suite endpoint automatically. Provide the user credentials to authenticate with the vCloud Suite endpoint.

6. Click Run.