# Microsoft Active Directory

> Configure and use the OneFuse Microsoft Active Directory module with VMware Aria Automation 8x/Cloud

---

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

---

To learn more about this OneFuse module, refer to [Microsoft Active Directory](/docs/onefuse/configure/modules/microsoft-active-directory/).

## Prerequisites

1. Configure OneFuse [Property Set(s)](/docs/onefuse/templating/property-sets/) and OneFuse Module Policies.
2. Run OneFuse Configuration per Cloud Assembly Organization.
3. Review an overview on OneFuse Modules with Aria Automation 8.1+/Cloud.
4. Create a new **Cloud Template** (if none exist) or determine which existing Cloud Template(s) will utilize this OneFuse Module.
   - Resource: [Designing your vRealize Automation Cloud Assembly deployments](https://docs.vmware.com/en/vRealize-Automation/8.1/Using-and-Managing-Cloud-Assembly/GUID-BFD33C28-ADCC-43F4-BE43-CC92B62FBE2E.html)

## Steps

1. **Know the name of the OneFuse Endpoint** created via [OneFuse Configuration](/docs/onefuse/consume/vmware-aria-automation/aria-automation-8x/installation-and-setup/#run-the-onefuse-configuration-workflow).
2. **Determine which OneFuse Microsoft Active Directory Policy to run** for this Cloud Template.
3. **Update the Cloud Template** to add in the necessary vRA Property and/or add in the Custom Resource to invoke a OneFuse Microsoft Active Directory Policy.
4. **Deploy the Cloud Template** to provision a vRA Deployment and create a computer account in Microsoft Active Directory.
5. **Destroy the vRA Deployment** to remove the computer account from Microsoft Active Directory.

### Update the Cloud Template

1. Log in to vRA > **Cloud Assembly**
2. Select the **Design** tab from the top menu bar
3. Select the **Cloud Templates** tab from the left menu
4. **Edit the Cloud Template** and perform the below:

#### Option 1: Add in necessary vRA property

The following vRA Property needs to be added to the Cloud Template's **Code** section under the **Resource(s)** of interest.

| Property Name Format | Property Value Format |
| --- | --- |
| `OneFuse_ADPolicy` | `'<OneFuse Endpoint Name>:<Microsoft AD Policy Name>'` |

**Example YAML:**

```yaml
# Execute OneFuse Microsoft Active Directory Policy

# -- Property Value
# <OneFuse Endpoint Name>  is onefuse
# <Microsoft Active Directory Policy Name> is global

name: Simple Example
resources:
  Cloud_Machine_1:
    type: Cloud.Machine
    properties:
      image: CentOS7
      flavor: small
      count: 1
      OneFuse_ADPolicy: 'onefuse:global'
```

##### Additional helpful vRA properties

| Property | Value Format |
| --- | --- |
| `OneFuse_Tracking_Id` | A GUID (globally unique identifier) that links OneFuse Policy Executions and the resulting Managed Objects together for a given resource on a deployment. The first OneFuse Module Policy execution will populate this vRA property and it will be passed into other OneFuse Modules automatically. When a Tracking ID is not provided, a Tracking ID gets generated for the Policy execution. Learn more about OneFuse [Tracking ID](/docs/onefuse/concepts/tracking-id/). |

| Property Format | Example |
| --- | --- |
| `OneFuse_VmNic<#>.<value>`: replace `<#>` with a number from `0` to `9`, one for each NIC; replace `<value>` with an appropriate key: `dnsSuffix`, `fqdn`, `gateway`, `hostname`, `ipAddress`, `macAddress`, `netmask`, `network`, `subnet`, `target` | For most use cases, NIC 0 is the primary network interface and the target hostname is a Fully Qualified Domain Name (FQDN). Examples: `OneFuse_VmNic0.dnsSuffix`, `OneFuse_VmNic0.fqdn`, `OneFuse_VmNic0.hostname`, `OneFuse_VmNic0.ipAddress`, `OneFuse_VmNic0.target`: when DNS Suffix is provided, will be the FQDN; otherwise, will be the hostname (without domain). |

---

#### Option 2: Add in Custom Resource for OneFuse Microsoft Active Directory

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


Review [OneFuse custom resources](/docs/onefuse/consume/vmware-aria-automation/aria-automation-8x/modules/custom-resources/) before using this method.
</div>


- From the **Resource Types** navigation, expand **Custom Resources**
- Drag-and-drop `OneFuse:AD_v1` to the canvas
- In the **Code** tab, provide values for the following *properties*:

| Parameter Name | Required? | Notes |
| --- | --- | --- |
| `endpointName` | Required | OneFuse Endpoint Name in vRA. Refer to [Managing endpoints](/docs/onefuse/consume/vmware-aria-automation/aria-automation-8x/installation-and-setup/#managing-endpoints). |
| `policyName` | Required | OneFuse Module Policy Name (string). |
| `templateProperties` | Optional | Additional properties that are referenced within the Policy. JSON format. |
| `trackingId` | Optional | Tracking ID (string) to link multiple OneFuse Policy Executions and resulting OneFuse Managed Objects together. If none is passed, one gets generated by OneFuse for that specific Policy Execution. |

*Microsoft Active Directory specific parameters:*

| Parameter Name | Required? | Notes |
| --- | --- | --- |
| `name` | Required | Computer Account Name |

### Provision

Deploy a Cloud Template with OneFuse Microsoft Active Directory Policy configured. A computer account will register in Microsoft Active Directory.

#### Outputs

The following vRA Properties will exist on the Deployment.

| Property Name | Property Value |
| --- | --- |
| `OneFuse_AD` | JSON string of OneFuse Microsoft Active Directory Managed Object |
| `OneFuse_AD_State` | `build` or `final` depending on the state. |

### Deprovision

Destroy an existing deployment with OneFuse Microsoft Active Directory Policy configured. The computer account will be removed from Microsoft Active Directory.

## vRA EBS

| EBS Execution | Subscription State | EBS Priority | EBS Name |
| --- | --- | --- | --- |
| **Provision** | | | |
| ComputeProvisionPre | Early | 1500 | OneFuse_Provision_AD |
| ComputeProvisionPost | Early | 1500 | OneFuse_Move_OU_AD |
| **Deprovision** | | | |
| ComputePostRemoval | - | 1200 | OneFuse_De-Provision_AD |

## Troubleshooting

Troubleshoot in vRealize Orchestrator.

1. Log in to **vRealize Orchestrator**.
2. Turn on [Verbose Logging](/docs/onefuse/consume/vmware-aria-automation/aria-automation-8x/modules/#troubleshooting-verbose-logging) and try again to see additional log messages in vRO Workflows:
   1. Select **Library** > **Workflows** from the left menu
   2. Go to: **OneFuse** > **AD** > **vRA8** to find corresponding workflow runs and view logs
   3. Optionally, run the workflows in the **Manual** folder to manually test
3. Optionally, [configure timeouts for EBS](/docs/onefuse/consume/vmware-aria-automation/aria-automation-8x/modules/event-broker-subscriptions/#configure-ebs-timeouts) and/or [Configure timeouts for OneFuse modules](/docs/onefuse/consume/vmware-aria-automation/aria-automation-8x/installation-and-setup/#configure-timeouts-for-onefuse-modules).

**Additional Resources:**

- Review [Troubleshooting in OneFuse](/docs/onefuse/getting-started/troubleshooting/)
- Review [VMware troubleshooting resources](/docs/onefuse/consume/vmware-aria-automation/aria-automation-8x/getting-started/#troubleshooting)
