# VMware vCloud

### Introduction

When deploying the vCloud [Extractor template](https://github.com/exivity/templates/tree/master/Azure%20Stack) for Exivity, some input and configuration is required from your vCloud environment. The following process must be completed in order to report on vCloud consumption:

1. Create Exivity vCloud user (vCloud < 9.1)
2. Create Exivity vCloud user (vCloud >= 9.1)
3. Configure an Extractor
4. Configure a Transformer
5. Create your Report

### Create Exivity vCloud user (vCloud < 9.1)

For environments with a vCloud previous to 9.1 Exivity needs a user with the sysadmin role on the system ORG. Please follow this procedure:

* Click the **Administration** tab and click **Users** in the left panel.
* Click New, fill the required details.
* Note the username and password.
* Finally, click **OK**.

### Create Exivity vCloud user (vCloud >= 9.1)

For environments with vCloud version 9.1 or higher, you can create a user with more fine grained permissions. Exivity needs a user with a reader role on the *system* ORG. Please follow this procedure:

First you will need to create a new custom role for the Exivity user:

* From the main menu, select **Administration**.
* In the left panel, under **Access Control**, click **Roles**
* Click **New**.
* Enter a name and, optionally, a description for the new role.
* Select the rights that you want to associate with the role. Exivity needs all the *View* Rights in the different tabs and also *Perform Administrator Queries* under the *General* tab.

![](https://3540922554-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LHEKskLK6aXinV75Knl%2F-Lt9vBVNVEZH4fFSkeL0%2F-Lt9vr_bHqJl8m6LNuKa%2Fimage.png?alt=media\&token=1149ef22-60a9-4076-8055-979d2c7b32e6)

* Click **Save**.

Once you have the Role created, you need to setup a new user and assign the Role previously created:

* On the VMware Cloud Service toolbar, click the VMware Cloud Services icon and select **Identity & Access Management**.
* Click **Add Users**.
* On the **Active Users** tab, fill the details of the user you want to add to the *system* organization.
* In the **Role in organization** text box, assign the role previously created.

### Configure an Extractor

To create the Extractor, browse to **Data Sources > Extractors** in the Exivity GUI and click the **Create Extractor** button. This will try to connect to the Exivity Github account to obtain a list of available templates. For vCloud:

* Pick *vCloud\_Extractor\_AdminVM* from the list
* Provide a name for the Extractor in the **name** field
* Click the **Create** button.

![vCloud Extractor](https://3540922554-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LHEKskLK6aXinV75Knl%2F-Lt9w2X9xSyAdhtews_F%2F-Lt9wWpHcEc_3vYEg5sq%2Fimage.png?alt=media\&token=eb766bc2-4416-4f11-82b0-8e0b092d0ade)

Once you've created the Extractor, next go to the*Variables* tab:

![](https://3540922554-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LHEKskLK6aXinV75Knl%2F-Lt9w2X9xSyAdhtews_F%2F-Lt9x1z6iwZvku44uP03%2Fimage.png?alt=media\&token=546d08a8-4077-4510-8151-fb2ba80faede)

Fill in all required variables with the values that you gathered in the previous step. You have the option to encrypt them. Click on **Update**.

Once you've filled in all details, go to the **Run** tab to execute the Extractor clicking on **Run Now**:

![](https://3540922554-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LHEKskLK6aXinV75Knl%2F-Lt9w2X9xSyAdhtews_F%2F-Lt9xM2v7uot-qcUqcLy%2Fimage.png?alt=media\&token=b79946c7-516f-4ab0-96e7-96937117ab2f)

### Configure a Transformer

Once you have successfully run your vCloud Extractor, you can create a Transformer template via **Data Sources > Transformers** in the Exivity GUI. Browse to this location and click the **Create Transformer** button. Make any changes that you feel necessary and then select the **run** tab to execute it for a single day (today) as a test.

![](https://3540922554-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LHEKskLK6aXinV75Knl%2F-Lt9w2X9xSyAdhtews_F%2F-Lt9xgKaWRs7H7WZTZn7%2Fimage.png?alt=media\&token=70355658-0863-4ba0-abd9-96322baf1bac)

### Create a Report

Once you have run both your Extractor and Transformer successfully create a *Report Definition* via the menu option **Reports > Definitions.**

Select your *vCloud* dataset, and your preferred *Reporting Columns to break down the report* (we recommend only Org\_name and VDC for the default report). When you are ready, click on **Create**.

Once you have created the report, you should then click the **Prepare Report** button after first making sure you have selected a valid date range from the date selector shown when preparing the report.