ansible / ansible.builtin / v2.4.2.0-1 / module / ipa_role Manage FreeIPA role | "added in version" 2.3 of ansible.builtin" Authors: Thomas Krahn (@Nosmoht) preview | supported by communityansible.builtin.ipa_role (v2.4.2.0-1) — module
pip
Install with pip install ansible==2.4.2.0.post1
Add, modify and delete a role within FreeIPA server using FreeIPA API
# Ensure role is present - ipa_role: name: dba description: Database Administrators state: present user: - pinky - brain ipa_host: ipa.example.com ipa_user: admin ipa_pass: topsecret
# Ensure role with certain details - ipa_role: name: another-role description: Just another role group: - editors host: - host01.example.com hostgroup: - hostgroup01 privilege: - Group Administrators - User Administrators service: - service01
# Ensure role is absent - ipa_role: name: dba state: absent ipa_host: ipa.example.com ipa_user: admin ipa_pass: topsecret
cn: aliases: - name description: - Role name. - Can not be changed as it is the unique identifier. required: true host: description: - List of host names to assign. - If an empty list is passed all assigned hosts will be unassigned from the role. - If option is omitted hosts will not be checked or changed. - If option is passed all assigned hosts that are not passed will be unassigned from the role. required: false user: description: - List of user names to assign. - If an empty list is passed all assigned users will be removed from the role. - If option is omitted users will not be checked or changed. required: false group: description: - List of group names assign to this role. - If an empty list is passed all assigned groups will be unassigned from the role. - If option is omitted groups will not be checked or changed. - If option is passed all assigned groups that are not passed will be unassigned from the role. state: choices: - present - absent default: present description: State to ensure required: false service: description: - List of service names to assign. - If an empty list is passed all assigned services will be removed from the role. - If option is omitted services will not be checked or changed. - If option is passed all assigned services that are not passed will be removed from the role. required: false ipa_host: default: ipa.example.com description: IP or hostname of IPA server required: false ipa_pass: description: Password of administrative user required: true ipa_port: default: 443 description: Port of IPA server required: false ipa_prot: choices: - http - https default: https description: Protocol used by IPA server required: false ipa_user: default: admin description: Administrative account used on IPA server required: false hostgroup: description: - List of host group names to assign. - If an empty list is passed all assigned host groups will be removed from the role. - If option is omitted host groups will not be checked or changed. - If option is passed all assigned hostgroups that are not passed will be unassigned from the role. required: false privilege: default: None description: - List of privileges granted to the role. - If an empty list is passed all assigned privileges will be removed. - If option is omitted privileges will not be checked or changed. - If option is passed all assigned privileges that are not passed will be removed. required: false version_added: '2.4' version_added_collection: ansible.builtin description: description: - A description of this role-group. required: false validate_certs: default: true description: - This only applies if C(ipa_prot) is I(https). - If set to C(no), the SSL certificates will not be validated. - This should only set to C(no) used on personally controlled sites using self-signed certificates. required: false
role: description: Role as returned by IPA API. returned: always type: dict