Clarify how package module works (#70345)
Module package is actually a proxy to a native package manager modules (internally it delegates to the module that matches the results of ansible_pkg_mgr). Fixes #69371
This commit is contained in:
parent
ea119d3089
commit
3af7425367
1 changed files with 11 additions and 5 deletions
|
@ -17,8 +17,14 @@ author:
|
||||||
- Ansible Core Team
|
- Ansible Core Team
|
||||||
short_description: Generic OS package manager
|
short_description: Generic OS package manager
|
||||||
description:
|
description:
|
||||||
- Installs, upgrade and removes packages using the underlying OS package manager.
|
- This modules manages packages on a target without specifying a package manager module (like M(ansible.builtin.yum), M(ansible.builtin.apt), ...).
|
||||||
- For Windows targets, use the M(ansible.windows.win_package) module instead.
|
It is convenient to use in an heterogeneous environment of machines without having to create a specific task for
|
||||||
|
each package manager. `package` calls behind the module for the package manager used by the operating system
|
||||||
|
discovered by the module M(ansible.builtin.setup). If `setup` was not yet run, `package` will run it.
|
||||||
|
- This module acts as a proxy to the underlying package manager module. While all arguments will be passed to the
|
||||||
|
underlying module, not all modules support the same arguments. This documentation only covers the minimum intersection
|
||||||
|
of module arguments that all packaging modules support.
|
||||||
|
- For Windows targets, use the M(ansile.windows.win_package) module instead.
|
||||||
options:
|
options:
|
||||||
name:
|
name:
|
||||||
description:
|
description:
|
||||||
|
@ -33,15 +39,15 @@ options:
|
||||||
required: true
|
required: true
|
||||||
use:
|
use:
|
||||||
description:
|
description:
|
||||||
- The required package manager module to use (yum, apt, etc). The default 'auto' will use existing facts or try to autodetect it.
|
- The required package manager module to use (`yum`, `apt`, etc). The default 'auto' will use existing facts or try to autodetect it.
|
||||||
- You should only use this field if the automatic selection is not working for some reason.
|
- You should only use this field if the automatic selection is not working for some reason.
|
||||||
required: false
|
required: false
|
||||||
default: auto
|
default: auto
|
||||||
requirements:
|
requirements:
|
||||||
- Whatever is required for the package plugins specific for each system.
|
- Whatever is required for the package plugins specific for each system.
|
||||||
notes:
|
notes:
|
||||||
- This module actually calls the pertinent package modules for each system (apt, yum, etc).
|
- While `package` abstracts package managers to ease dealing with multiple distributions, package name often differs for the same software.
|
||||||
- For Windows targets, use the M(ansible.windows.win_package) module instead.
|
|
||||||
'''
|
'''
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
- name: Install ntpdate
|
- name: Install ntpdate
|
||||||
|
|
Loading…
Reference in a new issue