mirror of
https://github.com/freeipa/ansible-freeipa.git
synced 2026-07-28 18:34:44 +00:00
ipareplica_restart_kdc: Fix documentation sections and agument spec
ansible-test with ansible-2.14 is adding a lot of new tests to ensure that the documentation section and the agument spec is complete. Needed changes: DOCUMENTATION section - `type: str` needs to be set for string parameters - `required` tags need to be fixed according to the `argument_spec` - `type` tag needs to match `argument_spec` - `author` needs to be given with the github user also: `Name (@user)` argument_spec - `type='str'` needs to be set for string parameters supports_check_mode is turned off as it is not supported. A call to ansible_ipa_replica.check_imports has been added to check for import errors. The `copyright` date is extended with `-2022`.
This commit is contained in:
@@ -5,7 +5,7 @@
|
|||||||
#
|
#
|
||||||
# Based on ipa-replica-install code
|
# Based on ipa-replica-install code
|
||||||
#
|
#
|
||||||
# Copyright (C) 2018 Red Hat
|
# Copyright (C) 2018-2022 Red Hat
|
||||||
# see file 'COPYING' for use and warranty information
|
# see file 'COPYING' for use and warranty information
|
||||||
#
|
#
|
||||||
# This program is free software; you can redistribute it and/or modify
|
# This program is free software; you can redistribute it and/or modify
|
||||||
@@ -40,38 +40,48 @@ description:
|
|||||||
options:
|
options:
|
||||||
setup_ca:
|
setup_ca:
|
||||||
description: Configure a dogtag CA
|
description: Configure a dogtag CA
|
||||||
required: yes
|
type: bool
|
||||||
|
required: no
|
||||||
setup_kra:
|
setup_kra:
|
||||||
description: Configure a dogtag KRA
|
description: Configure a dogtag KRA
|
||||||
required: yes
|
type: bool
|
||||||
|
required: no
|
||||||
no_pkinit:
|
no_pkinit:
|
||||||
description: Disable pkinit setup steps
|
description: Disable pkinit setup steps
|
||||||
required: yes
|
type: bool
|
||||||
|
required: no
|
||||||
no_ui_redirect:
|
no_ui_redirect:
|
||||||
description: Do not automatically redirect to the Web UI
|
description: Do not automatically redirect to the Web UI
|
||||||
required: yes
|
type: bool
|
||||||
|
required: no
|
||||||
subject_base:
|
subject_base:
|
||||||
description:
|
description:
|
||||||
The certificate subject base (default O=<realm-name>).
|
The certificate subject base (default O=<realm-name>).
|
||||||
RDNs are in LDAP order (most specific RDN first).
|
RDNs are in LDAP order (most specific RDN first).
|
||||||
required: no
|
type: str
|
||||||
|
required: yes
|
||||||
config_master_host_name:
|
config_master_host_name:
|
||||||
description: The config master_host_name setting
|
description: The config master_host_name setting
|
||||||
required: no
|
type: str
|
||||||
|
required: yes
|
||||||
ccache:
|
ccache:
|
||||||
description: The local ccache
|
description: The local ccache
|
||||||
required: no
|
type: str
|
||||||
|
required: yes
|
||||||
_ca_file:
|
_ca_file:
|
||||||
description: The installer _ca_file setting
|
description: The installer _ca_file setting
|
||||||
required: yes
|
type: str
|
||||||
|
required: no
|
||||||
_top_dir:
|
_top_dir:
|
||||||
description: The installer _top_dir setting
|
description: The installer _top_dir setting
|
||||||
required: no
|
type: str
|
||||||
|
required: yes
|
||||||
dirman_password:
|
dirman_password:
|
||||||
description: Directory Manager (master) password
|
description: Directory Manager (master) password
|
||||||
required: no
|
type: str
|
||||||
|
required: yes
|
||||||
author:
|
author:
|
||||||
- Thomas Woerner
|
- Thomas Woerner (@t-woerner)
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
@@ -84,6 +94,7 @@ import os
|
|||||||
|
|
||||||
from ansible.module_utils.basic import AnsibleModule
|
from ansible.module_utils.basic import AnsibleModule
|
||||||
from ansible.module_utils.ansible_ipa_replica import (
|
from ansible.module_utils.ansible_ipa_replica import (
|
||||||
|
check_imports,
|
||||||
AnsibleModuleLog, setup_logging, installer, DN, paths, sysrestore,
|
AnsibleModuleLog, setup_logging, installer, DN, paths, sysrestore,
|
||||||
gen_env_boostrap_finalize_core, constants, api_bootstrap_finalize,
|
gen_env_boostrap_finalize_core, constants, api_bootstrap_finalize,
|
||||||
gen_ReplicaConfig, gen_remote_api, api, redirect_stdout, service,
|
gen_ReplicaConfig, gen_remote_api, api, redirect_stdout, service,
|
||||||
@@ -100,18 +111,19 @@ def main():
|
|||||||
no_pkinit=dict(required=False, type='bool'),
|
no_pkinit=dict(required=False, type='bool'),
|
||||||
no_ui_redirect=dict(required=False, type='bool'),
|
no_ui_redirect=dict(required=False, type='bool'),
|
||||||
# certificate system
|
# certificate system
|
||||||
subject_base=dict(required=True),
|
subject_base=dict(required=True, type='str'),
|
||||||
# additional
|
# additional
|
||||||
config_master_host_name=dict(required=True),
|
config_master_host_name=dict(required=True, type='str'),
|
||||||
ccache=dict(required=True),
|
ccache=dict(required=True, type='str'),
|
||||||
_ca_file=dict(required=False),
|
_ca_file=dict(required=False, type='str'),
|
||||||
_top_dir=dict(required=True),
|
_top_dir=dict(required=True, type='str'),
|
||||||
dirman_password=dict(required=True, no_log=True),
|
dirman_password=dict(required=True, type='str', no_log=True),
|
||||||
),
|
),
|
||||||
supports_check_mode=True,
|
supports_check_mode=False,
|
||||||
)
|
)
|
||||||
|
|
||||||
ansible_module._ansible_debug = True
|
ansible_module._ansible_debug = True
|
||||||
|
check_imports(ansible_module)
|
||||||
setup_logging()
|
setup_logging()
|
||||||
ansible_log = AnsibleModuleLog(ansible_module)
|
ansible_log = AnsibleModuleLog(ansible_module)
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user