community.general.omapi_host – Setup OMAPI hosts.

Note

This plugin is part of the community.general collection (version 3.8.1).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.omapi_host.

Synopsis

  • Manage OMAPI hosts into compatible DHCPd servers

Requirements

The below requirements are needed on the host that executes this module.

  • pypureomapi

Parameters

Parameter Choices/Defaults Comments
ddns
boolean
    Choices:
  • no ←
  • yes
Enable dynamic DNS updates for this host.
host
string
Default:
"localhost"
Sets OMAPI server host to interact with.
hostname
string
Sets the host lease hostname (mandatory if state=present).

aliases: name
ip
string
Sets the lease host IP address.
key
string / required
Sets the TSIG key content for authenticating against OMAPI server.
key_name
string / required
Sets the TSIG key name for authenticating against OMAPI server.
macaddr
string / required
Sets the lease host MAC address.
port
integer
Default:
7911
Sets the OMAPI server port to interact with.
state
string / required
    Choices:
  • absent
  • present
Create or remove OMAPI host.
statements
list / elements=string
Default:
[]
Attach a list of OMAPI DHCP statements with host lease (without ending semicolon).

Examples

- name: Add a host using OMAPI
  community.general.omapi_host:
    key_name: defomapi
    key: +bFQtBCta6j2vWkjPkNFtgA==
    host: 10.98.4.55
    macaddr: 44:dd:ab:dd:11:44
    name: server01
    ip: 192.168.88.99
    ddns: yes
    statements:
    - filename "pxelinux.0"
    - next-server 1.1.1.1
    state: present

- name: Remove a host using OMAPI
  community.general.omapi_host:
    key_name: defomapi
    key: +bFQtBCta6j2vWkjPkNFtgA==
    host: 10.1.1.1
    macaddr: 00:66:ab:dd:11:44
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
lease
complex
success
dictionary containing host information
hardware-address
string
success
MAC address

Sample:
00:11:22:33:44:55
hardware-type
integer
success
hardware type, generally '1'

Sample:
1
ip-address
string
success
IP address, if there is.

Sample:
192.168.1.5
name
string
success
hostname

Sample:
mydesktop


Authors

  • Loic Blot (@nerzhul)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/omapi_host_module.html