ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-04-06 10:40:32 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 11

[ip ... j]*.py: normalize docs (#9392)

Browse source 
* [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:
Alexei Znamensky 2024-12-27 01:40:05 +13:00 • committed by GitHub
parent cea6eeef37
commit a99f72fc36
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
43 changed files with 1290 additions and 1429 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
plugins/modules/ip_netns.py
View file

@ -7,14 +7,13 @@
from __future__ import absolute_import, division, print_function from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = ''' DOCUMENTATION = r"""
---
module: ip_netns module: ip_netns
author: "Arie Bregman (@bregman-arie)" author: "Arie Bregman (@bregman-arie)"
short_description: Manage network namespaces short_description: Manage network namespaces
requirements: [ip] requirements: [ip]
description: description:
- Create or delete network namespaces using the ip command. - Create or delete network namespaces using the C(ip) command.
extends_documentation_fragment: extends_documentation_fragment:
- community.general.attributes - community.general.attributes
attributes: attributes:
@ -26,18 +25,18 @@ options:
name: name:
required: false required: false
description: description:
- Name of the namespace - Name of the namespace.
type: str type: str
state: state:
required: false required: false
default: "present" default: "present"
choices: [present, absent] choices: [present, absent]
description: description:
- Whether the namespace should exist - Whether the namespace should exist.
type: str type: str
''' """
EXAMPLES = ''' EXAMPLES = r"""
- name: Create a namespace named mario - name: Create a namespace named mario
community.general.ip_netns: community.general.ip_netns:
name: mario name: mario
@ -47,11 +46,11 @@ EXAMPLES = '''
community.general.ip_netns: community.general.ip_netns:
name: luigi name: luigi
state: absent state: absent
''' """
RETURN = ''' RETURN = r"""
# Default return values # Default return values
''' """
from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.common.text.converters import to_text from ansible.module_utils.common.text.converters import to_text

14
plugins/modules/ipa_config.py
View file

@ -7,8 +7,7 @@
from __future__ import absolute_import, division, print_function from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = r''' DOCUMENTATION = r"""
---
module: ipa_config module: ipa_config
author: Fran Fitzpatrick (@fxfitz) author: Fran Fitzpatrick (@fxfitz)
short_description: Manage Global FreeIPA Configuration Settings short_description: Manage Global FreeIPA Configuration Settings
@ -115,10 +114,9 @@ options:
extends_documentation_fragment: extends_documentation_fragment:
- community.general.ipa.documentation - community.general.ipa.documentation
- community.general.attributes - community.general.attributes
"""
''' EXAMPLES = r"""
EXAMPLES = r'''
- name: Ensure password plugin features DC:Disable Last Success and KDC:Disable Lockout are enabled - name: Ensure password plugin features DC:Disable Last Success and KDC:Disable Lockout are enabled
community.general.ipa_config: community.general.ipa_config:
ipaconfigstring: ["KDC:Disable Last Success", "KDC:Disable Lockout"] ipaconfigstring: ["KDC:Disable Last Success", "KDC:Disable Lockout"]
@ -221,14 +219,14 @@ EXAMPLES = r'''
ipa_host: localhost ipa_host: localhost
ipa_user: admin ipa_user: admin
ipa_pass: supersecret ipa_pass: supersecret
''' """
RETURN = r''' RETURN = r"""
config: config:
description: Configuration as returned by IPA API. description: Configuration as returned by IPA API.
returned: always returned: always
type: dict type: dict
''' """
import traceback import traceback

22
plugins/modules/ipa_dnsrecord.py
View file

@ -8,8 +8,7 @@
from __future__ import absolute_import, division, print_function from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = r''' DOCUMENTATION = r"""
---
module: ipa_dnsrecord module: ipa_dnsrecord
author: Abhijeet Kasurde (@Akasurde) author: Abhijeet Kasurde (@Akasurde)
short_description: Manage FreeIPA DNS records short_description: Manage FreeIPA DNS records
@ -50,7 +49,8 @@ options:
- In the case of V(A6) record type, this will be the A6 Record data. - In the case of V(A6) record type, this will be the A6 Record data.
- In the case of V(CNAME) record type, this will be the hostname. - In the case of V(CNAME) record type, this will be the hostname.
- In the case of V(DNAME) record type, this will be the DNAME target. - In the case of V(DNAME) record type, this will be the DNAME target.
- In the case of V(NS) record type, this will be the name server hostname. Hostname must already have a valid A or AAAA record. - In the case of V(NS) record type, this will be the name server hostname. Hostname must already have a valid A or AAAA
record.
- In the case of V(PTR) record type, this will be the hostname. - In the case of V(PTR) record type, this will be the hostname.
- In the case of V(TXT) record type, this will be a text. - In the case of V(TXT) record type, this will be a text.
- In the case of V(SRV) record type, this will be a service record. - In the case of V(SRV) record type, this will be a service record.
@ -65,7 +65,8 @@ options:
- In the case of V(A6) record type, this will be the A6 Record data. - In the case of V(A6) record type, this will be the A6 Record data.
- In the case of V(CNAME) record type, this will be the hostname. - In the case of V(CNAME) record type, this will be the hostname.
- In the case of V(DNAME) record type, this will be the DNAME target. - In the case of V(DNAME) record type, this will be the DNAME target.
- In the case of V(NS) record type, this will be the name server hostname. Hostname must already have a valid A or AAAA record. - In the case of V(NS) record type, this will be the name server hostname. Hostname must already have a valid A or AAAA
record.
- In the case of V(PTR) record type, this will be the hostname. - In the case of V(PTR) record type, this will be the hostname.
- In the case of V(TXT) record type, this will be a text. - In the case of V(TXT) record type, this will be a text.
- In the case of V(SRV) record type, this will be a service record. - In the case of V(SRV) record type, this will be a service record.
@ -80,7 +81,7 @@ options:
required: false required: false
type: int type: int
state: state:
description: State to ensure description: State to ensure.
required: false required: false
default: present default: present
choices: ["absent", "present"] choices: ["absent", "present"]
@ -88,10 +89,9 @@ options:
extends_documentation_fragment: extends_documentation_fragment:
- community.general.ipa.documentation - community.general.ipa.documentation
- community.general.attributes - community.general.attributes
"""
''' EXAMPLES = r"""
EXAMPLES = r'''
- name: Ensure dns record is present - name: Ensure dns record is present
community.general.ipa_dnsrecord: community.general.ipa_dnsrecord:
ipa_host: spider.example.com ipa_host: spider.example.com
@ -189,14 +189,14 @@ EXAMPLES = r'''
ipa_host: ipa.example.com ipa_host: ipa.example.com
ipa_user: admin ipa_user: admin
ipa_pass: ChangeMe! ipa_pass: ChangeMe!
''' """
RETURN = r''' RETURN = r"""
dnsrecord: dnsrecord:
description: DNS record as returned by IPA API. description: DNS record as returned by IPA API.
returned: always returned: always
type: dict type: dict
''' """
import traceback import traceback

18
plugins/modules/ipa_dnszone.py
View file

@ -8,13 +8,12 @@
from __future__ import absolute_import, division, print_function from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = r''' DOCUMENTATION = r"""
---
module: ipa_dnszone module: ipa_dnszone
author: Fran Fitzpatrick (@fxfitz) author: Fran Fitzpatrick (@fxfitz)
short_description: Manage FreeIPA DNS Zones short_description: Manage FreeIPA DNS Zones
description: description:
- Add and delete an IPA DNS Zones using IPA API - Add and delete an IPA DNS Zones using IPA API.
attributes: attributes:
check_mode: check_mode:
support: full support: full
@ -27,7 +26,7 @@ options:
required: true required: true
type: str type: str
state: state:
description: State to ensure description: State to ensure.
required: false required: false
default: present default: present
choices: ["absent", "present"] choices: ["absent", "present"]
@ -44,10 +43,9 @@ options:
extends_documentation_fragment: extends_documentation_fragment:
- community.general.ipa.documentation - community.general.ipa.documentation
- community.general.attributes - community.general.attributes
"""
''' EXAMPLES = r"""
EXAMPLES = r'''
- name: Ensure dns zone is present - name: Ensure dns zone is present
community.general.ipa_dnszone: community.general.ipa_dnszone:
ipa_host: spider.example.com ipa_host: spider.example.com
@ -78,14 +76,14 @@ EXAMPLES = r'''
state: present state: present
zone_name: example.com zone_name: example.com
allowsyncptr: true allowsyncptr: true
''' """
RETURN = r''' RETURN = r"""
zone: zone:
description: DNS zone as returned by IPA API. description: DNS zone as returned by IPA API.
returned: always returned: always
type: dict type: dict
''' """
from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.basic import AnsibleModule
from ansible_collections.community.general.plugins.module_utils.ipa import IPAClient, ipa_argument_spec from ansible_collections.community.general.plugins.module_utils.ipa import IPAClient, ipa_argument_spec

12
plugins/modules/ipa_getkeytab.py
View file

@ -8,8 +8,7 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = r''' DOCUMENTATION = r"""
---
module: ipa_getkeytab module: ipa_getkeytab
short_description: Manage keytab file in FreeIPA short_description: Manage keytab file in FreeIPA
version_added: 9.5.0 version_added: 9.5.0
@ -82,7 +81,8 @@ options:
state: state:
description: description:
- The state of the keytab file. - The state of the keytab file.
- V(present) only check for existence of a file, if you want to recreate keytab with other parameters you should set O(force=true). - V(present) only check for existence of a file, if you want to recreate keytab with other parameters you should set
O(force=true).
type: str type: str
default: present default: present
choices: ["present", "absent"] choices: ["present", "absent"]
@ -95,9 +95,9 @@ requirements:
- Managed host is FreeIPA client - Managed host is FreeIPA client
extends_documentation_fragment: extends_documentation_fragment:
- community.general.attributes - community.general.attributes
''' """
EXAMPLES = r''' EXAMPLES = r"""
- name: Get Kerberos ticket using default principal - name: Get Kerberos ticket using default principal
community.general.krb_ticket: community.general.krb_ticket:
password: "{{ aldpro_admin_password }}" password: "{{ aldpro_admin_password }}"
@ -121,7 +121,7 @@ EXAMPLES = r'''
principal: HTTP/freeipa-dc02.ipa.test principal: HTTP/freeipa-dc02.ipa.test
ipa_host: freeipa-dc01.ipa.test ipa_host: freeipa-dc01.ipa.test
force: true force: true
''' """
import os import os

20
plugins/modules/ipa_group.py
View file

@ -7,13 +7,12 @@
from __future__ import absolute_import, division, print_function from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = r''' DOCUMENTATION = r"""
---
module: ipa_group module: ipa_group
author: Thomas Krahn (@Nosmoht) author: Thomas Krahn (@Nosmoht)
short_description: Manage FreeIPA group short_description: Manage FreeIPA group
description: description:
- Add, modify and delete group within IPA server - Add, modify and delete group within IPA server.
attributes: attributes:
check_mode: check_mode:
support: full support: full
@ -82,17 +81,16 @@ options:
version_added: 6.3.0 version_added: 6.3.0
state: state:
description: description:
- State to ensure - State to ensure.
default: "present" default: "present"
choices: ["absent", "present"] choices: ["absent", "present"]
type: str type: str
extends_documentation_fragment: extends_documentation_fragment:
- community.general.ipa.documentation - community.general.ipa.documentation
- community.general.attributes - community.general.attributes
"""
''' EXAMPLES = r"""
EXAMPLES = r'''
- name: Ensure group is present - name: Ensure group is present
community.general.ipa_group: community.general.ipa_group:
name: oinstall name: oinstall
@ -162,14 +160,14 @@ EXAMPLES = r'''
ipa_host: ipa.example.com ipa_host: ipa.example.com
ipa_user: admin ipa_user: admin
ipa_pass: topsecret ipa_pass: topsecret
''' """
RETURN = r''' RETURN = r"""
group: group:
description: Group as returned by IPA API description: Group as returned by IPA API.
returned: always returned: always
type: dict type: dict
''' """
import traceback import traceback

28
plugins/modules/ipa_hbacrule.py
View file

@ -7,8 +7,7 @@
from __future__ import absolute_import, division, print_function from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = r''' DOCUMENTATION = r"""
---
module: ipa_hbacrule module: ipa_hbacrule
author: Thomas Krahn (@Nosmoht) author: Thomas Krahn (@Nosmoht)
short_description: Manage FreeIPA HBAC rule short_description: Manage FreeIPA HBAC rule
@ -28,7 +27,7 @@ options:
aliases: ["name"] aliases: ["name"]
type: str type: str
description: description:
description: Description description: Description.
type: str type: str
host: host:
description: description:
@ -39,13 +38,13 @@ options:
type: list type: list
elements: str elements: str
hostcategory: hostcategory:
description: Host category description: Host category.
choices: ['all'] choices: ['all']
type: str type: str
hostgroup: hostgroup:
description: description:
- List of hostgroup names to assign. - List of hostgroup names to assign.
- If an empty list is passed all hostgroups will be removed. from the rule - If an empty list is passed all hostgroups will be removed from the rule.
- If option is omitted hostgroups will not be checked or changed. - If option is omitted hostgroups will not be checked or changed.
type: list type: list
elements: str elements: str
@ -57,7 +56,7 @@ options:
type: list type: list
elements: str elements: str
servicecategory: servicecategory:
description: Service category description: Service category.
choices: ['all'] choices: ['all']
type: str type: str
servicegroup: servicegroup:
@ -75,7 +74,7 @@ options:
type: list type: list
elements: str elements: str
sourcehostcategory: sourcehostcategory:
description: Source host category description: Source host category.
choices: ['all'] choices: ['all']
type: str type: str
sourcehostgroup: sourcehostgroup:
@ -86,7 +85,7 @@ options:
type: list type: list
elements: str elements: str
state: state:
description: State to ensure description: State to ensure.
default: "present" default: "present"
choices: ["absent", "disabled", "enabled", "present"] choices: ["absent", "disabled", "enabled", "present"]
type: str type: str
@ -98,7 +97,7 @@ options:
type: list type: list
elements: str elements: str
usercategory: usercategory:
description: User category description: User category.
choices: ['all'] choices: ['all']
type: str type: str
usergroup: usergroup:
@ -111,10 +110,9 @@ options:
extends_documentation_fragment: extends_documentation_fragment:
- community.general.ipa.documentation - community.general.ipa.documentation
- community.general.attributes - community.general.attributes
"""
''' EXAMPLES = r"""
EXAMPLES = r'''
- name: Ensure rule to allow all users to access any host from any host - name: Ensure rule to allow all users to access any host from any host
community.general.ipa_hbacrule: community.general.ipa_hbacrule:
name: allow_all name: allow_all
@ -147,14 +145,14 @@ EXAMPLES = r'''
ipa_host: ipa.example.com ipa_host: ipa.example.com
ipa_user: admin ipa_user: admin
ipa_pass: topsecret ipa_pass: topsecret
''' """
RETURN = r''' RETURN = r"""
hbacrule: hbacrule:
description: HBAC rule as returned by IPA API. description: HBAC rule as returned by IPA API.
returned: always returned: always
type: dict type: dict
''' """
import traceback import traceback

24
plugins/modules/ipa_host.py
View file

@ -7,8 +7,7 @@
from __future__ import absolute_import, division, print_function from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = r''' DOCUMENTATION = r"""
---
module: ipa_host module: ipa_host
author: Thomas Krahn (@Nosmoht) author: Thomas Krahn (@Nosmoht)
short_description: Manage FreeIPA host short_description: Manage FreeIPA host
@ -51,17 +50,17 @@ options:
elements: str elements: str
ns_host_location: ns_host_location:
description: description:
- Host location (e.g. "Lab 2") - Host location (for example V(Lab 2)).
aliases: ["nshostlocation"] aliases: ["nshostlocation"]
type: str type: str
ns_hardware_platform: ns_hardware_platform:
description: description:
- Host hardware platform (e.g. "Lenovo T61") - Host hardware platform (for example V(Lenovo T61")).
aliases: ["nshardwareplatform"] aliases: ["nshardwareplatform"]
type: str type: str
ns_os_version: ns_os_version:
description: description:
- Host operating system and version (e.g. "Fedora 9") - Host operating system and version (for example V(Fedora 9)).
aliases: ["nsosversion"] aliases: ["nsosversion"]
type: str type: str
user_certificate: user_certificate:
@ -88,7 +87,7 @@ options:
update_dns: update_dns:
description: description:
- If set V(true) with O(state=absent), then removes DNS records of the host managed by FreeIPA DNS. - 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". - This option has no effect for states other than V(absent).
type: bool type: bool
random_password: random_password:
description: Generate a random password to be used in bulk enrollment. description: Generate a random password to be used in bulk enrollment.
@ -96,10 +95,9 @@ options:
extends_documentation_fragment: extends_documentation_fragment:
- community.general.ipa.documentation - community.general.ipa.documentation
- community.general.attributes - community.general.attributes
"""
''' EXAMPLES = r"""
EXAMPLES = r'''
- name: Ensure host is present - name: Ensure host is present
community.general.ipa_host: community.general.ipa_host:
name: host01.example.com name: host01.example.com
@ -159,18 +157,18 @@ EXAMPLES = r'''
ipa_user: admin ipa_user: admin
ipa_pass: topsecret ipa_pass: topsecret
update_dns: true update_dns: true
''' """
RETURN = r''' RETURN = r"""
host: host:
description: Host as returned by IPA API. description: Host as returned by IPA API.
returned: always returned: always
type: dict type: dict
host_diff: 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 returned: if check mode and a difference is found
type: list type: list
''' """
import traceback import traceback

13
plugins/modules/ipa_hostgroup.py
View file

@ -7,8 +7,7 @@
from __future__ import absolute_import, division, print_function from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = r''' DOCUMENTATION = r"""
---
module: ipa_hostgroup module: ipa_hostgroup
author: Thomas Krahn (@Nosmoht) author: Thomas Krahn (@Nosmoht)
short_description: Manage FreeIPA host-group short_description: Manage FreeIPA host-group
@ -65,9 +64,9 @@ options:
extends_documentation_fragment: extends_documentation_fragment:
- community.general.ipa.documentation - community.general.ipa.documentation
- community.general.attributes - community.general.attributes
''' """
EXAMPLES = r''' EXAMPLES = r"""
- name: Ensure host-group databases is present - name: Ensure host-group databases is present
community.general.ipa_hostgroup: community.general.ipa_hostgroup:
name: databases name: databases
@ -88,14 +87,14 @@ EXAMPLES = r'''
ipa_host: ipa.example.com ipa_host: ipa.example.com
ipa_user: admin ipa_user: admin
ipa_pass: topsecret ipa_pass: topsecret
''' """
RETURN = r''' RETURN = r"""
hostgroup: hostgroup:
description: Hostgroup as returned by IPA API. description: Hostgroup as returned by IPA API.
returned: always returned: always
type: dict type: dict
''' """
import traceback import traceback

14
plugins/modules/ipa_otpconfig.py
View file

@ -8,8 +8,7 @@
from __future__ import absolute_import, division, print_function from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = r''' DOCUMENTATION = r"""
---
module: ipa_otpconfig module: ipa_otpconfig
author: justchris1 (@justchris1) author: justchris1 (@justchris1)
short_description: Manage FreeIPA OTP Configuration Settings short_description: Manage FreeIPA OTP Configuration Settings
@ -41,10 +40,9 @@ options:
extends_documentation_fragment: extends_documentation_fragment:
- community.general.ipa.documentation - community.general.ipa.documentation
- community.general.attributes - community.general.attributes
"""
''' EXAMPLES = r"""
EXAMPLES = r'''
- name: Ensure the TOTP authentication window is set to 300 seconds - name: Ensure the TOTP authentication window is set to 300 seconds
community.general.ipa_otpconfig: community.general.ipa_otpconfig:
ipatokentotpauthwindow: '300' ipatokentotpauthwindow: '300'
@ -72,14 +70,14 @@ EXAMPLES = r'''
ipa_host: localhost ipa_host: localhost
ipa_user: admin ipa_user: admin
ipa_pass: supersecret ipa_pass: supersecret
''' """
RETURN = r''' RETURN = r"""
otpconfig: otpconfig:
description: OTP configuration as returned by IPA API. description: OTP configuration as returned by IPA API.
returned: always returned: always
type: dict type: dict
''' """
import traceback import traceback

33
plugins/modules/ipa_otptoken.py
View file

@ -7,8 +7,7 @@
from __future__ import absolute_import, division, print_function from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = r''' DOCUMENTATION = r"""
---
module: ipa_otptoken module: ipa_otptoken
author: justchris1 (@justchris1) author: justchris1 (@justchris1)
short_description: Manage FreeIPA OTPs short_description: Manage FreeIPA OTPs
@ -32,14 +31,14 @@ options:
otptype: otptype:
description: description:
- Type of OTP. - Type of OTP.
- "B(Note:) Cannot be modified after OTP is created." - B(Note:) Cannot be modified after OTP is created.
type: str type: str
choices: [totp, hotp] choices: [totp, hotp]
secretkey: secretkey:
description: description:
- Token secret (Base64). - Token secret (Base64).
- If OTP is created and this is not specified, a random secret will be generated by IPA. - If OTP is created and this is not specified, a random secret will be generated by IPA.
- "B(Note:) Cannot be modified after OTP is created." - B(Note:) Cannot be modified after OTP is created.
type: str type: str
description: description:
description: Description of the token (informational only). description: Description of the token (informational only).
@ -55,13 +54,13 @@ options:
description: description:
- First date/time the token can be used. - First date/time the token can be used.
- In the format C(YYYYMMddHHmmss). - In the format C(YYYYMMddHHmmss).
- For example, C(20180121182022) will allow the token to be used starting on 21 January 2018 at 18:20:22. - For example, V(20180121182022) will allow the token to be used starting on 21 January 2018 at 18:20:22.
type: str type: str
notafter: notafter:
description: description:
- Last date/time the token can be used. - Last date/time the token can be used.
- In the format C(YYYYMMddHHmmss). - In the format C(YYYYMMddHHmmss).
- For example, C(20200121182022) will allow the token to be used until 21 January 2020 at 18:20:22. - For example, V(20200121182022) will allow the token to be used until 21 January 2020 at 18:20:22.
type: str type: str
vendor: vendor:
description: Token vendor name (informational only). description: Token vendor name (informational only).
@ -80,36 +79,36 @@ options:
algorithm: algorithm:
description: description:
- Token hash algorithm. - Token hash algorithm.
- "B(Note:) Cannot be modified after OTP is created." - B(Note:) Cannot be modified after OTP is created.
choices: ['sha1', 'sha256', 'sha384', 'sha512'] choices: ['sha1', 'sha256', 'sha384', 'sha512']
type: str type: str
digits: digits:
description: description:
- Number of digits each token code will have. - Number of digits each token code will have.
- "B(Note:) Cannot be modified after OTP is created." - B(Note:) Cannot be modified after OTP is created.
choices: [6, 8] choices: [6, 8]
type: int type: int
offset: offset:
description: description:
- TOTP token / IPA server time difference. - TOTP token / IPA server time difference.
- "B(Note:) Cannot be modified after OTP is created." - B(Note:) Cannot be modified after OTP is created.
type: int type: int
interval: interval:
description: description:
- Length of TOTP token code validity in seconds. - Length of TOTP token code validity in seconds.
- "B(Note:) Cannot be modified after OTP is created." - B(Note:) Cannot be modified after OTP is created.
type: int type: int
counter: counter:
description: description:
- Initial counter for the HOTP token. - Initial counter for the HOTP token.
- "B(Note:) Cannot be modified after OTP is created." - B(Note:) Cannot be modified after OTP is created.
type: int type: int
extends_documentation_fragment: extends_documentation_fragment:
- community.general.ipa.documentation - community.general.ipa.documentation
- community.general.attributes - community.general.attributes
''' """
EXAMPLES = r''' EXAMPLES = r"""
- name: Create a totp for pinky, allowing the IPA server to generate using defaults - name: Create a totp for pinky, allowing the IPA server to generate using defaults
community.general.ipa_otptoken: community.general.ipa_otptoken:
uniqueid: Token123 uniqueid: Token123
@ -161,14 +160,14 @@ EXAMPLES = r'''
ipa_host: ipa.example.com ipa_host: ipa.example.com
ipa_user: admin ipa_user: admin
ipa_pass: topsecret ipa_pass: topsecret
''' """
RETURN = r''' RETURN = r"""
otptoken: otptoken:
description: OTP Token as returned by IPA API description: OTP Token as returned by IPA API.
returned: always returned: always
type: dict type: dict
''' """
import base64 import base64
import traceback import traceback

19
plugins/modules/ipa_pwpolicy.py
View file

@ -7,8 +7,7 @@
from __future__ import absolute_import, division, print_function from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = r''' DOCUMENTATION = r"""
---
module: ipa_pwpolicy module: ipa_pwpolicy
author: Adralioh (@adralioh) author: Adralioh (@adralioh)
short_description: Manage FreeIPA password policies short_description: Manage FreeIPA password policies
@ -73,7 +72,8 @@ options:
type: int type: int
version_added: 8.2.0 version_added: 8.2.0
maxsequence: maxsequence:
description: Maximum length of monotonic character sequences in the new password. An example of a monotonic sequence of length 5 is V(12345). description: Maximum length of monotonic character sequences in the new password. An example of a monotonic sequence of
length 5 is V(12345).
type: int type: int
version_added: 8.2.0 version_added: 8.2.0
dictcheck: dictcheck:
@ -81,15 +81,16 @@ options:
type: bool type: bool
version_added: 8.2.0 version_added: 8.2.0
usercheck: usercheck:
description: Check whether the password (with possible modifications) contains the user name in some form (if the name has > 3 characters). description: Check whether the password (with possible modifications) contains the user name in some form (if the name
has > 3 characters).
type: bool type: bool
version_added: 8.2.0 version_added: 8.2.0
extends_documentation_fragment: extends_documentation_fragment:
- community.general.ipa.documentation - community.general.ipa.documentation
- community.general.attributes - community.general.attributes
''' """
EXAMPLES = r''' EXAMPLES = r"""
- name: Modify the global password policy - name: Modify the global password policy
community.general.ipa_pwpolicy: community.general.ipa_pwpolicy:
maxpwdlife: '90' maxpwdlife: '90'
@ -133,9 +134,9 @@ EXAMPLES = r'''
ipa_host: ipa.example.com ipa_host: ipa.example.com
ipa_user: admin ipa_user: admin
ipa_pass: topsecret ipa_pass: topsecret
''' """
RETURN = r''' RETURN = r"""
pwpolicy: pwpolicy:
description: Password policy as returned by IPA API. description: Password policy as returned by IPA API.
returned: always returned: always
@ -152,7 +153,7 @@ pwpolicy:
krbpwdmaxfailure: ['4'] krbpwdmaxfailure: ['4']
krbpwdmindiffchars: ['4'] krbpwdmindiffchars: ['4']
objectclass: ['top', 'nscontainer', 'krbpwdpolicy'] objectclass: ['top', 'nscontainer', 'krbpwdpolicy']
''' """
import traceback import traceback

14
plugins/modules/ipa_role.py
View file

@ -7,8 +7,7 @@
from __future__ import absolute_import, division, print_function from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = r''' DOCUMENTATION = r"""
---
module: ipa_role module: ipa_role
author: Thomas Krahn (@Nosmoht) author: Thomas Krahn (@Nosmoht)
short_description: Manage FreeIPA role short_description: Manage FreeIPA role
@ -86,10 +85,9 @@ options:
extends_documentation_fragment: extends_documentation_fragment:
- community.general.ipa.documentation - community.general.ipa.documentation
- community.general.attributes - community.general.attributes
"""
''' EXAMPLES = r"""
EXAMPLES = r'''
- name: Ensure role is present - name: Ensure role is present
community.general.ipa_role: community.general.ipa_role:
name: dba name: dba
@ -125,14 +123,14 @@ EXAMPLES = r'''
ipa_host: ipa.example.com ipa_host: ipa.example.com
ipa_user: admin ipa_user: admin
ipa_pass: topsecret ipa_pass: topsecret
''' """
RETURN = r''' RETURN = r"""
role: role:
description: Role as returned by IPA API. description: Role as returned by IPA API.
returned: always returned: always
type: dict type: dict
''' """
import traceback import traceback

16
plugins/modules/ipa_service.py
View file

@ -7,8 +7,7 @@
from __future__ import absolute_import, division, print_function from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = r''' DOCUMENTATION = r"""
---
module: ipa_service module: ipa_service
author: Cédric Parent (@cprh) author: Cédric Parent (@cprh)
short_description: Manage FreeIPA service short_description: Manage FreeIPA service
@ -29,7 +28,7 @@ options:
type: str type: str
hosts: hosts:
description: description:
- Defines the list of 'ManagedBy' hosts. - Defines the list of C(ManagedBy) hosts.
required: false required: false
type: list type: list
elements: str elements: str
@ -55,10 +54,9 @@ options:
extends_documentation_fragment: extends_documentation_fragment:
- community.general.ipa.documentation - community.general.ipa.documentation
- community.general.attributes - community.general.attributes
"""
''' EXAMPLES = r"""
EXAMPLES = r'''
- name: Ensure service is present - name: Ensure service is present
community.general.ipa_service: community.general.ipa_service:
name: http/host01.example.com name: http/host01.example.com
@ -84,14 +82,14 @@ EXAMPLES = r'''
ipa_host: ipa.example.com ipa_host: ipa.example.com
ipa_user: admin ipa_user: admin
ipa_pass: topsecret ipa_pass: topsecret
''' """
RETURN = r''' RETURN = r"""
service: service:
description: Service as returned by IPA API. description: Service as returned by IPA API.
returned: always returned: always
type: dict type: dict
''' """
import traceback import traceback

18
plugins/modules/ipa_subca.py
View file

@ -7,8 +7,7 @@
from __future__ import absolute_import, division, print_function from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = r''' DOCUMENTATION = r"""
---
module: ipa_subca module: ipa_subca
author: Abhijeet Kasurde (@Akasurde) author: Abhijeet Kasurde (@Akasurde)
short_description: Manage FreeIPA Lightweight Sub Certificate Authorities short_description: Manage FreeIPA Lightweight Sub Certificate Authorities
@ -28,7 +27,7 @@ options:
type: str type: str
subca_subject: subca_subject:
description: description:
- The Sub Certificate Authority's Subject. e.g., 'CN=SampleSubCA1,O=testrelm.test'. - The Sub Certificate Authority's Subject, for example V(CN=SampleSubCA1,O=testrelm.test).
required: true required: true
type: str type: str
subca_desc: subca_desc:
@ -38,7 +37,7 @@ options:
state: state:
description: description:
- State to ensure. - State to ensure.
- State 'disable' and 'enable' is available for FreeIPA 4.4.2 version and onwards. - States V(disable) and V(enable) are available for FreeIPA 4.4.2 version and onwards.
required: false required: false
default: present default: present
choices: ["absent", "disabled", "enabled", "present"] choices: ["absent", "disabled", "enabled", "present"]
@ -46,10 +45,9 @@ options:
extends_documentation_fragment: extends_documentation_fragment:
- community.general.ipa.documentation - community.general.ipa.documentation
- community.general.attributes - community.general.attributes
"""
''' EXAMPLES = r"""
EXAMPLES = '''
- name: Ensure IPA Sub CA is present - name: Ensure IPA Sub CA is present
community.general.ipa_subca: community.general.ipa_subca:
ipa_host: spider.example.com ipa_host: spider.example.com
@ -72,14 +70,14 @@ EXAMPLES = '''
ipa_pass: Passw0rd! ipa_pass: Passw0rd!
state: disable state: disable
subca_name: AnsibleSubCA1 subca_name: AnsibleSubCA1
''' """
RETURN = r''' RETURN = r"""
subca: subca:
description: IPA Sub CA record as returned by IPA API. description: IPA Sub CA record as returned by IPA API.
returned: always returned: always
type: dict type: dict
''' """
from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.basic import AnsibleModule
from ansible_collections.community.general.plugins.module_utils.ipa import IPAClient, ipa_argument_spec from ansible_collections.community.general.plugins.module_utils.ipa import IPAClient, ipa_argument_spec

16
plugins/modules/ipa_sudocmd.py
View file

@ -7,8 +7,7 @@
from __future__ import absolute_import, division, print_function from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = r''' DOCUMENTATION = r"""
---
module: ipa_sudocmd module: ipa_sudocmd
author: Thomas Krahn (@Nosmoht) author: Thomas Krahn (@Nosmoht)
short_description: Manage FreeIPA sudo command short_description: Manage FreeIPA sudo command
@ -38,10 +37,9 @@ options:
extends_documentation_fragment: extends_documentation_fragment:
- community.general.ipa.documentation - community.general.ipa.documentation
- community.general.attributes - community.general.attributes
"""
''' EXAMPLES = r"""
EXAMPLES = r'''
- name: Ensure sudo command exists - name: Ensure sudo command exists
community.general.ipa_sudocmd: community.general.ipa_sudocmd:
name: su name: su
@ -57,14 +55,14 @@ EXAMPLES = r'''
ipa_host: ipa.example.com ipa_host: ipa.example.com
ipa_user: admin ipa_user: admin
ipa_pass: topsecret ipa_pass: topsecret
''' """
RETURN = r''' RETURN = r"""
sudocmd: sudocmd:
description: Sudo command as return from IPA API description: Sudo command as return from IPA API.
returned: always returned: always
type: dict type: dict
''' """
import traceback import traceback

16
plugins/modules/ipa_sudocmdgroup.py
View file

@ -7,8 +7,7 @@
from __future__ import absolute_import, division, print_function from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = r''' DOCUMENTATION = r"""
---
module: ipa_sudocmdgroup module: ipa_sudocmdgroup
author: Thomas Krahn (@Nosmoht) author: Thomas Krahn (@Nosmoht)
short_description: Manage FreeIPA sudo command group short_description: Manage FreeIPA sudo command group
@ -45,10 +44,9 @@ options:
extends_documentation_fragment: extends_documentation_fragment:
- community.general.ipa.documentation - community.general.ipa.documentation
- community.general.attributes - community.general.attributes
"""
''' EXAMPLES = r"""
EXAMPLES = r'''
- name: Ensure sudo command group exists - name: Ensure sudo command group exists
community.general.ipa_sudocmdgroup: community.general.ipa_sudocmdgroup:
name: group01 name: group01
@ -66,14 +64,14 @@ EXAMPLES = r'''
ipa_host: ipa.example.com ipa_host: ipa.example.com
ipa_user: admin ipa_user: admin
ipa_pass: topsecret ipa_pass: topsecret
''' """
RETURN = r''' RETURN = r"""
sudocmdgroup: sudocmdgroup:
description: Sudo command group as returned by IPA API description: Sudo command group as returned by IPA API.
returned: always returned: always
type: dict type: dict
''' """
import traceback import traceback

21
plugins/modules/ipa_sudorule.py
View file

@ -7,8 +7,7 @@
from __future__ import absolute_import, division, print_function from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = r''' DOCUMENTATION = r"""
---
module: ipa_sudorule module: ipa_sudorule
author: Thomas Krahn (@Nosmoht) author: Thomas Krahn (@Nosmoht)
short_description: Manage FreeIPA sudo rule short_description: Manage FreeIPA sudo rule
@ -92,7 +91,7 @@ options:
elements: str elements: str
runasextusers: runasextusers:
description: description:
- List of external RunAs users - List of external RunAs users.
type: list type: list
elements: str elements: str
version_added: 2.3.0 version_added: 2.3.0
@ -138,11 +137,11 @@ options:
extends_documentation_fragment: extends_documentation_fragment:
- community.general.ipa.documentation - community.general.ipa.documentation
- community.general.attributes - community.general.attributes
"""
''' EXAMPLES = r"""
- name: Ensure sudo rule is present that's allows all every body to execute any command on any host without being asked
EXAMPLES = r''' for a password.
- name: Ensure sudo rule is present that's allows all every body to execute any command on any host without being asked for a password.
community.general.ipa_sudorule: community.general.ipa_sudorule:
name: sudo_all_nopasswd name: sudo_all_nopasswd
cmdcategory: all cmdcategory: all
@ -188,14 +187,14 @@ EXAMPLES = r'''
ipa_host: ipa.example.com ipa_host: ipa.example.com
ipa_user: admin ipa_user: admin
ipa_pass: topsecret ipa_pass: topsecret
''' """
RETURN = r''' RETURN = r"""
sudorule: sudorule:
description: Sudorule as returned by IPA description: Sudorule as returned by IPA.
returned: always returned: always
type: dict type: dict
''' """
import traceback import traceback

19
plugins/modules/ipa_user.py
View file

@ -7,8 +7,7 @@
from __future__ import absolute_import, division, print_function from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = r''' DOCUMENTATION = r"""
---
module: ipa_user module: ipa_user
author: Thomas Krahn (@Nosmoht) author: Thomas Krahn (@Nosmoht)
short_description: Manage FreeIPA users short_description: Manage FreeIPA users
@ -38,7 +37,7 @@ options:
description: description:
- Date at which the user password will expire. - Date at which the user password will expire.
- In the format YYYYMMddHHmmss. - In the format YYYYMMddHHmmss.
- e.g. 20180121182022 will expire on 21 January 2018 at 18:20:22. - For example V(20180121182022) will expire on 21 January 2018 at 18:20:22.
type: str type: str
loginshell: loginshell:
description: Login shell. description: Login shell.
@ -83,7 +82,7 @@ options:
description: Title. description: Title.
type: str type: str
uid: uid:
description: uid of the user. description: Uid of the user.
required: true required: true
aliases: ["name"] aliases: ["name"]
type: str type: str
@ -116,9 +115,9 @@ extends_documentation_fragment:
requirements: requirements:
- base64 - base64
- hashlib - hashlib
''' """
EXAMPLES = r''' EXAMPLES = r"""
- name: Ensure pinky is present and always reset password - name: Ensure pinky is present and always reset password
community.general.ipa_user: community.general.ipa_user:
name: pinky name: pinky
@ -170,14 +169,14 @@ EXAMPLES = r'''
ipa_host: ipa.example.com ipa_host: ipa.example.com
ipa_user: admin ipa_user: admin
ipa_pass: topsecret ipa_pass: topsecret
''' """
RETURN = r''' RETURN = r"""
user: user:
description: User as returned by IPA API description: User as returned by IPA API.
returned: always returned: always
type: dict type: dict
''' """
import base64 import base64
import hashlib import hashlib

20
plugins/modules/ipa_vault.py
View file

@ -7,8 +7,7 @@
from __future__ import absolute_import, division, print_function from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = r''' DOCUMENTATION = r"""
---
module: ipa_vault module: ipa_vault
author: Juan Manuel Parrilla (@jparrill) author: Juan Manuel Parrilla (@jparrill)
short_description: Manage FreeIPA vaults short_description: Manage FreeIPA vaults
@ -52,14 +51,14 @@ options:
username: username:
description: description:
- Any user can own one or more user vaults. - Any user can own one or more user vaults.
- Mutually exclusive with service. - Mutually exclusive with O(service).
aliases: ["user"] aliases: ["user"]
type: list type: list
elements: str elements: str
service: service:
description: description:
- Any service can own one or more service vaults. - Any service can own one or more service vaults.
- Mutually exclusive with user. - Mutually exclusive with O(user).
type: str type: str
state: state:
description: description:
@ -81,10 +80,9 @@ options:
extends_documentation_fragment: extends_documentation_fragment:
- community.general.ipa.documentation - community.general.ipa.documentation
- community.general.attributes - community.general.attributes
"""
''' EXAMPLES = r"""
EXAMPLES = r'''
- name: Ensure vault is present - name: Ensure vault is present
community.general.ipa_vault: community.general.ipa_vault:
name: vault01 name: vault01
@ -128,14 +126,14 @@ EXAMPLES = r'''
ipa_host: ipa.example.com ipa_host: ipa.example.com
ipa_user: admin ipa_user: admin
ipa_pass: topsecret ipa_pass: topsecret
''' """
RETURN = r''' RETURN = r"""
vault: vault:
description: Vault as returned by IPA API description: Vault as returned by IPA API.
returned: always returned: always
type: dict type: dict
''' """
import traceback import traceback

29
plugins/modules/ipbase_info.py
View file

@ -8,13 +8,12 @@
from __future__ import absolute_import, division, print_function from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = ''' DOCUMENTATION = r"""
---
module: "ipbase_info" module: "ipbase_info"
version_added: "7.0.0" version_added: "7.0.0"
short_description: "Retrieve IP geolocation and other facts of a host's IP address using the ipbase.com API" short_description: "Retrieve IP geolocation and other facts of a host's IP address using the ipbase.com API"
description: description:
- "Retrieve IP geolocation and other facts of a host's IP address using the ipbase.com API" - Retrieve IP geolocation and other facts of a host's IP address using the ipbase.com API.
author: "Dominik Kukacka (@dominikkukacka)" author: "Dominik Kukacka (@dominikkukacka)"
extends_documentation_fragment: extends_documentation_fragment:
- "community.general.attributes" - "community.general.attributes"
@ -22,31 +21,31 @@ extends_documentation_fragment:
options: options:
ip: ip:
description: description:
- "The IP you want to get the info for. If not specified the API will detect the IP automatically." - The IP you want to get the info for. If not specified the API will detect the IP automatically.
required: false required: false
type: str type: str
apikey: apikey:
description: description:
- "The API key for the request if you need more requests." - The API key for the request if you need more requests.
required: false required: false
type: str type: str
hostname: hostname:
description: description:
- "If the O(hostname) parameter is set to V(true), the API response will contain the hostname of the IP." - If the O(hostname) parameter is set to V(true), the API response will contain the hostname of the IP.
required: false required: false
type: bool type: bool
default: false default: false
language: language:
description: description:
- "An ISO Alpha 2 Language Code for localizing the IP data" - An ISO Alpha 2 Language Code for localizing the IP data.
required: false required: false
type: str type: str
default: "en" default: "en"
notes: notes:
- "Check U(https://ipbase.com/) for more information." - Check U(https://ipbase.com/) for more information.
''' """
EXAMPLES = ''' EXAMPLES = r"""
- name: "Get IP geolocation information of the primary outgoing IP" - name: "Get IP geolocation information of the primary outgoing IP"
community.general.ipbase_info: community.general.ipbase_info:
register: my_ip_info register: my_ip_info
@ -64,12 +63,12 @@ EXAMPLES = '''
hostname: true hostname: true
language: "de" language: "de"
register: my_ip_info register: my_ip_info
"""
''' RETURN = r"""
RETURN = '''
data: data:
description: "JSON parsed response from ipbase.com. Please refer to U(https://ipbase.com/docs/info) for the detailed structure of the response." description: "JSON parsed response from ipbase.com. Please refer to U(https://ipbase.com/docs/info) for the detailed structure
of the response."
returned: success returned: success
type: dict type: dict
sample: { sample: {
@ -213,7 +212,7 @@ data:
] ]
} }
} }
''' """
from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.basic import AnsibleModule

14
plugins/modules/ipify_facts.py
View file

@ -9,8 +9,7 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = r''' DOCUMENTATION = r"""
---
module: ipify_facts module: ipify_facts
short_description: Retrieve the public IP of your internet gateway short_description: Retrieve the public IP of your internet gateway
description: description:
@ -40,9 +39,9 @@ options:
default: true default: true
notes: notes:
- Visit https://www.ipify.org to get more information. - Visit https://www.ipify.org to get more information.
''' """
EXAMPLES = r''' EXAMPLES = r"""
# Gather IP facts from ipify.org # Gather IP facts from ipify.org
- name: Get my public IP - name: Get my public IP
community.general.ipify_facts: community.general.ipify_facts:
@ -52,16 +51,15 @@ EXAMPLES = r'''
community.general.ipify_facts: community.general.ipify_facts:
api_url: http://api.example.com/ipify api_url: http://api.example.com/ipify
timeout: 20 timeout: 20
''' """
RETURN = r''' RETURN = r"""
---
ipify_public_ip: ipify_public_ip:
description: Public IP of the internet gateway. description: Public IP of the internet gateway.
returned: success returned: success
type: str type: str
sample: 1.2.3.4 sample: 1.2.3.4
''' """
import json import json

39
plugins/modules/ipinfoio_facts.py
View file

@ -9,12 +9,11 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = ''' DOCUMENTATION = r"""
---
module: ipinfoio_facts module: ipinfoio_facts
short_description: Retrieve IP geolocation facts of a host's IP address short_description: Retrieve IP geolocation facts of a host's IP address
description: description:
- "Gather IP geolocation facts of a host's IP address using ipinfo.io API" - Gather IP geolocation facts of a host's IP address using ipinfo.io API.
author: "Aleksei Kostiuk (@akostyuk)" author: "Aleksei Kostiuk (@akostyuk)"
extends_documentation_fragment: extends_documentation_fragment:
- community.general.attributes - community.general.attributes
@ -23,65 +22,65 @@ extends_documentation_fragment:
options: options:
timeout: timeout:
description: description:
- HTTP connection timeout in seconds - HTTP connection timeout in seconds.
required: false required: false
default: 10 default: 10
type: int type: int
http_agent: http_agent:
description: description:
- Set http user agent - Set http user agent.
required: false required: false
default: "ansible-ipinfoio-module/0.0.1" default: "ansible-ipinfoio-module/0.0.1"
type: str type: str
notes: notes:
- "Check http://ipinfo.io/ for more information" - Check http://ipinfo.io/ for more information.
''' """
EXAMPLES = ''' EXAMPLES = r"""
# Retrieve geolocation data of a host's IP address # Retrieve geolocation data of a host's IP address
- name: Get IP geolocation data - name: Get IP geolocation data
community.general.ipinfoio_facts: community.general.ipinfoio_facts:
''' """
RETURN = ''' RETURN = r"""
ansible_facts: ansible_facts:
description: "Dictionary of ip geolocation facts for a host's IP address" description: "Dictionary of ip geolocation facts for a host's IP address."
returned: changed returned: changed
type: complex type: complex
contains: contains:
ip: ip:
description: "Public IP address of a host" description: "Public IP address of a host."
type: str type: str
sample: "8.8.8.8" sample: "8.8.8.8"
hostname: hostname:
description: Domain name description: Domain name.
type: str type: str
sample: "google-public-dns-a.google.com" sample: "google-public-dns-a.google.com"
country: country:
description: ISO 3166-1 alpha-2 country code description: ISO 3166-1 alpha-2 country code.
type: str type: str
sample: "US" sample: "US"
region: region:
description: State or province name description: State or province name.
type: str type: str
sample: "California" sample: "California"
city: city:
description: City name description: City name.
type: str type: str
sample: "Mountain View" sample: "Mountain View"
loc: loc:
description: Latitude and Longitude of the location description: Latitude and Longitude of the location.
type: str type: str
sample: "37.3860,-122.0838" sample: "37.3860,-122.0838"
org: org:
description: "organization's name" description: "Organization's name."
type: str type: str
sample: "AS3356 Level 3 Communications, Inc." sample: "AS3356 Level 3 Communications, Inc."
postal: postal:
description: Postal code description: Postal code.
type: str type: str
sample: "94035" sample: "94035"
''' """
from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.urls import fetch_url from ansible.module_utils.urls import fetch_url

44
plugins/modules/ipmi_boot.py
View file

@ -9,12 +9,11 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = ''' DOCUMENTATION = r"""
---
module: ipmi_boot module: ipmi_boot
short_description: Management of order of boot devices short_description: Management of order of boot devices
description: description:
- Use this module to manage order of boot devices - Use this module to manage order of boot devices.
extends_documentation_fragment: extends_documentation_fragment:
- community.general.attributes - community.general.attributes
attributes: attributes:
@ -52,14 +51,14 @@ options:
bootdev: bootdev:
description: description:
- Set boot device to use on next reboot - Set boot device to use on next reboot
- "The choices for the device are: - "The choices for the device are:"
- network -- Request network boot - V(network) -- Request network boot
- floppy -- Boot from floppy - V(floppy) -- Boot from floppy
- hd -- Boot from hard drive - V(hd) -- Boot from hard drive
- safe -- Boot from hard drive, requesting 'safe mode' - "V(safe) -- Boot from hard drive, requesting 'safe mode'"
- optical -- boot from CD/DVD/BD drive - V(optical) -- boot from CD/DVD/BD drive
- setup -- Boot into setup utility - V(setup) -- Boot into setup utility
- default -- remove any IPMI directed boot device request" - V(default) -- remove any IPMI directed boot device request
required: true required: true
choices: choices:
- network - network
@ -73,31 +72,28 @@ options:
state: state:
description: description:
- Whether to ensure that boot devices is desired. - Whether to ensure that boot devices is desired.
- "The choices for the state are: - 'The choices for the state are: - present -- Request system turn on - absent -- Request system turn on.'
- present -- Request system turn on
- absent -- Request system turn on"
default: present default: present
choices: [present, absent] choices: [present, absent]
type: str type: str
persistent: persistent:
description: description:
- If set, ask that system firmware uses this device beyond next boot. - If set, ask that system firmware uses this device beyond next boot. Be aware many systems do not honor this.
Be aware many systems do not honor this.
type: bool type: bool
default: false default: false
uefiboot: uefiboot:
description: description:
- If set, request UEFI boot explicitly. - If set, request UEFI boot explicitly. Strictly speaking, the spec suggests that if not set, the system should BIOS
Strictly speaking, the spec suggests that if not set, the system should BIOS boot and offers no "don't care" option. boot and offers no "do not care" option. In practice, this flag not being set does not preclude UEFI boot on any system
In practice, this flag not being set does not preclude UEFI boot on any system I've encountered. I have encountered.
type: bool type: bool
default: false default: false
requirements: requirements:
- pyghmi - pyghmi
author: "Bulat Gaifullin (@bgaifullin) <gaifullinbf@gmail.com>" author: "Bulat Gaifullin (@bgaifullin) <gaifullinbf@gmail.com>"
''' """
RETURN = ''' RETURN = r"""
bootdev: bootdev:
description: The boot device name which will be used beyond next boot. description: The boot device name which will be used beyond next boot.
returned: success returned: success
@ -113,9 +109,9 @@ uefimode:
returned: success returned: success
type: bool type: bool
sample: false sample: false
''' """
EXAMPLES = ''' EXAMPLES = r"""
- name: Ensure bootdevice is HD - name: Ensure bootdevice is HD
community.general.ipmi_boot: community.general.ipmi_boot:
name: test.testdomain.com name: test.testdomain.com
@ -131,7 +127,7 @@ EXAMPLES = '''
key: 1234567890AABBCCDEFF000000EEEE12 key: 1234567890AABBCCDEFF000000EEEE12
bootdev: network bootdev: network
state: absent state: absent
''' """
import traceback import traceback
import binascii import binascii

41
plugins/modules/ipmi_power.py
View file

@ -9,12 +9,11 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = ''' DOCUMENTATION = r"""
---
module: ipmi_power module: ipmi_power
short_description: Power management for machine short_description: Power management for machine
description: description:
- Use this module for power management - Use this module for power management.
extends_documentation_fragment: extends_documentation_fragment:
- community.general.attributes - community.general.attributes
attributes: attributes:
@ -52,12 +51,12 @@ options:
state: state:
description: description:
- Whether to ensure that the machine in desired state. - Whether to ensure that the machine in desired state.
- "The choices for state are: - "The choices for state are:"
- on -- Request system turn on - V(on) -- Request system turn on
- off -- Request system turn off without waiting for OS to shutdown - V(off) -- Request system turn off without waiting for OS to shutdown
- shutdown -- Have system request OS proper shutdown - V(shutdown) -- Have system request OS proper shutdown
- reset -- Request system reset without waiting for OS - V(reset) -- Request system reset without waiting for OS
- boot -- If system is off, then 'on', else 'reset'" - "V(boot) -- If system is off, then V(on), else V(reset)"
- Either this option or O(machine) is required. - Either this option or O(machine) is required.
choices: ['on', 'off', shutdown, reset, boot] choices: ['on', 'off', shutdown, reset, boot]
type: str type: str
@ -68,8 +67,7 @@ options:
type: int type: int
machine: machine:
description: description:
- Provide a list of the remote target address for the bridge IPMI request, - Provide a list of the remote target address for the bridge IPMI request, and the power status.
and the power status.
- Either this option or O(state) is required. - Either this option or O(state) is required.
required: false required: false
type: list type: list
@ -92,9 +90,9 @@ options:
requirements: requirements:
- pyghmi - pyghmi
author: "Bulat Gaifullin (@bgaifullin) <gaifullinbf@gmail.com>" author: "Bulat Gaifullin (@bgaifullin) <gaifullinbf@gmail.com>"
''' """
RETURN = ''' RETURN = r"""
powerstate: powerstate:
description: The current power state of the machine. description: The current power state of the machine.
returned: success and O(machine) is not provided returned: success and O(machine) is not provided
@ -113,19 +111,10 @@ status:
targetAddress: targetAddress:
description: The remote target address. description: The remote target address.
type: int type: int
sample: [ sample: [{"powerstate": "on", "targetAddress": 48}, {"powerstate": "on", "targetAddress": 50}]
{ """
"powerstate": "on",
"targetAddress": 48,
},
{
"powerstate": "on",
"targetAddress": 50,
},
]
'''
EXAMPLES = ''' EXAMPLES = r"""
- name: Ensure machine is powered on - name: Ensure machine is powered on
community.general.ipmi_power: community.general.ipmi_power:
name: test.testdomain.com name: test.testdomain.com
@ -153,7 +142,7 @@ EXAMPLES = '''
state: 'on' state: 'on'
- targetAddress: 50 - targetAddress: 50
state: 'off' state: 'off'
''' """
import traceback import traceback
import binascii import binascii

