# Properties list

> Complete list of vRA custom properties for OneFuse modules in vRealize Automation 7.6

---

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

---

The following vRA Properties need to exist on the vRA Blueprint to ensure the desired OneFuse Modules are called for the Deployment.

## General use

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

---

## Ansible Tower

### 1. Trigger vRA EBS for Ansible Tower

| Property name format | Property value |
| --- | --- |
| See options below | `true` |

**Option 1.** Trigger only specific individual EBS state(s):

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


This method is recommended to decrease provision time since it will only run the execute for the states defined. This also offers a quicker way to turn on/off the Policy for testing.
</div>


- `OneFuse_AnsibleTowerPolicy_Trigger_<EBSExecutionString>`
- Replace `<EBSExecutionString>` with an appropriate [Event Broker Subscription](/docs/onefuse/consume/vmware-aria-automation/vrealize-automation-76/modules/event-broker-subscriptions/).

**OR:**

**Option 2.** Trigger all EBS state(s):

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


This overrides the individual EBS Execution triggers if they are present (see above).
</div>


- `OneFuse_AnsibleTowerPolicy_Trigger`

**Example vRA Custom Properties:**

```yaml
# Option 1: trigger for a specific EBS execution state
OneFuse_AnsibleTowerPolicy_Trigger_ProvisionedPreLate: true

# OR

# Option 2: global trigger for Ansible Tower
OneFuse_AnsibleTowerPolicy_Trigger: true
```

### 2. Call Ansible Tower Policy for a vRA EBS

| Property name format | Property value format |
| --- | --- |
| `OneFuse_AnsibleTowerPolicy_<EBSExecutionString>_<CustomID>` | `<OneFuse Endpoint Name>:<Ansible Tower Policy Name>:<Ansible Tower Host>:<Ansible Tower Limit>` |

