# Installation and setup

> Install, upgrade, and configure the OneFuse integration for VMware vRealize Automation 8.1+ and vRA Cloud, including the vRO Workflow Package import and endpoint setup

---

Site [llms.txt](/llms.txt)

---

## New install requirements

Perform once for first initial install. Upgrading? Skip to [Upgrade to the latest](#upgrade-to-the-latest).

1. Review [Getting started](/docs/onefuse/consume/vmware-aria-automation/aria-automation-8x/getting-started/) for prerequisites.
2. **Create a OneFuse service account for vRealize Automation 8x with least permissions**
   1. Log in to `https://{MY-VRA-INSTANCE}/csp/gateway/portal/#/consumer/usermgmt/ad-groups/assign-roles`
   2. Select the **Enterprise Groups** tab.
   3. Select **Assign Roles**.
   4. **Search and select** the AD group containing the service account to be used for the OneFuse integration.
   5. Designate the group at minimum: **Organizational Member**.
   6. Select the [**+ Add Service Access**] button *twice*.
   7. Assign the following VMware **Service Roles** to the user:
      - **Orchestrator** with roles **Orchestrator Administrator**
      - **Cloud Assembly** with roles **Cloud Assembly Administrator**
      - \*To learn more, visit [vRealize Orchestrator Roles and Groups](https://docs.vmware.com/en/vRealize-Orchestrator/8.4/com.vmware.vrealize.orchestrator-using-client-guide.doc/GUID-D0FFDD2A-3D6C-485C-850B-FCD445391365.html).
3. If using vRA Cloud, **generate the vRA Cloud API Token with least permissions**:
   1. Log in to **vRA Cloud Assembly**.
   2. Select your name in the top-right menu > select **My Account** (under User Settings).
   3. Select the **API Tokens** tab.
   4. Select **Generate a New API Token**.
   5. In the **Generate a New API Token** form:
      1. Enter the token name and define the token TTL.
      2. For **Define Scopes**, two roles are required:
         1. The role **Organization Member** is required:
            1. In the **Organization Roles** column on the right, scroll down and expand **All Organization Roles**.
            2. Check the checkbox for **Organization Member**.
         2. The role **Cloud Assembly Administrator** is required:
            1. In the **Service Roles** column on the right, scroll down and expand **VMware Cloud Assembly**.
            2. Check the checkbox for **Cloud Assembly Administrator**.
      3. Select **Generate**.
   6. Save the API Token to be used later during [Run the OneFuse Configuration Workflow](#run-the-onefuse-configuration-workflow).
4. **Follow instructions below to:**
   1. [Download the latest OneFuse vRealize Orchestrator Workflow Package](#download-the-latest-onefuse-vrealize-orchestrator-workflow-package)
   2. [Import the OneFuse vRealize Orchestrator Workflow Package](#import-the-onefuse-vrealize-orchestrator-workflow-package)
   3. [Run the OneFuse Configuration Workflow](#run-the-onefuse-configuration-workflow)

---

## Upgrade to the latest

Follow instructions below to get the latest features for OneFuse + VMware's vRealize Automation.

1. [Download the latest OneFuse vRealize Orchestrator Workflow Package](#download-the-latest-onefuse-vrealize-orchestrator-workflow-package)
2. [Import the OneFuse vRealize Orchestrator Workflow Package](#import-the-onefuse-vrealize-orchestrator-workflow-package)
3. [Run the OneFuse Configuration Workflow](#run-the-onefuse-configuration-workflow)

---

## Download the latest OneFuse vRealize Orchestrator workflow package

<div class="alert alert-info" role="alert">


OneFuse integration with VMware's vRealize Automation is distributed as a vRealize Orchestrator Package for easy install and upgrades.
</div>


[Access CloudBolt's Download Article for CMP/OneFuse 2023.5](https://support.cloudbolt.io/cloudbolt/s/article/cloudbolt-2023-5--1983840286--1).

<div class="alert alert-info" role="alert">


The article will always contain the latest OneFuse vRO Package download link.
</div>


1. Log in with your **CloudBolt Connect** account.
2. Download the OneFuse vRO Package.

---

## Import the OneFuse vRealize Orchestrator workflow package

For a new install and upgrades, perform the following to import the latest OneFuse vRealize Orchestrator Workflow Package.

<div class="alert alert-warning" role="alert">


If the OneFuse vRealize Orchestrator **Plug-in** was previously installed for **OneFuse v1.0/1.0.1**, remove the plugin before installing the OneFuse vRO Package.

**VMware Docs:** [Delete a Plugin for vRA 8x](https://docs.vmware.com/en/vRealize-Orchestrator/8.1/vrealize-orchestrator-81-install-config-guide.pdf?hWord=N4IghgNiBcIK4DsCWCDOAXSEAEAHCcA5iiAL5A) and [Uninstall a Plug-in for vRA 7.6](https://docs.vmware.com/en/vRealize-Orchestrator/7.6/vrealize-orchestrator-76-using-plugins-guide.pdf?hWord=N4IghgNiBcIK4DsCWCDOAXSEAEAHCcA5iiAL5A).
</div>


1. **Log in** to vRealize Orchestrator.
2. Select **Assets** > **Packages**.
3. Select **Import**:
   1. Select **Browse**.
   2. Select the OneFuse vRealize Orchestrator Workflow Package (`.package`) to upload.
   3. Select **Open**.
   4. Review the imported package information.

      <div class="alert alert-info" role="alert">


      You might be prompted to indicate that you trust the publisher certificate of the source vRealize Orchestrator instance before you can import the file.
      </div>


   5. Select **Import**.
4. **Verify** the OneFuse vRealize Orchestrator Workflow Package successfully imported:
   - `io.cloudbolt.onefuse` is listed in the list of Packages under **Assets** > **Packages**.

Resource: [Import a Package in the vRealize Orchestrator Client](https://docs.vmware.com/en/vRealize-Orchestrator/8.5/com.vmware.vrealize.orchestrator-using-client-guide.doc/GUID-CE405299-1800-40C0-9054-5C032A5B022C.html)

---

## Run the OneFuse Configuration Workflow

Create the **vRA Endpoint**, **OneFuse Endpoint**, and **Event Broker Subscriptions** for OneFuse quickly in one workflow.

1. **Log in** to vRealize Orchestrator.
2. Select **Library** > **Workflows** from the left menu.
3. Go to the following workflow via treeview: **Workflows** > **OneFuse** > **Configuration** > **OneFuse Configuration**.
4. Select the Workflow: **OneFuse Configuration** > select **Run**.
5. Fill out the form fields.
6. Select the **[Run]** button.
7. Verify the workflow completed successfully.

### OneFuse Configuration form fields

| Field label | Description |
| --- | --- |
| **vRA Endpoint** | |
| vRA Version | Select the appropriate vRA Version. |
| vRA Appliance FQDN | *(Shown when **vRA Version** is `vra7` or `vra8`)* Enter the vRealize Automation host in FQDN format. |
| vRA Cloud API FQDN | *(Shown when **vRA Version** is `vrac`)* Enter the vRealize Automation Cloud in FQDN format. |
| vRA Username | *(Shown when **vRA Version** is `vra7` or `vra8`)* Username for OneFuse service account for vRA in UPN format. |
| vRA Password | *(Shown when **vRA Version** is `vra7` or `vra8`)* Password for user account. |
| vRA Appliance Port | *(Shown when **vRA Version** is `vra7` or `vra8`)* Enter the port number for this vRA Endpoint. |
| vRA 7.x Tenant | *(Shown when **vRA Version** is `vra7`)* **vRA Tenant Name is case sensitive.** Enter the vRA 7.6 Tenant Name. |
| vRA Cloud API Token | *(Shown when **vRA Version** is `vrac`)* Enter the vRA Cloud API Token. |
| **vRA Endpoint - Settings** | |
| Ignore Certificate Warnings? | Check yes to silently accept the certificate. |
| Verify whether the target hostname matches the names stored inside the server's X.509 certificate | Check yes if the target hostname matches the names stored inside the server's X.509 certificate. |
| Use Proxy? | Check yes if using a proxy. |
| Proxy Host FQDN / IP | *(Shown when **Use Proxy?** is `Yes`)* Enter the proxy host in FQDN or IP address format. |
| Proxy Port | *(Shown when **Use Proxy?** is `Yes`)* Enter the port number for this proxy host. |
| **Create a new OneFuse Endpoint** | |
| Create OneFuse Endpoint? | Select yes if running this workflow for the first time. |
| OneFuse Endpoint Name | Friendly label or name for this OneFuse Endpoint. |
| OneFuse FQDN | Enter the OneFuse instance host in FQDN or IP address format. |
| OneFuse Username | Username with Workspace Admin or Member role. |
| OneFuse Password | Password for user account. |
| OneFuse Port | Enter the port number for this OneFuse Endpoint. |
| Ignore Certificate Warnings? | Check yes to silently accept the certificate. |
| Verify whether the target hostname matches the names stored inside the server's X.509 certificate | Check yes if the target hostname matches the names stored inside the server's X.509 certificate. |
| Use Proxy? | Check yes if using a proxy. |
| Proxy Host FQDN / IP | *(Shown when **Use Proxy?** is `Yes`)* Enter the proxy host in FQDN or IP address format. |
| Proxy Port | *(Shown when **Use Proxy?** is `Yes`)* Enter the port number for this proxy host. |

<div class="alert alert-info" role="alert"><div class="h4 alert-heading" role="heading">Quickly verify vRA and OneFuse Endpoint connections</div>



- Go to: **Library** > **Workflows** > **OneFuse** > **Endpoints**.
- Within the **OneFuse** and **vRA** folders, there is a **Manual** folder.
- Run the respective **Verify [OneFuse|vRA] Endpoint Connection** workflow.
- Verify the workflow ran successfully.

If any failures occur, verify the credentials provided and/or turn on **Verbose Logging** and re-run the workflow(s).
</div>


---

## Managing endpoints

When credentials and/or endpoints are updated, use the workflows below to update endpoints previously configured.

### vRA Endpoint

Only one vRA Endpoint may exist at a given time.

To update the existing vRA Endpoint, run the **OneFuse Configuration** Workflow and select **Update vRA Endpoint**.

- The OneFuse Configuration workflow can run multiple times.

### OneFuse Endpoints

Multiple OneFuse Endpoints may exist at any given time.

- Go to: **Library** > **Workflows** > **OneFuse** > **Endpoints** > **OneFuse**.
- Run the appropriate workflows as desired: **Create OneFuse Endpoint**, **Update OneFuse Endpoint**, and **Delete OneFuse Endpoint**.

---

## Configure timeouts for OneFuse modules

Module timeouts in VMware vRealize Orchestrator allow the user to set a time limit on asynchronous task execution. This type of timeout communicates between vRealize Orchestrator and OneFuse.

1. In the vRealize Automation console, select to open **Orchestrator**.
2. From the left menu, select **Assets** > **Configurations**.
3. From the **Configurations** page, search for **Timeouts** and select to open the configuration.
4. Select the **Variables** tab.
5. Select a **Variable** from the list and edit the **Timeout** value.

   <div class="alert alert-info" role="alert">


   The timeout length for EBS should be greater than the module timeouts to ensure best performance.
   </div>


<div class="alert alert-info" role="alert">


"Other" is the default value if vRO cannot determine an appropriate module for the value.
</div>


---

## Next steps

Start integrating with [OneFuse modules](/docs/onefuse/consume/vmware-aria-automation/aria-automation-8x/modules/).