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

[PR #9371/13e2097f backport][stable-10] [pi ... prof]*: normalize docs (#9380)

Browse source 
[pi ... prof]*: normalize docs (#9371)

* [pi ... prof]*: normalize docs

* Update plugins/modules/pkg5_publisher.py

Co-authored-by: Felix Fontein <felix@fontein.de>

---------

Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit 13e2097f37)

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
This commit is contained in:
patchback[bot] 2024-12-25 22:58:57 +01:00 • committed by GitHub
parent e38f9e5cfc
commit 45a3396ab0
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
23 changed files with 702 additions and 766 deletions
Download patch file Download diff file Expand all files Collapse all files

49
plugins/modules/pkgutil.py
View file

@ -12,19 +12,18 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = r'''
---
DOCUMENTATION = r"""
module: pkgutil
short_description: OpenCSW package management on Solaris
description:
- This module installs, updates and removes packages from the OpenCSW project for Solaris.
- Unlike the M(community.general.svr4pkg) module, it will resolve and download dependencies.
- See U(https://www.opencsw.org/) for more information about the project.
- This module installs, updates and removes packages from the OpenCSW project for Solaris.
- Unlike the M(community.general.svr4pkg) module, it will resolve and download dependencies.
- See U(https://www.opencsw.org/) for more information about the project.
author:
- Alexander Winkler (@dermute)
- David Ponessa (@scathatheworm)
- Alexander Winkler (@dermute)
- David Ponessa (@scathatheworm)
extends_documentation_fragment:
- community.general.attributes
- community.general.attributes
attributes:
check_mode:
support: full
@ -35,40 +34,40 @@ attributes:
options:
name:
description:
- The name of the package.
- When using O(state=latest), this can be V('*'), which updates all installed packages managed by pkgutil.
- The name of the package.
- When using O(state=latest), this can be V('*'), which updates all installed packages managed by pkgutil.
type: list
required: true
elements: str
aliases: [ pkg ]
aliases: [pkg]
site:
description:
- The repository path to install the package from.
- Its global definition is in C(/etc/opt/csw/pkgutil.conf).
- The repository path to install the package from.
- Its global definition is in C(/etc/opt/csw/pkgutil.conf).
required: false
type: str
state:
description:
- Whether to install (V(present)/V(installed)), or remove (V(absent)/V(removed)) packages.
- The upgrade (V(latest)) operation will update/install the packages to the latest version available.
- Whether to install (V(present)/V(installed)), or remove (V(absent)/V(removed)) packages.
- The upgrade (V(latest)) operation will update/install the packages to the latest version available.
type: str
required: true
choices: [ absent, installed, latest, present, removed ]
choices: [absent, installed, latest, present, removed]
update_catalog:
description:
- If you always want to refresh your catalog from the mirror, even when it's not stale, set this to V(true).
- If you always want to refresh your catalog from the mirror, even when it's not stale, set this to V(true).
type: bool
default: false
force:
description:
- To allow the update process to downgrade packages to match what is present in the repository, set this to V(true).
- This is useful for rolling back to stable from testing, or similar operations.
- To allow the update process to downgrade packages to match what is present in the repository, set this to V(true).
- This is useful for rolling back to stable from testing, or similar operations.
type: bool
default: false
version_added: 1.2.0
'''
"""
EXAMPLES = r'''
EXAMPLES = r"""
- name: Install a package
community.general.pkgutil:
name: CSWcommon
@ -88,8 +87,8 @@ EXAMPLES = r'''
- name: Install several packages
community.general.pkgutil:
name:
- CSWsudo
- CSWtop
- CSWsudo
- CSWtop
state: present
- name: Update all packages
@ -102,9 +101,9 @@ EXAMPLES = r'''
name: '*'
state: latest
force: true
'''
"""
RETURN = r''' # '''
RETURN = r""" # """
from ansible.module_utils.basic import AnsibleModule