mirror of
https://github.com/freeipa/ansible-freeipa.git
synced 2026-06-21 16:24:32 +00:00
1440fb39b2
Update location README file and add tests for executing plugin with
`ipaapi_context` set to `client`.
A new test playbook can be found at:
tests/location/test_location_client_context.yml
The new test file can be executed in a FreeIPA client host that is
not a server. In this case, it should be defined in the `ipaclients`
group, in the inventory file.
94 lines
1.8 KiB
Markdown
94 lines
1.8 KiB
Markdown
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
|
|
|
|
```ini
|
|
[ipaserver]
|
|
ipaserver.test.local
|
|
```
|
|
|
|
|
|
Example playbook to make sure location "my_location1" is present:
|
|
|
|
```yaml
|
|
---
|
|
- 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:
|
|
|
|
```yaml
|
|
---
|
|
- name: Playbook to manage IPA location.
|
|
hosts: ipaserver
|
|
become: yes
|
|
|
|
tasks:
|
|
- ipalocation:
|
|
ipaadmin_password: SomeADMINpassword
|
|
name: my_location1
|
|
state: absent
|
|
```
|
|
|
|
|
|
Variables
|
|
---------
|
|
|
|
ipalocation
|
|
-------
|
|
|
|
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
|
|
`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
|