From 81143be96a27988cf5d8d05c09c4daa672640f60 Mon Sep 17 00:00:00 2001 From: Thomas Woerner <twoerner@redhat.com> Date: Fri, 26 Aug 2022 15:19:33 +0200 Subject: [PATCH] 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' --- plugins/modules/ipaautomember.py | 2 +- plugins/modules/ipadelegation.py | 2 +- plugins/modules/ipadnsconfig.py | 2 +- plugins/modules/ipadnsrecord.py | 2 +- plugins/modules/ipadnszone.py | 2 +- plugins/modules/ipagroup.py | 2 +- plugins/modules/ipahbacrule.py | 2 +- plugins/modules/ipahbacsvc.py | 2 +- plugins/modules/ipahbacsvcgroup.py | 2 +- plugins/modules/ipahost.py | 2 +- plugins/modules/ipahostgroup.py | 2 +- plugins/modules/ipaidrange.py | 2 +- plugins/modules/ipalocation.py | 2 +- plugins/modules/ipapermission.py | 2 +- plugins/modules/ipaprivilege.py | 2 +- plugins/modules/ipapwpolicy.py | 2 +- plugins/modules/iparole.py | 2 +- plugins/modules/ipaselfservice.py | 2 +- plugins/modules/ipaserver.py | 2 +- plugins/modules/ipaservice.py | 2 +- plugins/modules/ipaservicedelegationrule.py | 2 +- plugins/modules/ipaservicedelegationtarget.py | 2 +- plugins/modules/ipasudocmd.py | 2 +- plugins/modules/ipasudocmdgroup.py | 2 +- plugins/modules/ipasudorule.py | 2 +- plugins/modules/ipatopologysegment.py | 2 +- plugins/modules/ipatopologysuffix.py | 2 +- plugins/modules/ipauser.py | 2 +- plugins/modules/ipavault.py | 2 +- roles/ipabackup/library/ipabackup_get_backup_dir.py | 2 +- roles/ipaclient/library/ipaclient_api.py | 2 +- roles/ipaclient/library/ipaclient_fix_ca.py | 2 +- roles/ipaclient/library/ipaclient_fstore.py | 2 +- roles/ipaclient/library/ipaclient_get_facts.py | 2 +- roles/ipaclient/library/ipaclient_get_otp.py | 2 +- roles/ipaclient/library/ipaclient_ipa_conf.py | 2 +- roles/ipaclient/library/ipaclient_join.py | 2 +- roles/ipaclient/library/ipaclient_set_hostname.py | 2 +- roles/ipaclient/library/ipaclient_setup_automount.py | 2 +- roles/ipaclient/library/ipaclient_setup_firefox.py | 2 +- roles/ipaclient/library/ipaclient_setup_krb5.py | 2 +- roles/ipaclient/library/ipaclient_setup_nis.py | 2 +- roles/ipaclient/library/ipaclient_setup_nss.py | 2 +- roles/ipaclient/library/ipaclient_setup_ntp.py | 2 +- roles/ipaclient/library/ipaclient_setup_ssh.py | 2 +- roles/ipaclient/library/ipaclient_setup_sssd.py | 2 +- roles/ipaclient/library/ipaclient_test.py | 2 +- roles/ipaclient/library/ipaclient_test_keytab.py | 2 +- roles/ipareplica/library/ipareplica_add_to_ipaservers.py | 2 +- roles/ipareplica/library/ipareplica_create_ipa_conf.py | 2 +- .../library/ipareplica_custodia_import_dm_password.py | 2 +- roles/ipareplica/library/ipareplica_ds_apply_updates.py | 2 +- roles/ipareplica/library/ipareplica_ds_enable_ssl.py | 2 +- roles/ipareplica/library/ipareplica_enable_ipa.py | 2 +- roles/ipareplica/library/ipareplica_install_ca_certs.py | 2 +- roles/ipareplica/library/ipareplica_krb_enable_ssl.py | 2 +- roles/ipareplica/library/ipareplica_master_password.py | 2 +- roles/ipareplica/library/ipareplica_prepare.py | 2 +- roles/ipareplica/library/ipareplica_promote_openldap_conf.py | 2 +- roles/ipareplica/library/ipareplica_promote_sssd.py | 2 +- roles/ipareplica/library/ipareplica_restart_kdc.py | 2 +- roles/ipareplica/library/ipareplica_setup_adtrust.py | 2 +- roles/ipareplica/library/ipareplica_setup_ca.py | 2 +- roles/ipareplica/library/ipareplica_setup_certmonger.py | 2 +- roles/ipareplica/library/ipareplica_setup_custodia.py | 2 +- roles/ipareplica/library/ipareplica_setup_dns.py | 2 +- roles/ipareplica/library/ipareplica_setup_ds.py | 2 +- roles/ipareplica/library/ipareplica_setup_http.py | 2 +- roles/ipareplica/library/ipareplica_setup_kra.py | 2 +- roles/ipareplica/library/ipareplica_setup_krb.py | 2 +- roles/ipareplica/library/ipareplica_setup_otpd.py | 2 +- roles/ipareplica/library/ipareplica_test.py | 2 +- roles/ipaserver/library/ipaserver_enable_ipa.py | 2 +- roles/ipaserver/library/ipaserver_load_cache.py | 2 +- roles/ipaserver/library/ipaserver_master_password.py | 2 +- roles/ipaserver/library/ipaserver_prepare.py | 2 +- roles/ipaserver/library/ipaserver_set_ds_password.py | 2 +- roles/ipaserver/library/ipaserver_setup_adtrust.py | 2 +- roles/ipaserver/library/ipaserver_setup_ca.py | 2 +- roles/ipaserver/library/ipaserver_setup_custodia.py | 2 +- roles/ipaserver/library/ipaserver_setup_dns.py | 2 +- roles/ipaserver/library/ipaserver_setup_ds.py | 2 +- roles/ipaserver/library/ipaserver_setup_http.py | 2 +- roles/ipaserver/library/ipaserver_setup_kra.py | 2 +- roles/ipaserver/library/ipaserver_setup_krb.py | 2 +- roles/ipaserver/library/ipaserver_setup_ntp.py | 2 +- roles/ipaserver/library/ipaserver_setup_otpd.py | 2 +- roles/ipaserver/library/ipaserver_test.py | 2 +- .../ipasmartcard_client/library/ipasmartcard_client_get_vars.py | 2 +- .../library/ipasmartcard_client_validate_ca_certs.py | 2 +- .../ipasmartcard_server/library/ipasmartcard_server_get_vars.py | 2 +- .../library/ipasmartcard_server_validate_ca_certs.py | 2 +- utils/templates/ipamodule+member.py.in | 2 +- utils/templates/ipamodule.py.in | 2 +- 94 files changed, 94 insertions(+), 94 deletions(-) diff --git a/plugins/modules/ipaautomember.py b/plugins/modules/ipaautomember.py index 412706e7..0597f287 100644 --- a/plugins/modules/ipaautomember.py +++ b/plugins/modules/ipaautomember.py @@ -34,7 +34,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = """ --- module: ipaautomember -short description: Add and delete FreeIPA Auto Membership Rules. +short_description: Add and delete FreeIPA Auto Membership Rules. description: Add, modify and delete an IPA Auto Membership Rules. extends_documentation_fragment: - ipamodule_base_docs diff --git a/plugins/modules/ipadelegation.py b/plugins/modules/ipadelegation.py index 6097a29e..a4670981 100644 --- a/plugins/modules/ipadelegation.py +++ b/plugins/modules/ipadelegation.py @@ -32,7 +32,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = """ --- module: ipadelegation -short description: Manage FreeIPA delegations +short_description: Manage FreeIPA delegations description: Manage FreeIPA delegations and delegation attributes extends_documentation_fragment: - ipamodule_base_docs diff --git a/plugins/modules/ipadnsconfig.py b/plugins/modules/ipadnsconfig.py index 7b743202..084a30c7 100644 --- a/plugins/modules/ipadnsconfig.py +++ b/plugins/modules/ipadnsconfig.py @@ -33,7 +33,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = """ --- module: ipadnsconfig -short description: Manage FreeIPA dnsconfig +short_description: Manage FreeIPA dnsconfig description: Manage FreeIPA dnsconfig extends_documentation_fragment: - ipamodule_base_docs diff --git a/plugins/modules/ipadnsrecord.py b/plugins/modules/ipadnsrecord.py index 1f5e787e..5fbea9dc 100644 --- a/plugins/modules/ipadnsrecord.py +++ b/plugins/modules/ipadnsrecord.py @@ -34,7 +34,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = """ --- module: ipadnsrecord -short description: Manage FreeIPA DNS records +short_description: Manage FreeIPA DNS records description: Manage FreeIPA DNS records extends_documentation_fragment: - ipamodule_base_docs diff --git a/plugins/modules/ipadnszone.py b/plugins/modules/ipadnszone.py index d64e6e0a..59b5aa9d 100644 --- a/plugins/modules/ipadnszone.py +++ b/plugins/modules/ipadnszone.py @@ -32,7 +32,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = """ --- module: ipadnszone -short description: Manage FreeIPA dnszone +short_description: Manage FreeIPA dnszone description: Manage FreeIPA dnszone extends_documentation_fragment: - ipamodule_base_docs diff --git a/plugins/modules/ipagroup.py b/plugins/modules/ipagroup.py index 09d8e1c9..f75f54ec 100644 --- a/plugins/modules/ipagroup.py +++ b/plugins/modules/ipagroup.py @@ -32,7 +32,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = """ --- module: ipagroup -short description: Manage FreeIPA groups +short_description: Manage FreeIPA groups description: Manage FreeIPA groups extends_documentation_fragment: - ipamodule_base_docs diff --git a/plugins/modules/ipahbacrule.py b/plugins/modules/ipahbacrule.py index f1e0a5c4..25aaf3c2 100644 --- a/plugins/modules/ipahbacrule.py +++ b/plugins/modules/ipahbacrule.py @@ -32,7 +32,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = """ --- module: ipahbacrule -short description: Manage FreeIPA HBAC rules +short_description: Manage FreeIPA HBAC rules description: Manage FreeIPA HBAC rules extends_documentation_fragment: - ipamodule_base_docs diff --git a/plugins/modules/ipahbacsvc.py b/plugins/modules/ipahbacsvc.py index 59053e07..a278781d 100644 --- a/plugins/modules/ipahbacsvc.py +++ b/plugins/modules/ipahbacsvc.py @@ -32,7 +32,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = """ --- module: ipahbacsvc -short description: Manage FreeIPA HBAC Services +short_description: Manage FreeIPA HBAC Services description: Manage FreeIPA HBAC Services extends_documentation_fragment: - ipamodule_base_docs diff --git a/plugins/modules/ipahbacsvcgroup.py b/plugins/modules/ipahbacsvcgroup.py index ca060752..77bc1078 100644 --- a/plugins/modules/ipahbacsvcgroup.py +++ b/plugins/modules/ipahbacsvcgroup.py @@ -33,7 +33,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = """ --- module: ipahbacsvcgroup -short description: Manage FreeIPA hbacsvcgroups +short_description: Manage FreeIPA hbacsvcgroups description: Manage FreeIPA hbacsvcgroups extends_documentation_fragment: - ipamodule_base_docs diff --git a/plugins/modules/ipahost.py b/plugins/modules/ipahost.py index 39857bca..fd6c475f 100644 --- a/plugins/modules/ipahost.py +++ b/plugins/modules/ipahost.py @@ -32,7 +32,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = """ --- module: ipahost -short description: Manage FreeIPA hosts +short_description: Manage FreeIPA hosts description: Manage FreeIPA hosts extends_documentation_fragment: - ipamodule_base_docs diff --git a/plugins/modules/ipahostgroup.py b/plugins/modules/ipahostgroup.py index 57dad3dc..0e180477 100644 --- a/plugins/modules/ipahostgroup.py +++ b/plugins/modules/ipahostgroup.py @@ -33,7 +33,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = """ --- module: ipahostgroup -short description: Manage FreeIPA hostgroups +short_description: Manage FreeIPA hostgroups description: Manage FreeIPA hostgroups extends_documentation_fragment: - ipamodule_base_docs diff --git a/plugins/modules/ipaidrange.py b/plugins/modules/ipaidrange.py index 5e37aa01..d9f0f981 100644 --- a/plugins/modules/ipaidrange.py +++ b/plugins/modules/ipaidrange.py @@ -32,7 +32,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = """ --- module: ipaidrange -short description: Manage FreeIPA idrange +short_description: Manage FreeIPA idrange description: Manage FreeIPA idrange extends_documentation_fragment: - ipamodule_base_docs diff --git a/plugins/modules/ipalocation.py b/plugins/modules/ipalocation.py index 0b7feadc..7a42b05c 100644 --- a/plugins/modules/ipalocation.py +++ b/plugins/modules/ipalocation.py @@ -32,7 +32,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = """ --- module: ipalocation -short description: Manage FreeIPA location +short_description: Manage FreeIPA location description: Manage FreeIPA location extends_documentation_fragment: - ipamodule_base_docs diff --git a/plugins/modules/ipapermission.py b/plugins/modules/ipapermission.py index 2624a25e..6b93375c 100644 --- a/plugins/modules/ipapermission.py +++ b/plugins/modules/ipapermission.py @@ -32,7 +32,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = """ --- module: ipapermission -short description: Manage FreeIPA permission +short_description: Manage FreeIPA permission description: Manage FreeIPA permission and permission members extends_documentation_fragment: - ipamodule_base_docs diff --git a/plugins/modules/ipaprivilege.py b/plugins/modules/ipaprivilege.py index 45abe646..7b4c1df1 100644 --- a/plugins/modules/ipaprivilege.py +++ b/plugins/modules/ipaprivilege.py @@ -35,7 +35,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = """ --- module: ipaprivilege -short description: Manage FreeIPA privilege +short_description: Manage FreeIPA privilege description: Manage FreeIPA privilege and privilege members extends_documentation_fragment: - ipamodule_base_docs diff --git a/plugins/modules/ipapwpolicy.py b/plugins/modules/ipapwpolicy.py index 7746b10c..82e48408 100644 --- a/plugins/modules/ipapwpolicy.py +++ b/plugins/modules/ipapwpolicy.py @@ -32,7 +32,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = """ --- module: ipapwpolicy -short description: Manage FreeIPA pwpolicies +short_description: Manage FreeIPA pwpolicies description: Manage FreeIPA pwpolicies options: ipaadmin_principal: diff --git a/plugins/modules/iparole.py b/plugins/modules/iparole.py index 61e4d3d4..499cbd68 100644 --- a/plugins/modules/iparole.py +++ b/plugins/modules/iparole.py @@ -34,7 +34,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = """ --- module: iparole -short description: Manage FreeIPA role +short_description: Manage FreeIPA role description: Manage FreeIPA role extends_documentation_fragment: - ipamodule_base_docs diff --git a/plugins/modules/ipaselfservice.py b/plugins/modules/ipaselfservice.py index cc6ca6bd..cab5dc49 100644 --- a/plugins/modules/ipaselfservice.py +++ b/plugins/modules/ipaselfservice.py @@ -32,7 +32,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = """ --- module: ipaselfservice -short description: Manage FreeIPA selfservices +short_description: Manage FreeIPA selfservices description: Manage FreeIPA selfservices and selfservice attributes extends_documentation_fragment: - ipamodule_base_docs diff --git a/plugins/modules/ipaserver.py b/plugins/modules/ipaserver.py index e80e706a..01546e9c 100644 --- a/plugins/modules/ipaserver.py +++ b/plugins/modules/ipaserver.py @@ -32,7 +32,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = """ --- module: ipaserver -short description: Manage FreeIPA server +short_description: Manage FreeIPA server description: Manage FreeIPA server extends_documentation_fragment: - ipamodule_base_docs diff --git a/plugins/modules/ipaservice.py b/plugins/modules/ipaservice.py index 989ab9a0..8e42cb70 100644 --- a/plugins/modules/ipaservice.py +++ b/plugins/modules/ipaservice.py @@ -33,7 +33,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = """ --- module: ipaservice -short description: Manage FreeIPA service +short_description: Manage FreeIPA service description: Manage FreeIPA service extends_documentation_fragment: - ipamodule_base_docs diff --git a/plugins/modules/ipaservicedelegationrule.py b/plugins/modules/ipaservicedelegationrule.py index aaff1115..aed826ba 100644 --- a/plugins/modules/ipaservicedelegationrule.py +++ b/plugins/modules/ipaservicedelegationrule.py @@ -32,7 +32,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = """ --- module: ipaservicedelegationrule -short description: Manage FreeIPA servicedelegationrule +short_description: Manage FreeIPA servicedelegationrule description: | Manage FreeIPA servicedelegationrule and servicedelegationrule members extends_documentation_fragment: diff --git a/plugins/modules/ipaservicedelegationtarget.py b/plugins/modules/ipaservicedelegationtarget.py index 59b3418c..5a25856d 100644 --- a/plugins/modules/ipaservicedelegationtarget.py +++ b/plugins/modules/ipaservicedelegationtarget.py @@ -32,7 +32,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = """ --- module: ipaservicedelegationtarget -short description: Manage FreeIPA servicedelegationtarget +short_description: Manage FreeIPA servicedelegationtarget description: | Manage FreeIPA servicedelegationtarget and servicedelegationtarget members extends_documentation_fragment: diff --git a/plugins/modules/ipasudocmd.py b/plugins/modules/ipasudocmd.py index 10089073..5942d510 100644 --- a/plugins/modules/ipasudocmd.py +++ b/plugins/modules/ipasudocmd.py @@ -33,7 +33,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = """ --- module: ipasudocmd -short description: Manage FreeIPA sudo command +short_description: Manage FreeIPA sudo command description: Manage FreeIPA sudo command extends_documentation_fragment: - ipamodule_base_docs diff --git a/plugins/modules/ipasudocmdgroup.py b/plugins/modules/ipasudocmdgroup.py index 118dea00..2e74fd2f 100644 --- a/plugins/modules/ipasudocmdgroup.py +++ b/plugins/modules/ipasudocmdgroup.py @@ -33,7 +33,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = """ --- module: ipasudocmdgroup -short description: Manage FreeIPA sudocmd groups +short_description: Manage FreeIPA sudocmd groups description: Manage FreeIPA sudocmd groups extends_documentation_fragment: - ipamodule_base_docs diff --git a/plugins/modules/ipasudorule.py b/plugins/modules/ipasudorule.py index d26f023a..6115de99 100644 --- a/plugins/modules/ipasudorule.py +++ b/plugins/modules/ipasudorule.py @@ -32,7 +32,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = """ --- module: ipasudorule -short description: Manage FreeIPA sudo rules +short_description: Manage FreeIPA sudo rules description: Manage FreeIPA sudo rules extends_documentation_fragment: - ipamodule_base_docs diff --git a/plugins/modules/ipatopologysegment.py b/plugins/modules/ipatopologysegment.py index 616fc5f7..520fd016 100644 --- a/plugins/modules/ipatopologysegment.py +++ b/plugins/modules/ipatopologysegment.py @@ -32,7 +32,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = """ --- module: ipatopologysegment -short description: Manage FreeIPA topology segments +short_description: Manage FreeIPA topology segments description: Manage FreeIPA topology segments extends_documentation_fragment: - ipamodule_base_docs diff --git a/plugins/modules/ipatopologysuffix.py b/plugins/modules/ipatopologysuffix.py index 9845eb7b..a860aa9d 100644 --- a/plugins/modules/ipatopologysuffix.py +++ b/plugins/modules/ipatopologysuffix.py @@ -32,7 +32,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = """ --- module: ipatopologysuffix -short description: Verify FreeIPA topology suffix +short_description: Verify FreeIPA topology suffix description: Verify FreeIPA topology suffix extends_documentation_fragment: - ipamodule_base_docs diff --git a/plugins/modules/ipauser.py b/plugins/modules/ipauser.py index ec185229..ced9cf86 100644 --- a/plugins/modules/ipauser.py +++ b/plugins/modules/ipauser.py @@ -32,7 +32,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = """ --- module: ipauser -short description: Manage FreeIPA users +short_description: Manage FreeIPA users description: Manage FreeIPA users extends_documentation_fragment: - ipamodule_base_docs diff --git a/plugins/modules/ipavault.py b/plugins/modules/ipavault.py index 46d053bb..5a77f5bc 100644 --- a/plugins/modules/ipavault.py +++ b/plugins/modules/ipavault.py @@ -32,7 +32,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = """ --- module: ipavault -short description: Manage vaults and secret vaults. +short_description: Manage vaults and secret vaults. description: Manage vaults and secret vaults. KRA service must be enabled. extends_documentation_fragment: - ipamodule_base_docs diff --git a/roles/ipabackup/library/ipabackup_get_backup_dir.py b/roles/ipabackup/library/ipabackup_get_backup_dir.py index ae2a05b7..14ceaa41 100644 --- a/roles/ipabackup/library/ipabackup_get_backup_dir.py +++ b/roles/ipabackup/library/ipabackup_get_backup_dir.py @@ -32,7 +32,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = ''' --- module: ipabackup_get_backup_dir -short description: +short_description: Get IPA_BACKUP_DIR from ipaplatform description: Get IPA_BACKUP_DIR from ipaplatform diff --git a/roles/ipaclient/library/ipaclient_api.py b/roles/ipaclient/library/ipaclient_api.py index 763be405..6b8ce667 100644 --- a/roles/ipaclient/library/ipaclient_api.py +++ b/roles/ipaclient/library/ipaclient_api.py @@ -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 diff --git a/roles/ipaclient/library/ipaclient_fix_ca.py b/roles/ipaclient/library/ipaclient_fix_ca.py index 799920a5..10e81685 100644 --- a/roles/ipaclient/library/ipaclient_fix_ca.py +++ b/roles/ipaclient/library/ipaclient_fix_ca.py @@ -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: diff --git a/roles/ipaclient/library/ipaclient_fstore.py b/roles/ipaclient/library/ipaclient_fstore.py index f05c35b3..62f230b7 100644 --- a/roles/ipaclient/library/ipaclient_fstore.py +++ b/roles/ipaclient/library/ipaclient_fstore.py @@ -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: diff --git a/roles/ipaclient/library/ipaclient_get_facts.py b/roles/ipaclient/library/ipaclient_get_facts.py index 3e75accc..e0b87bda 100644 --- a/roles/ipaclient/library/ipaclient_get_facts.py +++ b/roles/ipaclient/library/ipaclient_get_facts.py @@ -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 diff --git a/roles/ipaclient/library/ipaclient_get_otp.py b/roles/ipaclient/library/ipaclient_get_otp.py index cb85c114..a26f972a 100644 --- a/roles/ipaclient/library/ipaclient_get_otp.py +++ b/roles/ipaclient/library/ipaclient_get_otp.py @@ -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 diff --git a/roles/ipaclient/library/ipaclient_ipa_conf.py b/roles/ipaclient/library/ipaclient_ipa_conf.py index 36a41d83..8f1fbad7 100644 --- a/roles/ipaclient/library/ipaclient_ipa_conf.py +++ b/roles/ipaclient/library/ipaclient_ipa_conf.py @@ -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: diff --git a/roles/ipaclient/library/ipaclient_join.py b/roles/ipaclient/library/ipaclient_join.py index 2c72a6a6..31c01a4f 100644 --- a/roles/ipaclient/library/ipaclient_join.py +++ b/roles/ipaclient/library/ipaclient_join.py @@ -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: diff --git a/roles/ipaclient/library/ipaclient_set_hostname.py b/roles/ipaclient/library/ipaclient_set_hostname.py index 3b57d9ae..e92496bc 100644 --- a/roles/ipaclient/library/ipaclient_set_hostname.py +++ b/roles/ipaclient/library/ipaclient_set_hostname.py @@ -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: diff --git a/roles/ipaclient/library/ipaclient_setup_automount.py b/roles/ipaclient/library/ipaclient_setup_automount.py index 6ff12bf4..83c84edb 100644 --- a/roles/ipaclient/library/ipaclient_setup_automount.py +++ b/roles/ipaclient/library/ipaclient_setup_automount.py @@ -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: diff --git a/roles/ipaclient/library/ipaclient_setup_firefox.py b/roles/ipaclient/library/ipaclient_setup_firefox.py index 69fccc58..276fe615 100644 --- a/roles/ipaclient/library/ipaclient_setup_firefox.py +++ b/roles/ipaclient/library/ipaclient_setup_firefox.py @@ -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: diff --git a/roles/ipaclient/library/ipaclient_setup_krb5.py b/roles/ipaclient/library/ipaclient_setup_krb5.py index 48c42d00..f236b027 100644 --- a/roles/ipaclient/library/ipaclient_setup_krb5.py +++ b/roles/ipaclient/library/ipaclient_setup_krb5.py @@ -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: diff --git a/roles/ipaclient/library/ipaclient_setup_nis.py b/roles/ipaclient/library/ipaclient_setup_nis.py index f3a4d7d0..f07d391c 100644 --- a/roles/ipaclient/library/ipaclient_setup_nis.py +++ b/roles/ipaclient/library/ipaclient_setup_nis.py @@ -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: diff --git a/roles/ipaclient/library/ipaclient_setup_nss.py b/roles/ipaclient/library/ipaclient_setup_nss.py index d61a65a9..7fc466ce 100644 --- a/roles/ipaclient/library/ipaclient_setup_nss.py +++ b/roles/ipaclient/library/ipaclient_setup_nss.py @@ -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: diff --git a/roles/ipaclient/library/ipaclient_setup_ntp.py b/roles/ipaclient/library/ipaclient_setup_ntp.py index 7f4a0e82..908c310e 100644 --- a/roles/ipaclient/library/ipaclient_setup_ntp.py +++ b/roles/ipaclient/library/ipaclient_setup_ntp.py @@ -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: diff --git a/roles/ipaclient/library/ipaclient_setup_ssh.py b/roles/ipaclient/library/ipaclient_setup_ssh.py index 11ea652c..8da49cdc 100644 --- a/roles/ipaclient/library/ipaclient_setup_ssh.py +++ b/roles/ipaclient/library/ipaclient_setup_ssh.py @@ -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: diff --git a/roles/ipaclient/library/ipaclient_setup_sssd.py b/roles/ipaclient/library/ipaclient_setup_sssd.py index 5d2f520c..2ba33a9b 100644 --- a/roles/ipaclient/library/ipaclient_setup_sssd.py +++ b/roles/ipaclient/library/ipaclient_setup_sssd.py @@ -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: diff --git a/roles/ipaclient/library/ipaclient_test.py b/roles/ipaclient/library/ipaclient_test.py index 8e30494c..46eaec87 100644 --- a/roles/ipaclient/library/ipaclient_test.py +++ b/roles/ipaclient/library/ipaclient_test.py @@ -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: diff --git a/roles/ipaclient/library/ipaclient_test_keytab.py b/roles/ipaclient/library/ipaclient_test_keytab.py index 97a1ab79..b12b0def 100644 --- a/roles/ipaclient/library/ipaclient_test_keytab.py +++ b/roles/ipaclient/library/ipaclient_test_keytab.py @@ -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. diff --git a/roles/ipareplica/library/ipareplica_add_to_ipaservers.py b/roles/ipareplica/library/ipareplica_add_to_ipaservers.py index 2ec634cc..e44464c4 100644 --- a/roles/ipareplica/library/ipareplica_add_to_ipaservers.py +++ b/roles/ipareplica/library/ipareplica_add_to_ipaservers.py @@ -34,7 +34,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = ''' --- module: ipareplica_add_to_ipaservers -short description: Add to ipaservers +short_description: Add to ipaservers description: Add to ipaservers options: diff --git a/roles/ipareplica/library/ipareplica_create_ipa_conf.py b/roles/ipareplica/library/ipareplica_create_ipa_conf.py index e75f150e..0577cd5e 100644 --- a/roles/ipareplica/library/ipareplica_create_ipa_conf.py +++ b/roles/ipareplica/library/ipareplica_create_ipa_conf.py @@ -34,7 +34,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = ''' --- module: ipareplica_create_ipa_conf -short description: Create ipa.conf +short_description: Create ipa.conf description: Create ipa.conf options: diff --git a/roles/ipareplica/library/ipareplica_custodia_import_dm_password.py b/roles/ipareplica/library/ipareplica_custodia_import_dm_password.py index 2a2fe044..28346e7e 100644 --- a/roles/ipareplica/library/ipareplica_custodia_import_dm_password.py +++ b/roles/ipareplica/library/ipareplica_custodia_import_dm_password.py @@ -34,7 +34,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = ''' --- module: ipareplica_custodia_import_dm_password -short description: Import dm password into custodia +short_description: Import dm password into custodia description: Import dm password into custodia options: diff --git a/roles/ipareplica/library/ipareplica_ds_apply_updates.py b/roles/ipareplica/library/ipareplica_ds_apply_updates.py index 3d2fc97b..87e46a5d 100644 --- a/roles/ipareplica/library/ipareplica_ds_apply_updates.py +++ b/roles/ipareplica/library/ipareplica_ds_apply_updates.py @@ -34,7 +34,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = ''' --- module: ipareplica_ds_apply_updates -short description: DS apply updates +short_description: DS apply updates description: DS apply updates options: diff --git a/roles/ipareplica/library/ipareplica_ds_enable_ssl.py b/roles/ipareplica/library/ipareplica_ds_enable_ssl.py index 93f88f62..e751f684 100644 --- a/roles/ipareplica/library/ipareplica_ds_enable_ssl.py +++ b/roles/ipareplica/library/ipareplica_ds_enable_ssl.py @@ -34,7 +34,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = ''' --- module: ipareplica_ds_enable_ssl -short description: DS enable SSL +short_description: DS enable SSL description: DS enable SSL options: diff --git a/roles/ipareplica/library/ipareplica_enable_ipa.py b/roles/ipareplica/library/ipareplica_enable_ipa.py index da79154e..b4cf5d52 100644 --- a/roles/ipareplica/library/ipareplica_enable_ipa.py +++ b/roles/ipareplica/library/ipareplica_enable_ipa.py @@ -34,7 +34,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = ''' --- module: ipareplica_enable_ipa -short description: Enable IPA +short_description: Enable IPA description: Enable IPA Enable IPA options: diff --git a/roles/ipareplica/library/ipareplica_install_ca_certs.py b/roles/ipareplica/library/ipareplica_install_ca_certs.py index 72d28080..e47e0a6d 100644 --- a/roles/ipareplica/library/ipareplica_install_ca_certs.py +++ b/roles/ipareplica/library/ipareplica_install_ca_certs.py @@ -34,7 +34,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = ''' --- module: ipareplica_install_ca_cert -short description: Install CA certs +short_description: Install CA certs description: Install CA certs options: diff --git a/roles/ipareplica/library/ipareplica_krb_enable_ssl.py b/roles/ipareplica/library/ipareplica_krb_enable_ssl.py index 5fcd5c8c..4380cbad 100644 --- a/roles/ipareplica/library/ipareplica_krb_enable_ssl.py +++ b/roles/ipareplica/library/ipareplica_krb_enable_ssl.py @@ -34,7 +34,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = ''' --- module: ipareplica_krb_enable_ssl -short description: KRB enable SSL +short_description: KRB enable SSL description: KRB enable SSL options: diff --git a/roles/ipareplica/library/ipareplica_master_password.py b/roles/ipareplica/library/ipareplica_master_password.py index 1b3f1b08..f617716b 100644 --- a/roles/ipareplica/library/ipareplica_master_password.py +++ b/roles/ipareplica/library/ipareplica_master_password.py @@ -34,7 +34,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = ''' --- module: ipareplica_master_password -short description: Generate kerberos master password if not given +short_description: Generate kerberos master password if not given description: Generate kerberos master password if not given options: diff --git a/roles/ipareplica/library/ipareplica_prepare.py b/roles/ipareplica/library/ipareplica_prepare.py index d93b5686..c04ad63c 100644 --- a/roles/ipareplica/library/ipareplica_prepare.py +++ b/roles/ipareplica/library/ipareplica_prepare.py @@ -34,7 +34,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = ''' --- module: ipareplica_prepare -short description: Prepare ipa replica installation +short_description: Prepare ipa replica installation description: | Prepare ipa replica installation: Create IPA configuration file, run install checks again and also update the host name and the hosts file if needed. diff --git a/roles/ipareplica/library/ipareplica_promote_openldap_conf.py b/roles/ipareplica/library/ipareplica_promote_openldap_conf.py index 9d847fde..4ff4a176 100644 --- a/roles/ipareplica/library/ipareplica_promote_openldap_conf.py +++ b/roles/ipareplica/library/ipareplica_promote_openldap_conf.py @@ -34,7 +34,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = ''' --- module: ipareplica_promote_openldap_conf -short description: Promote openldap.conf +short_description: Promote openldap.conf description: Promote openldap.conf options: diff --git a/roles/ipareplica/library/ipareplica_promote_sssd.py b/roles/ipareplica/library/ipareplica_promote_sssd.py index da490b8f..2ac27bd9 100644 --- a/roles/ipareplica/library/ipareplica_promote_sssd.py +++ b/roles/ipareplica/library/ipareplica_promote_sssd.py @@ -34,7 +34,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = ''' --- module: ipareplica_promote_sssd -short description: Promote sssd +short_description: Promote sssd description: Promote sssd options: diff --git a/roles/ipareplica/library/ipareplica_restart_kdc.py b/roles/ipareplica/library/ipareplica_restart_kdc.py index 48d46678..252dc9aa 100644 --- a/roles/ipareplica/library/ipareplica_restart_kdc.py +++ b/roles/ipareplica/library/ipareplica_restart_kdc.py @@ -34,7 +34,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = ''' --- module: ipareplica_restart_kdc -short description: Restart KDC +short_description: Restart KDC description: Restart KDC options: diff --git a/roles/ipareplica/library/ipareplica_setup_adtrust.py b/roles/ipareplica/library/ipareplica_setup_adtrust.py index 3532bb1a..72230783 100644 --- a/roles/ipareplica/library/ipareplica_setup_adtrust.py +++ b/roles/ipareplica/library/ipareplica_setup_adtrust.py @@ -34,7 +34,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = ''' --- module: ipareplica_setup_adtrust -short description: Setup adtrust +short_description: Setup adtrust description: Setup adtrust options: diff --git a/roles/ipareplica/library/ipareplica_setup_ca.py b/roles/ipareplica/library/ipareplica_setup_ca.py index 01d00a8e..c057e0b6 100644 --- a/roles/ipareplica/library/ipareplica_setup_ca.py +++ b/roles/ipareplica/library/ipareplica_setup_ca.py @@ -34,7 +34,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = ''' --- module: ipareplica_setup_ca -short description: Setup CA +short_description: Setup CA description: Setup CA options: diff --git a/roles/ipareplica/library/ipareplica_setup_certmonger.py b/roles/ipareplica/library/ipareplica_setup_certmonger.py index 7c319059..4029ed00 100644 --- a/roles/ipareplica/library/ipareplica_setup_certmonger.py +++ b/roles/ipareplica/library/ipareplica_setup_certmonger.py @@ -34,7 +34,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = ''' --- module: ipareplica_setup_certmonger -short description: Setup certmonger +short_description: Setup certmonger description: Setup certmonger options: diff --git a/roles/ipareplica/library/ipareplica_setup_custodia.py b/roles/ipareplica/library/ipareplica_setup_custodia.py index 825f756f..69b35d7c 100644 --- a/roles/ipareplica/library/ipareplica_setup_custodia.py +++ b/roles/ipareplica/library/ipareplica_setup_custodia.py @@ -34,7 +34,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = ''' --- module: ipareplica_setup_custodia -short description: Setup custodia +short_description: Setup custodia description: Setup custodia options: diff --git a/roles/ipareplica/library/ipareplica_setup_dns.py b/roles/ipareplica/library/ipareplica_setup_dns.py index 31d219f3..741cf497 100644 --- a/roles/ipareplica/library/ipareplica_setup_dns.py +++ b/roles/ipareplica/library/ipareplica_setup_dns.py @@ -34,7 +34,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = ''' --- module: ipareplica_setup_dns -short description: Setup DNS +short_description: Setup DNS description: Setup DNS options: diff --git a/roles/ipareplica/library/ipareplica_setup_ds.py b/roles/ipareplica/library/ipareplica_setup_ds.py index c3c4c864..ddcff597 100644 --- a/roles/ipareplica/library/ipareplica_setup_ds.py +++ b/roles/ipareplica/library/ipareplica_setup_ds.py @@ -34,7 +34,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = ''' --- module: ipareplica_setup_ds -short description: Setup DS +short_description: Setup DS description: Setup DS options: diff --git a/roles/ipareplica/library/ipareplica_setup_http.py b/roles/ipareplica/library/ipareplica_setup_http.py index 2d26d18c..6e87a115 100644 --- a/roles/ipareplica/library/ipareplica_setup_http.py +++ b/roles/ipareplica/library/ipareplica_setup_http.py @@ -34,7 +34,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = ''' --- module: ipareplica_setup_http -short description: Setup HTTP +short_description: Setup HTTP description: Setup HTTP options: diff --git a/roles/ipareplica/library/ipareplica_setup_kra.py b/roles/ipareplica/library/ipareplica_setup_kra.py index 5758ac22..49dab4dd 100644 --- a/roles/ipareplica/library/ipareplica_setup_kra.py +++ b/roles/ipareplica/library/ipareplica_setup_kra.py @@ -34,7 +34,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = ''' --- module: ipareplica_setup_kra -short description: Setup KRA +short_description: Setup KRA description: Setup KRA options: diff --git a/roles/ipareplica/library/ipareplica_setup_krb.py b/roles/ipareplica/library/ipareplica_setup_krb.py index 423f4dec..36c6578a 100644 --- a/roles/ipareplica/library/ipareplica_setup_krb.py +++ b/roles/ipareplica/library/ipareplica_setup_krb.py @@ -34,7 +34,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = ''' --- module: ipareplica_setup_krb -short description: Setup KRB +short_description: Setup KRB description: Setup KRB options: diff --git a/roles/ipareplica/library/ipareplica_setup_otpd.py b/roles/ipareplica/library/ipareplica_setup_otpd.py index 8d8aedbe..a4b1c389 100644 --- a/roles/ipareplica/library/ipareplica_setup_otpd.py +++ b/roles/ipareplica/library/ipareplica_setup_otpd.py @@ -34,7 +34,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = ''' --- module: ipareplica_setup_otpd -short description: Setup OTPD +short_description: Setup OTPD description: Setup OTPD options: diff --git a/roles/ipareplica/library/ipareplica_test.py b/roles/ipareplica/library/ipareplica_test.py index f34f3ed7..520502af 100644 --- a/roles/ipareplica/library/ipareplica_test.py +++ b/roles/ipareplica/library/ipareplica_test.py @@ -34,7 +34,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = ''' --- module: ipareplica_test -short description: IPA replica deployment tests +short_description: IPA replica deployment tests description: IPA replica deployment tests options: ip_addresses: diff --git a/roles/ipaserver/library/ipaserver_enable_ipa.py b/roles/ipaserver/library/ipaserver_enable_ipa.py index d1333d5f..332c72ff 100644 --- a/roles/ipaserver/library/ipaserver_enable_ipa.py +++ b/roles/ipaserver/library/ipaserver_enable_ipa.py @@ -34,7 +34,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = ''' --- module: ipaserver_enable_ipa -short description: Enable IPA +short_description: Enable IPA description: Enable IPA options: hostname: diff --git a/roles/ipaserver/library/ipaserver_load_cache.py b/roles/ipaserver/library/ipaserver_load_cache.py index e93567b5..e3f6fd32 100644 --- a/roles/ipaserver/library/ipaserver_load_cache.py +++ b/roles/ipaserver/library/ipaserver_load_cache.py @@ -34,7 +34,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = ''' --- module: ipaserver_load_cache -short description: Load cache file +short_description: Load cache file description: Load cache file options: dm_password: diff --git a/roles/ipaserver/library/ipaserver_master_password.py b/roles/ipaserver/library/ipaserver_master_password.py index 8d26cac4..3021498b 100644 --- a/roles/ipaserver/library/ipaserver_master_password.py +++ b/roles/ipaserver/library/ipaserver_master_password.py @@ -34,7 +34,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = ''' --- module: ipaserver_master_password -short description: Generate kerberos master password if not given +short_description: Generate kerberos master password if not given description: Generate kerberos master password if not given options: diff --git a/roles/ipaserver/library/ipaserver_prepare.py b/roles/ipaserver/library/ipaserver_prepare.py index b3795005..7a65a9f5 100644 --- a/roles/ipaserver/library/ipaserver_prepare.py +++ b/roles/ipaserver/library/ipaserver_prepare.py @@ -34,7 +34,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = ''' --- module: ipaserver_prepare -short description: Prepare IPA server deployment +short_description: Prepare IPA server deployment description: Prepare IPA server deployment options: force: diff --git a/roles/ipaserver/library/ipaserver_set_ds_password.py b/roles/ipaserver/library/ipaserver_set_ds_password.py index 283e093a..f4d767be 100644 --- a/roles/ipaserver/library/ipaserver_set_ds_password.py +++ b/roles/ipaserver/library/ipaserver_set_ds_password.py @@ -34,7 +34,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = ''' --- module: ipaserver_set_ds_password -short description: Set DS password +short_description: Set DS password description: Set DS password options: dm_password: diff --git a/roles/ipaserver/library/ipaserver_setup_adtrust.py b/roles/ipaserver/library/ipaserver_setup_adtrust.py index de15ef49..428d2528 100644 --- a/roles/ipaserver/library/ipaserver_setup_adtrust.py +++ b/roles/ipaserver/library/ipaserver_setup_adtrust.py @@ -34,7 +34,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = ''' --- module: ipaserver_setup_adtrust -short description: Setup trust ad +short_description: Setup trust ad description: Setup trust ad options: hostname: diff --git a/roles/ipaserver/library/ipaserver_setup_ca.py b/roles/ipaserver/library/ipaserver_setup_ca.py index 0b03f619..8c01e3c9 100644 --- a/roles/ipaserver/library/ipaserver_setup_ca.py +++ b/roles/ipaserver/library/ipaserver_setup_ca.py @@ -34,7 +34,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = ''' --- module: ipaserver_setup_ca -short description: Setup CA +short_description: Setup CA description: Setup CA options: dm_password: diff --git a/roles/ipaserver/library/ipaserver_setup_custodia.py b/roles/ipaserver/library/ipaserver_setup_custodia.py index b0b98cc4..a788ad12 100644 --- a/roles/ipaserver/library/ipaserver_setup_custodia.py +++ b/roles/ipaserver/library/ipaserver_setup_custodia.py @@ -34,7 +34,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = ''' --- module: ipaserver_setup_custodia -short description: Setup custodia +short_description: Setup custodia description: Setup custodia options: realm: diff --git a/roles/ipaserver/library/ipaserver_setup_dns.py b/roles/ipaserver/library/ipaserver_setup_dns.py index eba94e50..1ed1fe4f 100644 --- a/roles/ipaserver/library/ipaserver_setup_dns.py +++ b/roles/ipaserver/library/ipaserver_setup_dns.py @@ -34,7 +34,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = ''' --- module: ipaserver_setup_dns -short description: Setup DNS +short_description: Setup DNS description: Setup DNS options: ip_addresses: diff --git a/roles/ipaserver/library/ipaserver_setup_ds.py b/roles/ipaserver/library/ipaserver_setup_ds.py index 602ec9ea..76fb4b73 100644 --- a/roles/ipaserver/library/ipaserver_setup_ds.py +++ b/roles/ipaserver/library/ipaserver_setup_ds.py @@ -34,7 +34,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = ''' --- module: ipaserver_setup_ds -short description: Configure directory server +short_description: Configure directory server description: Configure directory server options: dm_password: diff --git a/roles/ipaserver/library/ipaserver_setup_http.py b/roles/ipaserver/library/ipaserver_setup_http.py index 350f39b5..5f72b1cb 100644 --- a/roles/ipaserver/library/ipaserver_setup_http.py +++ b/roles/ipaserver/library/ipaserver_setup_http.py @@ -34,7 +34,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = ''' --- module: ipaserver_setup_http -short description: Setup HTTP +short_description: Setup HTTP description: Setup HTTP options: dm_password: diff --git a/roles/ipaserver/library/ipaserver_setup_kra.py b/roles/ipaserver/library/ipaserver_setup_kra.py index 6ca32953..78f1fe26 100644 --- a/roles/ipaserver/library/ipaserver_setup_kra.py +++ b/roles/ipaserver/library/ipaserver_setup_kra.py @@ -34,7 +34,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = ''' --- module: ipaserver_setup_kra -short description: Setup KRA +short_description: Setup KRA description: Setup KRA options: dm_password: diff --git a/roles/ipaserver/library/ipaserver_setup_krb.py b/roles/ipaserver/library/ipaserver_setup_krb.py index 6cddbc83..70daab25 100644 --- a/roles/ipaserver/library/ipaserver_setup_krb.py +++ b/roles/ipaserver/library/ipaserver_setup_krb.py @@ -34,7 +34,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = ''' --- module: ipaserver_setup_krb -short description: Setup KRB +short_description: Setup KRB description: Setup KRB options: dm_password: diff --git a/roles/ipaserver/library/ipaserver_setup_ntp.py b/roles/ipaserver/library/ipaserver_setup_ntp.py index c2292ebe..9efad213 100644 --- a/roles/ipaserver/library/ipaserver_setup_ntp.py +++ b/roles/ipaserver/library/ipaserver_setup_ntp.py @@ -34,7 +34,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = ''' --- module: ipaserver_setup_ntp -short description: Setup NTP +short_description: Setup NTP description: Setup NTP options: ntp_servers: diff --git a/roles/ipaserver/library/ipaserver_setup_otpd.py b/roles/ipaserver/library/ipaserver_setup_otpd.py index e1f9ce2c..ca1e06c4 100644 --- a/roles/ipaserver/library/ipaserver_setup_otpd.py +++ b/roles/ipaserver/library/ipaserver_setup_otpd.py @@ -34,7 +34,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = ''' --- module: ipaserver_setup_otpd -short description: Setup OTPD +short_description: Setup OTPD description: Setup OTPD options: realm: diff --git a/roles/ipaserver/library/ipaserver_test.py b/roles/ipaserver/library/ipaserver_test.py index db108b77..21581505 100644 --- a/roles/ipaserver/library/ipaserver_test.py +++ b/roles/ipaserver/library/ipaserver_test.py @@ -34,7 +34,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = ''' --- module: ipaserver_test -short description: IPA server test +short_description: IPA server test description: IPA server test options: force: diff --git a/roles/ipasmartcard_client/library/ipasmartcard_client_get_vars.py b/roles/ipasmartcard_client/library/ipasmartcard_client_get_vars.py index 66c65912..ed1dc41e 100644 --- a/roles/ipasmartcard_client/library/ipasmartcard_client_get_vars.py +++ b/roles/ipasmartcard_client/library/ipasmartcard_client_get_vars.py @@ -32,7 +32,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = ''' --- module: ipasmartcard_client_get_vars -short description: +short_description: Get variables from ipaplatform and python interpreter used for the module. description: Get variables from ipaplatform and python interpreter used for the module. diff --git a/roles/ipasmartcard_client/library/ipasmartcard_client_validate_ca_certs.py b/roles/ipasmartcard_client/library/ipasmartcard_client_validate_ca_certs.py index c89427b1..7463efef 100644 --- a/roles/ipasmartcard_client/library/ipasmartcard_client_validate_ca_certs.py +++ b/roles/ipasmartcard_client/library/ipasmartcard_client_validate_ca_certs.py @@ -34,7 +34,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = ''' --- module: ipasmartcard_server_validate_ca_certs -short description: Validate CA certs +short_description: Validate CA certs description: Validate CA certs options: ca_cert_files: diff --git a/roles/ipasmartcard_server/library/ipasmartcard_server_get_vars.py b/roles/ipasmartcard_server/library/ipasmartcard_server_get_vars.py index 97b1d8c9..6a7f23f2 100644 --- a/roles/ipasmartcard_server/library/ipasmartcard_server_get_vars.py +++ b/roles/ipasmartcard_server/library/ipasmartcard_server_get_vars.py @@ -32,7 +32,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = ''' --- module: ipasmartcard_server_get_vars -short description: +short_description: Get variables from ipaplatform and ipaserver and python interpreter. description: Get variables from ipaplatform and ipaserver and python interpreter. diff --git a/roles/ipasmartcard_server/library/ipasmartcard_server_validate_ca_certs.py b/roles/ipasmartcard_server/library/ipasmartcard_server_validate_ca_certs.py index c89427b1..7463efef 100644 --- a/roles/ipasmartcard_server/library/ipasmartcard_server_validate_ca_certs.py +++ b/roles/ipasmartcard_server/library/ipasmartcard_server_validate_ca_certs.py @@ -34,7 +34,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = ''' --- module: ipasmartcard_server_validate_ca_certs -short description: Validate CA certs +short_description: Validate CA certs description: Validate CA certs options: ca_cert_files: diff --git a/utils/templates/ipamodule+member.py.in b/utils/templates/ipamodule+member.py.in index dc682cf9..d3e2153e 100644 --- a/utils/templates/ipamodule+member.py.in +++ b/utils/templates/ipamodule+member.py.in @@ -32,7 +32,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = """ --- module: ipa$name -short description: Manage FreeIPA $name +short_description: Manage FreeIPA $name description: Manage FreeIPA $name and $name members extends_documentation_fragment: - ipamodule_base_docs diff --git a/utils/templates/ipamodule.py.in b/utils/templates/ipamodule.py.in index 07fe2ac4..0e13fa5d 100644 --- a/utils/templates/ipamodule.py.in +++ b/utils/templates/ipamodule.py.in @@ -32,7 +32,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = """ --- module: ipa$name -short description: Manage FreeIPA $name +short_description: Manage FreeIPA $name description: Manage FreeIPA $name extends_documentation_fragment: - ipamodule_base_docs -- GitLab