mirror of https://github.com/freeipa/ansible-freeipa.git synced 2026-03-26 21:33:05 +00:00

Files

Thomas Woerner 65937ed8c3 module README files: Drop extra module header in Variables section

The Variables and also the Return Variables sections contained an extra
header with the module name. This is only needed if there are more than
one module in the README.

2021-12-23 15:25:46 +01:00

1.9 KiB

Raw Blame History

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.8+

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

1.9 KiB Raw Blame History