69
plugins/modules/iptables_state.py
View file

@ -9,8 +9,7 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = r''' DOCUMENTATION = r"""
---
module: iptables_state module: iptables_state
short_description: Save iptables state into a file or restore it from a file short_description: Save iptables state into a file or restore it from a file
version_added: '1.1.0' version_added: '1.1.0'
@ -19,26 +18,17 @@ extends_documentation_fragment:
- community.general.attributes - community.general.attributes
- community.general.attributes.flow - community.general.attributes.flow
description: description:
- C(iptables) is used to set up, maintain, and inspect the tables of IP - C(iptables) is used to set up, maintain, and inspect the tables of IP packet filter rules in the Linux kernel.
packet filter rules in the Linux kernel. - This module handles the saving and/or loading of rules. This is the same as the behaviour of the C(iptables-save) and
- This module handles the saving and/or loading of rules. This is the same C(iptables-restore) (or C(ip6tables-save) and C(ip6tables-restore) for IPv6) commands which this module uses internally.
as the behaviour of the C(iptables-save) and C(iptables-restore) (or - Modifying the state of the firewall remotely may lead to loose access to the host in case of mistake in new ruleset. This
C(ip6tables-save) and C(ip6tables-restore) for IPv6) commands which this module embeds a rollback feature to avoid this, by telling the host to restore previous rules if a cookie is still there
module uses internally. after a given delay, and all this time telling the controller to try to remove this cookie on the host through a new connection.
- Modifying the state of the firewall remotely may lead to loose access to
the host in case of mistake in new ruleset. This module embeds a rollback
feature to avoid this, by telling the host to restore previous rules if a
cookie is still there after a given delay, and all this time telling the
controller to try to remove this cookie on the host through a new
connection.
notes: notes:
- The rollback feature is not a module option and depends on task's - The rollback feature is not a module option and depends on task's attributes. To enable it, the module must be played
attributes. To enable it, the module must be played asynchronously, i.e. asynchronously, in other words by setting task attributes C(poll) to V(0), and C(async) to a value less or equal to C(ANSIBLE_TIMEOUT).
by setting task attributes C(poll) to V(0), and C(async) to a value less If C(async) is greater, the rollback will still happen if it shall happen, but you will experience a connection timeout
or equal to C(ANSIBLE_TIMEOUT). If C(async) is greater, the rollback will instead of more relevant info returned by the module after its failure.
still happen if it shall happen, but you will experience a connection
timeout instead of more relevant info returned by the module after its
failure.
attributes: attributes:
check_mode: check_mode:
support: full support: full
@ -63,18 +53,14 @@ options:
default: ipv4 default: ipv4
modprobe: modprobe:
description: description:
- Specify the path to the C(modprobe) program internally used by iptables - Specify the path to the C(modprobe) program internally used by iptables related commands to load kernel modules.
related commands to load kernel modules. - By default, V(/proc/sys/kernel/modprobe) is inspected to determine the executable's path.
- By default, V(/proc/sys/kernel/modprobe) is inspected to determine the
executable's path.
type: path type: path
noflush: noflush:
description: description:
- For O(state=restored), ignored otherwise. - For O(state=restored), ignored otherwise.
- If V(false), restoring iptables rules from a file flushes (deletes) - If V(false), restoring iptables rules from a file flushes (deletes) all previous contents of the respective table(s).
all previous contents of the respective table(s). If V(true), the If V(true), the previous rules are left untouched (but policies are updated anyway, for all built-in chains).
previous rules are left untouched (but policies are updated anyway,
for all built-in chains).
type: bool type: bool
default: false default: false
path: path:
@ -85,29 +71,26 @@ options:
required: true required: true
state: state:
description: description:
- Whether the firewall state should be saved (into a file) or restored - Whether the firewall state should be saved (into a file) or restored (from a file).
(from a file).
type: str type: str
choices: [saved, restored] choices: [saved, restored]
required: true required: true
table: table:
description: description:
- When O(state=restored), restore only the named table even if the input - When O(state=restored), restore only the named table even if the input file contains other tables. Fail if the named
file contains other tables. Fail if the named table is not declared in table is not declared in the file.
the file. - When O(state=saved), restrict output to the specified table. If not specified, output includes all active tables.
- When O(state=saved), restrict output to the specified table. If not
specified, output includes all active tables.
type: str type: str
choices: [filter, nat, mangle, raw, security] choices: [filter, nat, mangle, raw, security]
wait: wait:
description: description:
- Wait N seconds for the xtables lock to prevent instant failure in case - Wait N seconds for the xtables lock to prevent instant failure in case multiple instances of the program are running
multiple instances of the program are running concurrently. concurrently.
type: int type: int
requirements: [iptables, ip6tables] requirements: [iptables, ip6tables]
''' """
EXAMPLES = r''' EXAMPLES = r"""
# This will apply to all loaded/active IPv4 tables. # This will apply to all loaded/active IPv4 tables.
- name: Save current state of the firewall in system file - name: Save current state of the firewall in system file
community.general.iptables_state: community.general.iptables_state:
@ -151,9 +134,9 @@ EXAMPLES = r'''
- name: show current state of the firewall - name: show current state of the firewall
ansible.builtin.debug: ansible.builtin.debug:
var: iptables_state.initial_state var: iptables_state.initial_state
''' """
RETURN = r''' RETURN = r"""
applied: applied:
description: Whether or not the wanted state has been successfully restored. description: Whether or not the wanted state has been successfully restored.
type: bool type: bool
@ -235,7 +218,7 @@ tables:
] ]
} }
returned: always returned: always
''' """
import re import re

21
plugins/modules/ipwcli_dns.py
View file

@ -8,23 +8,20 @@
from __future__ import (absolute_import, division, print_function) from __future__ import (absolute_import, division, print_function)
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = ''' DOCUMENTATION = r"""
---
module: ipwcli_dns module: ipwcli_dns
short_description: Manage DNS Records for Ericsson IPWorks via ipwcli short_description: Manage DNS Records for Ericsson IPWorks using C(ipwcli)
version_added: '0.2.0' version_added: '0.2.0'
description: description:
- "Manage DNS records for the Ericsson IPWorks DNS server. The module will use the ipwcli to deploy the DNS records." - Manage DNS records for the Ericsson IPWorks DNS server. The module will use the C(ipwcli) to deploy the DNS records.
requirements: requirements:
- ipwcli (installed on Ericsson IPWorks) - ipwcli (installed on Ericsson IPWorks)
notes: notes:
- To make the DNS record changes effective, you need to run C(update dnsserver) on the ipwcli. - To make the DNS record changes effective, you need to run C(update dnsserver) on the ipwcli.
extends_documentation_fragment: extends_documentation_fragment:
- community.general.attributes - community.general.attributes
@ -126,9 +123,9 @@ options:
author: author:
- Christian Wollinger (@cwollinger) - Christian Wollinger (@cwollinger)
''' """
EXAMPLES = ''' EXAMPLES = r"""
- name: Create A record - name: Create A record
community.general.ipwcli_dns: community.general.ipwcli_dns:
dnsname: example.com dnsname: example.com
@ -157,14 +154,14 @@ EXAMPLES = '''
service: 'SIP+D2T' service: 'SIP+D2T'
replacement: '_sip._tcp.test.example.com.' replacement: '_sip._tcp.test.example.com.'
flags: S flags: S
''' """
RETURN = ''' RETURN = r"""
record: record:
description: The created record from the input params description: The created record from the input params.
type: str type: str
returned: always returned: always
''' """
from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.basic import AnsibleModule

51
plugins/modules/irc.py
View file

@ -9,8 +9,7 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = ''' DOCUMENTATION = r"""
---
module: irc module: irc
short_description: Send a message to an IRC channel or a nick short_description: Send a message to an IRC channel or a nick
description: description:
@ -26,12 +25,12 @@ options:
server: server:
type: str type: str
description: description:
- IRC server name/address - IRC server name/address.
default: localhost default: localhost
port: port:
type: int type: int
description: description:
- IRC server port number - IRC server port number.
default: 6667 default: 6667
nick: nick:
type: str type: str
@ -46,14 +45,14 @@ options:
topic: topic:
type: str type: str
description: description:
- Set the channel topic - Set the channel topic.
color: color:
type: str type: str
description: description:
- Text color for the message. - Text color for the message.
default: "none" default: "none"
choices: [ "none", "white", "black", "blue", "green", "red", "brown", "purple", "orange", "yellow", "light_green", "teal", "light_cyan", choices: ["none", "white", "black", "blue", "green", "red", "brown", "purple", "orange", "yellow", "light_green", "teal",
"light_blue", "pink", "gray", "light_gray"] "light_cyan", "light_blue", "pink", "gray", "light_gray"]
aliases: [colour] aliases: [colour]
channel: channel:
type: str type: str
@ -63,28 +62,27 @@ options:
type: list type: list
elements: str elements: str
description: description:
- A list of nicknames to send the message to. One of nick_to or channel needs to be set. When both are defined, the message will be sent to both of them. - A list of nicknames to send the message to. One of nick_to or channel needs to be set. When both are defined, the
message will be sent to both of them.
key: key:
type: str type: str
description: description:
- Channel key - Channel key.
passwd: passwd:
type: str type: str
description: description:
- Server password - Server password.
timeout: timeout:
type: int type: int
description: description:
- Timeout to use while waiting for successful registration and join - Timeout to use while waiting for successful registration and join messages, this is to prevent an endless loop.
messages, this is to prevent an endless loop
default: 30 default: 30
use_tls: use_tls:
description: description:
- Designates whether TLS/SSL should be used when connecting to the IRC server - Designates whether TLS/SSL should be used when connecting to the IRC server.
- O(use_tls) is available since community.general 8.1.0, before the option - O(use_tls) is available since community.general 8.1.0, before the option was exlusively called O(use_ssl). The latter
was exlusively called O(use_ssl). The latter is now an alias of O(use_tls). is now an alias of O(use_tls).
- B(Note:) for security reasons, you should always set O(use_tls=true) and - B(Note:) for security reasons, you should always set O(use_tls=true) and O(validate_certs=true) whenever possible.
O(validate_certs=true) whenever possible.
- The default of this option changed to V(true) in community.general 10.0.0. - The default of this option changed to V(true) in community.general 10.0.0.
type: bool type: bool
default: true default: true
@ -92,23 +90,22 @@ options:
- use_ssl - use_ssl
part: part:
description: description:
- Designates whether user should part from channel after sending message or not. - Designates whether user should part from channel after sending message or not. Useful for when using a mock bot and
Useful for when using a faux bot and not wanting join/parts between messages. not wanting join/parts between messages.
type: bool type: bool
default: true default: true
style: style:
type: str type: str
description: description:
- Text style for the message. Note italic does not work on some clients - Text style for the message. Note italic does not work on some clients.
choices: ["bold", "underline", "reverse", "italic", "none"] choices: ["bold", "underline", "reverse", "italic", "none"]
default: none default: none
validate_certs: validate_certs:
description: description:
- If set to V(false), the SSL certificates will not be validated. - If set to V(false), the SSL certificates will not be validated.
- This should always be set to V(true). Using V(false) is unsafe and should only be done - This should always be set to V(true). Using V(false) is unsafe and should only be done if the network between between
if the network between between Ansible and the IRC server is known to be safe. Ansible and the IRC server is known to be safe.
- B(Note:) for security reasons, you should always set O(use_tls=true) and - B(Note:) for security reasons, you should always set O(use_tls=true) and O(validate_certs=true) whenever possible.
O(validate_certs=true) whenever possible.
- The default of this option changed to V(true) in community.general 10.0.0. - The default of this option changed to V(true) in community.general 10.0.0.
type: bool type: bool
default: true default: true
@ -119,9 +116,9 @@ requirements: [ socket ]
author: author:
- "Jan-Piet Mens (@jpmens)" - "Jan-Piet Mens (@jpmens)"
- "Matt Martz (@sivel)" - "Matt Martz (@sivel)"
''' """
EXAMPLES = ''' EXAMPLES = r"""
- name: Send a message to an IRC channel from nick ansible - name: Send a message to an IRC channel from nick ansible
community.general.irc: community.general.irc:
server: irc.example.net server: irc.example.net
@ -156,7 +153,7 @@ EXAMPLES = '''
msg: 'All finished at {{ ansible_date_time.iso8601 }}' msg: 'All finished at {{ ansible_date_time.iso8601 }}'
color: red color: red
nick: ansibleIRC nick: ansibleIRC
''' """
# =========================================== # ===========================================
# IRC module support methods. # IRC module support methods.

19
plugins/modules/iso_create.py
View file

@ -9,8 +9,7 @@
from __future__ import absolute_import, division, print_function from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = r''' DOCUMENTATION = r"""
---
module: iso_create module: iso_create
short_description: Generate ISO file with specified files or folders short_description: Generate ISO file with specified files or folders
description: description:
@ -35,9 +34,9 @@ options:
description: description:
- This is a list of absolute paths of source files or folders which will be contained in the new generated ISO file. - This is a list of absolute paths of source files or folders which will be contained in the new generated ISO file.
- Will fail if specified file or folder in O(src_files) does not exist on local machine. - Will fail if specified file or folder in O(src_files) does not exist on local machine.
- 'Note: With all ISO9660 levels from 1 to 3, all file names are restricted to uppercase letters, numbers and - 'Note: With all ISO9660 levels from 1 to 3, all file names are restricted to uppercase letters, numbers and underscores
underscores (_). File names are limited to 31 characters, directory nesting is limited to 8 levels, and path (_). File names are limited to 31 characters, directory nesting is limited to 8 levels, and path names are limited
names are limited to 255 characters.' to 255 characters.'
type: list type: list
required: true required: true
elements: path elements: path
@ -82,9 +81,9 @@ options:
- If not specified or set to V(false), then no UDF support is added. - If not specified or set to V(false), then no UDF support is added.
type: bool type: bool
default: false default: false
''' """
EXAMPLES = r''' EXAMPLES = r"""
- name: Create an ISO file - name: Create an ISO file
community.general.iso_create: community.general.iso_create:
src_files: src_files:
@ -109,9 +108,9 @@ EXAMPLES = r'''
interchange_level: 3 interchange_level: 3
joliet: 3 joliet: 3
vol_ident: WIN_AUTOINSTALL vol_ident: WIN_AUTOINSTALL
''' """
RETURN = r''' RETURN = r"""
source_file: source_file:
description: Configured source files or directories list. description: Configured source files or directories list.
returned: on success returned: on success
@ -148,7 +147,7 @@ udf:
returned: on success returned: on success
type: bool type: bool
sample: false sample: false
''' """
import os import os
import traceback import traceback

20
plugins/modules/iso_customize.py
View file

@ -9,8 +9,7 @@
from __future__ import absolute_import, division, print_function from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = r''' DOCUMENTATION = r"""
---
module: iso_customize module: iso_customize
short_description: Add/remove/change files in ISO file short_description: Add/remove/change files in ISO file
description: description:
@ -70,13 +69,12 @@ options:
required: true required: true
notes: notes:
- The C(pycdlib) library states it supports Python 2.7 and 3.4+. - The C(pycdlib) library states it supports Python 2.7 and 3.4+.
- > - The function C(add_file) in pycdlib will overwrite the existing file in ISO with type ISO9660 / Rock Ridge 1.12 / Joliet
The function C(add_file) in pycdlib will overwrite the existing file in ISO with type ISO9660 / Rock Ridge 1.12 / Joliet / UDF. / UDF. But it will not overwrite the existing file in ISO with Rock Ridge 1.09 / 1.10. So we take workaround "delete the
But it will not overwrite the existing file in ISO with Rock Ridge 1.09 / 1.10. existing file and then add file for ISO with Rock Ridge".
So we take workaround "delete the existing file and then add file for ISO with Rock Ridge". """
'''
EXAMPLES = r''' EXAMPLES = r"""
- name: "Customize ISO file" - name: "Customize ISO file"
community.general.iso_customize: community.general.iso_customize:
src_iso: "/path/to/ubuntu-22.04-desktop-amd64.iso" src_iso: "/path/to/ubuntu-22.04-desktop-amd64.iso"
@ -89,9 +87,9 @@ EXAMPLES = r'''
- src_file: "/path/to/ubuntu.seed" - src_file: "/path/to/ubuntu.seed"
dest_file: "/preseed/ubuntu.seed" dest_file: "/preseed/ubuntu.seed"
register: customize_iso_result register: customize_iso_result
''' """
RETURN = r''' RETURN = r"""
src_iso: src_iso:
description: Path of source ISO file. description: Path of source ISO file.
returned: on success returned: on success
@ -102,7 +100,7 @@ dest_iso:
returned: on success returned: on success
type: str type: str
sample: "/path/to/customized.iso" sample: "/path/to/customized.iso"
''' """
import os import os

32
plugins/modules/iso_extract.py
View file

@ -11,8 +11,7 @@
from __future__ import absolute_import, division, print_function from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = r''' DOCUMENTATION = r"""
---
author: author:
- Jeroen Hoekx (@jhoekx) - Jeroen Hoekx (@jhoekx)
- Matt Robinson (@ribbons) - Matt Robinson (@ribbons)
@ -21,12 +20,10 @@ module: iso_extract
short_description: Extract files from an ISO image short_description: Extract files from an ISO image
description: description:
- This module has two possible ways of operation. - This module has two possible ways of operation.
- If 7zip is installed on the system, this module extracts files from an ISO - If 7zip is installed on the system, this module extracts files from an ISO into a temporary directory and copies files
into a temporary directory and copies files to a given destination, to a given destination, if needed.
if needed. - If the user has mount-capabilities (CAP_SYS_ADMIN on Linux) this module mounts the ISO image to a temporary location,
- If the user has mount-capabilities (CAP_SYS_ADMIN on Linux) this module and copies files to a given destination, if needed.
mounts the ISO image to a temporary location, and copies files to a given
destination, if needed.
requirements: requirements:
- Either 7z (from C(7zip) or C(p7zip) package) - Either 7z (from C(7zip) or C(p7zip) package)
- Or mount capabilities (root-access, or CAP_SYS_ADMIN capability on Linux) - Or mount capabilities (root-access, or CAP_SYS_ADMIN capability on Linux)
@ -71,17 +68,16 @@ options:
description: description:
- Password used to decrypt files from the ISO. - Password used to decrypt files from the ISO.
- Will only be used if 7z is used. - Will only be used if 7z is used.
- The password is used as a command line argument to 7z. This is a B(potential security risk) that - The password is used as a command line argument to 7z. This is a B(potential security risk) that allows passwords
allows passwords to be revealed if someone else can list running processes on the same machine to be revealed if someone else can list running processes on the same machine in the right moment.
in the right moment.
type: str type: str
version_added: 10.1.0 version_added: 10.1.0
notes: notes:
- Only the file checksum (content) is taken into account when extracting files - Only the file checksum (content) is taken into account when extracting files from the ISO image. If O(force=false), only
from the ISO image. If O(force=false), only checks the presence of the file. checks the presence of the file.
''' """
EXAMPLES = r''' EXAMPLES = r"""
- name: Extract kernel and ramdisk from a LiveCD - name: Extract kernel and ramdisk from a LiveCD
community.general.iso_extract: community.general.iso_extract:
image: /tmp/rear-test.iso image: /tmp/rear-test.iso
@ -89,11 +85,11 @@ EXAMPLES = r'''
files: files:
- isolinux/kernel - isolinux/kernel
- isolinux/initrd.cgz - isolinux/initrd.cgz
''' """
RETURN = r''' RETURN = r"""
# #
''' """
import os.path import os.path
import shutil import shutil

25
plugins/modules/jabber.py
View file

@ -9,12 +9,11 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = ''' DOCUMENTATION = r"""
---
module: jabber module: jabber
short_description: Send a message to jabber user or chat room short_description: Send a message to jabber user or chat room
description: description:
- Send a message to jabber - Send a message to jabber.
extends_documentation_fragment: extends_documentation_fragment:
- community.general.attributes - community.general.attributes
attributes: attributes:
@ -26,17 +25,17 @@ options:
user: user:
type: str type: str
description: description:
- User as which to connect - User as which to connect.
required: true required: true
password: password:
type: str type: str
description: description:
- password for user to connect - Password for user to connect.
required: true required: true
to: to:
type: str type: str
description: description:
- user ID or name of the room, when using room use a slash to indicate your nick. - User ID or name of the room, when using room use a slash to indicate your nick.
required: true required: true
msg: msg:
type: str type: str
@ -46,24 +45,22 @@ options:
host: host:
type: str type: str
description: description:
- host to connect, overrides user info - Host to connect, overrides user info.
port: port:
type: int type: int
description: description:
- port to connect to, overrides default - Port to connect to, overrides default.
default: 5222 default: 5222
encoding: encoding:
type: str type: str
description: description:
- message encoding - Message encoding.
# informational: requirements for nodes
requirements: requirements:
- python xmpp (xmpppy) - python xmpp (xmpppy)
author: "Brian Coca (@bcoca)" author: "Brian Coca (@bcoca)"
''' """
EXAMPLES = ''' EXAMPLES = r"""
- name: Send a message to a user - name: Send a message to a user
community.general.jabber: community.general.jabber:
user: mybot@example.net user: mybot@example.net
@ -86,7 +83,7 @@ EXAMPLES = '''
password: secret password: secret
to: mychaps@example.net to: mychaps@example.net
msg: Ansible task finished msg: Ansible task finished
''' """
import time import time
import traceback import traceback

26
plugins/modules/java_cert.py
View file

@ -8,14 +8,13 @@
from __future__ import absolute_import, division, print_function from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = r''' DOCUMENTATION = r"""
---
module: java_cert module: java_cert
short_description: Uses keytool to import/remove certificate to/from java keystore (cacerts) short_description: Uses keytool to import/remove certificate to/from java keystore (cacerts)
description: description:
- This is a wrapper module around keytool, which can be used to import certificates - This is a wrapper module around keytool, which can be used to import certificates and optionally private keys to a given
and optionally private keys to a given java keystore, or remove them from it. java keystore, or remove them from it.
extends_documentation_fragment: extends_documentation_fragment:
- community.general.attributes - community.general.attributes
- ansible.builtin.files - ansible.builtin.files
@ -61,9 +60,8 @@ options:
pkcs12_path: pkcs12_path:
description: description:
- Local path to load PKCS12 keystore from. - Local path to load PKCS12 keystore from.
- Unlike O(cert_url), O(cert_path) and O(cert_content), the PKCS12 keystore embeds the private key matching - Unlike O(cert_url), O(cert_path) and O(cert_content), the PKCS12 keystore embeds the private key matching the certificate,
the certificate, and is used to import both the certificate and its private key into the and is used to import both the certificate and its private key into the java keystore.
java keystore.
- Exactly one of O(cert_url), O(cert_path), O(cert_content), or O(pkcs12_path) is required to load certificate. - Exactly one of O(cert_url), O(cert_path), O(cert_content), or O(pkcs12_path) is required to load certificate.
type: path type: path
pkcs12_password: pkcs12_password:
@ -100,8 +98,8 @@ options:
state: state:
description: description:
- Defines action which can be either certificate import or removal. - Defines action which can be either certificate import or removal.
- When state is present, the certificate will always idempotently be inserted - When state is present, the certificate will always idempotently be inserted into the keystore, even if there already
into the keystore, even if there already exists a cert alias that is different. exists a cert alias that is different.
type: str type: str
choices: [absent, present] choices: [absent, present]
default: present default: present
@ -126,9 +124,9 @@ options:
requirements: [openssl, keytool] requirements: [openssl, keytool]
author: author:
- Adam Hamsik (@haad) - Adam Hamsik (@haad)
''' """
EXAMPLES = r''' EXAMPLES = r"""
- name: Import SSL certificate from google.com to a given cacerts keystore - name: Import SSL certificate from google.com to a given cacerts keystore
community.general.java_cert: community.general.java_cert:
cert_url: google.com cert_url: google.com
@ -196,9 +194,9 @@ EXAMPLES = r'''
keystore_pass: changeit keystore_pass: changeit
keystore_create: true keystore_create: true
state: present state: present
''' """
RETURN = r''' RETURN = r"""
msg: msg:
description: Output from stdout of keytool command after execution of given command. description: Output from stdout of keytool command after execution of given command.
returned: success returned: success
@ -216,7 +214,7 @@ cmd:
returned: success returned: success
type: str type: str
sample: "keytool -importcert -noprompt -keystore" sample: "keytool -importcert -noprompt -keystore"
''' """
import os import os
import tempfile import tempfile

67
plugins/modules/java_keystore.py
View file

@ -10,8 +10,7 @@ from __future__ import (absolute_import, division, print_function)
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = ''' DOCUMENTATION = r"""
---
module: java_keystore module: java_keystore
short_description: Create a Java keystore in JKS format short_description: Create a Java keystore in JKS format
description: description:
@ -25,25 +24,22 @@ options:
name: name:
description: description:
- Name of the certificate in the keystore. - Name of the certificate in the keystore.
- If the provided name does not exist in the keystore, the module - If the provided name does not exist in the keystore, the module will re-create the keystore. This behavior changed
will re-create the keystore. This behavior changed in community.general 3.0.0, in community.general 3.0.0, before that the module would fail when the name did not match.
before that the module would fail when the name did not match.
type: str type: str
required: true required: true
certificate: certificate:
description: description:
- Content of the certificate used to create the keystore. - Content of the certificate used to create the keystore.
- If the fingerprint of the provided certificate does not match the - If the fingerprint of the provided certificate does not match the fingerprint of the certificate bundled in the keystore,
fingerprint of the certificate bundled in the keystore, the keystore the keystore is regenerated with the provided certificate.
is regenerated with the provided certificate.
- Exactly one of O(certificate) or O(certificate_path) is required. - Exactly one of O(certificate) or O(certificate_path) is required.
type: str type: str
certificate_path: certificate_path:
description: description:
- Location of the certificate used to create the keystore. - Location of the certificate used to create the keystore.
- If the fingerprint of the provided certificate does not match the - If the fingerprint of the provided certificate does not match the fingerprint of the certificate bundled in the keystore,
fingerprint of the certificate bundled in the keystore, the keystore the keystore is regenerated with the provided certificate.
is regenerated with the provided certificate.
- Exactly one of O(certificate) or O(certificate_path) is required. - Exactly one of O(certificate) or O(certificate_path) is required.
type: path type: path
version_added: '3.0.0' version_added: '3.0.0'
@ -66,10 +62,8 @@ options:
password: password:
description: description:
- Password that should be used to secure the keystore. - Password that should be used to secure the keystore.
- If the provided password fails to unlock the keystore, the module - If the provided password fails to unlock the keystore, the module will re-create the keystore with the new passphrase.
will re-create the keystore with the new passphrase. This behavior This behavior changed in community.general 3.0.0, before that the module would fail when the password did not match.
changed in community.general 3.0.0, before that the module would fail
when the password did not match.
type: str type: str
required: true required: true
dest: dest:
@ -106,16 +100,13 @@ options:
keystore_type: keystore_type:
description: description:
- Type of the Java keystore. - Type of the Java keystore.
- When this option is omitted and the keystore doesn't already exist, the - When this option is omitted and the keystore does not already exist, the behavior follows C(keytool)'s default store
behavior follows C(keytool)'s default store type which depends on type which depends on Java version; V(pkcs12) since Java 9 and V(jks) prior (may also be V(pkcs12) if new default
Java version; V(pkcs12) since Java 9 and V(jks) prior (may also has been backported to this version).
be V(pkcs12) if new default has been backported to this version). - When this option is omitted and the keystore already exists, the current type is left untouched, unless another option
- When this option is omitted and the keystore already exists, the current leads to overwrite the keystore (in that case, this option behaves like for keystore creation).
type is left untouched, unless another option leads to overwrite the - When O(keystore_type) is set, the keystore is created with this type if it does not already exist, or is overwritten
keystore (in that case, this option behaves like for keystore creation). to match the given type in case of mismatch.
- When O(keystore_type) is set, the keystore is created with this type if
it does not already exist, or is overwritten to match the given type in
case of mismatch.
type: str type: str
choices: choices:
- jks - jks
@ -135,16 +126,14 @@ seealso:
- module: community.crypto.openssl_pkcs12 - module: community.crypto.openssl_pkcs12
- module: community.general.java_cert - module: community.general.java_cert
notes: notes:
- O(certificate) and O(private_key) require that their contents are available - O(certificate) and O(private_key) require that their contents are available on the controller (either inline in a playbook,
on the controller (either inline in a playbook, or with the P(ansible.builtin.file#lookup) lookup), or with the P(ansible.builtin.file#lookup) lookup), while O(certificate_path) and O(private_key_path) require that the
while O(certificate_path) and O(private_key_path) require that the files are files are available on the target host.
available on the target host. - By design, any change of a value of options O(keystore_type), O(name) or O(password), as well as changes of key or certificate
- By design, any change of a value of options O(keystore_type), O(name) or materials will cause the existing O(dest) to be overwritten.
O(password), as well as changes of key or certificate materials will cause """
the existing O(dest) to be overwritten.
'''
EXAMPLES = ''' EXAMPLES = r"""
- name: Create a keystore for the given certificate/private key pair (inline) - name: Create a keystore for the given certificate/private key pair (inline)
community.general.java_keystore: community.general.java_keystore:
name: example name: example
@ -174,9 +163,9 @@ EXAMPLES = '''
private_key_path: /etc/ssl/private/ssl-cert-snakeoil.key private_key_path: /etc/ssl/private/ssl-cert-snakeoil.key
password: changeit password: changeit
dest: /etc/security/keystore.jks dest: /etc/security/keystore.jks
''' """
RETURN = ''' RETURN = r"""
msg: msg:
description: Output from stdout of keytool/openssl command after execution of given command or an error. description: Output from stdout of keytool/openssl command after execution of given command or an error.
returned: changed and failure returned: changed and failure
@ -190,17 +179,17 @@ err:
sample: "Keystore password is too short - must be at least 6 characters\n" sample: "Keystore password is too short - must be at least 6 characters\n"
rc: rc:
description: keytool/openssl command execution return value description: Keytool/openssl command execution return value.
returned: changed and failure returned: changed and failure
type: int type: int
sample: "0" sample: "0"
cmd: cmd:
description: Executed command to get action done description: Executed command to get action done.
returned: changed and failure returned: changed and failure
type: str type: str
sample: "/usr/bin/openssl x509 -noout -in /tmp/user/1000/tmp8jd_lh23 -fingerprint -sha256" sample: "/usr/bin/openssl x509 -noout -in /tmp/user/1000/tmp8jd_lh23 -fingerprint -sha256"
''' """
import os import os

12
plugins/modules/jboss.py
View file

@ -9,7 +9,7 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = r''' DOCUMENTATION = r"""
module: jboss module: jboss
short_description: Deploy applications to JBoss short_description: Deploy applications to JBoss
description: description:
@ -45,17 +45,17 @@ options:
- Whether the application should be deployed or undeployed. - Whether the application should be deployed or undeployed.
type: str type: str
notes: notes:
- The JBoss standalone deployment-scanner has to be enabled in standalone.xml - The JBoss standalone deployment-scanner has to be enabled in C(standalone.xml).
- The module can wait until O(deployment) file is deployed/undeployed by deployment-scanner. - The module can wait until O(deployment) file is deployed/undeployed by deployment-scanner. Duration of waiting time depends
Duration of waiting time depends on scan-interval parameter from standalone.xml. on scan-interval parameter from C(standalone.xml).
- Ensure no identically named application is deployed through the JBoss CLI - Ensure no identically named application is deployed through the JBoss CLI.
seealso: seealso:
- name: WildFly reference - name: WildFly reference
description: Complete reference of the WildFly documentation. description: Complete reference of the WildFly documentation.
link: https://docs.wildfly.org link: https://docs.wildfly.org
author: author:
- Jeroen Hoekx (@jhoekx) - Jeroen Hoekx (@jhoekx)
''' """
EXAMPLES = r""" EXAMPLES = r"""
- name: Deploy a hello world application to the default deploy_path - name: Deploy a hello world application to the default deploy_path

14
plugins/modules/jenkins_build.py
View file

@ -8,8 +8,7 @@
from __future__ import absolute_import, division, print_function from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = ''' DOCUMENTATION = r"""
---
module: jenkins_build module: jenkins_build
short_description: Manage jenkins builds short_description: Manage jenkins builds
version_added: 2.2.0 version_added: 2.2.0
@ -79,9 +78,9 @@ options:
default: 10 default: 10
type: int type: int
version_added: 7.4.0 version_added: 7.4.0
''' """
EXAMPLES = ''' EXAMPLES = r"""
- name: Create a jenkins build using basic authentication - name: Create a jenkins build using basic authentication
community.general.jenkins_build: community.general.jenkins_build:
name: "test-check" name: "test-check"
@ -108,10 +107,9 @@ EXAMPLES = '''
user: Jenkins user: Jenkins
token: abcdefghijklmnopqrstuvwxyz123456 token: abcdefghijklmnopqrstuvwxyz123456
url: http://localhost:8080 url: http://localhost:8080
''' """
RETURN = ''' RETURN = r"""
---
name: name:
description: Name of the jenkins job. description: Name of the jenkins job.
returned: success returned: success
@ -136,7 +134,7 @@ build_info:
description: Build info of the jenkins job. description: Build info of the jenkins job.
returned: success returned: success
type: dict type: dict
''' """
import traceback import traceback
from time import sleep from time import sleep

14
plugins/modules/jenkins_build_info.py
View file

@ -8,8 +8,7 @@
from __future__ import absolute_import, division, print_function from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = ''' DOCUMENTATION = r"""
---
module: jenkins_build_info module: jenkins_build_info
short_description: Get information about Jenkins builds short_description: Get information about Jenkins builds
version_added: 7.4.0 version_added: 7.4.0
@ -50,9 +49,9 @@ options:
description: description:
- User to authenticate with the Jenkins server. - User to authenticate with the Jenkins server.
type: str type: str
''' """
EXAMPLES = ''' EXAMPLES = r"""
- name: Get information about a jenkins build using basic authentication - name: Get information about a jenkins build using basic authentication
community.general.jenkins_build_info: community.general.jenkins_build_info:
name: "test-check" name: "test-check"
@ -74,10 +73,9 @@ EXAMPLES = '''
user: Jenkins user: Jenkins
token: abcdefghijklmnopqrstuvwxyz123456 token: abcdefghijklmnopqrstuvwxyz123456
url: http://localhost:8080 url: http://localhost:8080
''' """
RETURN = ''' RETURN = r"""
---
name: name:
description: Name of the jenkins job. description: Name of the jenkins job.
returned: success returned: success
@ -102,7 +100,7 @@ build_info:
description: Build info of the jenkins job. description: Build info of the jenkins job.
returned: success returned: success
type: dict type: dict
''' """
import traceback import traceback

21
plugins/modules/jenkins_job.py
View file

@ -8,8 +8,7 @@
from __future__ import absolute_import, division, print_function from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = ''' DOCUMENTATION = r"""
---
module: jenkins_job module: jenkins_job
short_description: Manage jenkins jobs short_description: Manage jenkins jobs
description: description:
@ -28,7 +27,7 @@ options:
config: config:
type: str type: str
description: description:
- config in XML format. - Config in XML format.
- Required if job does not yet exist. - Required if job does not yet exist.
- Mutually exclusive with O(enabled). - Mutually exclusive with O(enabled).
- Considered if O(state=present). - Considered if O(state=present).
@ -77,14 +76,13 @@ options:
type: bool type: bool
default: true default: true
description: description:
- If set to V(false), the SSL certificates will not be validated. - If set to V(false), the SSL certificates will not be validated. This should only set to V(false) used on personally
This should only set to V(false) used on personally controlled sites controlled sites using self-signed certificates as it avoids verifying the source site.
using self-signed certificates as it avoids verifying the source site.
- The C(python-jenkins) library only handles this by using the environment variable E(PYTHONHTTPSVERIFY). - The C(python-jenkins) library only handles this by using the environment variable E(PYTHONHTTPSVERIFY).
version_added: 2.3.0 version_added: 2.3.0
''' """
EXAMPLES = ''' EXAMPLES = r"""
- name: Create a jenkins job using basic authentication - name: Create a jenkins job using basic authentication
community.general.jenkins_job: community.general.jenkins_job:
config: "{{ lookup('file', 'templates/test.xml') }}" config: "{{ lookup('file', 'templates/test.xml') }}"
@ -132,10 +130,9 @@ EXAMPLES = '''
enabled: false enabled: false
url: http://localhost:8080 url: http://localhost:8080
user: admin user: admin
''' """
RETURN = ''' RETURN = r"""
---
name: name:
description: Name of the jenkins job. description: Name of the jenkins job.
returned: success returned: success
@ -161,7 +158,7 @@ url:
returned: success returned: success
type: str type: str
sample: https://jenkins.mydomain.com sample: https://jenkins.mydomain.com
''' """
import os import os
import traceback import traceback

16
plugins/modules/jenkins_job_info.py
View file

@ -9,8 +9,7 @@
from __future__ import (absolute_import, division, print_function) from __future__ import (absolute_import, division, print_function)
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = ''' DOCUMENTATION = r"""
---
module: jenkins_job_info module: jenkins_job_info
short_description: Get information about Jenkins jobs short_description: Get information about Jenkins jobs
description: description:
@ -60,9 +59,9 @@ options:
type: bool type: bool
author: author:
- "Chris St. Pierre (@stpierre)" - "Chris St. Pierre (@stpierre)"
''' """
EXAMPLES = ''' EXAMPLES = r"""
# Get all Jenkins jobs anonymously # Get all Jenkins jobs anonymously
- community.general.jenkins_job_info: - community.general.jenkins_job_info:
user: admin user: admin
@ -122,12 +121,11 @@ EXAMPLES = '''
token: 126df5c60d66c66e3b75b11104a16a8a token: 126df5c60d66c66e3b75b11104a16a8a
url: https://jenkins.example.com url: https://jenkins.example.com
register: my_jenkins_job_info register: my_jenkins_job_info
''' """
RETURN = ''' RETURN = r"""
---
jobs: jobs:
description: All jobs found matching the specified criteria description: All jobs found matching the specified criteria.
returned: success returned: success
type: list type: list
sample: sample:
@ -139,7 +137,7 @@ jobs:
"color": "blue" "color": "blue"
}, },
] ]
''' """
import ssl import ssl
import fnmatch import fnmatch

34
plugins/modules/jenkins_node.py
View file

@ -8,8 +8,7 @@
from __future__ import absolute_import, division, print_function from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = ''' DOCUMENTATION = r"""
---
module: jenkins_node module: jenkins_node
short_description: Manage Jenkins nodes short_description: Manage Jenkins nodes
version_added: 10.0.0 version_added: 10.0.0
@ -25,8 +24,7 @@ attributes:
check_mode: check_mode:
support: partial support: partial
details: details:
- Check mode is unable to show configuration changes for a node that is not yet - Check mode is unable to show configuration changes for a node that is not yet present.
present.
diff_mode: diff_mode:
support: none support: none
options: options:
@ -50,8 +48,8 @@ options:
type: str type: str
state: state:
description: description:
- Specifies whether the Jenkins node should be V(present) (created), V(absent) - Specifies whether the Jenkins node should be V(present) (created), V(absent) (deleted), V(enabled) (online) or V(disabled)
(deleted), V(enabled) (online) or V(disabled) (offline). (offline).
default: present default: present
choices: ['enabled', 'disabled', 'present', 'absent'] choices: ['enabled', 'disabled', 'present', 'absent']
type: str type: str
@ -66,18 +64,15 @@ options:
elements: str elements: str
offline_message: offline_message:
description: description:
- Specifies the offline reason message to be set when configuring the Jenkins node - Specifies the offline reason message to be set when configuring the Jenkins node state.
state. - If O(offline_message) is given and requested O(state) is not V(disabled), an error will be raised.
- If O(offline_message) is given and requested O(state) is not V(disabled), an - Internally O(offline_message) is set using the V(toggleOffline) API, so updating the message when the node is already
error will be raised. offline (current state V(disabled)) is not possible. In this case, a warning will be issued.
- Internally O(offline_message) is set via the V(toggleOffline) API, so updating
the message when the node is already offline (current state V(disabled)) is not
possible. In this case, a warning will be issued.
type: str type: str
version_added: 10.0.0 version_added: 10.0.0
''' """
EXAMPLES = ''' EXAMPLES = r"""
- name: Create a Jenkins node using token authentication - name: Create a Jenkins node using token authentication
community.general.jenkins_node: community.general.jenkins_node:
url: http://localhost:8080 url: http://localhost:8080
@ -105,12 +100,11 @@ EXAMPLES = '''
community.general.jenkins_node: community.general.jenkins_node:
name: my-node name: my-node
state: disabled state: disabled
offline_message: > offline_message: >-
This node is offline for some reason. This node is offline for some reason.
''' """
RETURN = ''' RETURN = r"""
---
url: url:
description: URL used to connect to the Jenkins server. description: URL used to connect to the Jenkins server.
returned: success returned: success
@ -151,7 +145,7 @@ configured:
description: Whether or not the Jenkins node was configured by the task. description: Whether or not the Jenkins node was configured by the task.
returned: success returned: success
type: bool type: bool
''' """
import sys import sys
import traceback import traceback

60
plugins/modules/jenkins_plugin.py
View file

@ -9,14 +9,12 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = ''' DOCUMENTATION = r"""
---
module: jenkins_plugin module: jenkins_plugin
author: Jiri Tyr (@jtyr) author: Jiri Tyr (@jtyr)
short_description: Add or remove Jenkins plugin short_description: Add or remove Jenkins plugin
description: description:
- Ansible module which helps to manage Jenkins plugins. - Ansible module which helps to manage Jenkins plugins.
attributes: attributes:
check_mode: check_mode:
support: full support: full
@ -53,8 +51,7 @@ options:
type: str type: str
description: description:
- Desired plugin state. - Desired plugin state.
- If set to V(latest), the check for new version will be performed - If set to V(latest), the check for new version will be performed every time. This is suitable to keep the plugin up-to-date.
every time. This is suitable to keep the plugin up-to-date.
choices: [absent, present, pinned, unpinned, enabled, disabled, latest] choices: [absent, present, pinned, unpinned, enabled, disabled, latest]
default: present default: present
timeout: timeout:
@ -65,12 +62,10 @@ options:
updates_expiration: updates_expiration:
type: int type: int
description: description:
- Number of seconds after which a new copy of the C(update-center.json) - Number of seconds after which a new copy of the C(update-center.json) file is downloaded. This is used to avoid the
file is downloaded. This is used to avoid the need to download the need to download the plugin to calculate its checksum when O(state=latest) is specified.
plugin to calculate its checksum when O(state=latest) is specified. - Set it to V(0) if no cache file should be used. In that case, the plugin file will always be downloaded to calculate
- Set it to V(0) if no cache file should be used. In that case, the its checksum when O(state=latest) is specified.
plugin file will always be downloaded to calculate its checksum when
O(state=latest) is specified.
default: 86400 default: 86400
updates_url: updates_url:
type: list type: list
@ -109,12 +104,11 @@ options:
type: str type: str
description: description:
- Plugin version number. - Plugin version number.
- If this option is specified, all plugin dependencies must be installed - If this option is specified, all plugin dependencies must be installed manually.
manually. - It might take longer to verify that the correct version is installed. This is especially true if a specific version
- It might take longer to verify that the correct version is installed. number is specified.
This is especially true if a specific version number is specified. - Quote the version to prevent the value to be interpreted as float. For example if V(1.20) would be unquoted, it would
- Quote the version to prevent the value to be interpreted as float. For become V(1.2).
example if V(1.20) would be unquoted, it would become V(1.2).
with_dependencies: with_dependencies:
description: description:
- Defines whether to install plugin dependencies. - Defines whether to install plugin dependencies.
@ -123,24 +117,20 @@ options:
default: true default: true
notes: notes:
- Plugin installation should be run under root or the same user which owns - Plugin installation should be run under root or the same user which owns the plugin files on the disk. Only if the plugin
the plugin files on the disk. Only if the plugin is not installed yet and is not installed yet and no version is specified, the API installation is performed which requires only the Web UI credentials.
no version is specified, the API installation is performed which requires - It is necessary to notify the handler or call the M(ansible.builtin.service) module to restart the Jenkins service after
only the Web UI credentials. a new plugin was installed.
- It is necessary to notify the handler or call the M(ansible.builtin.service) module to - Pinning works only if the plugin is installed and Jenkins service was successfully restarted after the plugin installation.
restart the Jenkins service after a new plugin was installed. - It is not possible to run the module remotely by changing the O(url) parameter to point to the Jenkins server. The module
- Pinning works only if the plugin is installed and Jenkins service was must be used on the host where Jenkins runs as it needs direct access to the plugin files.
successfully restarted after the plugin installation.
- It is not possible to run the module remotely by changing the O(url)
parameter to point to the Jenkins server. The module must be used on the
host where Jenkins runs as it needs direct access to the plugin files.
extends_documentation_fragment: extends_documentation_fragment:
- ansible.builtin.url - ansible.builtin.url
- ansible.builtin.files - ansible.builtin.files
- community.general.attributes - community.general.attributes
''' """
EXAMPLES = ''' EXAMPLES = r"""
- name: Install plugin - name: Install plugin
community.general.jenkins_plugin: community.general.jenkins_plugin:
name: build-pipeline-plugin name: build-pipeline-plugin
@ -305,20 +295,20 @@ EXAMPLES = '''
when: > when: >
'enabled' in item.value 'enabled' in item.value
with_dict: "{{ my_jenkins_plugins }}" with_dict: "{{ my_jenkins_plugins }}"
''' """
RETURN = ''' RETURN = r"""
plugin: plugin:
description: plugin name description: Plugin name.
returned: success returned: success
type: str type: str
sample: build-pipeline-plugin sample: build-pipeline-plugin
state: state:
description: state of the target, after execution description: State of the target, after execution.
returned: success returned: success
type: str type: str
sample: "present" sample: "present"
''' """
import hashlib import hashlib
import io import io

41
plugins/modules/jenkins_script.py
View file

@ -9,15 +9,13 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = ''' DOCUMENTATION = r"""
---
author: James Hogarth (@hogarthj) author: James Hogarth (@hogarthj)
module: jenkins_script module: jenkins_script
short_description: Executes a groovy script in the jenkins instance short_description: Executes a groovy script in the jenkins instance
description: description:
- The C(jenkins_script) module takes a script plus a dict of values - The C(jenkins_script) module takes a script plus a dict of values to use within the script and returns the result of the
to use within the script and returns the result of the script being run. script being run.
extends_documentation_fragment: extends_documentation_fragment:
- community.general.attributes - community.general.attributes
@ -31,20 +29,18 @@ options:
script: script:
type: str type: str
description: description:
- The groovy script to be executed. - The groovy script to be executed. This gets passed as a string Template if args is defined.
This gets passed as a string Template if args is defined.
required: true required: true
url: url:
type: str type: str
description: description:
- The jenkins server to execute the script against. The default is a local - The jenkins server to execute the script against. The default is a local jenkins instance that is not being proxied
jenkins instance that is not being proxied through a webserver. through a webserver.
default: http://localhost:8080 default: http://localhost:8080
validate_certs: validate_certs:
description: description:
- If set to V(false), the SSL certificates will not be validated. - If set to V(false), the SSL certificates will not be validated. This should only set to V(false) used on personally
This should only set to V(false) used on personally controlled sites controlled sites using self-signed certificates as it avoids verifying the source site.
using self-signed certificates as it avoids verifying the source site.
type: bool type: bool
default: true default: true
user: user:
@ -58,21 +54,18 @@ options:
timeout: timeout:
type: int type: int
description: description:
- The request timeout in seconds - The request timeout in seconds.
default: 10 default: 10
args: args:
type: dict type: dict
description: description:
- A dict of key-value pairs used in formatting the script using string.Template (see https://docs.python.org/2/library/string.html#template-strings). - A dict of key-value pairs used in formatting the script using string.Template (see https://docs.python.org/2/library/string.html#template-strings).
notes: notes:
- Since the script can do anything this does not report on changes. - Since the script can do anything this does not report on changes. Knowing the script is being run it's important to set
Knowing the script is being run it's important to set changed_when changed_when for the ansible output to be clear on any alterations made.
for the ansible output to be clear on any alterations made. """
''' EXAMPLES = r"""
EXAMPLES = '''
- name: Obtaining a list of plugins - name: Obtaining a list of plugins
community.general.jenkins_script: community.general.jenkins_script:
script: 'println(Jenkins.instance.pluginManager.plugins)' script: 'println(Jenkins.instance.pluginManager.plugins)'
@ -100,15 +93,15 @@ EXAMPLES = '''
password: admin password: admin
url: https://localhost url: https://localhost
validate_certs: false # only do this when you trust the network! validate_certs: false # only do this when you trust the network!
''' """
RETURN = ''' RETURN = r"""
output: output:
description: Result of script description: Result of script.
returned: success returned: success
type: str type: str
sample: 'Result: true' sample: 'Result: true'
''' """
import json import json

58
plugins/modules/jira.py
View file

@ -20,7 +20,6 @@ module: jira
short_description: Create and modify issues in a JIRA instance short_description: Create and modify issues in a JIRA instance
description: description:
- Create and modify issues in a JIRA instance. - Create and modify issues in a JIRA instance.
extends_documentation_fragment: extends_documentation_fragment:
- community.general.attributes - community.general.attributes
@ -36,7 +35,6 @@ options:
required: true required: true
description: description:
- Base URI for the JIRA instance. - Base URI for the JIRA instance.
operation: operation:
type: str type: str
required: true required: true
@ -45,19 +43,16 @@ options:
description: description:
- The operation to perform. - The operation to perform.
- V(worklog) was added in community.general 6.5.0. - V(worklog) was added in community.general 6.5.0.
username: username:
type: str type: str
description: description:
- The username to log-in with. - The username to log-in with.
- Must be used with O(password). Mutually exclusive with O(token). - Must be used with O(password). Mutually exclusive with O(token).
password: password:
type: str type: str
description: description:
- The password to log-in with. - The password to log-in with.
- Must be used with O(username). Mutually exclusive with O(token). - Must be used with O(username). Mutually exclusive with O(token).
token: token:
type: str type: str
description: description:
@ -70,27 +65,23 @@ options:
required: false required: false
description: description:
- The project for this operation. Required for issue creation. - The project for this operation. Required for issue creation.
summary: summary:
type: str type: str
required: false required: false
description: description:
- The issue summary, where appropriate. - The issue summary, where appropriate.
- Note that JIRA may not allow changing field values on specific transitions or states. - Note that JIRA may not allow changing field values on specific transitions or states.
description: description:
type: str type: str
required: false required: false
description: description:
- The issue description, where appropriate. - The issue description, where appropriate.
- Note that JIRA may not allow changing field values on specific transitions or states. - Note that JIRA may not allow changing field values on specific transitions or states.
issuetype: issuetype:
type: str type: str
required: false required: false
description: description:
- The issue type, for issue creation. - The issue type, for issue creation.
issue: issue:
type: str type: str
required: false required: false
@ -104,12 +95,13 @@ options:
description: description:
- The comment text to add. - The comment text to add.
- Note that JIRA may not allow changing field values on specific transitions or states. - Note that JIRA may not allow changing field values on specific transitions or states.
comment_visibility: comment_visibility:
type: dict type: dict
description: description:
- Used to specify comment comment visibility. - Used to specify comment comment visibility.
- See U(https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issue-comments/#api-rest-api-2-issue-issueidorkey-comment-post) for details. - See
U(https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issue-comments/#api-rest-api-2-issue-issueidorkey-comment-post)
for details.
suboptions: suboptions:
type: type:
description: description:
@ -119,7 +111,8 @@ options:
choices: [group, role] choices: [group, role]
value: value:
description: description:
- Use value to specify value corresponding to the type of visibility restriction. For example name of the group or role. - Use value to specify value corresponding to the type of visibility restriction. For example name of the group
or role.
type: str type: str
required: true required: true
version_added: '3.2.0' version_added: '3.2.0'
@ -129,7 +122,6 @@ options:
required: false required: false
description: description:
- Only used when O(operation) is V(transition), and a bit of a misnomer, it actually refers to the transition name. - Only used when O(operation) is V(transition), and a bit of a misnomer, it actually refers to the transition name.
assignee: assignee:
type: str type: str
required: false required: false
@ -137,7 +129,6 @@ options:
- Sets the the assignee when O(operation) is V(create), V(transition), or V(edit). - Sets the the assignee when O(operation) is V(create), V(transition), or V(edit).
- Recent versions of JIRA no longer accept a user name as a user identifier. In that case, use O(account_id) instead. - Recent versions of JIRA no longer accept a user name as a user identifier. In that case, use O(account_id) instead.
- Note that JIRA may not allow changing field values on specific transitions or states. - Note that JIRA may not allow changing field values on specific transitions or states.
account_id: account_id:
type: str type: str
description: description:
@ -150,33 +141,31 @@ options:
required: false required: false
description: description:
- Set type of link, when action 'link' selected. - Set type of link, when action 'link' selected.
inwardissue: inwardissue:
type: str type: str
required: false required: false
description: description:
- Set issue from which link will be created. - Set issue from which link will be created.
outwardissue: outwardissue:
type: str type: str
required: false required: false
description: description:
- Set issue to which link will be created. - Set issue to which link will be created.
fields: fields:
type: dict type: dict
required: false required: false
description: description:
- This is a free-form data structure that can contain arbitrary data. This is passed directly to the JIRA REST API - This is a free-form data structure that can contain arbitrary data. This is passed directly to the JIRA REST API (possibly
(possibly after merging with other required data, as when passed to create). See examples for more information, after merging with other required data, as when passed to create). See examples for more information, and the JIRA
and the JIRA REST API for the structure required for various fields. REST API for the structure required for various fields.
- When passed to comment, the data structure is merged at the first level since community.general 4.6.0. Useful to add JIRA properties for example. - When passed to comment, the data structure is merged at the first level since community.general 4.6.0. Useful to add
JIRA properties for example.
- Note that JIRA may not allow changing field values on specific transitions or states. - Note that JIRA may not allow changing field values on specific transitions or states.
default: {} default: {}
jql: jql:
required: false required: false
description: description:
- Query JIRA in JQL Syntax, e.g. 'CMDB Hostname'='test.example.com'. - Query JIRA in JQL Syntax, for example V("CMDB Hostname" = test.example.com).
type: str type: str
version_added: '0.2.0' version_added: '0.2.0'
@ -198,7 +187,7 @@ options:
validate_certs: validate_certs:
required: false required: false
description: description:
- Require valid SSL certificates (set to V(false) if you would like to use self-signed certificates) - Require valid SSL certificates (set to V(false) if you would like to use self-signed certificates).
default: true default: true
type: bool type: bool
@ -212,23 +201,20 @@ options:
required: true required: true
type: path type: path
description: description:
- The path to the file to upload (from the remote node) or, if O(attachment.content) is specified, - The path to the file to upload (from the remote node) or, if O(attachment.content) is specified, the filename
the filename to use for the attachment. to use for the attachment.
content: content:
type: str type: str
description: description:
- The Base64 encoded contents of the file to attach. If not specified, the contents of O(attachment.filename) will be - The Base64 encoded contents of the file to attach. If not specified, the contents of O(attachment.filename) will
used instead. be used instead.
mimetype: mimetype:
type: str type: str
description: description:
- The MIME type to supply for the upload. If not specified, best-effort detection will be - The MIME type to supply for the upload. If not specified, best-effort detection will be done.
done.
notes: notes:
- "Currently this only works with basic-auth, or tokens." - Currently this only works with basic-auth, or tokens.
- "To use with JIRA Cloud, pass the login e-mail as the O(username) and the API token as O(password)." - To use with JIRA Cloud, pass the login e-mail as the O(username) and the API token as O(password).
author: author:
- "Steve Smith (@tarka)" - "Steve Smith (@tarka)"
- "Per Abildgaard Toft (@pertoft)" - "Per Abildgaard Toft (@pertoft)"
@ -376,8 +362,8 @@ EXAMPLES = r"""
operation: update operation: update
args: args:
fields: fields:
customfield_12931: [ {'set': {'value': 'Virtual'}} ] customfield_12931: ['set': {'value': 'Virtual'}]
customfield_13820: [ {'set': {'value':'Manually'}} ] customfield_13820: ['set': {'value': 'Manually'}]
register: cmdb_issue register: cmdb_issue
delegate_to: localhost delegate_to: localhost
@ -406,7 +392,7 @@ EXAMPLES = r"""
jql: project=cmdb AND cf[13225]="test" jql: project=cmdb AND cf[13225]="test"
args: args:
fields: fields:
lastViewed: null lastViewed:
register: issue register: issue
- name: Create a unix account for the reporter - name: Create a unix account for the reporter