Pluggable modules

To learn more about this OneFuse feature, refer to Pluggable modules.

Prerequisites

1. Configure OneFuse Property Set(s) and OneFuse Module Policies.
2. Run OneFuse Configuration per vRA Tenant.
3. Review the OneFuse Modules overview for vRealize Automation 7.6.
4. Create a new vRA Blueprint (if none exist) or determine which existing Blueprint(s) will utilize this OneFuse Module.
   • Resource: Designing Machine Blueprints

Configure the Blueprint

1. Know the name of the OneFuse Endpoint created via OneFuse Configuration.
2. Determine which OneFuse Pluggable Module Policies to run for this Blueprint.
3. Determine when to run each OneFuse Pluggable Module Policy for the deployment provisioning lifecycle with vRA’s EBS'.
4. Update the Blueprint to add in necessary vRA Properties to invoke OneFuse Pluggable Module Policies.
5. Deploy the Blueprint to provision a vRA Deployment and run provisioning scenarios for the Pluggable Module Policy.
6. Destroy the vRA Deployment to run deprovision for the Pluggable Module Policy, if any.

Update the Blueprint

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

Add in necessary vRA Properties

The following vRA Properties need to be added Blueprint’s Properties > Custom Properties section under the Resource(s) of interest.

1. Trigger vRA EBS for Pluggable Module:

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 vRA Custom Properties (in key: value pair format)

# -- Property Name
# <EBSExecutionString> is replaced with ProvisionedPreLate
# <CustomID> is replaced with 001F5

# -- Property Value
# <OneFuse Endpoint Name>  is onefuse
# <Pluggable Module Policy Name> is prod
# <Pluggable Module Name> is F5

OneFuse_PluggableModulePolicy_Trigger_ProvisionedPreLate: true
OneFuse_PluggableModulePolicy_ProvisionedPreLate_001F5: onefuse:prod:F5

2. Call Pluggable Module Policy for a vRA EBS:

• 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, or special characters. Does not need to match the actual Pluggable Module’s name.

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

# Example CustomID with sorting

001Apache
002WebApp
003BackupClient

Pluggable Module EBS execution states

EBSExecutionString refers to a specific vRA EBS State for the OneFuse Module’s policy to execute on.

Replace <EBSExecutionString> variable with one of the following EBS Execution State, using the table below as a resource:

List of vRA EBS Trigger Properties:

# -- Property Name
# <EBSExecutionString> is replaced with ProvisionedPreLate
# <CustomID> is replaced with 001F5

# -- Property Value
# <OneFuse Endpoint Name>  is onefuse
# <Pluggable Module Policy Name> is prod
# <Pluggable Module Name> is F5

OneFuse_PluggableModulePolicy_Trigger_ProvisionedPreLate: true
OneFuse_PluggableModulePolicy_ProvisionedPreLate_001F5: onefuse:prod:F5

CustomID

CustomID refers to a user specified text string to identify and can set an order of precedence for execution when calling multiple Policies for the OneFuse Module in the same vRA EBS State.

Replace <CustomID> variable with a unique custom identifier:

• Format is alphanumeric characters only A-Z, a-z, 0-9. No spaces, underscores, hyphens nor special characters.
• Must be unique across all EBS Execution Strings for the OneFuse Module on the specific VM for the Blueprint/Cloud Template.
• Is reusable either between different VM components of the Blueprint/Cloud Template canvas or between different Blueprints/Cloud Templates.

# -- Property Name
# <EBSExecutionString> is replaced with ProvisionedPreLate
# <CustomID> is replaced with 001F5

# -- Property Value
# <OneFuse Endpoint Name>  is onefuse
# <Pluggable Module Policy Name> is prod
# <Pluggable Module Name> is F5

OneFuse_PluggableModulePolicy_Trigger_ProvisionedPreLate: true
OneFuse_PluggableModulePolicy_ProvisionedPreLate_001F5: onefuse:prod:F5

Specify sorting with CustomID:

When executing multiple different OneFuse Module’s Policies in the same EBS State, prefix the <CustomID> with a numeric value (for example 001, 002, etc).

The <CustomID> is sorted prior to executing the OneFuse module’s policies.

# Example CustomID with sorting

001Apache
002WebApp
003BackupClient

Additional helpful vRA Properties

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

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

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

Custom Property placement methods

Influence Custom Properties for Resources using different methods:

Learn more: Understanding Custom Properties Precedence

Compiled example vRA Custom Properties

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

# -- Property Name
# <EBSExecutionString> is replaced with ProvisionedPreLate
# <CustomID> is replaced with 001F5

# -- Property Value
# <OneFuse Endpoint Name>  is onefuse
# <Pluggable Module Policy Name> is prod
# <Pluggable Module Name> is F5

OneFuse_PluggableModulePolicy_Trigger_ProvisionedPreLate: true
OneFuse_PluggableModulePolicy_ProvisionedPreLate_001F5: onefuse:prod:F5

Provision

Deploy a Blueprint with OneFuse Pluggable Module Policy configured. Pluggable Module’s provisioning scenarios will run.

Outputs

The following vRA Properties will have the generated OneFuse Pluggable Module Managed Object as a JSON string on the Deployment.

Deprovision

Destroy an existing deployment with OneFuse Pluggable Module Policy configured. The Pluggable Module Policy’s deprovisioning scenarios (if any) will run.

vRA EBS

List of vRA EBS Trigger Properties:

# -- Property Name
# <EBSExecutionString> is replaced with ProvisionedPreLate
# <CustomID> is replaced with 001F5

# -- Property Value
# <OneFuse Endpoint Name>  is onefuse
# <Pluggable Module Policy Name> is prod
# <Pluggable Module Name> is F5

OneFuse_PluggableModulePolicy_Trigger_ProvisionedPreLate: true
OneFuse_PluggableModulePolicy_ProvisionedPreLate_001F5: onefuse:prod:F5

Troubleshooting

Troubleshoot in vRealize Orchestrator.

1. Log in to vRealize Orchestrator.
2. Turn on Verbose Logging and try again to see additional log messages in vRO Workflows:
   • Select Library > Workflows from the left menu
   • Go to: OneFuse > Pluggable Module > vRA7 to find corresponding workflow runs and view logs
   • Optionally, run the workflows in the Manual folder to manually test
3. Optionally, configure timeouts for EBS and/or Configure timeouts for OneFuse modules.

Additional resources:

• Review Troubleshooting in OneFuse
• Review VMware troubleshooting resources