Parameters list

Complete list of parameters for OneFuse modules in the OneFuse XUI

  5 minute read  

The following parameters need to exist on the CloudBolt Blueprint to ensure the desired OneFuse Modules are called for the resource.

Learn more about parameters for Blueprints, Environments, and Groups.

Ansible Tower

Parameter Name Format Parameter Value Format
OneFuse_AnsibleTowerPolicy_<ExecutionString>_<CustomID>

- Replace <ExecutionString> with an appropriate Trigger Point state
- Replace <CustomID> with a unique, user-defined friendly label.		 <OneFuse Connection Info Name>:<Ansible Tower Policy Name>:<Ansible Tower Host>:<Ansible Tower Limit>

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

It is recommended to insert a required filter for the <Ansible Tower Limit>. When left blank, it will execute an Ansible Tower Job on the entire Ansible Host Inventory. Refer to the example below.

Example parameter:

# Parameter Name (in blue) is separated from the Parameter value (in black) with the first colon (:)

# -- Parameter Value
# <OneFuse Connection Info Name>  is onefuse
# <ServiceNow CMDB Policy Name> is prod

# Example
OneFuse_ServiceNowCmdbPolicy: onefuse:prod

DNS

Parameter Name Format Parameter Value Format
OneFuse_DnsPolicy_Nic<#>

- Replace <#> with a number from 0 to 9, one for each NIC. Default is 0.		 <OneFuse Connection Info Name>:<DNS Policy Name>:<DNS Suffix(es)>

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

Example parameter:

# Parameter Name (in blue) is separated from the Parameter value (in black) with the first colon (:)

# -- Parameter Value
# <OneFuse Connection Info Name>  is onefuse
# <ServiceNow CMDB Policy Name> is prod

# Example
OneFuse_ServiceNowCmdbPolicy: onefuse:prod

IPAM

Parameter Name Format Parameter Value Format
OneFuse_IpamPolicy_Nic<#>

- Replace <#> with a number from 0 to 9, one for each NIC. Default is 0.		 <OneFuse Connection Info Name>:<IPAM Policy Name>

Example parameter:

# Parameter Name (in blue) is separated from the Parameter value (in black) with the first colon (:)

# -- Parameter Value
# <OneFuse Connection Info Name>  is onefuse
# <ServiceNow CMDB Policy Name> is prod

# Example
OneFuse_ServiceNowCmdbPolicy: onefuse:prod

Microsoft Active Directory

Parameter Name Format Parameter Value Format
OneFuse_ADPolicy <OneFuse Connection Info Name>:<Microsoft AD Policy Name>

Example parameter:

# Parameter Name (in blue) is separated from the Parameter value (in black) with the first colon (:)

# -- Parameter Value
# <OneFuse Connection Info Name>  is onefuse
# <ServiceNow CMDB Policy Name> is prod

# Example
OneFuse_ServiceNowCmdbPolicy: onefuse:prod

Naming

Parameter Name Format Parameter Value Format
OneFuse_NamingPolicy <OneFuse Connection Info Name>:<Naming Policy Name>

Example parameter:

# Parameter Name (in blue) is separated from the Parameter value (in black) with the first colon (:)

# -- Parameter Value
# <OneFuse Connection Info Name>  is onefuse
# <OneFuse Naming Policy Name> is global

# Example
OneFuse_NamingPolicy: onefuse:global

Pluggable Modules

Parameter Name Format Parameter Value Format
OneFuse_PluggableModulePolicy_<ExecutionString>_<CustomID>

- Replace <ExecutionString> with an appropriate Trigger Point state
- Replace <CustomID> with a unique, user-defined friendly label.		 <OneFuse Connection Info Name>:<Pluggable Module Policy Name>

Example parameter:

# Parameter Name (in blue) is separated from the Parameter value (in black) with the first colon (:)

# -- Parameter Value
# <OneFuse Connection Info Name>  is onefuse
# <ServiceNow CMDB Policy Name> is prod

# Example
OneFuse_ServiceNowCmdbPolicy: onefuse:prod

Property Toolkit

1. Trigger Property Toolkit

Parameter Name Format Parameter Value Format
OneFuse_PropertyToolkit <OneFuse Connection Info Name>:true

Example parameter:

# Parameter Name (in blue) is separated from the Parameter value (in black) with the first colon (:)

# -- Parameter Value
# <OneFuse Connection Info Name>  is onefuse
# <ServiceNow CMDB Policy Name> is prod

# Example
OneFuse_ServiceNowCmdbPolicy: onefuse:prod

2. Add in additional parameters

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

Parameter Name Format Parameter Value Format
OneFuse_SPS_<CustomID>

- Replace <CustomID> with a unique, user-defined friendly label.		 <OneFuse Property Set Name>

2b. Method to dynamically add in parameter properties

Parameter Name Format Parameter Value Format
OneFuse_CreateProperties_<CustomID>

- Replace <CustomID> with a unique, user-defined friendly label.		 <JSON key:value pairs of Properties>

Property value format for a single property (single JSON object with key:value):

# Property Value Format for Single Property (Single JSON Object with key:value)
# Replace <Property Key Name> and <Property Value>
{"key": "<Property Key Name>", "value": "<Property Value>"}

# Property Value Format for Multiple Properties (Array of JSON Objects with key:value pairs)
# Replace <Property Key Name> and <Property Value>
[{"key": "<Property Key Name>", "value": "<Property Value>"}, {"key": "<Property Key Name>", "value": "<Property Value>"}]

Example parameter:

# Parameter Name (in blue) is separated from the Parameter value (in black) with the first colon (:)

# Method A Example - Add in properties from OneFuse Property Set(s)

# -- Parameter Name
# <CustomID> is App and Env

# -- Parameter Value
# <Property Set Names>: linux and prod
OneFuse_PropertyToolkit: onefuse:true
OneFuse_SPS_App: linux
OneFuse_SPS_Env: prod


# Method B Example - Create Parameters

# -- Parameter Name
# <CustomID> is 001Backup

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

Scripting

Parameter Name Format Parameter Value Format
OneFuse_ScriptingPolicy_<ExecutionString>_<CustomID>

- Replace <ExecutionString> with an appropriate Trigger Point state
- Replace <CustomID> with a unique, user-defined friendly label.		 <OneFuse Connection Info Name>:<Scripting Policy Name>

Example parameter:

# Parameter Name (in blue) is separated from the Parameter value (in black) with the first colon (:)

# -- Parameter Value
# <OneFuse Connection Info Name>  is onefuse
# <ServiceNow CMDB Policy Name> is prod

# Example
OneFuse_ServiceNowCmdbPolicy: onefuse:prod

ServiceNow CMDB

Parameter Name Format Parameter Value Format
OneFuse_ServiceNowCmdbPolicy <OneFuse Connection Info Name>:<ServiceNow CMDB Policy Name>

Example parameter:

# Parameter Name (in blue) is separated from the Parameter value (in black) with the first colon (:)

# -- Parameter Value
# <OneFuse Connection Info Name>  is onefuse
# <ServiceNow CMDB Policy Name> is prod

# Example
OneFuse_ServiceNowCmdbPolicy: onefuse:prod