Modules on CloudBolt Documentation

Templating and Property Toolkit

Mon, 01 Jan 0001 00:00:00 +0000

To learn more about this OneFuse feature, refer to Templating guide and Property Toolkit features.

Introduction

The OneFuse Property Toolkit (PTK) is the Swiss army knife of the OneFuse Platform.

PTK can be used to simplify configurations, define business logic as configuration, build simple logic or tackle the most complex problems. At face value, the PTK is meta-data that can be called upon offering simple name value pairs that can be used as a reference for decision making. In its most powerful form, it can contain logic, decision trees, platform abstractions, and much more.

Ansible Tower

Mon, 01 Jan 0001 00:00:00 +0000

To learn more about this OneFuse module, refer to Ansible Tower.

Prerequisites

Configure OneFuse Manager
Review an overview on OneFuse Modules with OneFuse Python Module

Provision

Run provisioning job template(s) configured on the OneFuse Ansible Tower Policy for a resource.

Method

#Run the following in the Python Console
#Assumes OneFuse Manager is instantiated to 'ofm' variable

ofm.provision_ansible_tower('<policy_name>', <template_properties>, '<hosts>', '<limit>', '<tracking_id>')

Parameter references

The following defines the function of each Ansible Tower specific parameter.

Parameter name	Required?	Notes
`policy_name`	Required	OneFuse Module Policy Name (string).
`template_properties`	Optional	Additional properties that are referenced within the Policy. Python dict format.
`tracking_id`	Optional	Tracking ID (string) to link multiple OneFuse Policy Executions and resulting OneFuse Managed Objects together. If none is passed, one gets generated by OneFuse for that specific Policy Execution.

OneFuse Python Module Tracking ID methods:

DNS

Mon, 01 Jan 0001 00:00:00 +0000

To learn more about this OneFuse module, refer to DNS.

Prerequisites

Configure OneFuse Manager
Review an overview on OneFuse Modules with OneFuse Python Module

Provision

Method

#Run the following in the Python Console
#Assumes OneFuse Manager is instantiated to 'ofm' variable

ofm.provision_dns('<policy_name>', <template_properties>, '<name>', '<value>', '["<zones>"]', '<tracking_id>')

Parameter references

The following defines the function of each DNS specific Parameters.

Parameter Name	Required?	Notes
`policy_name`	Required	OneFuse Module Policy Name (string).
`template_properties`	Optional	Additional properties that are referenced within the Policy. Python dict format.
`tracking_id`	Optional	Tracking ID (string) to link multiple OneFuse Policy Executions and resulting OneFuse Managed Objects together. If none is passed, one gets generated by OneFuse for that specific Policy Execution. See Tracking ID methods below.

Tracking ID methods

Method Name	Notes
`create_tracking_id()`	Generate a unique Tracking ID to link OneFuse Policy Executions and the resulting Managed Objects together.
`get_tracking_id_from_mo('<Path to OneFuse Managed Object>')`	Get the Tracking ID from a OneFuse Managed Object.
`add_tracking_id_to_headers('<Tracking ID>')`	Add Tracking ID into request headers. When making custom requests to OneFuse instead of using OneFuse Python Module methods provided.

Learn more about OneFuse Tracking ID.

IPAM

Mon, 01 Jan 0001 00:00:00 +0000

To learn more about this OneFuse module, refer to IPAM.

Prerequisites

Configure OneFuse Manager
Review an overview on OneFuse Modules with OneFuse Python Module

Provision

Reserve IP Addresses for a resource.

Method

#Run the following in the Python Console
#Assumes OneFuse Manager is instantiated to 'ofm' variable

ofm.provision_ipam('<policy_name>', <template_properties>, '<hostname>', '<tracking_id>')

Parameter references

The following defines the function of each IPAM specific parameter.

Parameter Name	Required?	Notes
`policy_name`	Required	OneFuse Module Policy Name (string).
`template_properties`	Optional	Additional properties that are referenced within the Policy. Python dict format.
`tracking_id`	Optional	Tracking ID (string) to link multiple OneFuse Policy Executions and resulting OneFuse Managed Objects together. If none is passed, one gets generated by OneFuse for that specific Policy Execution.

OneFuse Python Module Tracking ID methods:

Microsoft Active Directory

Mon, 01 Jan 0001 00:00:00 +0000

To learn more about this OneFuse module, refer to Microsoft Active Directory.

Prerequisites

Configure OneFuse Manager
Review an overview on OneFuse Modules with OneFuse Python Module

Provision

Method

#Run the following in the Python Console
#Assumes OneFuse Manager is instantiated to 'ofm' variable

ofm.provision_ad('<policy_name>', <template_properties>, '<name>', '<tracking_id>')

Parameter references

The following defines the function of each Microsoft Active Directory specific Parameters.

Parameter Name	Required?	Notes
`policy_name`	Required	OneFuse Module Policy Name (string).
`template_properties`	Optional	Additional properties that are referenced within the Policy. Python dict format.
`tracking_id`	Optional	Tracking ID (string) to link multiple OneFuse Policy Executions and resulting OneFuse Managed Objects together. If none is passed, one gets generated by OneFuse for that specific Policy Execution. (See OneFuse Python Module Tracking ID Methods below.)

OneFuse Python Module Tracking ID Methods:

Naming

Mon, 01 Jan 0001 00:00:00 +0000

To learn more about this OneFuse module, refer to Naming.

Prerequisites

Configure OneFuse Manager
Review an overview on OneFuse Modules with OneFuse Python Module

Provision

Generate a name for a resource.

Method

