Pluggable modules

Configure and use OneFuse Pluggable Modules with Red Hat Ansible

2 minute read

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

Prerequisites

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

Ansible OneFuse Module name

Ansible OneFuse Module name for this OneFuse Module is: pluggable

present

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

Sample play

- name: OneFuse Pluggable Module - present
  hosts: localhost
  gather_facts: false
  vars:
    policy_name: <REPLACEME_with_OneFusePolicyName>
  tasks:
  - name: Run Pluggable Module Provisioning scenario(s)
    onefuse:
      module: pluggable
      state: present
      policy_name: '{{ policy_name }}'
      template_properties: {}
      tracking_id: '{{ tracking_id  | default(omit) }}'
    delegate_to: localhost
    register: output
  - name: Output Results
    debug:
      msg: '{{ output }}'
  - name: "Pass Pluggable Module Outputs to workflow"
    set_stats:
        data:
         onefuse_pluggable_module: '{{ onefuse_pluggable }}'
         tracking_id: '{{ tracking_id }}'

Parameter references

The following defines the function of each Pluggable Module specific Task Parameters for onefuse.

Parameter Name	Required?	Notes
`module`	Required	OneFuse Module Name (string). (Refer to Module names for OneFuse modules.)
`state`	Required	`present` for provision, or the appropriate “update” state for the OneFuse Module.
`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.

absent

Run Deprovisioning scenarios, if configured on the OneFuse Pluggable Module Policy, for a resource.

Sample play

- name: OneFuse Pluggable Module - absent
  hosts: '{{ ansible_hosts }}'
  gather_facts: false
  tasks:
  - name: Run Pluggable Module Deprovisioning scenario(s)
    onefuse:
      module: pluggable
      state: absent
      object_name: '{{ onefuse_pluggable.id | default(omit) }}'
    delegate_to: localhost
    register: output
  - name: Output Results
    debug:
      msg: '{{ output }}'

Parameter references

The following defines the function of the Task Parameters for onefuse.

Parameter Name	Required?	Notes
`module`	Required	OneFuse Module Name (string). (Refer to Module names for OneFuse modules.)
`state`	Required	`absent` for deprovision.
`object_name`	Required	OneFuse Managed Object ID (string).