mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-05-28 03:49:09 -07:00
[ip ... j]*.py: normalize docs (#9392)
* [ip ... j]*.py: normalize docs * Update plugins/modules/ip_netns.py Co-authored-by: Felix Fontein <felix@fontein.de> --------- Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
parent
cea6eeef37
commit
a99f72fc36
43 changed files with 1290 additions and 1429 deletions
|
@ -7,8 +7,7 @@
|
|||
from __future__ import absolute_import, division, print_function
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = r'''
|
||||
---
|
||||
DOCUMENTATION = r"""
|
||||
module: ipa_host
|
||||
author: Thomas Krahn (@Nosmoht)
|
||||
short_description: Manage FreeIPA host
|
||||
|
@ -22,73 +21,73 @@ attributes:
|
|||
options:
|
||||
fqdn:
|
||||
description:
|
||||
- Full qualified domain name.
|
||||
- Can not be changed as it is the unique identifier.
|
||||
- Full qualified domain name.
|
||||
- Can not be changed as it is the unique identifier.
|
||||
required: true
|
||||
aliases: ["name"]
|
||||
type: str
|
||||
description:
|
||||
description:
|
||||
- A description of this host.
|
||||
- A description of this host.
|
||||
type: str
|
||||
force:
|
||||
description:
|
||||
- Force host name even if not in DNS.
|
||||
- Force host name even if not in DNS.
|
||||
required: false
|
||||
type: bool
|
||||
ip_address:
|
||||
description:
|
||||
- Add the host to DNS with this IP address.
|
||||
- Add the host to DNS with this IP address.
|
||||
type: str
|
||||
mac_address:
|
||||
description:
|
||||
- List of Hardware MAC address(es) off this host.
|
||||
- If option is omitted MAC addresses will not be checked or changed.
|
||||
- If an empty list is passed all assigned MAC addresses will be removed.
|
||||
- MAC addresses that are already assigned but not passed will be removed.
|
||||
- List of Hardware MAC address(es) off this host.
|
||||
- If option is omitted MAC addresses will not be checked or changed.
|
||||
- If an empty list is passed all assigned MAC addresses will be removed.
|
||||
- MAC addresses that are already assigned but not passed will be removed.
|
||||
aliases: ["macaddress"]
|
||||
type: list
|
||||
elements: str
|
||||
ns_host_location:
|
||||
description:
|
||||
- Host location (e.g. "Lab 2")
|
||||
- Host location (for example V(Lab 2)).
|
||||
aliases: ["nshostlocation"]
|
||||
type: str
|
||||
ns_hardware_platform:
|
||||
description:
|
||||
- Host hardware platform (e.g. "Lenovo T61")
|
||||
- Host hardware platform (for example V(Lenovo T61")).
|
||||
aliases: ["nshardwareplatform"]
|
||||
type: str
|
||||
ns_os_version:
|
||||
description:
|
||||
- Host operating system and version (e.g. "Fedora 9")
|
||||
- Host operating system and version (for example V(Fedora 9)).
|
||||
aliases: ["nsosversion"]
|
||||
type: str
|
||||
user_certificate:
|
||||
description:
|
||||
- List of Base-64 encoded server certificates.
|
||||
- If option is omitted certificates will not be checked or changed.
|
||||
- If an empty list is passed all assigned certificates will be removed.
|
||||
- Certificates already assigned but not passed will be removed.
|
||||
- List of Base-64 encoded server certificates.
|
||||
- If option is omitted certificates will not be checked or changed.
|
||||
- If an empty list is passed all assigned certificates will be removed.
|
||||
- Certificates already assigned but not passed will be removed.
|
||||
aliases: ["usercertificate"]
|
||||
type: list
|
||||
elements: str
|
||||
state:
|
||||
description:
|
||||
- State to ensure.
|
||||
- State to ensure.
|
||||
default: present
|
||||
choices: ["absent", "disabled", "enabled", "present"]
|
||||
type: str
|
||||
force_creation:
|
||||
description:
|
||||
- Create host if O(state=disabled) or O(state=enabled) but not present.
|
||||
- Create host if O(state=disabled) or O(state=enabled) but not present.
|
||||
default: true
|
||||
type: bool
|
||||
version_added: 9.5.0
|
||||
update_dns:
|
||||
description:
|
||||
- If set V(true) with O(state=absent), then removes DNS records of the host managed by FreeIPA DNS.
|
||||
- This option has no effect for states other than "absent".
|
||||
- If set V(true) with O(state=absent), then removes DNS records of the host managed by FreeIPA DNS.
|
||||
- This option has no effect for states other than V(absent).
|
||||
type: bool
|
||||
random_password:
|
||||
description: Generate a random password to be used in bulk enrollment.
|
||||
|
@ -96,10 +95,9 @@ options:
|
|||
extends_documentation_fragment:
|
||||
- community.general.ipa.documentation
|
||||
- community.general.attributes
|
||||
"""
|
||||
|
||||
'''
|
||||
|
||||
EXAMPLES = r'''
|
||||
EXAMPLES = r"""
|
||||
- name: Ensure host is present
|
||||
community.general.ipa_host:
|
||||
name: host01.example.com
|
||||
|
@ -109,8 +107,8 @@ EXAMPLES = r'''
|
|||
ns_os_version: CentOS 7
|
||||
ns_hardware_platform: Lenovo T61
|
||||
mac_address:
|
||||
- "08:00:27:E3:B1:2D"
|
||||
- "52:54:00:BD:97:1E"
|
||||
- "08:00:27:E3:B1:2D"
|
||||
- "52:54:00:BD:97:1E"
|
||||
state: present
|
||||
ipa_host: ipa.example.com
|
||||
ipa_user: admin
|
||||
|
@ -159,18 +157,18 @@ EXAMPLES = r'''
|
|||
ipa_user: admin
|
||||
ipa_pass: topsecret
|
||||
update_dns: true
|
||||
'''
|
||||
"""
|
||||
|
||||
RETURN = r'''
|
||||
RETURN = r"""
|
||||
host:
|
||||
description: Host as returned by IPA API.
|
||||
returned: always
|
||||
type: dict
|
||||
host_diff:
|
||||
description: List of options that differ and would be changed
|
||||
description: List of options that differ and would be changed.
|
||||
returned: if check mode and a difference is found
|
||||
type: list
|
||||
'''
|
||||
"""
|
||||
|
||||
import traceback
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue