Update documentation of the 'pkg' and 'state' parameters in yum.
The yum module allows the 'name' parameter to be given as 'pkg', in a similar way to some of the other package managers. This change documents this alias. The module's 'state' parameter has two other aliases, in line with the 'apt' action; the 'state' parameter can take 'installed' as an alias for 'present', and 'removed' as an alias for 'absent'. These aliases are documented.
This commit is contained in:
parent
03035d7a31
commit
490038b0e4
1 changed files with 3 additions and 3 deletions
|
@ -51,7 +51,7 @@ options:
|
||||||
- "Package name, or package specifier with version, like C(name-1.0). When using state=latest, this can be '*' which means run: yum -y update. You can also pass a url or a local path to a rpm file. To operate on several packages this can accept a comma separated list of packages or (as of 2.0) a list of packages."
|
- "Package name, or package specifier with version, like C(name-1.0). When using state=latest, this can be '*' which means run: yum -y update. You can also pass a url or a local path to a rpm file. To operate on several packages this can accept a comma separated list of packages or (as of 2.0) a list of packages."
|
||||||
required: true
|
required: true
|
||||||
default: null
|
default: null
|
||||||
aliases: []
|
aliases: [ 'pkg' ]
|
||||||
exclude:
|
exclude:
|
||||||
description:
|
description:
|
||||||
- "Package name(s) to exclude when state=present, or latest"
|
- "Package name(s) to exclude when state=present, or latest"
|
||||||
|
@ -65,9 +65,9 @@ options:
|
||||||
default: null
|
default: null
|
||||||
state:
|
state:
|
||||||
description:
|
description:
|
||||||
- Whether to install (C(present), C(latest)), or remove (C(absent)) a package.
|
- Whether to install (C(present) or C(installed), C(latest)), or remove (C(absent) or C(removed)) a package.
|
||||||
required: false
|
required: false
|
||||||
choices: [ "present", "latest", "absent" ]
|
choices: [ "present", "installed", "latest", "absent", "removed" ]
|
||||||
default: "present"
|
default: "present"
|
||||||
enablerepo:
|
enablerepo:
|
||||||
description:
|
description:
|
||||||
|
|
Loading…
Reference in a new issue