1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00

Add attributes to ipa and keycloak modules (#5950)

Add attributes to ipa and keycloak modules.
This commit is contained in:
Felix Fontein 2023-02-24 09:25:31 +01:00 committed by GitHub
parent 3ec2fde2c6
commit 18a6bdd6aa
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
30 changed files with 228 additions and 53 deletions

View file

@ -14,6 +14,11 @@ author: Fran Fitzpatrick (@fxfitz)
short_description: Manage Global FreeIPA Configuration Settings
description:
- Modify global configuration settings of a FreeIPA Server.
attributes:
check_mode:
support: full
diff_mode:
support: none
options:
ipaconfigstring:
description: Extra hashes to generate in password plug-in.
@ -94,6 +99,7 @@ options:
version_added: '2.5.0'
extends_documentation_fragment:
- community.general.ipa.documentation
- community.general.attributes
'''

View file

@ -15,6 +15,11 @@ author: Abhijeet Kasurde (@Akasurde)
short_description: Manage FreeIPA DNS records
description:
- Add, modify and delete an IPA DNS Record using IPA API.
attributes:
check_mode:
support: full
diff_mode:
support: none
options:
zone_name:
description:
@ -79,6 +84,7 @@ options:
type: str
extends_documentation_fragment:
- community.general.ipa.documentation
- community.general.attributes
'''

View file

@ -15,6 +15,11 @@ author: Fran Fitzpatrick (@fxfitz)
short_description: Manage FreeIPA DNS Zones
description:
- Add and delete an IPA DNS Zones using IPA API
attributes:
check_mode:
support: full
diff_mode:
support: none
options:
zone_name:
description:
@ -38,6 +43,7 @@ options:
version_added: 4.3.0
extends_documentation_fragment:
- community.general.ipa.documentation
- community.general.attributes
'''

View file

@ -14,6 +14,11 @@ author: Thomas Krahn (@Nosmoht)
short_description: Manage FreeIPA group
description:
- Add, modify and delete group within IPA server
attributes:
check_mode:
support: full
diff_mode:
support: none
options:
append:
description:
@ -83,6 +88,7 @@ options:
type: str
extends_documentation_fragment:
- community.general.ipa.documentation
- community.general.attributes
'''

View file

@ -14,6 +14,11 @@ author: Thomas Krahn (@Nosmoht)
short_description: Manage FreeIPA HBAC rule
description:
- Add, modify or delete an IPA HBAC rule using IPA API.
attributes:
check_mode:
support: full
diff_mode:
support: none
options:
cn:
description:
@ -105,6 +110,7 @@ options:
elements: str
extends_documentation_fragment:
- community.general.ipa.documentation
- community.general.attributes
'''

View file

@ -14,6 +14,11 @@ author: Thomas Krahn (@Nosmoht)
short_description: Manage FreeIPA host
description:
- Add, modify and delete an IPA host using IPA API.
attributes:
check_mode:
support: full
diff_mode:
support: none
options:
fqdn:
description:
@ -83,6 +88,7 @@ options:
type: bool
extends_documentation_fragment:
- community.general.ipa.documentation
- community.general.attributes
'''

View file

@ -14,6 +14,11 @@ author: Thomas Krahn (@Nosmoht)
short_description: Manage FreeIPA host-group
description:
- Add, modify and delete an IPA host-group using IPA API.
attributes:
check_mode:
support: full
diff_mode:
support: none
options:
cn:
description:
@ -50,6 +55,7 @@ options:
type: str
extends_documentation_fragment:
- community.general.ipa.documentation
- community.general.attributes
'''

View file

@ -16,6 +16,11 @@ short_description: Manage FreeIPA OTP Configuration Settings
version_added: 2.5.0
description:
- Modify global configuration settings of a FreeIPA Server with respect to OTP (One Time Passwords).
attributes:
check_mode:
support: full
diff_mode:
support: none
options:
ipatokentotpauthwindow:
description: TOTP authentication window in seconds.
@ -35,6 +40,7 @@ options:
type: int
extends_documentation_fragment:
- community.general.ipa.documentation
- community.general.attributes
'''

View file

@ -15,6 +15,11 @@ short_description: Manage FreeIPA OTPs
version_added: 2.5.0
description:
- Add, modify, and delete One Time Passwords in IPA.
attributes:
check_mode:
support: full
diff_mode:
support: none
options:
uniqueid:
description: Unique ID of the token in IPA.
@ -101,6 +106,7 @@ options:
type: int
extends_documentation_fragment:
- community.general.ipa.documentation
- community.general.attributes
'''
EXAMPLES = r'''

View file

@ -15,6 +15,11 @@ short_description: Manage FreeIPA password policies
description:
- Add, modify, or delete a password policy using the IPA API.
version_added: 2.0.0
attributes:
check_mode:
support: full
diff_mode:
support: none
options:
group:
description:
@ -61,8 +66,7 @@ options:
type: str
extends_documentation_fragment:
- community.general.ipa.documentation
notes:
- Supports C(check_mode).
- community.general.attributes
'''
EXAMPLES = r'''

View file

@ -14,6 +14,11 @@ author: Thomas Krahn (@Nosmoht)
short_description: Manage FreeIPA role
description:
- Add, modify and delete a role within FreeIPA server using FreeIPA API.
attributes:
check_mode:
support: full
diff_mode:
support: none
options:
cn:
description:
@ -80,6 +85,7 @@ options:
elements: str
extends_documentation_fragment:
- community.general.ipa.documentation
- community.general.attributes
'''

View file

@ -14,6 +14,11 @@ author: Cédric Parent (@cprh)
short_description: Manage FreeIPA service
description:
- Add and delete an IPA service using IPA API.
attributes:
check_mode:
support: full
diff_mode:
support: none
options:
krbcanonicalname:
description:
@ -49,6 +54,7 @@ options:
type: str
extends_documentation_fragment:
- community.general.ipa.documentation
- community.general.attributes
'''

View file

@ -14,6 +14,11 @@ author: Abhijeet Kasurde (@Akasurde)
short_description: Manage FreeIPA Lightweight Sub Certificate Authorities
description:
- Add, modify, enable, disable and delete an IPA Lightweight Sub Certificate Authorities using IPA API.
attributes:
check_mode:
support: full
diff_mode:
support: none
options:
subca_name:
description:
@ -40,6 +45,7 @@ options:
type: str
extends_documentation_fragment:
- community.general.ipa.documentation
- community.general.attributes
'''

View file

@ -14,6 +14,11 @@ author: Thomas Krahn (@Nosmoht)
short_description: Manage FreeIPA sudo command
description:
- Add, modify or delete sudo command within FreeIPA server using FreeIPA API.
attributes:
check_mode:
support: full
diff_mode:
support: none
options:
sudocmd:
description:
@ -32,6 +37,7 @@ options:
type: str
extends_documentation_fragment:
- community.general.ipa.documentation
- community.general.attributes
'''

View file

@ -14,6 +14,11 @@ author: Thomas Krahn (@Nosmoht)
short_description: Manage FreeIPA sudo command group
description:
- Add, modify or delete sudo command group within IPA server using IPA API.
attributes:
check_mode:
support: full
diff_mode:
support: none
options:
cn:
description:
@ -39,6 +44,7 @@ options:
elements: str
extends_documentation_fragment:
- community.general.ipa.documentation
- community.general.attributes
'''

View file

@ -14,6 +14,11 @@ author: Thomas Krahn (@Nosmoht)
short_description: Manage FreeIPA sudo rule
description:
- Add, modify or delete sudo rule within IPA server using IPA API.
attributes:
check_mode:
support: full
diff_mode:
support: none
options:
cn:
description:
@ -116,6 +121,7 @@ options:
type: str
extends_documentation_fragment:
- community.general.ipa.documentation
- community.general.attributes
'''

View file

@ -14,6 +14,11 @@ author: Thomas Krahn (@Nosmoht)
short_description: Manage FreeIPA users
description:
- Add, modify and delete user within IPA server.
attributes:
check_mode:
support: full
diff_mode:
support: none
options:
displayname:
description: Display name.
@ -100,6 +105,7 @@ options:
version_added: '1.2.0'
extends_documentation_fragment:
- community.general.ipa.documentation
- community.general.attributes
requirements:
- base64

View file

@ -15,6 +15,11 @@ short_description: Manage FreeIPA vaults
description:
- Add, modify and delete vaults and secret vaults.
- KRA service should be enabled to use this module.
attributes:
check_mode:
support: full
diff_mode:
support: none
options:
cn:
description:
@ -75,6 +80,7 @@ options:
default: true
extends_documentation_fragment:
- community.general.ipa.documentation
- community.general.attributes
'''

View file

@ -19,6 +19,12 @@ description:
version_added: "3.3.0"
attributes:
check_mode:
support: full
diff_mode:
support: full
options:
realm:
description:
@ -87,6 +93,7 @@ options:
extends_documentation_fragment:
- community.general.keycloak
- community.general.attributes
author:
- Philippe Gauthier (@elfelip)

View file

@ -30,6 +30,12 @@ description:
SAML-specific settings on an OpenID Connect client for instance and vice versa. Be careful.
If you do not specify a setting, usually a sensible default is chosen.
attributes:
check_mode:
support: full
diff_mode:
support: full
options:
state:
description:
@ -540,6 +546,7 @@ options:
extends_documentation_fragment:
- community.general.keycloak
- community.general.attributes
author:
- Eike Frost (@eikef)

View file

@ -33,6 +33,11 @@ description:
- When updating a client_rolemapping, where possible provide the role ID to the module. This removes a lookup
to the API to translate the name into the role ID.
attributes:
check_mode:
support: full
diff_mode:
support: full
options:
state:
@ -98,7 +103,7 @@ options:
extends_documentation_fragment:
- community.general.keycloak
- community.general.attributes
author:
- Gaëtan Daubresse (@Gaetan2907)

View file

@ -33,6 +33,11 @@ description:
- When updating a client_scope, where possible provide the client_scope ID to the module. This removes a lookup
to the API to translate the name into the client_scope ID.
attributes:
check_mode:
support: full
diff_mode:
support: full
options:
state:
@ -152,7 +157,7 @@ options:
extends_documentation_fragment:
- community.general.keycloak
- community.general.attributes
author:
- Gaëtan Daubresse (@Gaetan2907)

View file

@ -32,6 +32,12 @@ description:
- "Note that this module returns the client secret. To avoid this showing up in the logs,
please add C(no_log: true) to the task."
attributes:
check_mode:
support: full
diff_mode:
support: none
options:
realm:
type: str
@ -57,6 +63,7 @@ options:
extends_documentation_fragment:
- community.general.keycloak
- community.general.attributes
author:
- Fynn Chen (@fynncfchen)

View file

@ -14,7 +14,6 @@ module: keycloak_clienttemplate
short_description: Allows administration of Keycloak client templates via Keycloak API
description:
- This module allows the administration of Keycloak client templates via the Keycloak REST API. It
requires access to the REST API via OpenID Connect; the user connecting and the client being
@ -29,6 +28,12 @@ description:
SAML-specific settings on an OpenID Connect client for instance and vice versa. Be careful.
If you do not specify a setting, usually a sensible default is chosen.
attributes:
check_mode:
support: full
diff_mode:
support: full
options:
state:
description:
@ -163,6 +168,7 @@ notes:
extends_documentation_fragment:
- community.general.keycloak
- community.general.attributes
author:
- Eike Frost (@eikef)

View file

@ -31,6 +31,11 @@ description:
- When updating a group, where possible provide the group ID to the module. This removes a lookup
to the API to translate the name into the group ID.
attributes:
check_mode:
support: full
diff_mode:
support: full
options:
state:
@ -75,7 +80,7 @@ notes:
extends_documentation_fragment:
- community.general.keycloak
- community.general.attributes
author:
- Adam Goossens (@adamgoossens)

View file

@ -26,6 +26,11 @@ description:
- The names of module options are snake_cased versions of the camelCase ones found in the
Keycloak API and its documentation at U(https://www.keycloak.org/docs-api/15.0/rest-api/index.html).
attributes:
check_mode:
support: full
diff_mode:
support: full
options:
state:
@ -271,6 +276,7 @@ options:
extends_documentation_fragment:
- community.general.keycloak
- community.general.attributes
author:
- Laurent Paumier (@laurpaum)

View file

@ -17,7 +17,6 @@ short_description: Allows administration of Keycloak realm via Keycloak API
version_added: 3.0.0
description:
- This module allows the administration of Keycloak realm via the Keycloak REST API. It
requires access to the REST API via OpenID Connect; the user connecting and the realm being
@ -33,6 +32,12 @@ description:
SAML-specific settings on an OpenID Connect client for instance and vice versa. Be careful.
If you do not specify a setting, usually a sensible default is chosen.
attributes:
check_mode:
support: full
diff_mode:
support: full
options:
state:
description:
@ -504,7 +509,7 @@ options:
extends_documentation_fragment:
- community.general.keycloak
- community.general.attributes
author:
- Christophe Gilles (@kris2kris)

View file

@ -30,6 +30,11 @@ description:
be returned that way by this module. You may pass single values for attributes when calling the module,
and this will be translated into a list suitable for the API.
attributes:
check_mode:
support: full
diff_mode:
support: full
options:
state:
@ -75,7 +80,7 @@ options:
extends_documentation_fragment:
- community.general.keycloak
- community.general.attributes
author:
- Laurent Paumier (@laurpaum)

View file

@ -26,6 +26,11 @@ description:
- The names of module options are snake_cased versions of the camelCase ones found in the
Keycloak API and its documentation at U(https://www.keycloak.org/docs-api/20.0.2/rest-api/index.html).
attributes:
check_mode:
support: full
diff_mode:
support: full
options:
state:
@ -462,6 +467,7 @@ options:
extends_documentation_fragment:
- community.general.keycloak
- community.general.attributes
author:
- Laurent Paumier (@laurpaum)

View file

@ -32,6 +32,11 @@ description:
- When updating a user_rolemapping, where possible provide the role ID to the module. This removes a lookup
to the API to translate the name into the role ID.
attributes:
check_mode:
support: full
diff_mode:
support: full
options:
state:
@ -105,7 +110,7 @@ options:
extends_documentation_fragment:
- community.general.keycloak
- community.general.attributes
author:
- Dušan Marković (@bratwurzt)