# IPAM

> Configure and use the OneFuse IPAM module with Red Hat Ansible

---

Site [llms.txt](/llms.txt)

---

To learn more about this OneFuse module, refer to [IPAM](/docs/onefuse/configure/modules/ipam/).

## Prerequisites

1. [Configure OneFuse Manager](/docs/onefuse/consume/red-hat-ansible/getting-started/#configure-onefuse-manager)
1. Review an overview on [OneFuse Modules](/docs/onefuse/consume/red-hat-ansible/modules/) with OneFuse Ansible Module

## Ansible OneFuse Module name

- Ansible OneFuse Module name for this OneFuse Module is: `ipam`

## present

Reserve IP Addresses for a resource.

### Sample Play

```yaml
- name: OneFuse IPAM - present
  hosts: localhost
  gather_facts: false
  vars:
    policy_name: <REPLACEME_with_OneFusePolicyName>
    name: <REPLACEME_with_hostname> #{{ onefuse_name.name }}
  tasks:
  - name: Reserve IP Address
    onefuse:
      module: ipam
      state: present
      policy_name: '{{ policy_name }}'
      name: '{{ name }}'
      template_properties: {}
      tracking_id: '{{ tracking_id | default(omit) }}'
    register: output
  - name: Output Results
    debug:
      msg: '{{ output }}'
  - name: "Pass IPAM Outputs to workflow"
    set_stats:
        data:
         onefuse_ipam: '{{ onefuse_ipam }}'
         tracking_id: '{{ tracking_id }}'
```

### Parameter references

The following defines the function of each IPAM specific Task Parameters for `onefuse`.

| Parameter Name | Required? | Notes |
| --- | --- | --- |
| `module` | Required | OneFuse Module Name (string). *(Refer to [Module names for OneFuse modules](/docs/onefuse/consume/red-hat-ansible/modules/#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](https://www.w3schools.com/python/python_dictionaries.asp) 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. |

**IPAM specific parameters:**

| Parameter Name | Required? | Notes |
| --- | --- | --- |
| `name` | Required | Hostname for the IP Address |

## absent

Release a reserved IP Address for a resource.

### Sample Play

```yaml
- name: OneFuse IPAM - absent
  hosts: '{{ ansible_hosts }}'
  gather_facts: false
  tasks:
  - name: Release IP Address
    onefuse:
      module: ipam
      state: absent
      object_name: '{{ onefuse_ipam.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](/docs/onefuse/consume/red-hat-ansible/modules/#module-names-for-onefuse-modules).)* |
| `state` | Required | `absent` for deprovision |
| `object_name` | Required | OneFuse Managed Object ID (string). |