mirror of
https://github.com/freeipa/ansible-freeipa.git
synced 2026-07-30 19:34:45 +00:00
Fix short_description flag in plugins, role modules and templates
Before "short description" was used in most plugins, modules and also in the new module templates. ansible-doc was therefore not showing the short description. To fix the issue the flag was renamed to short_description instead. Fixes: https://bugzilla.redhat.com/show_bug.cgi?id=2121362 'ansible-doc' -l lists most idm modules as 'UNDOCUMENTED'
This commit is contained in:
@@ -32,7 +32,7 @@ ANSIBLE_METADATA = {'metadata_version': '1.0',
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
module: ipaclient_api
|
||||
short description:
|
||||
short_description:
|
||||
Create temporary NSS database, call IPA API for remaining enrollment parts
|
||||
description:
|
||||
Create temporary NSS database, call IPA API for remaining enrollment parts
|
||||
|
||||
@@ -32,7 +32,7 @@ ANSIBLE_METADATA = {'metadata_version': '1.0',
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
module: ipaclient_fix_ca
|
||||
short description: Fix IPA ca certificate
|
||||
short_description: Fix IPA ca certificate
|
||||
description: Repair Fix IPA ca certificate
|
||||
options:
|
||||
servers:
|
||||
|
||||
@@ -34,7 +34,7 @@ ANSIBLE_METADATA = {
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
module: ipaclient_fstore
|
||||
short description: Backup files using IPA client sysrestore
|
||||
short_description: Backup files using IPA client sysrestore
|
||||
description: Backup files using IPA client sysrestore
|
||||
options:
|
||||
backup:
|
||||
|
||||
@@ -7,7 +7,7 @@ __metaclass__ = type
|
||||
DOCUMENTATION = """
|
||||
---
|
||||
module: ipaclient_get_facts
|
||||
short description: Get facts about IPA client and server configuration.
|
||||
short_description: Get facts about IPA client and server configuration.
|
||||
description: Get facts about IPA client and server configuration.
|
||||
author:
|
||||
- Thomas Woerner
|
||||
|
||||
@@ -30,7 +30,7 @@ ANSIBLE_METADATA = {'metadata_version': '1.0',
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
module: ipaclient_get_otp
|
||||
short description: Manage IPA hosts
|
||||
short_description: Manage IPA hosts
|
||||
description:
|
||||
Manage hosts in a IPA domain.
|
||||
The operation needs to be authenticated with Kerberos either by providing
|
||||
|
||||
@@ -34,7 +34,7 @@ ANSIBLE_METADATA = {
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
module: ipaclient_ipa_conf
|
||||
short description: Configure ipa.conf
|
||||
short_description: Configure ipa.conf
|
||||
description:
|
||||
Configure ipa.conf
|
||||
options:
|
||||
|
||||
@@ -34,7 +34,7 @@ ANSIBLE_METADATA = {
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
module: ipaclient_join
|
||||
short description:
|
||||
short_description:
|
||||
Join a machine to an IPA realm and get a keytab for the host service
|
||||
principal
|
||||
description:
|
||||
|
||||
@@ -34,7 +34,7 @@ ANSIBLE_METADATA = {
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
module: ipaclient_set_hostname
|
||||
short description: Backup and set hostname
|
||||
short_description: Backup and set hostname
|
||||
description:
|
||||
Backup and set hostname
|
||||
options:
|
||||
|
||||
@@ -34,7 +34,7 @@ ANSIBLE_METADATA = {
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
module: ipaclient_setup_automount
|
||||
short description: Setup automount for IPA client
|
||||
short_description: Setup automount for IPA client
|
||||
description:
|
||||
Setup automount for IPA client
|
||||
options:
|
||||
|
||||
@@ -34,7 +34,7 @@ ANSIBLE_METADATA = {
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
module: ipaclient_setup_firefox
|
||||
short description: Setup firefox for IPA client
|
||||
short_description: Setup firefox for IPA client
|
||||
description:
|
||||
Setup firefox for IPA client
|
||||
options:
|
||||
|
||||
@@ -34,7 +34,7 @@ ANSIBLE_METADATA = {
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
module: ipaclient_setup_krb5
|
||||
short description: Setup krb5 for IPA client
|
||||
short_description: Setup krb5 for IPA client
|
||||
description:
|
||||
Setup krb5 for IPA client
|
||||
options:
|
||||
|
||||
@@ -34,7 +34,7 @@ ANSIBLE_METADATA = {
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
module: ipaclient_setup_nis
|
||||
short description: Setup NIS for IPA client
|
||||
short_description: Setup NIS for IPA client
|
||||
description:
|
||||
Setup NIS for IPA client
|
||||
options:
|
||||
|
||||
@@ -34,7 +34,7 @@ ANSIBLE_METADATA = {
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
module: ipaclient_setup_nss
|
||||
short description: Create IPA client NSS database
|
||||
short_description: Create IPA client NSS database
|
||||
description: Create IPA NSS database
|
||||
options:
|
||||
servers:
|
||||
|
||||
@@ -34,7 +34,7 @@ ANSIBLE_METADATA = {
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
module: ipaclient_setup_ntp
|
||||
short description: Setup NTP for IPA client
|
||||
short_description: Setup NTP for IPA client
|
||||
description:
|
||||
Setup NTP for IPA client
|
||||
options:
|
||||
|
||||
@@ -34,7 +34,7 @@ ANSIBLE_METADATA = {
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
module: ipaclient_setup_ssh
|
||||
short description: Configure ssh and sshd for IPA client
|
||||
short_description: Configure ssh and sshd for IPA client
|
||||
description:
|
||||
Configure ssh and sshd for IPA client
|
||||
options:
|
||||
|
||||
@@ -34,7 +34,7 @@ ANSIBLE_METADATA = {
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
module: ipaclient_setup_ssd
|
||||
short description: Setup sssd for IPA client
|
||||
short_description: Setup sssd for IPA client
|
||||
description:
|
||||
Setup sssd for IPA client
|
||||
options:
|
||||
|
||||
@@ -34,7 +34,7 @@ ANSIBLE_METADATA = {
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
module: ipaclient_test
|
||||
short description: Tries to discover IPA server
|
||||
short_description: Tries to discover IPA server
|
||||
description:
|
||||
Tries to discover IPA server using DNS or host name
|
||||
options:
|
||||
|
||||
@@ -34,7 +34,7 @@ ANSIBLE_METADATA = {
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
module: ipaclient_test_keytab
|
||||
short description:
|
||||
short_description:
|
||||
Test if the krb5.keytab on the machine is valid and can be used.
|
||||
description:
|
||||
Test if the krb5.keytab on the machine is valid and can be used.
|
||||
|
||||
Reference in New Issue
Block a user