Properties list

Reference for all Aria Automation 8.1+ vRA Cloud Template properties used to invoke OneFuse module policies across DNS, IPAM, Naming, Microsoft Active Directory, Scripting, ServiceNow CMDB, VM Tagging, Ansible Tower, Pluggable Module, and vRealize Automation modules

The following vRA Properties need to exist on the vRA Cloud Template 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.

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

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

  • OneFuse_AnsibleTowerPolicy_Trigger_<EBSExecutionString>
  • Replace <EBSExecutionString> with an appropriate Event Broker Subscription.

OR:

Option 2. Trigger all EBS state(s):

  • OneFuse_AnsibleTowerPolicy_Trigger

Example YAML:

# Option 1
# Set Ansible Tower triggers for one or more specific vRA EBS execution states
OneFuse_AnsibleTowerPolicy_Trigger_ComputeAllocationPreEarly: 'true'
OneFuse_AnsibleTowerPolicy_Trigger_ComputeProvisionPostLate: '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.
  • 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. See Patterns: targeting hosts and groups.

Example YAML:

# -- Property Name
# <EBSExecutionString> is replaced with ComputeProvisionPostLate
# <CustomID> is replaced with 001Apache

# -- Property Value
# <OneFuse Endpoint Name> is onefuse
# <Ansible Tower Policy Name> is linux_Apache
# <Ansible Tower Host> and <Ansible Tower Limit> are the VM's FQDN

# Example
OneFuse_AnsibleTowerPolicy_ComputeProvisionPostLate_001Apache: 'onefuse:linux_Apache:{{ OneFuse_VmNic0.fqdn }}:{{ OneFuse_VmNic0.fqdn | required("Limit is not defined") }}'

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.

When listing multiple DNS Suffixes, comma separate the values without any spaces.

Example 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.
  • 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.

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.

When listing multiple DNS Suffixes, comma separate the values without any spaces.

Example 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 that will be used in the event IP addresses are getting 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 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.
  • 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.

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 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 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 YAML:

OneFuse_NamingPolicy: 'onefuse:NamingPolicyName'

Optional: request additional names 2022.0.0 Build 17166779

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

  • OneFuse_PluggableModulePolicy_Trigger_<EBSExecutionString>
  • Replace <EBSExecutionString> with an appropriate Event Broker Subscription.

OR:

Option 2. Trigger all EBS state(s):

  • OneFuse_PluggableModulePolicy_Trigger

Example YAML:

# Option 1
# Set Pluggable Module triggers for one or more specific vRA EBS execution states
OneFuse_PluggableModulePolicy_Trigger_ComputeProvisionPostLate: '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.
  • 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, nor special characters.
    • Does not need to match the actual Pluggable Module’s name.

Example YAML:

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

OneFuse_PluggableModulePolicy_ComputeProvisionPostLate_001MyPlugin: 'onefuse:MyPMPolicyName:MyPlugin'

Property Toolkit

1. Trigger Property Toolkit and/or VM Tagging

Property name format Property value format
OneFuse_PropertyToolkit '<OneFuse Endpoint Name>:true'

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

Example YAML:

# <CustomID> is replaced with 001MyProps
OneFuse_SPS_001MyProps: 'MyPropertySetName'

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 YAML:

# <CustomID> is replaced with 001MyProps
OneFuse_CreateProperties_001MyProps: '{"MyPropertyKey": "MyPropertyValue"}'

Scripting

1. Trigger EBS for Scripting

Property name format Property value
See options below 'true'

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

  • OneFuse_ScriptingPolicy_Trigger_<EBSExecutionString>
  • Replace <EBSExecutionString> with an appropriate Event Broker Subscription.

OR:

Option 2. Trigger all EBS state(s):

  • OneFuse_ScriptingPolicy_Trigger

Example YAML:

# Option 1
# Set Scripting triggers for one or more specific vRA EBS execution states
OneFuse_ScriptingPolicy_Trigger_ComputeProvisionPostLate: '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.
  • Replace <CustomID> with a unique, user-defined friendly label.

Example YAML:

# <EBSExecutionString> is replaced with ComputeProvisionPostLate
# <CustomID> is replaced with 001MyScript
# <OneFuse Endpoint Name> is onefuse
# <Scripting Policy Name> is MyScriptingPolicyName

OneFuse_ScriptingPolicy_ComputeProvisionPostLate_001MyScript: 'onefuse:MyScriptingPolicyName'

ServiceNow CMDB

Call a ServiceNow CMDB Policy

Property name format Property value format
OneFuse_ServiceNowCmdbPolicy '<OneFuse Endpoint Name>:<ServiceNow CMDB Policy Name>'

Example YAML:

OneFuse_ServiceNowCmdbPolicy: 'onefuse:CmdbPolicyName'

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 YAML:

# <CustomID> is replaced with 001Secondary
OneFuse_ServiceNowCmdbPolicy_001Secondary: 'onefuse:CmdbPolicyName'

VM Tagging

1. Trigger Property Toolkit and/or VM Tagging

Property name format Property value
OneFuse_PropertyToolkit '<OneFuse Endpoint Name>:true'

2. Add in tags

Property name format Property value format
OneFuse_CreateTags_<CustomID> '<JSON key:value pairs of Tags>'
  • Replace <CustomID> with a unique, user-defined friendly label.

Example YAML:

# -- Property Name
# <CustomID> is replaced with 001Backup

# -- Property Value
# <Category Name>  is Backup
# <Tag Name> is the provisioned resource hostname

# Example
OneFuse_CreateTags_001Backup: '{"key":"Backup", "value":"{{ OneFuse_VmNic0.hostname }}"}'

vRealize Automation

1. Trigger vRA EBS for vRA Module

Property name format Property value
See options below 'true'

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

OR:

Option 2. Trigger all EBS state(s):

  • OneFuse_VraPolicy_Trigger

Example YAML:

# Option 1
# Set vRA Module triggers for one or more specific vRA EBS execution states
OneFuse_VraPolicy_Trigger_ComputeAllocationPreEarly: 'true'
OneFuse_VraPolicy_Trigger_ComputeProvisionPostLate: 'true'

# OR

# Option 2
# Global trigger for vRA Module
OneFuse_VraPolicy_Trigger: 'true'

2. Call vRA Module Policy for a vRA EBS

Property name format Property value format
OneFuse_VraPolicy_<EBSExecutionString>_<CustomID> '<OneFuse Endpoint Name>:<vRA Policy Name>:<vRA Deployment Name>'
  • Replace <EBSExecutionString> with an appropriate Event Broker Subscription.
  • Replace <CustomID> with a unique, user-defined friendly label.

Example YAML:

# -- Property Name
# <EBSExecutionString> is replaced with ComputeProvisionPostLate
# <CustomID> is replaced with 001Apache

# -- Property Value
# <OneFuse Endpoint Name>  is onefuse
# <vRA Policy Name> is linux_ApacheDeployment

# Example
OneFuse_VraPolicy_ComputeProvisionPostLate_001Apache: 'onefuse:linux_ApacheDeployment'