ipa_host - Manage FreeIPA host

New in version 2.3.

Synopsis
Parameters
Examples
Return Values
Status
- Author

Synopsis

Add, modify and delete an IPA host using IPA API

Parameters

Parameter	Choices/Defaults	Comments
description		A description of this host.
force		Force host name even if not in DNS.
fqdn required		Full qualified domain name. Can not be changed as it is the unique identifier. aliases: name
ip_address		Add the host to DNS with this IP address.
ipa_host	Default: ipa.example.com	IP or hostname of IPA server. If the value is not specified in the task, the value of environment variable `IPA_HOST` will be used instead. If both the environment variable `IPA_HOST` and the value are not specified in the task, then default value is set. Environment variable fallback mechanism is added in version 2.5.
ipa_pass required		Password of administrative user. If the value is not specified in the task, the value of environment variable `IPA_PASS` will be used instead. If both the environment variable `IPA_PASS` and the value are not specified in the task, then default value is set. Environment variable fallback mechanism is added in version 2.5.
ipa_port	Default: 443	Port of FreeIPA / IPA server. If the value is not specified in the task, the value of environment variable `IPA_PORT` will be used instead. If both the environment variable `IPA_PORT` and the value are not specified in the task, then default value is set. Environment variable fallback mechanism is added in version 2.5.
ipa_prot	Choices: http https ←	Protocol used by IPA server. If the value is not specified in the task, the value of environment variable `IPA_PROT` will be used instead. If both the environment variable `IPA_PROT` and the value are not specified in the task, then default value is set. Environment variable fallback mechanism is added in version 2.5.
ipa_user	Default: admin	Administrative account used on IPA server. If the value is not specified in the task, the value of environment variable `IPA_USER` will be used instead. If both the environment variable `IPA_USER` and the value are not specified in the task, then default value is set. Environment variable fallback mechanism is added in version 2.5.
mac_address		List of Hardware MAC address(es) off this host. If option is omitted MAC addresses will not be checked or changed. If an empty list is passed all assigned MAC addresses will be removed. MAC addresses that are already assigned but not passed will be removed. aliases: macaddress
ns_hardware_platform		Host hardware platform (e.g. "Lenovo T61") aliases: nshardwareplatform
ns_host_location		Host location (e.g. "Lab 2") aliases: nshostlocation
ns_os_version		Host operating system and version (e.g. "Fedora 9") aliases: nsosversion
random_password (added in 2.5)	Choices: no ← yes	Generate a random password to be used in bulk enrollment
state	Choices: present ← absent disabled	State to ensure
update_dns (added in 2.5)	Default: no	If set `"True"` with state as `"absent"`, then removes DNS records of the host managed by FreeIPA DNS. This option has no effect for states other than "absent".
user_certificate		List of Base-64 encoded server certificates. If option is omitted certificates will not be checked or changed. If an empty list is passed all assigned certificates will be removed. Certificates already assigned but not passed will be removed. aliases: usercertificate
validate_certs	Default: yes	This only applies if `ipa_prot` is https. If set to `no`, the SSL certificates will not be validated. This should only set to `no` used on personally controlled sites using self-signed certificates.

Examples

# Ensure host is present
- ipa_host:
    name: host01.example.com
    description: Example host
    ip_address: 192.168.0.123
    ns_host_location: Lab
    ns_os_version: CentOS 7
    ns_hardware_platform: Lenovo T61
    mac_address:
    - "08:00:27:E3:B1:2D"
    - "52:54:00:BD:97:1E"
    state: present
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret

# Generate a random password for bulk enrolment
- ipa_host:
    name: host01.example.com
    description: Example host
    ip_address: 192.168.0.123
    state: present
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret
    validate_certs: False
    random_password: True

# Ensure host is disabled
- ipa_host:
    name: host01.example.com
    state: disabled
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret

# Ensure that all user certificates are removed
- ipa_host:
    name: host01.example.com
    user_certificate: []
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret

# Ensure host is absent
- ipa_host:
    name: host01.example.com
    state: absent
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret

# Ensure host and its DNS record is absent
- ipa_host:
    name: host01.example.com
    state: absent
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret
    update_dns: True

Return Values

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

Key	Returned	Description
host dict	always	Host as returned by IPA API.
host_diff list	if check mode and a difference is found	List of options that differ and would be changed

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

Thomas Krahn (@Nosmoht)

Hint

If you notice any issues in this documentation you can edit this document to improve it.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/ipa_host_module.html