Files
ansible-freeipa/README-location.md
Rafael Guterres Jeffman 7126dec0f3 README-*: Bump minimum Ansible supported version to 2.15
ansible-freeipa roles do not work with Ansible 2.8 anymore, so the
minimum supported version is changed to 2.15, the oldest supported
Ansible version as of today.

This patch includes the change to the version number in the collection
and all plugin README files. The collection README was also update to
remove text that related only to previous Ansible versions.
2024-06-28 10:51:44 -03:00

1.9 KiB

Location module

Description

The location module allows to ensure presence and absence of locations.

Features

  • Location management

Supported FreeIPA Versions

FreeIPA versions 4.4.0 and up are supported by the ipalocation module.

Requirements

Controller

  • Ansible version: 2.15+

Node

  • Supported FreeIPA version (see above)

Usage

Example inventory file

[ipaserver]
ipaserver.test.local

Example playbook to make sure location "my_location1" is present:

---
- name: Playbook to manage IPA location.
  hosts: ipaserver
  become: yes

  tasks:
  - ipalocation:
      ipaadmin_password: SomeADMINpassword
      name: my_location1
      description: My Location 1

Example playbook to make sure location "my_location1" is absent:

---
- name: Playbook to manage IPA location.
  hosts: ipaserver
  become: yes

  tasks:
  - ipalocation:
      ipaadmin_password: SomeADMINpassword
      name: my_location1
      state: absent

Variables

Variable Description Required
ipaadmin_principal The admin principal is a string and defaults to admin no
ipaadmin_password The admin password is a string and is required if there is no admin ticket available on the node no
ipaapi_context The context in which the module will execute. Executing in a server context is preferred. If not provided context will be determined by the execution environment. Valid values are server and client. no
ipaapi_ldap_cache Use LDAP cache for IPA connection. The bool setting defaults to yes. (bool) no
name | idnsname The list of location name strings. yes
description The IPA location string false
state The state to ensure. It can be one of present, absent, default: present. no

Authors

Thomas Woerner