community.general.ipa_user module – Manage FreeIPA users
Note
This module is part of the community.general collection (version 5.8.3).
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
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.general.ipa_user
.
Synopsis
Add, modify and delete user within IPA server.
Requirements
The below requirements are needed on the host that executes this module.
base64
hashlib
Parameters
Parameter |
Comments |
---|---|
Display name. |
|
Posix Group ID. |
|
First name. |
|
Default home directory of the user. |
|
IP or hostname of IPA server. If the value is not specified in the task, the value of environment variable If both the environment variable The relevant entry needed in FreeIPA is the ‘ipa-ca’ entry. If neither the DNS entry, nor the environment Environment variable fallback mechanism is added in Ansible 2.5. Default: |
|
Password of administrative user. If the value is not specified in the task, the value of environment variable Note that if the ‘urllib_gssapi’ library is available, it is possible to use GSSAPI to authenticate to FreeIPA. If the environment variable If the environment variable If GSSAPI is not available, the usage of ‘ipa_pass’ is required. Environment variable fallback mechanism is added in Ansible 2.5. |
|
Port of FreeIPA / IPA server. If the value is not specified in the task, the value of environment variable If both the environment variable Environment variable fallback mechanism is added in Ansible 2.5. Default: |
|
Protocol used by IPA server. If the value is not specified in the task, the value of environment variable If both the environment variable Environment variable fallback mechanism is added in Ansible 2.5. Choices:
|
|
Specifies idle timeout (in seconds) for the connection. For bulk operations, you may want to increase this in order to avoid timeout from IPA server. If the value is not specified in the task, the value of environment variable If both the environment variable Default: |
|
Administrative account used on IPA server. If the value is not specified in the task, the value of environment variable If both the environment variable Environment variable fallback mechanism is added in Ansible 2.5. Default: |
|
Date at which the user password will expire. In the format YYYYMMddHHmmss. e.g. 20180121182022 will expire on 21 January 2018 at 18:20:22. |
|
Login shell. |
|
List of mail addresses assigned to the user. If an empty list is passed all assigned email addresses will be deleted. If None is passed email addresses will not be checked or changed. |
|
Password for a user. Will not be set for an existing user unless update_password=always, which is the default. |
|
Surname. |
|
List of public SSH key. If an empty list is passed all assigned public keys will be deleted. If None is passed SSH public keys will not be checked or changed. |
|
State to ensure. Choices:
|
|
List of telephone numbers assigned to the user. If an empty list is passed all assigned telephone numbers will be deleted. If None is passed telephone numbers will not be checked or changed. |
|
Title. |
|
uid of the user. |
|
Account Settings UID/Posix User ID number. |
|
Set password for a user. Choices:
|
|
The authentication type to use for the user. Choices:
|
|
This only applies if If set to This should only set to Choices:
|
Examples
- name: Ensure pinky is present and always reset password
community.general.ipa_user:
name: pinky
state: present
krbpasswordexpiration: 20200119235959
givenname: Pinky
sn: Acme
mail:
- [email protected]
telephonenumber:
- '+555123456'
sshpubkey:
- ssh-rsa ....
- ssh-dsa ....
uidnumber: '1001'
gidnumber: '100'
homedirectory: /home/pinky
ipa_host: ipa.example.com
ipa_user: admin
ipa_pass: topsecret
- name: Ensure brain is absent
community.general.ipa_user:
name: brain
state: absent
ipa_host: ipa.example.com
ipa_user: admin
ipa_pass: topsecret
- name: Ensure pinky is present but don't reset password if already exists
community.general.ipa_user:
name: pinky
state: present
givenname: Pinky
sn: Acme
password: zounds
ipa_host: ipa.example.com
ipa_user: admin
ipa_pass: topsecret
update_password: on_create
- name: Ensure pinky is present and using one time password and RADIUS authentication
community.general.ipa_user:
name: pinky
state: present
userauthtype:
- otp
- radius
ipa_host: ipa.example.com
ipa_user: admin
ipa_pass: topsecret
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
User as returned by IPA API Returned: always |
Collection links
Issue Tracker Repository (Sources) Submit a bug report Request a feature Communication