# IPAM

> Configure and use the OneFuse IPAM module with VMware vRealize Automation 7.6

---

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

---

To learn more about this OneFuse module, refer to [IPAM](/docs/onefuse/configure/modules/ipam/).

## Prerequisites

1. Configure OneFuse [Property Set(s)](/docs/onefuse/templating/property-sets/) and OneFuse Module Policies.
1. Run [OneFuse Configuration](/docs/onefuse/consume/vmware-aria-automation/vrealize-automation-76/installation-and-setup/#run-the-onefuse-configuration-workflow) per vRA Tenant.
1. Review the [OneFuse Modules](/docs/onefuse/consume/vmware-aria-automation/vrealize-automation-76/modules/) overview for vRealize Automation 7.6.
1. Create a new **vRA Blueprint** (if none exist) or determine which existing Blueprint(s) will utilize this OneFuse Module.
   - Resource: [Designing Machine Blueprints](https://docs.vmware.com/en/vRealize-Automation/7.6/com.vmware.vra.prepare.use.doc/GUID-62A92480-A122-4C89-A4E3-F8F6EC26C19E.html#GUID-62A92480-A122-4C89-A4E3-F8F6EC26C19E)

## Configure the Blueprint

1. **Know the name of the OneFuse Endpoint** created via [OneFuse Configuration](/docs/onefuse/consume/vmware-aria-automation/vrealize-automation-76/installation-and-setup/#run-the-onefuse-configuration-workflow).
1. **Determine _which_ OneFuse IPAM Policies to run** for this Blueprint.
1. **Update the Blueprint** to add in the necessary vRA Properties to invoke a OneFuse IPAM Policy.
1. **Deploy the Blueprint** to provision a vRA Deployment and reserve IP Address(es).
1. **Destroy the vRA Deployment** to remove the IP Address(es) for the destroyed resource(s).

### Update the Blueprint

1. Log in to the **vRA Tenant**
1. Select the **Design** tab from the top menu bar
1. Select the **Blueprints** tab from the left menu
1. **Edit the Blueprint** and perform the below:

#### Add in necessary vRA property

The following vRA Property needs to be added to the Blueprint's **Properties** > **Custom Properties** section under the **Resource(s)** of interest.

**Call an IPAM Policy for a specific NIC:**

| Property name format | Property value format |
| --- | --- |
| `OneFuse_IpamPolicy_Nic<#>` | `<OneFuse Endpoint Name>:<IPAM Policy Name>` |

- Replace `<#>` with a number from `0` to `9`, one for each NIC. Default is `0`.

**Example vRA Custom Properties** (in `key: value` pair format):

```yaml
# Execute OneFuse IPAM Policy

# -- Property Value
# <OneFuse Endpoint Name>  is onefuse
# <IPAM Policy Name> is prod

OneFuse_IpamPolicy_Nic0: onefuse:prod
```

**_Optional._ IPAM Multi-IP support:**

Support for multiple IP Addresses on a single interface. The IP Addresses are reserved and stored in both OneFuse and vRA Machine Properties for future reference in vRA lifecycles.

| Property name format | Property value format |
| --- | --- |
| `OneFuse_IpamPolicy_AdditionalTrigger` | `true` |
| `OneFuse_IpamPolicy_Additional_<niclabel>` | `<OneFuse Endpoint Name>:<IPAM Policy Name>` |

- `OneFuse_IpamPolicy_AdditionalTrigger` is the required trigger property to enable IPAM for additional NICs.
- Replace `<niclabel>` with a value that is appended to the hostname.

Name behavior:

- **Without additional Naming Property:** Default behavior appends `<niclabel>` to the hostname after a hyphen (-). To override, modify the **Hostname Override** field on the OneFuse IPAM Policy.
- **With additional Naming Property:** If an Additional Naming Policy is defined that matches this value, the name generated from the Naming Policy will be used.

**Example vRA Custom Properties** (in `key: value` pair format):

```yaml
# -- Property Name
# <niclabel> is xyz

# -- Property Value
# <OneFuse Endpoint Name>  is onefuse
# <OneFuse IPAM Policy Name> is prod

# Example
OneFuse_IpamPolicy_AdditionalTrigger: true
OneFuse_IpamPolicy_Additional_xyz: onefuse:prod
```

##### Additional helpful vRA properties

**Purpose: Relate OneFuse Policy executions from different OneFuse Modules together with a Tracking ID.**

| 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. Learn more about OneFuse [Tracking ID](/docs/onefuse/concepts/tracking-id/). |

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


When a Tracking ID is not provided, a Tracking ID gets generated for the Policy execution.
</div>


**Purpose: Reference a specific NIC's values to get hostname, IP address, etc.**

| Property format | Example |
| --- | --- |
| `OneFuse_VmNic<#>.<value>` | See examples below |

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`

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


For most use cases, NIC 0 is the primary network interface and the target hostname is a Fully Qualified Domain Name (FQDN).
</div>


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).

##### Custom property placement methods

Influence **Custom Properties** for Resources using different methods:

| Method | Description |
| --- | --- |
| Basic | Add a Custom Property to the vSphere machine on the blueprint canvas, or to the blueprint layer itself. |
| Advanced 1 | Add a Custom Property to an existing or new vRA [Property Group](https://docs.vmware.com/en/vRealize-Automation/7.6/com.vmware.vra.prepare.use.doc/GUID-73D5DB94-3B5D-410A-8E9C-CF42D4ADF6F0.html). |
| Advanced 2 | Add a Custom Property to a more global level, such as vCenter Endpoint (to run on all deployments) and/or a Reservation (to run on all deployments using that reservation), etc. |

Learn more: [Understanding Custom Properties Precedence](https://docs.vmware.com/en/vRealize-Automation/7.6/com.vmware.vra.prepare.use.doc/GUID-F45F332E-1003-45BC-BC05-0EA2FDE1B31F.html)

### Compiled example vRA custom properties

Review example below of vRA Custom Properties (in `key: value` pair format) for this OneFuse Module.

```yaml
# Execute OneFuse IPAM Policy

# -- Property Value
# <OneFuse Endpoint Name>  is onefuse
# <IPAM Policy Name> is prod

OneFuse_IpamPolicy_Nic0: onefuse:prod
```

### Provision

Deploy a Blueprint with OneFuse IPAM Policies configured. IP Address(es) will get reserved in the desired IPAM Provider.

#### Outputs

The following vRA Properties will exist on the Deployment.

| Property name | Property value |
| --- | --- |
| `OneFuse_Ipam_Nic<#>` | _JSON string of OneFuse IPAM Managed Object_ |
| `OneFuse_Ipam_Additional<niclabel>` | _JSON string of OneFuse IPAM Managed Object_ |

- `<#>` is a number `0`-`9`.
- `<niclabel>` is the user-specified value (if configured to register additional IPs).

### Deprovision

Destroy an existing deployment with OneFuse IPAM Policies configured. The IP Address(es) will be removed from the desired IPAM Provider.

## vRA EBS

| EBS Execution | Subscription State | EBS Priority | EBS Name |
| --- | --- | --- | --- |
| **Provision** | | | |
| BuildingPre | Early | 1200 | OneFuse_Provision_IPAM |
| **Deprovision** | | | |
| MachineDisposingPost | - | 1400 | OneFuse_De-Provision_IPAM |

## Troubleshooting

Troubleshoot in vRealize Orchestrator.

1. Log in to **vRealize Orchestrator**.
1. Turn on [Verbose Logging](/docs/onefuse/consume/vmware-aria-automation/vrealize-automation-76/modules/#troubleshooting-verbose-logging) and try again to see additional log messages in vRO Workflows:
   - Select **Library** > **Workflows** from the left menu
   - Go to: **OneFuse** > **IPAM** > **vRA7** to find corresponding workflow runs and view logs
   - Optionally, run the workflows in the **Manual** folder to manually test
1. Optionally, [configure timeouts for EBS](/docs/onefuse/consume/vmware-aria-automation/vrealize-automation-76/modules/event-broker-subscriptions/#configure-ebs-timeouts) and/or [Configure timeouts for OneFuse modules](/docs/onefuse/consume/vmware-aria-automation/vrealize-automation-76/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/vrealize-automation-76/getting-started/#troubleshooting)