- Replace `<EBSExecutionString>` with an appropriate [Event Broker Subscription](/docs/onefuse/consume/vmware-aria-automation/vrealize-automation-76/modules/event-broker-subscriptions/).
- Replace `<CustomID>` with a unique, user-defined friendly label.
- *(Optional)* `<Ansible Tower Host>` is a specific Hostname (FQDN) or IP Address of the Host to add to the Ansible Tower Inventory.
- *(Optional)* `<Ansible Tower Limit>` is a valid Limit definition to pass to Ansible Tower. This can be a specific Hostname (FQDN) or IP Address or any valid Limit pattern. Resource: [Patterns: targeting hosts and groups](https://docs.ansible.com/ansible/latest/user_guide/intro_patterns.html).

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


It is recommended to insert a [required filter](/docs/onefuse/templating/filters/#required) for the `<Ansible Tower Limit>`. When left blank, it will execute an Ansible Tower Job on the entire Ansible Host Inventory. Refer to example below.
</div>


**Example vRA Custom Properties:**

```yaml
# <EBSExecutionString> is replaced with ProvisionedPreLate
# <CustomID> is replaced with 001Apache
# <OneFuse Endpoint Name> is onefuse
# <Ansible Tower Policy Name> is linux_Apache

OneFuse_AnsibleTowerPolicy_ProvisionedPreLate_001Apache: onefuse:linux_Apache
```

---

## DNS

### Call a DNS Policy for a specific NIC

| Property name format | Property value format |
| --- | --- |
| `OneFuse_DnsPolicy_Nic<#>` | `<OneFuse Endpoint Name>:<DNS Policy Name>:<DNS Suffix(es)>` |

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

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


Values for all three parameters must be passed in. When listing multiple DNS Suffixes, comma separate the values without any spaces.
</div>


**Example vRA Custom Properties:**

```yaml
# <#> is replaced with 0
# <OneFuse Endpoint Name> is onefuse
# <DNS Policy Name> is DnsPolicyName
# <DNS Suffix(es)> is domain.local

OneFuse_DnsPolicy_Nic0: onefuse:DnsPolicyName:domain.local
```

### Optional: DNS registration for additional IPs

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

| Property name format | Property value format |
| --- | --- |
| `OneFuse_DnsPolicy_AdditionalTrigger` | `true` |
| `OneFuse_DnsPolicy_Additional_<niclabel>` | `<OneFuse Endpoint Name>:<DNS Policy Name>:<DNS Suffix(es)>` |

For `OneFuse_DnsPolicy_Additional_<niclabel>`:

- Replace `<niclabel>` with a value that is appended to the hostname.
- `OneFuse_DnsPolicy_AdditionalTrigger` is the required Trigger Property to enable DNS for additional NICs.

Name behavior:

- **Without additional Naming Property:** Default behavior of the `<niclabel>` is to get appended to the hostname after a hyphen (-). To override this behavior, modify the field **Hostname Override** on the OneFuse DNS 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:**

```yaml
# <niclabel> is replaced with nic1
# <OneFuse Endpoint Name> is onefuse
# <DNS Policy Name> is DnsPolicyName
# <DNS Suffix(es)> is domain.local

OneFuse_DnsPolicy_AdditionalTrigger: true
OneFuse_DnsPolicy_Additional_nic1: onefuse:DnsPolicyName:domain.local
```

### Optional: IP address not using OneFuse IPAM module

Use the following optional vRA Property in the event IP addresses are being obtained not using OneFuse IPAM and the user wants to register those IP addresses in DNS.

| Property name format | Property value format |
| --- | --- |
| `OneFuse_IP_Additional_<niclabel>` | `<IP Address>` |

- Match the `<niclabel>` here with the value set for the `<niclabel>` for the property `OneFuse_DnsPolicy_Additional_`.
- Templatable. Additional IP Address to register into DNS.

---

## IPAM

### 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:**

```yaml
OneFuse_IpamPolicy_Nic0: onefuse:IpamPolicyName
```

### 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>` |

For `OneFuse_IpamPolicy_Additional_<niclabel>`:

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

Name behavior:

- **Without additional Naming Property:** Default behavior of the `<niclabel>` is to get appended to the hostname after a hyphen (-). To override this behavior, modify the field **Hostname Override** 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:**

```yaml
OneFuse_IpamPolicy_AdditionalTrigger: true
OneFuse_IpamPolicy_Additional_nic1: onefuse:IpamPolicyName
```

---

## Microsoft Active Directory

### Call a Microsoft Active Directory Policy

| Property name format | Property value format |
| --- | --- |
| `OneFuse_ADPolicy` | `<OneFuse Endpoint Name>:<Microsoft AD Policy Name>` |

**Example vRA Custom Property:**

```yaml
OneFuse_ADPolicy: onefuse:AdPolicyName
```

---

## Naming

### Call a Naming Policy

| Property name format | Property value format |
| --- | --- |
| `OneFuse_NamingPolicy` | `<OneFuse Endpoint Name>:<Naming Policy Name>` |

**Example vRA Custom Property:**

```yaml
OneFuse_NamingPolicy: onefuse:NamingPolicyName
```

### Optional: request additional names

Available since build `2022.0.0 Build 16976327`.

Support for requesting Additional Naming objects from one VM (for example, naming installed components in the VM or naming the additional IPAM and DNS objects being requested alongside them). The additional Names are reserved and stored in both OneFuse and vRA Machine Properties for future reference in vRA lifecycles.

| Property name format | Property value format |
| --- | --- |
| `OneFuse_NamingPolicy_Additional_<CustomID>` | `<OneFuse Endpoint Name>:<Naming Policy Name>` |

- Replace `<CustomID>` with a unique, user-defined friendly label.
- To name the additional IPAM and/or DNS objects being requested with the VM, replace `<CustomID>` with the matching value for `<niclabel>` defined for IPAM and/or DNS Additional properties.

**Example vRA Custom Property:**

```yaml
# <CustomID> is replaced with nic1 (to match the niclabel defined for IPAM/DNS Additional)
OneFuse_NamingPolicy_Additional_nic1: onefuse:NamingPolicyName
```

---

## Pluggable module

### 1. Trigger vRA EBS for Pluggable Module

| Property name format | Property value |
| --- | --- |
| See options below | `true` |

**Option 1.** Trigger only specific individual EBS state(s):

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


This method is recommended to decrease provision time since it will only run the execute for the states defined. This also offers a quicker way to turn on/off the Policy for testing.
</div>


- `OneFuse_PluggableModulePolicy_Trigger_<EBSExecutionString>`
- Replace `<EBSExecutionString>` with an appropriate [Event Broker Subscription](/docs/onefuse/consume/vmware-aria-automation/vrealize-automation-76/modules/event-broker-subscriptions/).

**OR:**

**Option 2.** Trigger all EBS state(s):

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


This overrides the individual EBS Execution triggers if they are present (see above).
</div>


- `OneFuse_PluggableModulePolicy_Trigger`

**Example vRA Custom Properties:**

```yaml
# Option 1: trigger for a specific EBS execution state
OneFuse_PluggableModulePolicy_Trigger_ProvisionedPreLate: true

# OR

# Option 2: global trigger for Pluggable Module
OneFuse_PluggableModulePolicy_Trigger: true
```

### 2. Call Pluggable Module Policy for a vRA EBS

| Property name format | Property value format |
| --- | --- |
| `OneFuse_PluggableModulePolicy_<EBSExecutionString>_<CustomID>` | `<OneFuse Endpoint Name>:<Pluggable Module Policy Name>:<Pluggable Module Label>` |

- Replace `<EBSExecutionString>` with an appropriate [Event Broker Subscription](/docs/onefuse/consume/vmware-aria-automation/vrealize-automation-76/modules/event-broker-subscriptions/).
- Replace `<CustomID>` with a unique, user-defined friendly label.
- `<Pluggable Module Label>` is a friendly label for the Pluggable Module. Format is alphanumeric characters only (`A-Z`, `a-z`, `0-9`); no spaces, underscores, hyphens, or special characters. Does not need to match the actual Pluggable Module's name.

**Example vRA Custom Properties:**

```yaml
# <EBSExecutionString> is replaced with ProvisionedPreLate
# <CustomID> is replaced with 001MyPlugin
# <OneFuse Endpoint Name> is onefuse
# <Pluggable Module Policy Name> is MyPMPolicyName
# <Pluggable Module Label> is MyPlugin

OneFuse_PluggableModulePolicy_ProvisionedPreLate_001MyPlugin: onefuse:MyPMPolicyName:MyPlugin
```

---

## Property Toolkit

### 1. Trigger Property Toolkit

| Property name format | Property value format |
| --- | --- |
| `OneFuse_PropertyToolkit` | `<OneFuse Endpoint Name>:true` |

**Example vRA Custom Properties:**

```yaml
OneFuse_PropertyToolkit: onefuse:true
```

### 2. Add in additional vRA Properties

#### 2a. Method to add in properties from a OneFuse Property Set

| Property name format | Property value format |
| --- | --- |
| `OneFuse_SPS_<CustomID>` | `<OneFuse Property Set Name>` |

- Replace `<CustomID>` with a unique, user-defined friendly label.

#### 2b. Method to dynamically add in vRA properties

| Property name format | Property value format |
| --- | --- |
| `OneFuse_CreateProperties_<CustomID>` | `<JSON key:value pairs of Properties>` |

- Replace `<CustomID>` with a unique, user-defined friendly label.

**Example vRA Custom Properties:**

```yaml
# Method A Example - Add in properties from OneFuse Property Set(s)
# !!Note: Starting in OneFuse v1.4, Static Property Sets was renamed to Property Sets.  Backwards compatibility exists.

# -- Property Name Format
# <CustomID> is App and Env

# -- Property Value Format
# <Property Set Names>: linux and prod
OneFuse_SPS_App: linux
OneFuse_SPS_Env: prod


# Method B Example - Create vRA Properties

# -- Property Name Format
# <CustomID> is 001Backup

# -- Property Value Format
# <Property Name>  is Backup-VM
# <Property Value> is the provisioned resource hostname
OneFuse_CreateProperties_001Backup: {"key":"Backup-VM", "value":"{{ OneFuse_VmNic0.hostname }}"}
```

---

## Scripting

### 1. Trigger EBS for Scripting

| Property name format | Property value |
| --- | --- |
| See options below | `true` |

**Option 1.** Trigger only specific individual EBS state(s):

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


This method is recommended to decrease provision time since it will only run the execute for the states defined. This also offers a quicker way to turn on/off the Policy for testing.
</div>


- `OneFuse_ScriptingPolicy_Trigger_<EBSExecutionString>`
- Replace `<EBSExecutionString>` with an appropriate [Event Broker Subscription](/docs/onefuse/consume/vmware-aria-automation/vrealize-automation-76/modules/event-broker-subscriptions/).

**OR:**

**Option 2.** Trigger all EBS state(s):

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


This overrides the individual EBS Execution triggers if they are present (see above).
</div>


- `OneFuse_ScriptingPolicy_Trigger`

**Example vRA Custom Properties:**

```yaml
# Option 1: trigger for a specific EBS execution state
OneFuse_ScriptingPolicy_Trigger_ProvisionedPreLate: true

# OR

# Option 2: global trigger for Scripting
OneFuse_ScriptingPolicy_Trigger: true
```

### 2. Call Scripting Policy for an EBS

| Property name format | Property value format |
| --- | --- |
| `OneFuse_ScriptingPolicy_<EBSExecutionString>_<CustomID>` | `<OneFuse Endpoint Name>:<Scripting Policy Name>` |

- Replace `<EBSExecutionString>` with an appropriate [Event Broker Subscription](/docs/onefuse/consume/vmware-aria-automation/vrealize-automation-76/modules/event-broker-subscriptions/).
- Replace `<CustomID>` with a unique, user-defined friendly label.

**Example vRA Custom Properties:**

```yaml
# <EBSExecutionString> is replaced with ProvisionedPreLate
# <CustomID> is replaced with 001Apache
# <OneFuse Endpoint Name> is onefuse
# <Scripting Policy Name> is linux_Apache

OneFuse_ScriptingPolicy_ProvisionedPreLate_001Apache: onefuse:linux_Apache
```

---

## ServiceNow CMDB

### Call a ServiceNow CMDB Policy

| Property name format | Property value format |
| --- | --- |
| `OneFuse_ServiceNowCmdbPolicy` | `<OneFuse Endpoint Name>:<ServiceNow CMDB Policy Name>` |

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


`OneFuse_ServiceNowCmdbPolicy` is a **required** vRA Property for ServiceNow CMDB.
</div>


### Optionally, call additional ServiceNow CMDB Policies

| Property name format | Property value format |
| --- | --- |
| `OneFuse_ServiceNowCmdbPolicy_<CustomID>` | `<OneFuse Endpoint Name>:<ServiceNow CMDB Policy Name>` |

- Replace `<CustomID>` with a unique, user-defined friendly label.

**Example vRA Custom Properties:**

```yaml
# Execute 2 OneFuse ServiceNow CMDB Policies
# <CustomID> is replaced with 001Apache
# <OneFuse Endpoint Name> is onefuse
# <ServiceNow CMDB Policy Name> is prod and linux_Apache

OneFuse_ServiceNowCmdbPolicy: onefuse:prod
OneFuse_ServiceNowCmdbPolicy_001Apache: onefuse:linux_Apache
```