Naming

Configure and use the OneFuse Naming module with Red Hat Ansible

2 minute read

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

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

present

Generate a name for a resource.

Sample Play

- name: OneFuse Naming - present
  hosts: localhost
  gather_facts: false
  vars:
    policy_name: <REPLACEME_with_OneFusePolicyName>
  tasks:
  - name: Generate unique name
    onefuse:
      module: naming
      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: "Set Stats"
    set_stats:
        data:
          onefuse_name: '{{ onefuse_name }}'
          tracking_id: '{{ tracking_id }}'

Parameter references

The following defines the function of each Naming 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

Delete a name.

Sample Play

- name: OneFuse Naming - absent
  hosts: '{{ ansible_hosts }}'
  gather_facts: false
  tasks:
  - name: Delete a generated name
    onefuse:
      module: naming
      state: absent
      object_name: '{{ onefuse_name.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).