#Run the following in the Python Console
#Assumes OneFuse Manager is instantiated to 'ofm' variable

ofm.provision_naming('<policy_name>', <template_properties>, '<tracking_id>')

Parameter references

The following defines the function of each Naming specific parameters.

Parameter Name	Required?	Notes
`policy_name`	Required	OneFuse Module Policy Name (string).
`template_properties`	Optional	Additional properties that are referenced within the Policy. Python dict format.
`tracking_id`	Optional	Tracking ID (string) to link multiple OneFuse Policy Executions and resulting OneFuse Managed Objects together. If none is passed, one gets generated by OneFuse for that specific Policy Execution. See the OneFuse Python Module Tracking ID methods below.

OneFuse Python Module Tracking ID methods:

Pluggable modules

Mon, 01 Jan 0001 00:00:00 +0000

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

Prerequisites

Configure OneFuse Manager
Review an overview on OneFuse Modules with OneFuse Python Module

Provision

Run provisioning scenarios configured on the OneFuse Pluggable Module Policy for a resource.

Method

#Run the following in the Python Console
#Assumes OneFuse Manager is instantiated to 'ofm' variable

ofm.provision_module('<policy_name>', <template_properties>, '<tracking_id>')

Parameter references

The following defines the function of each Pluggable Module specific parameters.

Parameter Name	Required?	Notes
`policy_name`	Required	OneFuse Module Policy Name (string).
`template_properties`	Optional	Additional properties that are referenced within the Policy. Python dict format.
`tracking_id`	Optional	Tracking ID (string) to link multiple OneFuse Policy Executions and resulting OneFuse Managed Objects together. If none is passed, one gets generated by OneFuse for that specific Policy Execution. See the tracking ID methods below.

OneFuse Python Module Tracking ID methods

Method Name	Notes
`create_tracking_id()`	Generate a unique Tracking ID to link OneFuse Policy Executions and the resulting Managed Objects together.
`get_tracking_id_from_mo('<Path to OneFuse Managed Object>')`	Get the Tracking ID from a OneFuse Managed Object.
`add_tracking_id_to_headers('<Tracking ID>')`	Add Tracking ID into request headers. When making custom requests to OneFuse instead of using OneFuse Python Module methods provided.

Learn more about OneFuse Tracking ID.

Scripting

Mon, 01 Jan 0001 00:00:00 +0000

To learn more about this OneFuse module, refer to Scripting.

Prerequisites

Configure OneFuse Manager
Review an overview on OneFuse Modules with OneFuse Python Module

Provision

Run Provisioning Script(s) configured on the OneFuse Scripting Policy for a resource.

Method

#Run the following in the Python Console
#Assumes OneFuse Manager is instantiated to 'ofm' variable

ofm.provision_scripting('<policy_name>', <template_properties>, '<tracking_id>')

Parameter references

The following defines the function of each Scripting specific Parameters.

Parameter Name	Required?	Notes
`policy_name`	Required	OneFuse Module Policy Name (string).
`template_properties`	Optional	Additional properties that are referenced within the Policy. Python dict format.
`tracking_id`	Optional	Tracking ID (string) to link multiple OneFuse Policy Executions and resulting OneFuse Managed Objects together. If none is passed, one gets generated by OneFuse for that specific Policy Execution. See the OneFuse Python Module Tracking ID Methods table below.

OneFuse Python Module Tracking ID Methods:

ServiceNow CMDB

Mon, 01 Jan 0001 00:00:00 +0000

To learn more about this OneFuse module, refer to ServiceNow CMDB.

Prerequisites

Configure OneFuse Manager
Review an overview on OneFuse Modules with OneFuse Python Module

Provision

Run Provisioning IRE Template(s) configured on the OneFuse ServiceNow CMDB Policy for a resource.

Method

#Run the following in the Python Console
#Assumes OneFuse Manager is instantiated to 'ofm' variable

ofm.provision_cmdb('<policy_name>', <template_properties>, '<tracking_id>')

Parameter references

The following defines the function of each ServiceNow CMDB specific Parameters.

Parameter Name	Required?	Notes
`policy_name`	Required	OneFuse Module Policy Name (string).
`template_properties`	Optional	Additional properties that are referenced within the Policy. Python dict format.
`tracking_id`	Optional	Tracking ID (string) to link multiple OneFuse Policy Executions and resulting OneFuse Managed Objects together. If none is passed, one gets generated by OneFuse for that specific Policy Execution. See OneFuse Python Module Tracking ID Methods below.

OneFuse Python Module Tracking ID Methods:

VMware Aria Automation

Mon, 01 Jan 0001 00:00:00 +0000

To learn more about this OneFuse module, refer to Aria Automation.

Prerequisites

Configure OneFuse Manager
Review an overview on OneFuse Modules with OneFuse Python Module

Provision

Deploy a VMware Aria Automation 8x/Cloud Cloud Template.

Method

#Run the following in the Python Console
#Assumes OneFuse Manager is instantiated to 'ofm' variable

ofm.provision_vra('<policy_name>', <template_properties>, '<deployment_name>', '<tracking_id>')

Parameter references

The following defines the function of each Aria Automation specific Parameters.

Parameter Name	Required?	Notes
`policy_name`	Required	OneFuse Module Policy Name (string).
`template_properties`	Optional	Additional properties that are referenced within the Policy. Python dict format.
`tracking_id`	Optional	Tracking ID (string) to link multiple OneFuse Policy Executions and resulting OneFuse Managed Objects together. If none is passed, one gets generated by OneFuse for that specific Policy Execution. See tracking ID methods below.

OneFuse Python Module Tracking ID methods: