From cd16490531b4dc69f2166acaf60e8a13ff45bc2b Mon Sep 17 00:00:00 2001
From: Thomas Woerner <twoerner@redhat.com>
Date: Mon, 1 Jul 2024 11:33:28 +0200
Subject: [PATCH] Role modules: Docs: Fix default value for string list
parameters
Fix default values for string list parameters where default is missing
in the DOCUMENTATION section, but is defined in argument_specs.
---
roles/ipareplica/library/ipareplica_create_ipa_conf.py | 3 +++
roles/ipareplica/library/ipareplica_install_ca_certs.py | 4 ++++
roles/ipareplica/library/ipareplica_prepare.py | 7 +++++++
roles/ipareplica/library/ipareplica_setup_ca.py | 1 +
roles/ipareplica/library/ipareplica_setup_dns.py | 1 +
roles/ipareplica/library/ipareplica_setup_ds.py | 4 ++++
roles/ipareplica/library/ipareplica_setup_kra.py | 3 +++
roles/ipareplica/library/ipareplica_test.py | 8 ++++++++
roles/ipaserver/library/ipaserver_prepare.py | 5 +++++
roles/ipaserver/library/ipaserver_set_ds_password.py | 2 ++
roles/ipaserver/library/ipaserver_setup_ca.py | 2 ++
roles/ipaserver/library/ipaserver_setup_dns.py | 1 +
roles/ipaserver/library/ipaserver_setup_ds.py | 2 ++
roles/ipaserver/library/ipaserver_setup_http.py | 5 +++++
roles/ipaserver/library/ipaserver_setup_krb.py | 3 +++
roles/ipaserver/library/ipaserver_test.py | 3 +++
.../library/ipasmartcard_client_validate_ca_certs.py | 1 +
.../library/ipasmartcard_server_validate_ca_certs.py | 1 +
18 files changed, 56 insertions(+)
diff --git a/roles/ipareplica/library/ipareplica_create_ipa_conf.py b/roles/ipareplica/library/ipareplica_create_ipa_conf.py
index 582a4124..84ba5556 100644
--- a/roles/ipareplica/library/ipareplica_create_ipa_conf.py
+++ b/roles/ipareplica/library/ipareplica_create_ipa_conf.py
@@ -51,6 +51,7 @@ options:
type: list
elements: str
required: no
+ default: []
domain:
description: Primary DNS domain of the IPA deployment
type: str
@@ -70,6 +71,7 @@ options:
type: list
elements: str
required: no
+ default: []
no_host_dns:
description: Do not use DNS for hostname lookup during installation
type: bool
@@ -97,6 +99,7 @@ options:
type: list
elements: str
required: no
+ default: []
force_join:
description: Force client enrollment even if already enrolled
type: bool
diff --git a/roles/ipareplica/library/ipareplica_install_ca_certs.py b/roles/ipareplica/library/ipareplica_install_ca_certs.py
index db0fb54a..8aba576a 100644
--- a/roles/ipareplica/library/ipareplica_install_ca_certs.py
+++ b/roles/ipareplica/library/ipareplica_install_ca_certs.py
@@ -51,6 +51,7 @@ options:
type: list
elements: str
required: no
+ default: []
domain:
description: Primary DNS domain of the IPA deployment
type: str
@@ -70,6 +71,7 @@ options:
type: list
elements: str
required: no
+ default: []
no_host_dns:
description: Do not use DNS for hostname lookup during installation
type: bool
@@ -97,6 +99,7 @@ options:
type: list
elements: str
required: no
+ default: []
force_join:
description: Force client enrollment even if already enrolled
type: bool
@@ -156,6 +159,7 @@ options:
type: list
elements: str
required: no
+ default: []
author:
- Thomas Woerner (@t-woerner)
'''
diff --git a/roles/ipareplica/library/ipareplica_prepare.py b/roles/ipareplica/library/ipareplica_prepare.py
index 3445b46c..ab772f73 100644
--- a/roles/ipareplica/library/ipareplica_prepare.py
+++ b/roles/ipareplica/library/ipareplica_prepare.py
@@ -53,6 +53,7 @@ options:
type: list
elements: str
required: no
+ default: []
domain:
description: Primary DNS domain of the IPA deployment
type: str
@@ -77,6 +78,7 @@ options:
type: list
elements: str
required: no
+ default: []
no_host_dns:
description: Do not use DNS for hostname lookup during installation
type: bool
@@ -104,6 +106,7 @@ options:
type: list
elements: str
required: no
+ default: []
dirsrv_cert_name:
description: Name of the Directory Server SSL certificate to install
type: str
@@ -118,6 +121,7 @@ options:
type: list
elements: str
required: no
+ default: []
http_cert_name:
description: Name of the Apache Server SSL certificate to install
type: str
@@ -132,6 +136,7 @@ options:
type: list
elements: str
required: no
+ default: []
pkinit_cert_name:
description: Name of the Kerberos KDC SSL certificate to install
type: str
@@ -182,6 +187,7 @@ options:
type: list
elements: str
required: no
+ default: []
no_reverse:
description: Do not create new reverse DNS zone
type: bool
@@ -197,6 +203,7 @@ options:
type: list
elements: str
required: no
+ default: []
no_forwarders:
description: Do not add any DNS forwarders, use root servers instead
type: bool
diff --git a/roles/ipareplica/library/ipareplica_setup_ca.py b/roles/ipareplica/library/ipareplica_setup_ca.py
index cbecd797..3323daa7 100644
--- a/roles/ipareplica/library/ipareplica_setup_ca.py
+++ b/roles/ipareplica/library/ipareplica_setup_ca.py
@@ -127,6 +127,7 @@ options:
type: list
elements: str
required: no
+ default: []
author:
- Thomas Woerner (@t-woerner)
'''
diff --git a/roles/ipareplica/library/ipareplica_setup_dns.py b/roles/ipareplica/library/ipareplica_setup_dns.py
index 7dadafca..d8c643e5 100644
--- a/roles/ipareplica/library/ipareplica_setup_dns.py
+++ b/roles/ipareplica/library/ipareplica_setup_dns.py
@@ -61,6 +61,7 @@ options:
type: list
elements: str
required: no
+ default: []
forward_policy:
description: DNS forwarding policy for global forwarders
type: str
diff --git a/roles/ipareplica/library/ipareplica_setup_ds.py b/roles/ipareplica/library/ipareplica_setup_ds.py
index 67e73a7e..64f5a61b 100644
--- a/roles/ipareplica/library/ipareplica_setup_ds.py
+++ b/roles/ipareplica/library/ipareplica_setup_ds.py
@@ -51,6 +51,7 @@ options:
type: list
elements: str
required: no
+ default: []
domain:
description: Primary DNS domain of the IPA deployment
type: str
@@ -70,6 +71,7 @@ options:
type: list
elements: str
required: no
+ default: []
no_host_dns:
description: Do not use DNS for hostname lookup during installation
type: bool
@@ -108,6 +110,7 @@ options:
type: list
elements: str
required: no
+ default: []
force_join:
description: Force client enrollment even if already enrolled
type: bool
@@ -176,6 +179,7 @@ options:
type: list
elements: str
required: no
+ default: []
author:
- Thomas Woerner (@t-woerner)
'''
diff --git a/roles/ipareplica/library/ipareplica_setup_kra.py b/roles/ipareplica/library/ipareplica_setup_kra.py
index 92fdfec5..866b4bc6 100644
--- a/roles/ipareplica/library/ipareplica_setup_kra.py
+++ b/roles/ipareplica/library/ipareplica_setup_kra.py
@@ -51,6 +51,7 @@ options:
type: list
elements: str
required: no
+ default: []
domain:
description: Primary DNS domain of the IPA deployment
type: str
@@ -70,6 +71,7 @@ options:
type: list
elements: str
required: no
+ default: []
no_host_dns:
description: Do not use DNS for hostname lookup during installation
type: bool
@@ -101,6 +103,7 @@ options:
type: list
elements: str
required: no
+ default: []
force_join:
description: Force client enrollment even if already enrolled
type: bool
diff --git a/roles/ipareplica/library/ipareplica_test.py b/roles/ipareplica/library/ipareplica_test.py
index fabb52aa..a29368e7 100644
--- a/roles/ipareplica/library/ipareplica_test.py
+++ b/roles/ipareplica/library/ipareplica_test.py
@@ -42,6 +42,7 @@ options:
type: list
elements: str
required: no
+ default: []
domain:
description: Primary DNS domain of the IPA deployment
type: str
@@ -51,6 +52,7 @@ options:
type: list
elements: str
required: no
+ default: []
realm:
description: Kerberos realm name of the IPA deployment
type: str
@@ -66,6 +68,7 @@ options:
type: list
elements: str
required: no
+ default: []
hidden_replica:
description: Install a hidden replica
type: bool
@@ -112,18 +115,21 @@ options:
type: list
elements: str
required: no
+ default: []
http_cert_files:
description:
File containing the Apache Server SSL certificate and private key
type: list
elements: str
required: no
+ default: []
pkinit_cert_files:
description:
File containing the Kerberos KDC SSL certificate and private key
type: list
elements: str
required: no
+ default: []
no_ntp:
description: Do not configure ntp
type: bool
@@ -134,6 +140,7 @@ options:
type: list
elements: str
required: no
+ default: []
ntp_pool:
description: ntp server pool to use
type: str
@@ -153,6 +160,7 @@ options:
type: list
elements: str
required: no
+ default: []
no_forwarders:
description: Do not add any DNS forwarders, use root servers instead
type: bool
diff --git a/roles/ipaserver/library/ipaserver_prepare.py b/roles/ipaserver/library/ipaserver_prepare.py
index 24eccf23..1276729f 100644
--- a/roles/ipaserver/library/ipaserver_prepare.py
+++ b/roles/ipaserver/library/ipaserver_prepare.py
@@ -55,6 +55,7 @@ options:
type: list
elements: str
required: no
+ default: []
domain:
description: Primary DNS domain of the IPA deployment
type: str
@@ -74,6 +75,7 @@ options:
type: list
elements: str
required: no
+ default: []
no_host_dns:
description: Do not use DNS for hostname lookup during installation
type: bool
@@ -114,6 +116,7 @@ options:
type: list
elements: str
required: no
+ default: []
subject_base:
description:
The certificate subject base (default O=<realm-name>).
@@ -134,6 +137,7 @@ options:
type: list
elements: str
required: no
+ default: []
no_reverse:
description: Do not create new reverse DNS zone
type: bool
@@ -149,6 +153,7 @@ options:
type: list
elements: str
required: no
+ default: []
no_forwarders:
description: Do not add any DNS forwarders, use root servers instead
type: bool
diff --git a/roles/ipaserver/library/ipaserver_set_ds_password.py b/roles/ipaserver/library/ipaserver_set_ds_password.py
index 2dd9a783..b23c777e 100644
--- a/roles/ipaserver/library/ipaserver_set_ds_password.py
+++ b/roles/ipaserver/library/ipaserver_set_ds_password.py
@@ -96,6 +96,7 @@ options:
type: list
elements: str
required: no
+ default: []
subject_base:
description:
The certificate subject base (default O=<realm-name>).
@@ -113,6 +114,7 @@ options:
type: list
elements: str
required: no
+ default: []
domainlevel:
description: The domain level
type: int
diff --git a/roles/ipaserver/library/ipaserver_setup_ca.py b/roles/ipaserver/library/ipaserver_setup_ca.py
index 1a453e49..b71cd618 100644
--- a/roles/ipaserver/library/ipaserver_setup_ca.py
+++ b/roles/ipaserver/library/ipaserver_setup_ca.py
@@ -54,6 +54,7 @@ options:
type: list
elements: str
required: no
+ default: []
domain:
description: Primary DNS domain of the IPA deployment
type: str
@@ -182,6 +183,7 @@ options:
type: list
elements: str
required: no
+ default: []
no_reverse:
description: Do not create new reverse DNS zone
type: bool
diff --git a/roles/ipaserver/library/ipaserver_setup_dns.py b/roles/ipaserver/library/ipaserver_setup_dns.py
index cf31eda9..b06246c4 100644
--- a/roles/ipaserver/library/ipaserver_setup_dns.py
+++ b/roles/ipaserver/library/ipaserver_setup_dns.py
@@ -42,6 +42,7 @@ options:
type: list
elements: str
required: no
+ default: []
domain:
description: Primary DNS domain of the IPA deployment
type: str
diff --git a/roles/ipaserver/library/ipaserver_setup_ds.py b/roles/ipaserver/library/ipaserver_setup_ds.py
index 4479daaa..f97770f3 100644
--- a/roles/ipaserver/library/ipaserver_setup_ds.py
+++ b/roles/ipaserver/library/ipaserver_setup_ds.py
@@ -87,6 +87,7 @@ options:
type: list
elements: str
required: no
+ default: []
_dirsrv_pkcs12_info:
description: The installer _dirsrv_pkcs12_info setting
type: list
@@ -99,6 +100,7 @@ options:
type: list
elements: str
required: no
+ default: []
subject_base:
description:
The certificate subject base (default O=<realm-name>).
diff --git a/roles/ipaserver/library/ipaserver_setup_http.py b/roles/ipaserver/library/ipaserver_setup_http.py
index cd6478ee..3aa4b21b 100644
--- a/roles/ipaserver/library/ipaserver_setup_http.py
+++ b/roles/ipaserver/library/ipaserver_setup_http.py
@@ -66,17 +66,20 @@ options:
type: list
elements: str
required: no
+ default: []
reverse_zones:
description: The reverse DNS zones to use
type: list
elements: str
required: no
+ default: []
http_cert_files:
description:
File containing the Apache Server SSL certificate and private key
type: list
elements: str
required: no
+ default: []
setup_adtrust:
description: Configure AD trust capability
type: bool
@@ -124,6 +127,7 @@ options:
type: list
elements: str
required: no
+ default: []
subject_base:
description:
The certificate subject base (default O=<realm-name>).
@@ -166,6 +170,7 @@ options:
type: list
elements: str
required: no
+ default: []
no_reverse:
description: Do not create new reverse DNS zone
type: bool
diff --git a/roles/ipaserver/library/ipaserver_setup_krb.py b/roles/ipaserver/library/ipaserver_setup_krb.py
index df37ed31..9a66107a 100644
--- a/roles/ipaserver/library/ipaserver_setup_krb.py
+++ b/roles/ipaserver/library/ipaserver_setup_krb.py
@@ -66,11 +66,13 @@ options:
type: list
elements: str
required: no
+ default: []
reverse_zones:
description: The reverse DNS zones to use
type: list
elements: str
required: no
+ default: []
setup_adtrust:
description: Configure AD trust capability
type: bool
@@ -113,6 +115,7 @@ options:
type: list
elements: str
required: no
+ default: []
subject_base:
description:
The certificate subject base (default O=<realm-name>).
diff --git a/roles/ipaserver/library/ipaserver_test.py b/roles/ipaserver/library/ipaserver_test.py
index bf8d3b4c..06df1b70 100644
--- a/roles/ipaserver/library/ipaserver_test.py
+++ b/roles/ipaserver/library/ipaserver_test.py
@@ -73,6 +73,7 @@ options:
type: list
elements: str
required: no
+ default: []
no_host_dns:
description: Do not use DNS for hostname lookup during installation
type: bool
@@ -223,6 +224,7 @@ options:
type: list
elements: str
required: no
+ default: []
no_reverse:
description: Do not create new reverse DNS zone
type: bool
@@ -242,6 +244,7 @@ options:
type: list
elements: str
required: no
+ default: []
no_forwarders:
description: Do not add any DNS forwarders, use root servers instead
type: bool
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 0501d388..3765e334 100644
--- a/roles/ipasmartcard_client/library/ipasmartcard_client_validate_ca_certs.py
+++ b/roles/ipasmartcard_client/library/ipasmartcard_client_validate_ca_certs.py
@@ -44,6 +44,7 @@ options:
type: list
elements: str
required: no
+ default: []
author:
- Thomas Woerner (@t-woerner)
'''
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 b776e584..af67ec3c 100644
--- a/roles/ipasmartcard_server/library/ipasmartcard_server_validate_ca_certs.py
+++ b/roles/ipasmartcard_server/library/ipasmartcard_server_validate_ca_certs.py
@@ -44,6 +44,7 @@ options:
type: list
elements: str
required: no
+ default: []
author:
- Thomas Woerner (@t-woerner)
'''
--
GitLab